-#LyX 1.5.2svn created this file. For more info see http://www.lyx.org/
-\lyxformat 276
+#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 362
\begin_document
\begin_header
-\textclass book
+\textclass scrbook
\begin_preamble
+% DO NOT ALTER THIS PREAMBLE!!!
+%
+% This preamble is designed to ensure that the manual prints
+% out as advertised. If you mess with this preamble,
+% parts of the manual may not print out as expected. If you
+% have problems LaTeXing this file, please contact
+% the documentation team
+% email: lyx-docs@lists.lyx.org
+
+% if pdflatex is used
+\usepackage{ifpdf}
+\ifpdf
+
+ % set fonts for nicer pdf view
+ \IfFileExists{lmodern.sty}
+ {\usepackage{lmodern}}{}
+
+\fi % end if pdflatex is used
+
+% the pages of the TOC are numbered roman
+% and a PDF-bookmark for the TOC is added
+\pagenumbering{roman}
+\let\myTOC\tableofcontents
+\renewcommand{\tableofcontents}{%
+ \pdfbookmark[1]{\contentsname}{}
+ \myTOC
+ \cleardoublepage
+ \pagenumbering{arabic}}
+
+% redefine the \LyX macro for PDF bookmarks
+\def\LyX{\texorpdfstring{%
+ L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
+ {LyX}}
+
+% used for multi-column text
\usepackage{multicol}
+
+% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
\end_preamble
+\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
+\use_default_options false
+\begin_modules
+logicalmkup
+theorems-ams
+theorems-ams-extended
+\end_modules
+\begin_local_layout
+Format 7
+InsetLayout CharStyle:MenuItem
+LyxType charstyle
+LabelString menu
+LatexType command
+LatexName menuitem
+Font
+Family Sans
+EndFont
+Preamble
+\newcommand*{\menuitem}[1]{{\sffamily #1}}
+EndPreamble
+End
+\end_local_layout
\language english
\inputencoding latin1
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
+\use_xetex false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
+
\graphics default
-\paperfontsize default
+\default_output_format default
+\bibtex_command default
+\index_command default
+\paperfontsize 12
\spacing single
+\use_hyperref true
+\pdf_title "LyX's Extended manual"
+\pdf_author "LyX Team"
+\pdf_subject "LyX's extended documentation"
+\pdf_keywords "LyX, Documentation, Extended"
+\pdf_bookmarks true
+\pdf_bookmarksnumbered true
+\pdf_bookmarksopen false
+\pdf_bookmarksopenlevel 1
+\pdf_breaklinks false
+\pdf_pdfborder false
+\pdf_colorlinks true
+\pdf_backref false
+\pdf_pdfusetitle false
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
\papersize default
\use_geometry false
\use_amsmath 0
\use_esint 0
\cite_engine basic
\use_bibtopic false
+\use_indices false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\begin_body
\begin_layout Title
-Extended LyX Features
+Additional LyX Features
\end_layout
\begin_layout Author
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\noindent
Principal maintainer of this file is
\noun on
- Mike Ressler
+ Richard Heck
\noun default
.
If you have comments or error corrections, please send them to the LyX
- Documentation mailing list, <lyx-docs@lists.lyx.org>.
+ Documentation mailing list,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\noindent
+<lyx-docs@lists.lyx.org>
+\end_layout
+
+\end_inset
+
+.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand tableofcontents
+\begin_inset CommandInset toc
+LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Standard
-The
-\emph on
-Extended LyX Features
-\emph default
- manual, which you are now reading, is essentially Part II of the
+This manual is essentially Part II of the
\emph on
User's Guide\SpecialChar \@.
\emph default
- The reason for splitting this document is simple: the
+ The reason for separating this document out is simple: the
\emph on
User's Guide
\emph default
- is already huge, and it contains all of the basic features one needs to
- know in order to prepare most documents.
- However, the LyX Team has a long-term goal of making LyX extensible through
- various configuration files and external packages.
+ is already quite lengthy, and it contains information on all of the basic
+ features one needs to know in order to prepare most documents.
+ However, the LyX Team has worked to LyX extensible through various configuratio
+n files and external packages.
That means that if you want to support the Fizzwizzle LaTeX package, you
- can create a layout file for it without having to alter LyX itself.
+ can create a layout file (or module) for it without having to alter LyX
+ itself.
We've already had contributions of several new features this way.
- This is the place where all of that gets documented.
+ This is the place where all of those get documented.
\end_layout
\begin_layout Standard
\emph on
is
\emph default
- only WYSIWYM, and will only ever interface to certain LaTeX features.
-\end_layout
-
-\begin_layout Standard
-Of course, with all of this extra documentation,
-\emph on
-Extended LyX Features
-\emph default
- may itself grow too big for its britches.
- In that case, you can just call it the
-\begin_inset Quotes eld
-\end_inset
-
-Overextended Manual
-\begin_inset Quotes erd
-\end_inset
-
- for fun!
+ only WYSIWYM and will only ever interface to some, not all, LaTeX features.
\end_layout
\begin_layout Standard
\emph on
Introduction
\emph default
- is the first place to go, since it will direct you to the correct manual,
- and it also describes the notation and format of all of the manuals.
+ is the first place to go, since it describes the notation and format of
+ all of the manuals.
You should also be thoroughly familiar with the
\emph on
User's Guide
\emph default
- and all of the basic features of LyX.
-
-\end_layout
-
-\begin_layout Standard
-In this document, many sections are independent articles contributed by
- an individual and are noted as such.
- This person is generally whoever wrote the layout file for the new document
- class or LaTeX package, or implemented the feature.
- If there is no mention of an author to a chapter [or chapter sections],
- that means it was written by the LyX Documentation Team.
+ and all of the basic features of LyX before attempting to read this one.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand label
-name "sec:lyxandlatex"
-
-\end_inset
-
This chapter is for both TeX-nicians and the LaTeX-curious.
In it, we'll explain how LyX and LaTeX work together to produce printable
output.
\end_layout
\begin_layout Standard
-At one time, we called LyX a
+At one time, LyX was called a
\begin_inset Quotes eld
\end_inset
but that's no longer true.
There are frontends to LaTeX out there.
- They are basically editors with the ability to run LaTeX and mark any errors
- in the file you're editing.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
+ There are also the LaTeX modes for vi and emacs, of course.
+\end_layout
+
+\end_inset
+
+ These are basically text editors with the ability to run LaTeX and mark
+ any errors in the file you're editing.
Although LyX
\emph on
is
\emph on
does
\emph default
- run LaTeX, and it also marks errors in the file, it also does much, much
- more.
- Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
- LyX has also added a few extensions to LaTeX.
+ run LaTeX, and it also indicates errors in the file, it also does much,
+ much more.
+ For one thing, you don't need to know LaTeX to use LyX effectively.
+ And LyX has added its own extensions to LaTeX.
Try the following sometime: select
-\family sans
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Export\SpecialChar \menuseparator
LaTeX
-\family default
+\end_layout
+
+\end_inset
+
from the
-\family sans
-\bar under
-F
-\bar default
-ile
-\family default
- menu, then look at the preamble of the resulting
-\family typewriter
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File
+\end_layout
+
+\end_inset
+
+ menu (or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Source
+\end_layout
+
+\end_inset
+
+), then look at the preamble of the resulting
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
file.
You'll notice a variety of new macros defined specifically by LyX.
These macros are defined automatically, according to the features you use
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-View\InsetSpace ~
-
-\emph on
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
Format
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-\bar under
-U
-\bar default
-pdate\SpecialChar \menuseparator
+\end_layout
-\emph on
+\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Update\SpecialChar \menuseparator
Format
\end_layout
+\end_inset
+
+
+\end_layout
+
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Print
+\end_layout
+
+\end_inset
+
-\family sans
-\bar under
-F
-\bar default
-ile
-\bar under
-\SpecialChar \menuseparator
-P
-\bar default
-rint
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Fax
+\end_layout
+
+\end_inset
+
-\family sans
-\bar under
-F
-\bar default
-ile
-\bar under
-\SpecialChar \menuseparator
-F
-\bar default
-ax
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-When you run LaTeX on the file you're editing, LyX performs these steps:
+When LyX runs LaTeX on the file you're editing, it performs these steps:
\end_layout
\begin_layout Enumerate
Convert the document to LaTeX and save to a file with the extension
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
in place of
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.lyx
-\family default
+\end_layout
+
+\end_inset
+
.
\end_layout
\begin_layout Enumerate
Run LaTeX on the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
- file (maybe several times).
+\end_layout
+
+\end_inset
+
+ file (maybe several times), and run any other commands (such as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+bibtex
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+makeindex
+\end_layout
+
+\end_inset
+
+) needed to compile the LaTeX file.
\end_layout
\begin_layout Enumerate
-If there are any errors, insert error boxes in the document to mark where
- they are.
- These boxes are transient and are not saved along with the document.
+If there are any errors, show the error log.
\end_layout
\begin_layout Standard
If you've run LaTeX using
-\family sans
-View\InsetSpace ~
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+View
+\bar under
+\SpecialChar \menuseparator
+
+\bar default
DVI
-\family default
-, LyX then executes
-\family typewriter
-xdvi
-\family default
- on the DVI-file.
+\end_layout
+
+\end_inset
+
+, LyX then runs a DVI viewer to display the DVI-file.
If you've used
-\family sans
-View\InsetSpace ~
-PostScript
-\family default
- or
-\family sans
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+View
\bar under
-P
+\SpecialChar \menuseparator
+
\bar default
-rint
-\family default
-, LyX performs two more steps:
+PostScript
+\end_layout
+
+\end_inset
+
+, LyX performs further steps:
\end_layout
\begin_layout Itemize
Run
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
dvips
-\family default
- to convert the DVI file to PostScript:
\end_layout
-\begin_deeper
-\begin_layout Itemize
-For
-\family sans
-View\InsetSpace ~
-PostScript
-\family default
-, the output file has the extension
-\family typewriter
-.ps_tmp
-\end_layout
+\end_inset
-\begin_layout Itemize
-For
-\family sans
-\bar under
-P
-\bar default
-rint
-\family default
-\InsetSpace ~
-, the output file has the extension
-\family typewriter
-.ps
-\family default
-, as expected.
+ to convert the DVI file to PostScript.
\end_layout
-\end_deeper
\begin_layout Itemize
-Execute
-\family typewriter
+Run a PostScript viewer, such as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
ghostview
-\family default
- or send the PostScript file to the printer.
\end_layout
-\begin_layout Section
-\begin_inset Quotes eld
\end_inset
-Help! LyX generated an unreadable
-\family typewriter
-.tex
-\family default
- file!
-\begin_inset Quotes erd
-\end_inset
+, to display the PostScript file.
+\end_layout
+\begin_layout Standard
+LyX does similar things when viewing, or exporting, other formats.
+\end_layout
+\begin_layout Section
+Translating LaTeX files into LyX
\end_layout
\begin_layout Standard
-Die-hard LaTeX users will scream and howl this into the night, then declare
- LyX useless, simply because they didn't RTFM.
+You can import a LaTeX file into LyX by using the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Import\SpecialChar \menuseparator
+LaTeX
\end_layout
-\begin_layout Standard
-We're going to set the record straight.
- LyX produces two kinds of LaTeX files.
- One is human readable.
- The other is LyX readable.
- Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
- scan for errors.
- The resulting
-\family typewriter
-.tex
-\family default
- file is not human readable.
- Don't even try to read it.
- If you want a
-\family typewriter
-.tex
-\family default
- file that you can send to a colleague, select
-\family sans
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+\end_inset
-\bar under
-L
-\bar default
-aTeX
-\family default
- from the
-\family sans
-\bar under
-F
-\bar default
-ile
-\family default
- menu.
-\end_layout
+ command in LyX.
+ This will call a program named
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Section
-Translating LaTeX files into LyX
-\begin_inset LatexCommand label
-name "sec:Translating-LaTeX-files"
+\begin_layout Plain Layout
+tex2lyx
+\end_layout
\end_inset
+ which will create a file
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+foo.lyx
\end_layout
-\begin_layout Standard
-You can import a LaTeX file into LyX by using the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-mport\SpecialChar \menuseparator
+\end_inset
-\bar under
-L
-\bar default
-aTeX
-\family default
- command in LyX.
- This will call a program named
-\family typewriter
-tex2lyx
-\family default
----which will create a file
-\family typewriter
-foo.lyx
-\family default
from the file
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
foo.tex
-\family default
----and then open that file.
\end_layout
-\begin_layout Standard
+\end_inset
-\family typewriter
-tex2lyx
-\family default
- will translate most legal LaTeX, but not everything.
- It will leave things it doesn't understand in TeX mode, so after translating
- a file with
-\family typewriter
-tex2lyx
-\family default
-, you can look for red text and hand-edit it to look right.
-\end_layout
+.
+ LyX will then open that file.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
-If you just want to put a piece of LaTeX code into a LyX file, see Section\InsetSpace ~
+\begin_layout Plain Layout
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset LatexCommand ref
-reference "sec:latexcodes"
+\begin_layout Plain Layout
+tex2lyx
+\end_layout
\end_inset
-.
+ can also be run from the command line, of course.
\end_layout
-\begin_layout Section
-Inserting LaTeX Code into LyX Documents
-\begin_inset LatexCommand label
-name "sec:Inserting-LaTeX-Code"
-
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand label
-name "sec:latexcodes"
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+tex2lyx
+\end_layout
\end_inset
- This is a rather important point: You can always insert LaTeX code into
- any LyX document.
- LyX simply cannot, and will probably never be able to, display every possible
- LaTeX construct.
- If ever you need to insert LaTeX commands into your LyX document, you can
- use the ERT box, which you can insert into your document with
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+ will translate most legal LaTeX, but not everything.
+ It will put things it doesn't understand into TeX code, so after translating
+ a file with
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+tex2lyx
+\end_layout
-\bar under
-T
-\bar default
-eX
-\family default
-.
- The ERT box comes in three forms: collapsed, open, and inlined.
- The first two are used just like any other collapsible (foldable) box (such
- as footnotes), and are useful for significant amounts of LaTeX commands.
- An
-\begin_inset Quotes eld
\end_inset
-inlined
-\begin_inset Quotes erd
+, you can look for TeX code and hand-edit it until it looks right.
+\end_layout
+
+\begin_layout Standard
+If you don't know what TeX code is, read the next section.
+\end_layout
+
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Inserting-TeX-Code"
+
\end_inset
- ERT box displays its content as part of the button, and is useful for very
- short sections of LaTeX commands.
-
-\begin_inset ERT
-status inlined
+Inserting TeX Code into LyX Documents
+\end_layout
\begin_layout Standard
+Anything you can do in LaTeX you can do in LyX, for a very simple reason:
+ You can always insert TeX code into any LyX document.
+ LyX cannot, and will never be able to, display every possible LaTeX construct.
+ If ever you need to insert LaTeX commands into your LyX document, you can
+ use the
+\begin_inset Flex CharStyle:Code
+status collapsed
-% like this
+\begin_layout Plain Layout
+TeX Code
\end_layout
\end_inset
+ box, which you can insert into your document with
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+TeX Code
\end_layout
-\begin_layout Standard
-You can switch between all three by right-clicking on the ERT.
- Note that if you want more than one line of LaTeX commands, you cannot
- use the inlined mode.
+\end_inset
+
+.
\end_layout
\begin_layout Standard
\backslash
begin{tabular}{ll}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{minipage}{5cm}
-\newline
+\begin_inset Newline newline
+\end_inset
+
This is an example for a minipage environment.
You
-\newline
+\begin_inset Newline newline
+\end_inset
+
can put nearly everything in it, even (non-floating)
-\newline
+\begin_inset Newline newline
+\end_inset
+
figures and tables.
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{minipage}
-\newline
+\begin_inset Newline newline
+\end_inset
+
&
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{minipage}{5cm}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{verbatim}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{minipage}{5cm}
-\newline
+\begin_inset Newline newline
+\end_inset
+
This ...
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{minipage}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{verbatim}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{minipage}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{tabular}
\end_layout
\begin_layout Standard
-The ERT box containing this text is directly after this paragraph.
- Those of you reading the manual online will only see a bunch of funky text
- in red.
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TeX Code
+\end_layout
+
+\end_inset
+
+ box containing this text is directly after this paragraph.
+ Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
\end_layout
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
begin{tabular}{ll}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
begin{minipage}{5cm}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
This is an example for a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
end{minipage}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
&
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
begin{minipage}{5cm}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
begin{verbatim}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
begin{minipage}{5cm}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
This ...
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
end{minipage}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
end{verbatim}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
end{minipage}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\end_layout
\begin_layout Standard
-In addition to these two methods, you can also create a separate file containing
- some complex LaTeX structure.
- You can then use
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-\InsetSpace ~
+In addition to using TeX code, you can also create a separate file containing
+ some complex LaTeX structure and then use
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
Document
-\family default
+\end_layout
+
+\end_inset
+
to include your file (you should select the type
-\family sans
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
Input
-\family default
+\end_layout
+
+\end_inset
+
).
We recommend that you only do this if you have a
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
file which you
\emph on
know
\emph default
works already.
- Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
-
+ Otherwise, you'll have a big job tracking down LaTeX errors.
\end_layout
\begin_layout Standard
-There are a few last notes to emphasize:
-\end_layout
-
-\begin_layout Itemize
-Inside of LyX, LaTeX code appears
-\emph on
-in red
+There are a few last points to emphasize:
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-That last note refers to two things.
- First, LyX does have quite a few features tucked into it, and more are
- coming.
+On that last point, LyX does have quite a few features tucked into it, and
+ more are coming.
Be sure to check the manuals to make sure that LyX doesn't have such-and-such
- feature before you go off merrily coding LaTeX.
- Second, there are numerous LaTeX packages out there to do all sorts of
+ feature before you decide you have to do it by hand.
+ Moreover, there are numerous LaTeX packages out there to do all sorts of
things, from labels to envelopes to fancy multipage tables.
- Check out a CTAN site for details (see Section
-\begin_inset Quotes eld
-\end_inset
+ Check out
+\begin_inset CommandInset href
+LatexCommand href
+name "CTAN"
+target "http://www.ctan.org/"
-Requirements
-\begin_inset Quotes erd
\end_inset
- of the
-\emph on
-User's Guide
-\emph default
-).
-\begin_inset Foot
-status open
-
-\begin_layout Standard
-Note from
-\noun on
-John Weiss
-\noun default
-: I seem to do this an awful lot.
- Sat down and merrily began coding something to print out labels, only to
- learn that there were already 2 different LaTeX packages to do this.
- Worse yet --- I had them already!
-\end_layout
+ for details, and see chapter
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "cha:secrets"
\end_inset
-
+.
\end_layout
\begin_layout Standard
.
\end_layout
-\begin_layout Standard
-There are a number of LaTeX commands which have to be placed before the
- beginning of the actual text.
- They go into the preamble, and this is explained in the next section.
-\end_layout
-
\begin_layout Section
LyX and the LaTeX Preamble
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand label
-name "sec:preamble"
-
-\end_inset
-
If you already know LaTeX, there is no need to explain here what the preamble
is good for.
- If you don't, the following will give you some ideas --- we recommend again
+ If you don't, the following will give you some ideas—we recommend again
that you consult a LaTeX book for further information.
In any case, you should read the points below, because they explain what
you can do and what you don't need to do in the LaTeX preamble of a LyX
\end_layout
\begin_layout Itemize
-declare the document class.
- LyX already does this for you.
-\end_layout
+Declare the document class.
+
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
-If you're a seasoned LaTeX-nician, and you have some custom document class
+LyX already does this for you.
+ If you're a seasoned LaTeX-nician, and you have a custom document class
you want to use, check out the
\emph on
Customization Manual
\emph default
for information on how to make LyX interface to it.
- Be sure to submit your efforts to the LyX Team for inclusion in future
- versions!
\end_layout
-\end_deeper
\begin_layout Itemize
-declare the usage of packages.
- LaTeX packages provide special commands, which are only available within
+Declare the usage of packages.
+
+\begin_inset Newline newline
+\end_inset
+
+LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
For example, the package
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
indentfirst
-\family default
+\end_layout
+
+\end_inset
+
forces all paragraphs to be indented.
There are other packages for labels, envelopes, margins, etc.
\end_layout
\begin_layout Itemize
-set counters, variables, lengths and widths.
- There are several LaTeX counters and variables which
+Set counters, variables, lengths and widths.
+
+\begin_inset Newline newline
+\end_inset
+
+There are several LaTeX counters and variables which
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- [There are other variables which you can set and reset inside the document,
- too.] Margins are a good example of something which must be set in the preamble.
+ (There are variables which you can set and reset inside the document, too.)
+ Margins are a good example of something which must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\end_layout
\begin_layout Itemize
-declare user defined commands [with
-\family typewriter
+Declare user defined commands (with
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
newcommand
-\family default
+\end_layout
+
+\end_inset
+
or
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
renewcommand
-\family default
-], mostly abbreviations for LaTeX commands which appear very often inside
- a document.
- Although the preamble is a good place to declare such commands, they
-\emph on
-can
-\emph default
- be declared anywhere else [but
+\end_layout
+
+\end_inset
+
+).
+\begin_inset Newline newline
+\end_inset
+
+These are abbreviations for LaTeX commands which appear very often inside
+ a document.
+ Although the preamble is a good place to declare such commands, they
\emph on
-before
+can
\emph default
- they are used for the first time, of course\SpecialChar \ldots{}
-].
+ be declared anywhere (before they are used for the first time, of course).
This can be useful if there is a lot of raw LaTeX code in your document,
which normally should not be the case.
\end_layout
\begin_layout Standard
LyX adds its own set of definitions to the preamble of the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
file it produces.
This makes LaTeX files generated by LyX portable.
\end_layout
\begin_layout Standard
The commands which LyX adds to the preamble of a LaTeX file are fixed; you
can't change them without patching LyX itself.
- You can, however, add your own stuff to the preamble.
- There are two ways to do this:
+ You can, however, add your own stuff to the preamble by selecting
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Preamble
\end_layout
-\begin_layout Enumerate
-Select
-\family sans
-\bar under
-L
-\bar default
-aTeX\InsetSpace ~
+\end_inset
-\bar under
-P
-\bar default
-reamble
-\family default
- from the
-\family sans
-\bar under
-D
-\bar default
-ocument
-\family default
- menu, or via the
-\family sans
-\bar under
-D
-\bar default
-ocument
-\family default
-\SpecialChar \menuseparator
+ in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\family sans
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog, depending on your frontend.
- Note that the LyX keybindings will not work in this dialog, alas.
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
-\begin_layout Enumerate
-Use the preamble contents you've added as your default template (see
-\begin_inset Quotes eld
\end_inset
-Basic LyX Setup
-\begin_inset Quotes erd
-\end_inset
+ dialog.
+ LyX adds anything in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
- in the
-\emph on
-User's Guide
-\emph default
-), so that it will be the default preamble for any file you create.
+\begin_layout Plain Layout
+Preamble
\end_layout
-\begin_layout Standard
-LyX adds anything in the
-\family sans
-\bar under
-P
-\bar default
-reamble
-\family default
+\end_inset
+
dialog to its own built-in preamble.
Before adding your own declarations in the preamble, you should make sure
- that LyX doesn't already support what you want to do (remember what we
- said about reinventing the wheel?).
- Also,
+ that LyX doesn't already support what you want to do.
+ (Remember what we said about reinventing the wheel?) Also,
\emph on
make sure your preamble code is correct
\emph default
.
- LyX doesn't check it.
+ LyX doesn't check it for you.
+ If there is an error, you're likely to get an error like
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Missing
+\backslash
+begin{document}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ If you see this error, check your preamble.
\end_layout
\begin_layout Subsection
\begin_layout Standard
Here are some examples of what you can add to a preamble, and what they
- do:
+ do.
\end_layout
\begin_layout Subsubsection
\begin_layout Standard
There are two variables under LaTeX that control page position:
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
+\end_layout
+
+\end_inset
+
.
Their names should be self-explanatory.
These variables are useful if you think for a moment about computer labels.
Sometimes, the size of a print medium and the area of the medium that you
can actually print on aren't the same.
This is where
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
+\end_layout
+
+\end_inset
+
come in.
\end_layout
\begin_layout Standard
The default values for
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
- are both 0 pt.,\InsetSpace ~
-i.\InsetSpace ~
-e.\InsetSpace ~
-the page isn't shifted.
\end_layout
-\begin_layout Standard
-Unfortunately, some DVI drivers always seem to shift the page.
+\end_inset
+
+ are both 0
+\begin_inset space \thinspace{}
+\end_inset
+
+points, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+the page isn't shifted.
+ Unfortunately, some DVI drivers always seem to shift the page.
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
your sysadmin is a doofus,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
+\end_layout
+
+\end_inset
+
can save the day.
- Suppose you're left and top margins are always 0.5 inches too big.
+ Suppose you're left and top margins are always 0.5
+\begin_inset space \thinspace{}
+\end_inset
+
+inches too big.
You can add this to the preamble:
\end_layout
\end_layout
\begin_layout Standard
-\SpecialChar \ldots{}
and your margins should now be correct.
\end_layout
\begin_layout Standard
Speaking of labels, suppose you wanted to print out a bunch of address labels.
There's a rather nice package, available at your nearest CTAN archive,
- for printing sheets of labels, called
-\family typewriter
+ for printing sheets of labels:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
labels.sty
-\family default
+\end_layout
+
+\end_inset
+
.
Now, your system may not have this package installed by default.
We leave that up to you to check.
\begin_layout Standard
First, make sure you're using the
-\family sans
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
article
-\family default
+\end_layout
+
+\end_inset
+
document class.
Next, you need to put the following in your preamble:
\end_layout
\end_layout
\begin_layout Standard
-This sets things up for Avery® label sheets, stock #5360.
+This sets things up for Avery label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
begin{labels}
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
end{labels}
-\family default
+\end_layout
+
+\end_inset
+
around each label text.
This and other special features of
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
labels.sty
-\family default
+\end_layout
+
+\end_inset
+
are explained in its documentation.
\end_layout
paragraph.
As with all of their other weird quirks, most Americans will whine and
moan until they can have their way and indent the first line of all paragraphs.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-Note from
-\noun on
-John Weiss
-\noun default
-: This was written by an American ---
+ (Yes, we're joking.
+ (We are?)
\emph on
-me
+Yeah
\emph default
-! It's my perception of my fellow countrymen.
- Tough if you don't like it.
- Thpbpbpbpbpbpbpbp!
-\end_layout
-
-\end_inset
-
-
+, we are.)
\end_layout
\begin_layout Standard
it follows another one.
The idea behind indenting the first line of a paragraph is to distinguish
neighboring paragraphs from one another.
- If there is no previous paragraph, for example, it follows a figure, or
- is the first paragraph in a section, then there is no special indentation.
+ If there is no previous paragraph—for example, if it follows a figure or
+ is the first paragraph in a section—then there is no need for indentation.
\end_layout
\begin_layout Standard
-If you're a typical American, though, you don't care about such esoteric
- things; you want your indentation! Add this to the preamble:
+If you're a typical American (we're still joking!), though, you don't care
+ about such esoteric things; you want your indentation! Add this to the
+ preamble:
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Standard
-If your TeX distribution isn't a braindead one, you'll have this package,
- and all of your paragraphs will get the indentation you think they deserve.
+If your TeX distribution isn't braindead, you'll have this package, and
+ all of your paragraphs will get the indentation the Founding Fathers intended
+ they should have.
\end_layout
\begin_layout Subsubsection
\begin_layout Standard
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
- You'll probably need to make the
-\family sans
-\bar under
-P
-\bar default
-reamble\SpecialChar \ldots{}
-
-\family default
- dialog full-screen to see most of it.
Also, there are more examples and an assortment of LaTeX
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- given in Chapter\InsetSpace ~
+ given in Chapter
+\begin_inset space ~
+\end_inset
+
-\begin_inset LatexCommand ref
+\begin_inset CommandInset ref
+LatexCommand ref
reference "cha:secrets"
\end_inset
\begin_layout Standard
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
- It then uses the log-file from the LaTeX run to do a post-mortem.
- As we stated earlier in the chapter, LyX generates two kinds of
-\family typewriter
-.tex
-\family default
- files, one of which it uses to locate errors in the document.
- If there was an error someplace, LyX will put a box with the word
-\begin_inset Quotes eld
-\end_inset
-
-Error
-\begin_inset Quotes erd
-\end_inset
-
- at the appropriate place in the document.
+ It then uses the logfile from the LaTeX run to do a post-mortem.
+ After analyzing the logfile,LyX displays a dialog listing the errors.
+ Clicking on any one of them will take you to the position in your LyX file
+ where the error occurred.
\begin_inset Foot
status collapsed
-\begin_layout Standard
-LyX will occasionally misguess where the error was.
- This will typically happen with tables, figures, math, and the preamble.
+\begin_layout Plain Layout
+Well, usually.
+ Analyzing the logfile is a tough job, and LyX doesn't always go to the
+ right line.
+ There are also cases where LaTeX reports the error on one line, but the
+ actual error is earlier.
+ This is not unlike forgetting a closing brace in a program: You'll get
+ an error, but only later.
\end_layout
\end_inset
- It will also display a message alerting you to the fact that there were
- errors.
+
\end_layout
\begin_layout Standard
-You can navigate through the errors by using
-\family sans
-\bar under
-E
-\bar default
-rror
-\family default
- in the
-\family sans
+Some folks also like to look at the log file directly: It is available from
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document
\bar under
-N
+\SpecialChar \menuseparator
+
\bar default
-avigate
-\family default
- menu.
- You can
-\begin_inset Quotes eld
+Latex
+\begin_inset space ~
\end_inset
-open
-\begin_inset Quotes erd
-\end_inset
-
- the error-boxes and view the error message LaTeX produced by clicking on
- it.
+Log
\end_layout
-\begin_layout Standard
-Some folks also like to look at the log file directly, accessible from
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\end_inset
-\bar under
-L
-\bar default
-aTeX\InsetSpace ~
-Log\InsetSpace ~
-File
-\family default
.
There are some fairly common error messages and warnings.
We'll cover those here.
\end_layout
\begin_layout Itemize
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
-LaTeX Warning:
-\family default
+\begin_layout Plain Layout
+LaTeX Warning
+\end_layout
-\begin_inset Quotes eld
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
-Anything beginning with these word is a warning message for the purpose
+Anything beginning with these words is a warning message for the purpose
of
\begin_inset Quotes eld
\end_inset
You'll get messages like this if you added or changed cross-references
or bibliography entries, in which case, LaTeX is trying to tell you that
you need to make another run.
+ You can by-and-large ignore these.
\end_layout
-\begin_layout Standard
-You can by-and-large ignore these.
-\end_layout
-
-\end_deeper
\begin_layout Itemize
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
-LaTeX Font Warning:
-\family default
+\begin_layout Plain Layout
+LaTeX Font Warning
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
Another warning message, this time about fonts which LaTeX couldn't find.
The rest of the message will often say something about a replacement font
that LaTeX used.
+ You can safely ignore these, too.
\end_layout
-\begin_layout Standard
-You can safely ignore these.
-\end_layout
-
-\end_deeper
\begin_layout Itemize
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
Overfull
\backslash
hbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
LaTeX absolutely
\emph on
loves
\emph default
to spew these out.
- They are warning you about lines that were too long and run past the right
+ They are warnings about lines that were too long and run past the right
margin.
Almost always, this is unnoticeable in the final output.
- Or, only one or two characters extend past the margin.
+ (It can be just a point or two.) Or, only one or two characters extend past
+ the margin.
LaTeX seems to generate at least one of these messages for just about any
document you write.
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-You can ignore these stupid messages.
+You can ignore these messages.
Your eyes will tell you if there's a problem with something that's too
wide; just look at the output.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You can also enable the `draft' option in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document
+\bar under
+\SpecialChar \menuseparator
+
+\bar default
+Settings
\end_layout
-\end_deeper
-\begin_layout Itemize
-\begin_inset Quotes eld
\end_inset
+, and then LaTeX will draw a black box in the margin of lines that are overfull.
+\end_layout
-\family typewriter
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
Underfull
\backslash
hbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
Not quite as common as its cousin.
LaTeX seems to like to print lines that are a bit too wide as opposed to
ones that are a bit too narrow.
We have no idea why.
\end_layout
-\begin_layout Standard
-You can ignore these, too.
-\end_layout
-
-\end_deeper
\begin_layout Itemize
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
Overfull
\backslash
vbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
and
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
Underfull
\backslash
vbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
Warnings about troubles breaking the page.
Once again, just look at the output.
Your eyes will tell you where something has gone wrong.
\end_layout
-\end_deeper
\begin_layout Itemize
-\begin_inset Quotes eld
-\end_inset
+\begin_inset Flex CharStyle:Code
+status collapsed
-
-\family typewriter
-LaTeX Error: File
+\begin_layout Plain Layout
+ LaTeX Error: File
\begin_inset Quotes els
\end_inset
\end_inset
not found
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
-\end_layout
-\begin_deeper
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
+
The file
\begin_inset Quotes eld
\end_inset
isn't installed on this system.
This usually appears because some package your document needs isn't installed.
If you didn't touch the preamble or didn't use the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
usepackage{}
-\family default
+\end_layout
+
+\end_inset
+
command, then one of the packages LyX tried to load is missing.
Use
-\family sans
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-L
-\bar under
-a
-\bar default
-TeX Configuration
-\family default
-, to get a list of packages that LyX knows about.
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Help\SpecialChar \menuseparator
+LaTeX Configuration
+\end_layout
+
+\end_inset
+
+ to get a list of packages that LyX knows about.
This file is updated whenever you reconfigure LyX (using
-\family sans
-\bar under
-T
-\bar default
-ools
-\bar under
-\SpecialChar \menuseparator
-R
-\bar default
-econfigure
-\family default
-) and tells you which packages have been detected and what they do.
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
-\begin_layout Standard
-If you
-\emph on
-did
-\emph default
- use the
-\family typewriter
+\end_inset
+
+) and tells you which packages have been detected and what they do.
+\begin_inset Newline newline
+\end_inset
+
+If you did use the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
usepackage{}
-\family default
- command, and the package in question isn't installed, you'll need to install
- it yourself.
\end_layout
-\end_deeper
-\begin_layout Itemize
-\begin_inset Quotes eld
\end_inset
+ command and the package in question isn't installed, then you'll need to
+ install it yourself.
+\end_layout
-\family typewriter
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
LaTeX Error: Unknown option
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
Error messages beginning with this are trying to tell you that you specified
a bad or undefined option to a package.
Check the package's documentation.
\end_layout
-\end_deeper
\begin_layout Itemize
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
Undefined control sequence
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_deeper
-\begin_layout Standard
If you've inserted LaTeX code into your document, but made a typo, you'll
get one of these.
You may have forgotten to load a package.
In any case, this error message usually means that you used an undefined
command.
+
\end_layout
-\end_deeper
\begin_layout Standard
There are other error and warning messages.
Some are self-explanatory.
These are usually LaTeX messages.
Others are downright cryptic.
- These are actually TeX error messages, and we really have
+ These are usually TeX error messages, and we really have
\emph on
no clue
\emph default
what they mean or how to decipher them.
+ No-one does.
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Enumerate
-If there are no typos, check and see that you used the command(s) correctly.
+If there are no typos, check that you used the command(s) correctly.
\end_layout
\begin_layout Enumerate
-If you get a bunch of error boxes piled up at the very top of the document,
- it means that there are errors in the preamble.
+If you get a bunch of error boxes piled up at the very top of the document—and
+ especially if you see a
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Missing
+\backslash
+begin{document}
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ error—it means that there are errors in the preamble.
Start debugging your preamble.
\end_layout
misuse
\emph default
any of them, like trying to manually insert lots of
-\family sans
-Protected\InsetSpace ~
-Blank
-\family default
-s,
-\family sans
-Linebreak
-\family default
-s, or
-\family sans
-Pagebreak
-\family default
-s? Did you try to kludge something together with these instead of using
- the appropriate paragraph environment?
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Protected
+\begin_inset space ~
+\end_inset
+
+Blanks
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Linebreaks
+\end_layout
+
+\end_inset
+
+, or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Pagebreaks
+\end_layout
+
+\end_inset
+
+? Did you try to kludge something together with these instead of using the
+ appropriate paragraph environment?
\end_layout
\begin_layout Enumerate
spacing it will add in order to break a line.
Preferably, you should rework the paragraph to avoid the problem.
If this isn't an option, you can wrap your text in
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
sloppypar
-\family default
+\end_layout
+
+\end_inset
+
to make LaTeX's line breaking more, well, sloppy.
\end_layout
\end_inset
level, that's the problem.
+ (The limit in LaTeX is five.)
\end_layout
\begin_layout Enumerate
-Okay, you didn't get any error messages, but your output looks whacked.
+Okay, you didn't get any error messages, but your output looks awful.
If you have a table or figure that's too wide or long for the page, you
need to:
\end_layout
trim down the table so it fits.
\end_layout
-\begin_layout Standard
+\end_deeper
+\begin_layout Enumerate
If something else is wrong with the output, and you didn't try to pull anything
fancy or kludge the fine-tuning options, we're not sure what's wrong.
\end_layout
-\end_deeper
\begin_layout Standard
-If all this doesn't help --- well, then
+If all this doesn't help—well, then
\emph on
perhaps
\emph default
you might have found a bug in LyX\SpecialChar \ldots{}
-
+.
\end_layout
\begin_layout Chapter
\end_layout
\begin_layout Section
-Preparing a Bibliography with BibTeX
-\begin_inset LatexCommand label
-name "sec:Preparing-a-Bibliography"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
-\noun default
- and
-\noun on
-Jürgen Spitzmüller
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
-
+Customizing Bibliographies with BibTeX
\end_layout
\begin_layout Standard
-\noindent
-STOP! If you don't know what BibTeX is, or have a reasonably good idea of
- how to use it (
-\emph on
-e.\InsetSpace \thinspace{}
-g.
-\emph default
-\InsetSpace ~
-setting up your own bibliographic databases),
+The basics how to use BibTeX are explained in section
\emph on
-run
+Bibliography databases (BibTeX)
\emph default
-, do not walk, to your nearest copy of the 2nd edition of Lamport's
-\emph on
-LaTeX: A Document Preparation System
-\emph default
-, particularly Appendix B.
- The rest of this discussion assumes you have created a correct bibliography
- file, that you have all relevant environment variables set correctly (esp.
-
-\family typewriter
-BIBINPUTS
-\family default
-,
-\family typewriter
-BSTINPUTS
-\family default
-, and
-\family typewriter
-TEXINPUTS
-\family default
-), and that if sufficiently desperate, you could create and
-\begin_inset Quotes eld
-\end_inset
-
-TeX
-\begin_inset Quotes erd
-\end_inset
-
- a LaTeX file with a BibTeX database.
-
-\end_layout
-
-\begin_layout Standard
-For those who don't know what BibTeX is, it is a system for creating a large
- database of your most used journal references.
- For all future articles you write, you only need to include this standard
- database and reference the appropriate key to each reference.
- Even if you write only a few papers with handful of references each, it
- is well worth your time to examine BibTeX and decide whether it will be
- useful to you.
-\end_layout
-
-\begin_layout Standard
-To use BibTeX with LyX, first read the
+ of the
\emph on
-User Guide
+User's Guide
\emph default
- where it describes how to insert citations.
- The basic mechanism for inserting BibTeX references is the same.
- Then, at the very end of your document, select
-\family sans
-Insert\SpecialChar \menuseparator
-List
-\family default
- /
-\family sans
-TOC\SpecialChar \menuseparator
-BibTeX Reference
-\family default
.
- In the resulting dialog, fill out the dialog boxes as follows:
-\end_layout
-
-\begin_layout Description
-Database: enter the name of your
-\family typewriter
-.bib
-\family default
- file
-\emph on
-without
-\emph default
- the
-\family typewriter
-.bib
-\family default
- extension.
- For searching multiple
-\family typewriter
-.bib
-\family default
- files, just enter them in the desired order, separated by commas.
-
-\end_layout
-
-\begin_layout Description
-Style: enter the name of your BibTeX style file *without* the
-\family typewriter
-.bst
-\family default
- extension.
- The default style is
-\family typewriter
-plain
-\family default
- (which should be included in your LaTeX distribution, so you don't have
- to worry about creating it).
-\end_layout
-
-\begin_layout Standard
-For each citation, assuming that the source is in the
-\family typewriter
-.bib
-\family default
- file, just call
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-itation Reference
-\family default
- at the correct location in the text, and enter the appropriate reference
- key.
- Nothing else is required; when invoking
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-VI
-\family default
-, for example, you should see that BibTeX and LaTeX are invoked as needed,
- including multiple invocations of LaTeX.
-
+ The following subsections explain special bibliography features supported
+ by LyX.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
-g.\InsetSpace \space{}
+Standard BibTeX uses numbers (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
\begin_inset Quotes eld
\end_inset
) to refer to a cited work.
However, in many scientific disciplines, other citation styles are in use.
- The most common one is the author-year style (e.\InsetSpace \thinspace{}
-g.\InsetSpace \space{}
+ The most common one is the author-year style (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
\begin_inset Quotes eld
\end_inset
).
LyX supports two packages that provide this style,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
natbib
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
jurabib
-\family default
+\end_layout
+
+\end_inset
+
.
- Both packages have their own pros and cons, which cannot be listed in detail.
- If you only want to have simple author-year (or author-numerical) style
- or if you want to use one of the countless style files for natbib, than
- the established
-\family typewriter
+ Both packages have their pros and cons, which cannot be listed in detail.
+ If you only want to have simple author-year (or author-numerical) style,
+ or if you want to use one of the countless style files for
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
natbib
-\family default
+\end_layout
+
+\end_inset
+
+, than the established
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
+\end_layout
+
+\end_inset
+
package is probably your choice.
If you need special features like short title references, ibidem etc., you
- might consider the fairly new
-\family typewriter
+ might consider the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
jurabib
-\family default
+\end_layout
+
+\end_inset
+
package.
\end_layout
\begin_layout Standard
The handling of both packages in LyX is basically the same.
Go to
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-S
-\bar default
-ettings
-\family default
- and select the
-\family sans
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ and select under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Bibliography
-\family default
- pane (with the xforms frontend: the
-\family sans
-Extras
-\family default
- tab).
- Then select
-\family sans
+\end_layout
+
+\end_inset
+
+ the option
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Natbib
-\family default
+\end_layout
+
+\end_inset
+
or
-\family sans
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Jurabib
-\family default
+\end_layout
+
+\end_inset
+
.
With both packages, you will get some extra features in the citation dialog
and you can select the style of the reference (
\end_inset
etc.).
- Note that both packages need specifically designed style files (they both
- ship their own, while there are lots of additional style files and even
- an interactive style file builder
+ Note that both packages need specifically designed style files.
+ They both ship their own, but there are lots of additional style files,
+ and there is even an interactive style file builder
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
See
-\begin_inset LatexCommand url
-target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
+\end_layout
\end_inset
\end_inset
for
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
natbib
-\family default
- available).
\end_layout
-\begin_layout Subsection
-Sectionated Bibliographies
-\begin_inset LatexCommand label
-name "sub:Sectionated-Bibliographies"
-
\end_inset
+.
+\end_layout
+\begin_layout Subsection
+Sectioned Bibliographies
\end_layout
\begin_layout Standard
Sometimes you might need to divide your bibliography into several sections.
- If you are, for instance, a historian, the possibility to separate sources
+ If you are for instance a historian, the possibility to separate sources
and scientific works is most likely a
\begin_inset Quotes eld
\end_inset
.
Unfortunately, BibTeX itself does not allow you to do this.
- The good news is, though: With the help of some LaTeX packages, BibTeX
- can be extended to fit your historical needs.
+ But with the help of some LaTeX packages, BibTeX can be extended to fit
+ your needs.
\end_layout
\begin_layout Standard
-As of version 1.4, LyX provides native support for one of these packages,
- Stefan Ulrich's
+LyX provides native support for one of these packages,
\family typewriter
bibtopic
\family default
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Available from
-\begin_inset LatexCommand url
-target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
+\end_layout
\end_inset
\begin_inset Quotes erd
\end_inset
-, you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
-g.\InsetSpace \space{}
+, you first need to create two bibliographic databases, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
-\family typewriter
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
sources.bib
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
scientific.bib
-\family default
+\end_layout
+
+\end_inset
+
.
\end_layout
\begin_layout Standard
-In LyX, go to
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+Go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-S
-\bar default
-ettings
-\family default
- and select the
-\family sans
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ and check under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Bibliography
-\family default
- pane (with the xforms frontend: the
-\family sans
-Extras
-\family default
- tab).
- Check
-\family sans
-Sectionated\InsetSpace ~
-bibliography
-\family default
-.
- Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
+\end_layout
+
+\end_inset
+
+ the option
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_inset LatexCommand ref
-reference "sec:Preparing-a-Bibliography"
+\begin_layout Plain Layout
+Sectioned bibliography
+\end_layout
\end_inset
-), one for each section of your bibliography.
- Returning to our example: Insert a BibTeX reference for the database
-\family typewriter
+.
+ Now you can insert multiple BibTeX bibliographies, one for each section
+ of your bibliography.
+ Returning to our example: Insert the BibTeX bibliography
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
sources.bib
-\family default
+\end_layout
+
+\end_inset
+
and a second one for the database
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
scientific.bib
-\family default
+\end_layout
+
+\end_inset
+
.
You are free to use the same or different styles for each section.
Additionally, you can chose if the bibliography section should contain
.
The titles for the sections can be added as ordinary sections or subsections.
Since
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
bibtopic
-\family default
+\end_layout
+
+\end_inset
+
removes the bibliography title, you have manually re-add that, too (as
a chapter* or section*, for instance).
\end_layout
\end_layout
\begin_layout Standard
-Multiple bibliographies, e.\InsetSpace \thinspace{}
-g.\InsetSpace \space{}
-a bibliography for each section or chapter of
- the document, are not supported by BibTeX itself.
+Multiple bibliographies, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+a bibliography for each section or chapter of the document, are not supported
+ by BibTeX itself.
But the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
bibtopic
-\family default
- package, which is used for the creation of sectionated bibliographies in
- LyX (cf.\InsetSpace ~
-section\InsetSpace ~
+\end_layout
+
+\end_inset
+
+ package, which is used for the creation of sectioned bibliographies in
+ LyX (see the previous section), provides an easy way to solve this task,
+ if you are willing to use some
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+TeX Code
+\end_layout
-\begin_inset LatexCommand ref
-reference "sub:Sectionated-Bibliographies"
+\end_inset
+ (see section
+\begin_inset space ~
\end_inset
-), provides an easy way to solve this task, if you are willing to use some
- LaTeX-Code (ERT, cf.\InsetSpace ~
-section\InsetSpace ~
-\begin_inset LatexCommand ref
-reference "sec:Inserting-LaTeX-Code"
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
\end_inset
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
An alternative approach is to use the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
chapterbib
-\family default
+\end_layout
+
+\end_inset
+
or
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
bibunits
-\family default
+\end_layout
+
+\end_inset
+
package, respectively.
\end_layout
\end_layout
\begin_layout Standard
-First, go to
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+First go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-S
-\bar default
-ettings
-\family default
- and select the
-\family sans
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ and under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Bibliography
-\family default
- pane (with the xforms frontend: the
-\family sans
-Extras
-\family default
- tab).
- Check
-\family sans
-Sectionated\InsetSpace ~
-bibliography
-\family default
+\end_layout
+
+\end_inset
+
+ check
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Sectioned bibliography
+\end_layout
+
+\end_inset
+
.
In the document, you have to enclose the sections, which shall contain
- their own bibliography (including the BibTeX reference itself), between
+ their own bibliography (including the BibTeX bibliography itself), between
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-begin{btUnit}
-\family default
- and
-\family typewriter
+\begin_layout Plain Layout
\backslash
-end{btUnit}
-\family default
- (those commands have to be inserted as ERT).
- The bibliography will contain all references which have been cited in the
- current btUnit.
- N.\InsetSpace \thinspace{}
-B.: If you are using this approach, then
-\emph on
-every
-\emph default
- citation reference has to be inside some btUnit.
- Also, the btUnits cannot be nested.
+begin{btUnit}
\end_layout
-\begin_layout Section
-Making an Index
-\end_layout
+\end_inset
-\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
+ and
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-\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
-
-\family typewriter
-\size default
-\noun default
-xindy
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-.
+\backslash
+end{btUnit}
\end_layout
\end_inset
- 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.
-\end_layout
-
-\begin_layout Standard
-First, go to the end of your file and select
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-List
-\family default
-\InsetSpace ~
-/\InsetSpace ~
+ (those commands have to be inserted as TeX code).
+ The bibliography will contain all references which have been cited in the
+ current
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-T
-\bar under
-O
-\bar default
-C\SpecialChar \menuseparator
+\begin_layout Plain Layout
+btUnit
+\end_layout
-\bar under
-I
-\bar default
-ndex
-\family default
-\InsetSpace ~
+\end_inset
-\family sans
-List
-\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
+
+\series bold
+Note:
+\series default
+ If you are using this approach, then every citation reference has to be
+ inside some
+\begin_inset Flex CharStyle:Code
+status collapsed
-\bar under
-I
-\bar default
-ndex
-\family default
-\InsetSpace ~
+\begin_layout Plain Layout
+btUnit
+\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_inset Quotes eld
\end_inset
-nested entries
-\begin_inset Quotes erd
-\end_inset
+.
+ Also, the
+\begin_inset Flex CharStyle:Code
+status collapsed
-, etc.
+\begin_layout Plain Layout
+btUnit
\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_inset
+
+s cannot be nested.
\end_layout
\begin_layout Section
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.
+ 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.
+ own preamble (i.
+\begin_inset space \thinspace{}
+\end_inset
-\emph default
- everything up to and including the
-\family typewriter
+g.
+\begin_inset space \space{}
+\end_inset
+
+everything up to and including the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
begin{document}
-\family default
+\end_layout
+
+\end_inset
+
line as well as the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
end{document}
-\family default
+\end_layout
+
+\end_inset
+
line must be deleted) or else errors will be generated when you try to
make a DVI file.
\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 ~
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+ChiId
+\begin_inset space ~
+\end_inset
+
Document
-\family default
+\end_layout
+
+\end_inset
+
.
When you click on this selection a small box is inserted into the file
at the current cursor location.
\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
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 ~
-
-\family sans
-typeset
-\family default
- button prevents this conversion.
\end_layout
\begin_layout Standard
\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.
+ in the file, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+verbatim
+\end_layout
+
+\end_inset
+
+ 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 ~
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Mark
+\begin_inset space ~
+\end_inset
+
+spaces
+\begin_inset space ~
+\end_inset
+
+in
+\begin_inset space ~
+\end_inset
+
output
-\family default
+\end_layout
+
+\end_inset
+
checkbox typesets a mark to unambiguously define the presence of a space.
\end_layout
Cross-References Between Files
\end_layout
+\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
+
+\begin_layout Plain Layout
+This section is somewhat out of date.
+ Need to describe default master documents and how children are opened when
+ the master is.
+ [[FIXME]]
+\end_layout
+
+\end_inset
+
+
+\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
to use.
\end_layout
+\begin_layout Subsection
+Bibliography Lists in all Subdocuments
+\end_layout
+
+\begin_layout Standard
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
+
+\begin_layout Plain Layout
+This section also needs updating.
+ There is now material about this on the wiki, and it could be copied here.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Copy the bibliography list with all entries to all subdocuments and transform
+ them to a comment.
+ This way LyX will find the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.bib
+\end_layout
+
+\end_inset
+
+-files and you can easily insert references without making the bibliography
+ list visible.
+\end_layout
+
+\begin_layout Standard
+As the bibliography list is in a comment, LaTeX won't use use it and the
+ references will look like this: [?], instead of like this: [1].
+ One solution is to use the LaTeX-package
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+comment
+\end_layout
+
+\end_inset
+
+ that will only include comments by processing the files separately.
+ To do this, add in the LaTeX preamble of every subdocument the following:
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+usepackage{comment}
+\end_layout
+
+\begin_layout LyX-Code
+
+\backslash
+includecomment{comment}
+\end_layout
+
+\begin_layout Standard
+See also
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://wiki.lyx.org/FAQ/Unsorted#toc31
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
\begin_layout Section
Fancy Headers and Footers
\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
+The default page layout is rather plain; for an
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article
+\end_layout
+
+\end_inset
+
+ document class, all you get is a centered page number at the bottom of
+ the page.
+ This document uses KOMA-script's 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
\end_inset
, as mentioned in the
-\family sans
-User\InsetSpace ~
-Guide
-\family default
+\emph on
+User Guide
+\emph default
+.
+ This section describes the LaTeX code you need to insert in your LaTeX
+ preamble in order to get the desired effects.
+\end_layout
+
+\begin_layout Standard
+For more information on fancy headers, see the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+fancyhdr
+\end_layout
+
+\end_inset
+
+ package documentation.
+ This can be found in the file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+fancyhdr.dvi
+\end_layout
+
+\end_inset
+
+, which should have been installed with your LaTeX distribution, or
+\begin_inset CommandInset href
+LatexCommand href
+name "online"
+target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
+
+\end_inset
+
.
- 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
.
The footer is also divided into these three fields.
The LaTeX commands to set these fields in the simplest manner are
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
lhead
-\family default
+\end_layout
+
+\end_inset
+
,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
chead
-\family default
+\end_layout
+
+\end_inset
+
,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
rhead
-\family default
+\end_layout
+
+\end_inset
+
,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
lfoot
-\family default
+\end_layout
+
+\end_inset
+
, etc.
Suppose you wish to put your name in the upper left hand corner of each
page.
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.
+ with a blank argument, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.:
\end_layout
\begin_layout Standard
\begin_inset Quotes erd
\end_inset
- (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.
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+Section 3) in the upper left, the page number (e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+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
\end_layout
\begin_layout Standard
-The codes
-\family typewriter
+The commands
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
thesection
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
thepage
-\family default
+\end_layout
+
+\end_inset
+
access LaTeX's section and page counters, and so print out the current
section and page numbers.
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
today
-\family default
+\end_layout
+
+\end_inset
+
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.
+ If you don't want one of the rules, 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.
-
+ Use commands
\family typewriter
+
+\family default
+like
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
renewcommand{
\backslash
headrulewidth}{0.4pt}
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
renewcommand{
\backslash
footrulewidth}{0.4pt}
-\family default
+\end_layout
+
+\end_inset
+
to set the thicknesses.
\end_layout
\begin_layout Standard
You can switch the header/footer settings on and off for individual pages
using commands like
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
thispagestyle{empty}
-\family default
+\end_layout
+
+\end_inset
+
,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
thispagestyle{plain}
-\family default
-, and
-\family typewriter
+\end_layout
-\backslash
+\end_inset
+
+, and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
thispagestyle{fancy}
-\family default
+\end_layout
+
+\end_inset
+
.
Simply insert them in the text on the page you want changed and mark them
as TeX code.
\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
-\family typewriter
-/usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
-fancyhdr.dvi
-\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.
+As a final example, it is possible to include an image 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_layout Standard
\noindent
(you may need to preface this with
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\noindent
\backslash
usepackage{graphics}
-\family default
- if you don't include EPS files elsewhere in your document).
+\end_layout
+
+\end_inset
+
+ if you don't include graphics elsewhere in your document).
\end_layout
\begin_layout Section
Itemize Bullet Selection
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "sec:bullet"
\end_inset
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
+ sets of bullets for different paragraphs.
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Well, actually you can but you'll have to do it by hand.
\end_layout
\end_inset
-.
+
\end_layout
\begin_layout Subsection
\begin_layout Standard
Open the dialog by selecting the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\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
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Bullets
+\end_layout
+
+\end_inset
+
tab.
\end_layout
\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">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0pt">
+<column alignment="center" valignment="top" width="0pt">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family roman
\series medium
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family roman
\series medium
\end_inset
</cell>
</row>
-<row topline="true">
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family sans
\series medium
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\series medium
\shape up
\end_inset
</cell>
</row>
-<row topline="true">
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family sans
\series medium
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family typewriter
\series medium
\end_inset
</cell>
</row>
-<row topline="true">
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family sans
\series medium
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family typewriter
\series medium
\end_inset
</cell>
</row>
-<row topline="true">
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family sans
\series medium
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family typewriter
\series medium
\end_inset
</cell>
</row>
-<row topline="true">
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family sans
\series medium
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family typewriter
\series medium
\end_inset
</cell>
</row>
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family sans
\series medium
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
\family typewriter
\series medium
\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
+ If you get errors from LaTeX when you try to view or print the file, then
+ it is likely you are missing a package.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+LyX doesn't restrict your use since you may be editing locally and exporting
elsewhere.
\end_layout
+\end_inset
+
+
+\end_layout
+
\begin_layout Subsection
How to use it
\end_layout
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.
+ document.
\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_inset Foot
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
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.
+ in each, then you're going to have to get your hands dirty with TeX code.
+ The 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_layout Plain Layout
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Itemize
Use the LaTeX command
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
renewcommand{}{}
-\family default
+\end_layout
+
+\end_inset
+
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
+\end_layout
-\family typewriter
+\begin_deeper
+\begin_layout LyX-Code
\backslash
let
\backslash
savelabelitemi=
\backslash
-labelitemi
-\family default
-
-\family typewriter
+labelitemi
+\end_layout
-\newline
+\begin_layout LyX-Code
\backslash
renewcommand
sharp
\backslash
)}
-\newline
+\end_layout
-\family default
+\end_deeper
+\begin_layout Itemize
Note that the itemize depth is specified in Roman numerals as part of the
\family typewriter
\begin_layout Itemize
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
[
\backslash
\end_inset
Specify each individual entry by starting each item with the bullet shape
- enclosed in square brackets and set as TeX.
+ enclosed in square brackets and set as
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+TeX Code
+\end_layout
+
+\end_inset
+
+.
For example, this item was started with
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
[
\backslash
(
star
\backslash
)]
-\family default
+\end_layout
+
+\end_inset
+
.
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
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
+\end_layout
-\family typewriter
+\begin_layout LyX-Code
\backslash
renewcommand
savelabelitemi}
\end_layout
-\begin_layout Chapter
-Special Document Classes
+\end_inset
+
+
\end_layout
-\begin_layout Section
-AMS LaTeX
+\begin_layout Chapter
+The LyX Server
\end_layout
-\begin_layout Standard
-by
-\noun on
-David Johnson
+\begin_layout Section
+Introduction
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
+ and retrieve information about the LyX internal state.
+ This is only intended for advanced users, but they should find it useful.
+ It is by writing to the LyX server, for example, that bibliography managers,
+ such as JabRef, are able to
+\begin_inset Quotes eld
\end_inset
+push
+\begin_inset Quotes erd
+\end_inset
+ citations to LyX.
\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"
-
-\end_inset
-
- or by ftp at
-\begin_inset LatexCommand url
-target "ftp://ftp.ams.org/pub/tex/amslatex/"
+Please note that, at present,
+\emph on
+the server does not work natively on Windows
+\emph default
-\end_inset
+\begin_inset Foot
+status collapsed
-.These layouts are appropriate, and useful, for any mathematical writing.
- There are currently 4 distinct AMS LaTeX layouts:
+\begin_layout Plain Layout
+There is no reason it cannot do so.
+ But none of the developers on Windows have yet implemented this functionality
+ there.
\end_layout
-\begin_layout Enumerate
-amsart: The standard AMS-article format.
- All results and similar statements are numbered as
-\begin_inset Formula $(n.m)$
\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.
+ but it does work with Cygwin versions of LyX.
\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.
+\begin_layout Section
+Starting the LyX Server
\end_layout
-\begin_layout Enumerate
-amsart-plain: This one is even more terse, since all the environments are
- unnumbered.
+\begin_layout Standard
+The LyX server works through the use of a pair of named pipes.
+ These are usually located in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+UserDir
\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
-, 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.
-\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
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ and have the names
+\begin_inset Quotes eld
+\end_inset
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-
-\end_layout
-\begin_layout Subsection
-What these layouts provide
-\end_layout
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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:
+\begin_layout Plain Layout
+lyxpipe.in
\end_layout
-\begin_layout Description
-Theorem This is typically used for the statements of major results.
- The word
-\begin_inset Quotes eld
\end_inset
-\family sans
-Theorem
-\family default
-
\begin_inset Quotes erd
\end_inset
- appears in bold type, along with an automatically-determined number (an
- unnumbered version,
-\family sans
-Theorem*
-\family default
-, is also available).
- The text is italicized.
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Description
-Corollary This is used for statements which follow fairly directly from
- previous statements.
- Again, these can be major results.
- Unnumbered version
-\family sans
-Corollary*
-\family default
- is available.
-\end_layout
-\begin_layout Description
-Lemma These are smaller results needed to prove other statements.
-\end_layout
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Description
-Proposition These are less major results which (hopefully) add to the general
- theory being discussed.
+\begin_layout Plain Layout
+lyxpipe.out
\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).
-\end_layout
+\end_inset
-\begin_layout Description
-Criterion A required condition.
-\end_layout
-\begin_layout Description
-Algorithm A general procedure to be used.
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Description
-Axiom This is a property or statement taken as true within the system being
- discussed.
+.
+ External programs write into
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.lyxpipe.in
\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
+ and read back data from
+\begin_inset Flex CharStyle:Code
+status collapsed
-) is still set in boldface, along with the number, if any, but the rest
- is set upright.
+\begin_layout Plain Layout
+.lyxpipe.out
\end_layout
-\begin_layout Description
-Example Typeset similarly to Definition.
-\end_layout
+\end_inset
-\begin_layout Description
-Condition
-\end_layout
+.
+ The stem of the pipe names can be defined in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Description
-Problem
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
-\begin_layout Description
-Exercise
-\end_layout
+\end_inset
-\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
+ dialog, for example
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Description
-Note Set similarly to the Remark environment.
+\begin_layout Plain Layout
+"/home/myhome/lyxpipe"
\end_layout
-\begin_layout Description
-Notation
+\end_inset
+
+.
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
-\begin_layout Description
-Claim
+\begin_layout Standard
+LyX will add the '
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.in
\end_layout
-\begin_layout Description
-Summary
+\end_inset
+
+' and '
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+.out
\end_layout
-\begin_layout Description
-Acknowledgement
+\end_inset
+
+' to create the pipes.
+ If one of the pipes already exists, LyX will assume that another LyX process
+ is already running and will not start the server.
+ If for some other reason, an unused
+\begin_inset Quotes eld
+\end_inset
+
+stale
+\begin_inset Quotes erd
+\end_inset
+
+ pipe is left in existence when LyX closes, then LyX will try to delete
+ it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart LyX.
\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
+To have several LyX processes with servers at the same time, you have to
+ use different configurations, perhaps by using separate user directories,
+ each with its own
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+preferences
\end_layout
-\begin_layout Description
-Conclusion
+\end_inset
+
+ file, for each process.
\end_layout
-\begin_layout Description
-Fact
+\begin_layout Standard
+If you are developing a client program, you might find it useful to enable
+ debugging information from the LyX server.
+ Do this by starting LyX as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyx -dbg lyxserver
\end_layout
-\begin_layout Description
-Proof The word
-\begin_inset Quotes eld
\end_inset
+.
+\end_layout
-\shape italic
-Proof
-\shape default
+\begin_layout Standard
+You can find a complete example client written in C in the source distribution
+ as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+development/lyxserver/server_monitor.c
+\end_layout
-\begin_inset Quotes erd
\end_inset
- 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.
+.
\end_layout
-\begin_layout Description
-Address This should be the author's permanent address.
-\end_layout
+\begin_layout Standard
+Another useful tool is command-line based client you will find in
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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 Plain Layout
+src/client/lyxclient
\end_layout
-\begin_layout Description
-Email Author's e-mail address
+\end_inset
+
+.
\end_layout
-\begin_layout Description
-URL Author's Web address, if desired.
+\begin_layout Section
+Normal communication
\end_layout
-\begin_layout Description
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
+\begin_layout Standard
+To issue a LyX call, the client writes a line of ASCII text into the input
+ pipe.
+ This line has the following format:
\end_layout
-\begin_layout Description
-Subjectclass These refer to the AMS Subject Classifications, published and
- described in
+\begin_layout Quote
+LYXCMD:
\emph on
-Mathematical Reviews
+clientname
\emph default
-.
- These are also available online at the AMS cites listed above.
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
\end_layout
\begin_layout Description
-Thanks
+clientname is a name that the client can choose arbitrarily.
+ Its only use is that LyX will echo it if it sends an answer—so a client
+ can dispatch results from different requesters.
\end_layout
\begin_layout Description
-Dedicatory
+function is the function you want LyX to perform.
+ It is the same as the commands you'd use in the minibuffer.
\end_layout
\begin_layout Description
-Translator
-\end_layout
+argument is an optional argument which is meaningful only to some functions
+ (for instance, the
+\begin_inset Quotes eld
+\end_inset
-\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.
-\end_layout
+self-insert
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Section
-Dinbrief
+ LFUN will insert the argument as text at the cursor position).
\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.
+The answer from LyX will arrive in the output pipe and be of the form
\end_layout
-\begin_layout Section
-Paper
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
\end_layout
\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
+where
+\emph on
+clientname
+\emph default
+ and
+\emph on
+function
+\emph default
+ are just echoed from the command request, while
+\emph on
+data
+\emph default
+ is more or less useful information filled according to how the command
+ execution worked out.
+ Some commands, such as
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Section
-A&A Paper
+font-state
+\begin_inset Quotes erd
+\end_inset
+
+, will return information about the internal state of LyX, while other will
+ return an empty data-response.
+ This means that the command execution went fine.
\end_layout
\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
+In case of errors, the response from LyX will have this form
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
\end_layout
\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
+where the
\emph on
-Astronomy and Astrophysics
+error message
\emph default
- (
-\begin_inset LatexCommand url
-name "www.edpsciences.fr/aa/"
-target "http://www.edpsciences.fr/aa/"
+ should contain an explanation of why the command failed.
+\end_layout
+
+\begin_layout Standard
+Examples:
+\end_layout
+\begin_layout LyX-Code
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
+\begin_inset Newline newline
\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
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-\begin_inset VSpace medskip
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
\end_inset
+echo $a
+\end_layout
+\begin_layout Section
+Notification
\end_layout
\begin_layout Standard
-\align center
-\begin_inset LatexCommand url
-target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
+LyX can notify clients of events going on asynchronously.
+ Currently it will only do this if the user binds a key sequence with the
+ function
+\begin_inset Quotes eld
+\end_inset
+notify
+\begin_inset Quotes erd
\end_inset
+.
+ The format of the string LyX sends is as follows:
+\end_layout
+
+\begin_layout Quote
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+NOTIFY:
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+\emph on
+key-sequence
\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.
-
+where
+\emph on
+key-sequence
+\emph default
+ is the printed representation of the key sequence that was actually typed
+ by the user.
\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
-\family sans
-article (A&A V4)
-\family default
-.
- Please refer to the comments in
-\family typewriter
-LyXDir/layouts/aapaper.layout
-\family default
+This mechanism can be used to extend LyX's command set and implement macros.
+ Bind some key sequence to
+\begin_inset Quotes eld
+\end_inset
+
+notify
+\begin_inset Quotes erd
+\end_inset
+
.
+ Then start a client that listens on the output pipe, dispatches the command
+ according to the sequence, and starts a function that may use LyX calls
+ and LyX requests to issue a command or a series of commands to LyX.
\end_layout
-\begin_layout Subsection
-Getting started
+\begin_layout Section
+The simple LyX Server Protocol
\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:
+LyX implements a simple protocol that can be used for session management.
+ All messages are of the form
\end_layout
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\begin_layout Quote
+LYXSRV:
+\emph on
+clientname
+\emph default
+:
+\emph on
+protocol message
+\end_layout
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog (OK, that one was obvious).
-\end_layout
+\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
+\begin_inset Quotes eld
+\end_inset
+
+hello
+\begin_inset Quotes erd
+\end_inset
+
+ or
+\begin_inset Quotes eld
+\end_inset
+
+bye
+\begin_inset Quotes erd
+\end_inset
-\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
+ If
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-The header block
-\end_layout
+hello
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
-\end_layout
+ is received from a client, LyX will report back to inform the client that
+ it's listening to it's messages, while
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+bye
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Title
-\family default
-: [required]
+ sent from LyX will inform clients that LyX is closing.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Subtitle
-\family default
-: [optional]
+\begin_layout Section
+Reverse DVI/PDF search
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Some DVI/PDF viewers
+\begin_inset Foot
+status collapsed
-\family sans
-Author
-\family default
-: [required]
+\begin_layout Plain Layout
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
+ Skim on Mac OSX and SumatraPDF on Windows.
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Address
-\family default
-: [required]
+ provide
+\emph on
+reverse search
+\emph default
+ facility (also called
+\emph on
+inverse search
+\emph default
+).
+ This means that you can tell LyX to put the cursor to a specific line in
+ the document by clicking at the respective position in the DVI/PDF output.
+ To achieve this, the viewer must be able to communicate with LyX.
+ This is done via the LyX server either by using the named pipe (
+\emph on
+lyxpipe
+\emph default
+), or the UNIX domain socket (
+\emph on
+lyxsocket
+\emph default
+) that LyX creates in its temporary directory (this is the way the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
+ program communicates with LyX).
+ In some cases, you need a helper script that mediates between the viewer
+ and LyX, in others, the viewer can communicate with LyX directly.
+ This depends on the selected viewer and on your operating system.
+ The same applies to the way viewers need to be configured and the way the
+ reverse search is actually performed.
+ In what follows, we will thus describe how to setup reverse search for
+ specific viewers.
+ Before we turn to this, though, we will explain what needs to be done generally
+ to enable reverse search in the DVI/PDF output.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
+\begin_layout Subsection
+Enabling reverse search
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+\begin_layout Plain Layout
+latex/pdflatex
\end_layout
-\begin_layout Standard
-There is no need to issue the
-\family typewriter
+\end_inset
-\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.
+ program, some are provided by external packages.
+ Your choice depends on whether your LaTeX distribution already provides
+ a given method (the built-in methods are rather new) and whether your viewer
+ can cope with it.
+ The available methods are described in the following.
+\end_layout
+
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
\end_layout
\begin_layout Standard
-If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
-g.
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in LaTeX since quite some time (any somewhat recent LaTeX
+ distribution should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaT
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+{}
+\end_layout
-\backslash
-
+\end_inset
+
+eX (plain)->DVI
\end_layout
\end_inset
-to state your present address, just use the standard footnote via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-F
-\bar default
-ootnote.
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\family default
- LyX will automagically use the term
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-thanks{}
-\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:
+\end_inset
+
+eX (plain)->DraftDVI
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ converter in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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.
+\begin_layout Plain Layout
+latex -src-specials $$i
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
+\end_layout
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
\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.
-
+The packages
+\emph on
+pdfsync
+\emph default
+ and
+\emph on
+scrltx
+\emph default
+ provide reverse search facility for PDF output (via pdflatex) and DVI output,
+ respectively.
+ In order to enable it, load the packages in the LyX preamble:
\end_layout
-\begin_layout Subsection
-The abstract
-\end_layout
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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
+\begin_layout Plain Layout
\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
+usepackage{pdfsync}
\end_layout
-\begin_layout Subsection
-Supported environments
-\end_layout
+\end_inset
-\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
+ for reverse PDF search,
\end_layout
\begin_layout Itemize
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Standard
-\end_layout
-
-\begin_layout Itemize
+\begin_layout Plain Layout
-\family sans
-Section
+\backslash
+usepackage[active]{srcltx}
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsection
+ for reverse DVI search.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Subsubsection
+\begin_layout Standard
+If you want to be able to perform both DVI and PDF reverse searches, you
+ can also insert in the preamble the following lines
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
-\family sans
-Itemize
-\end_layout
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
+\end_inset
-\begin_layout Itemize
-\family sans
-Enumerate
-\end_layout
+\backslash
+ifpdf
+\begin_inset Newline newline
+\end_inset
-\begin_layout Itemize
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
+\end_inset
-\family sans
-Description
-\end_layout
-\begin_layout Itemize
+\backslash
+else
+\begin_inset Newline newline
+\end_inset
-\family sans
-Caption
-\end_layout
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
+\end_inset
-\begin_layout Itemize
-\family sans
-Abstract
+\backslash
+fi
\end_layout
-\begin_layout Itemize
-
-\family sans
-Acknowledgment
+\begin_layout Standard
+This way, you can preview the file as either DVI or PDF (pdflatex) and the
+ right package will be used.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Note that PDFSync might affect the output layout of your document.
+ It is therefore advised to disable PDFsync for final documents.
+\end_layout
-\family sans
-Bibliography
+\begin_layout Subsubsection*
+Built-in reverse search via SyncTeX (DVI and PDF)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Recent versions of
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-LaTeX
+\begin_layout Plain Layout
+(pdf)latex
\end_layout
-\begin_layout Subsection
-Commands not supported by LyX
+\end_inset
+
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+SyncTeX
+\emph default
+ facility is basically the result of the integration of the PDFSync package
+ to the pdftex program and its merge with the
+\emph on
+scr-specials
+\emph default
+ approach.
+ You need at least TeXLive 2008 or a recent MikTeX distribution in order
+ to use it.
+ Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
+ already provide SyncTeX support.
\end_layout
\begin_layout Standard
-Some commands are not yet supported by the
-\family sans
-paper (A&A)
-\family default
- layout for LyX.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
-\end_layout
+To enable SyncTeX for DVI output, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-and
+{}
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-email
+eX (plain) -> DVI
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-appendix
-\end_layout
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-authorrunning
+{}
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-inst{}
+eX (plain) -> DraftDVI
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ converter in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-keywords{}
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-object{}
+\begin_layout Plain Layout
+latex -synctex=1 $$i
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+, and for PDF output, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-titlerunning{}
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
\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!
+\end_inset
+
+eX (pdflatex) -> PDF (pdflatex)
\end_layout
-\begin_layout Subsection
-Figure and Table Floats
+\end_inset
+
+ or converter to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+pdflatex -synctex=1 $$i
\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
+\end_inset
+
.
- 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
+ Check the documentation of your viewer whether the viewer needs to be configure
+d for the use with SyncTeX.
+\begin_inset Foot
+status collapsed
-\bar under
-P
-\bar default
-aragraph\InsetSpace ~
-Settings.
+\begin_layout Plain Layout
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-synctex=1
\end_layout
-\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:
+\end_inset
+
+ option enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-synctex=-1
\end_layout
-\begin_layout Enumerate
-Create a wide figure float:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Flo
-\bar under
-a
-\bar default
-t\SpecialChar \menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
-\bar under
-S
-\bar default
-pan\InsetSpace ~
-columns
-\family default
+\end_inset
+
.
\end_layout
-\begin_layout Enumerate
-Enter your caption text.
-\end_layout
+\end_inset
-\begin_layout Enumerate
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
-\end_layout
-\begin_layout Enumerate
-Insert your figure
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+\begin_layout Subsection
+Configuring and using specific viewers
+\end_layout
-\bar under
-S
-\bar default
-pecial\InsetSpace ~
-Character
-\bar under
-\SpecialChar \menuseparator
-H
-\bar default
-orizontal\InsetSpace ~
-Fill
-\family default
-.
+\begin_layout Subsubsection*
+Xdvi (all platforms)
\end_layout
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c\InsetSpace ~
-t
-\family default
-.
+\begin_layout Standard
+If you use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+xdvi
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
+\end_inset
-\backslash
-parbox[b]{55mm}{
-\family default
-.
+, you don't need to do anything else for performing a reverse DVI search,
+ as LyX already provides the necessary hooks for automatically using the
-\series bold
-Do not close the brace!
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\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
-\family default
-
-\family typewriter
-}
-\family default
-.
+\end_inset
+
+ program.
+ Just setup your document as described above (reverse search is triggered
+ by Ctrl-click or Alt-click on Mac OSX, respectively).
\end_layout
\begin_layout Standard
-Also, refer to the figures in the example paper.
+However, if for whatever reason you want to use the named pipe instead of
+ the socket for communicating with LyX, simply change the DVI viewer in
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats
\end_layout
-\begin_layout Subsection
-Referee layout
+\end_inset
+
+ to
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+On Mac OSX you have to use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
\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
+\end_inset
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
-\end_layout
-\begin_layout Subsection
-The example paper
\end_layout
-\begin_layout Standard
-The
-\family sans
-Examples
-\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
+\end_inset
-\begin_layout Section
-AASTeX
-\end_layout
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+\begin_layout Plain Layout
+xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
-\begin_layout Subsection
-Introduction
-\end_layout
+\end_inset
-\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
+, where
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
-
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset LatexCommand url
-target "http://www.journals.uchicago.edu/AAS/AASTeX"
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
+
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
+\end_inset
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
\end_inset
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
+\end_inset
+read < "${LYXPIPE}".out || exit
\end_layout
\begin_layout Standard
-\begin_inset VSpace medskip
+where
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+/path/to/lyxpipe
+\end_layout
+
\end_inset
+ is the Ly
+\begin_inset ERT
+status open
-\end_layout
+\begin_layout Plain 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_inset
+
+XServer pipe path specified in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
-\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
-\family default
-, enter the new file name, then choose the
-\family typewriter
-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
-<>
-\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
+\end_inset
-\backslash
-altaffilmark
-\family default
- and
-\family typewriter
+.
+\begin_inset Foot
+status collapsed
-\backslash
-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 Plain Layout
+In the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Subsection
-Finishing Your Paper
+\begin_layout Plain Layout
+development/tools
\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
+ folder of a source distribution you can find a
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor
+\end_layout
+
\end_inset
- actions which need to be done before you submit it to the journals.
-
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
\end_layout
-\begin_layout Enumerate
-Export your paper as a LaTeX file (
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\end_inset
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-\bar under
-L
-\bar default
-aTeX
-\family default
-).
-
\end_layout
-\begin_layout Enumerate
-Edit the resulting
-\family typewriter
-.tex
-\family default
- file with your favorite text editor
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
-\family typewriter
+\begin_layout Standard
+At the end of
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-documentclass
-\family default
- command
+\begin_layout Plain Layout
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
-\begin_layout Enumerate
-remove the
-\family typewriter
-
-\backslash
-usepackage...{fontenc}
-\family default
- line if it appears (usually just after
-\family typewriter
-
-\backslash
-documentclass
-\family default
-}; also remove the
-\family typewriter
+\end_inset
-\backslash
-secnumdepth
-\family default
- line if it appears.
+, add the following lines:
\end_layout
-\begin_layout Enumerate
-remove everything between (and including) the
-\family typewriter
+\begin_layout LyX-Code
+/Applications/Ly
+\begin_inset ERT
+status collapsed
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
+\begin_layout Plain Layout
+
+{}
+\end_layout
-\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
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
\end_inset
- comment in the
-\family typewriter
-.tex
-\family default
- file).
+exit 1
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
+\begin_layout Standard
+Modify the lines accordingly if you install LyX somewhere else than in the
+ Applications folder.
\end_layout
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+\begin_layout Standard
+Reverse search is triggered by Alt-click (OPTION-click).
\end_layout
-\begin_layout Enumerate
-Submit it.
+\begin_layout Subsubsection*
+Skim (Mac OSX)
\end_layout
-\begin_layout Subsection
-Comments On Specific Commands
+\begin_layout Standard
+Enter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+open -a Skim.app $$i
\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_inset
+
+ to the viewer setting in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Subsubsection
-Things that work as expected
+\end_inset
+
+, and then in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Skim\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Sync
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\end_inset
-\begin_layout Standard
+ select Ly
+\begin_inset ERT
+status collapsed
+\begin_layout Plain Layout
-\backslash
-begin{sloppypar}
+{}
\end_layout
\end_inset
+X.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by COMMAND-SHIFT-click
+\end_layout
+\begin_layout Subsubsection*
+Okular (KDE)
\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
+Go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-documentclass
-\family default
- (2.1.1),
-\family typewriter
+\begin_layout Plain Layout
+Settings\SpecialChar \menuseparator
+Configure Okular\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Editor
+\end_layout
-\backslash
-begin{document}
-\family default
- (2.2),
-\family typewriter
+\end_inset
-\backslash
-title
-\family default
- (2.3),
-\family typewriter
+, select
+\begin_inset Quotes eld
+\end_inset
-\backslash
-author
-\family default
- (2.3),
-\family typewriter
+Custom Text Editor
+\begin_inset Quotes erd
+\end_inset
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
+ and add the command
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
+\begin_layout Plain Layout
+lyxclient -g %f %l
+\end_layout
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
+\end_inset
-\backslash
-section
-\family default
- (2.7),
-\family typewriter
+.
+\end_layout
-\backslash
-subsection
-\family default
- (2.7),
-\family typewriter
+\begin_layout Standard
+Reverse search is triggered by SHIFT-click.
+\end_layout
-\backslash
-subsubsection
-\family default
- (2.7),
-\family typewriter
+\begin_layout Subsubsection*
+YAP (Cygwin)
+\end_layout
-\backslash
-paragraph
-\family default
- (2.7),
-\family typewriter
+\begin_layout Standard
+Launch yap, choose its
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-facility
-\family default
- (2.10),
-\family typewriter
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
+\end_layout
-\backslash
-begin{displaymath}
-\family default
- (2.12),
-\family typewriter
+\end_inset
-\backslash
-begin{equation}
-\family default
- (2.12),
-\family typewriter
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{mathletters}
-\family default
- (2.12),
-\family typewriter
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{thebibliography}
-\family default
- (2.13.1),
-\family typewriter
+New\SpecialChar \ldots{}
-\backslash
-bibitem
-\family default
- (2.13.2), all the cite commands and their variations (2.13.2), the generic
- graphicx figure commands (2.14.1),
-\family typewriter
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{table}
-\family default
- (2.15.4),
-\family typewriter
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{tabular}
-\family default
- (2.15.4),
-\family typewriter
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\backslash
-caption
-\family default
- (2.15.4),
-\family typewriter
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-label
-\family default
- (2.15.4, amongst other places),
-\family typewriter
+Name:
+\begin_inset Quotes erd
+\end_inset
-\backslash
-tablerefs
-\family default
- (2.15.5),
-\family typewriter
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\backslash
-tablecomments
-\family default
- (2.15.5),
-\family typewriter
+\SpecialChar \ldots{}
-\backslash
-url
-\family default
- (2.17.4),
-\family typewriter
+\begin_inset Quotes erd
+\end_inset
-\backslash
-end{document}
-\family default
- (2.18).
-\end_layout
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
-The following style options also work correctly:
-\family typewriter
-longabstract
-\family default
- (2.4),
-\family typewriter
-preprint
-\family default
- (3.2.1),
-\family typewriter
-preprint2
-\family default
- (3.2.2),
-\family typewriter
-eqsecnum
-\family default
- (3.3),
-\family typewriter
-flushrt
-\family default
- (3.4).
- Simply put them in the
-\family sans
-Options
-\family default
- box in
-\family sans
-Layout\SpecialChar \menuseparator
-Document
-\family default
-.
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\end_inset
-\begin_layout Standard
+ (see below).
+ Select
+\begin_inset Flex CharStyle:Code
+status collapsed
-
-\backslash
-end{sloppypar}
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
\end_inset
+ and then specify the program arguments as
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+%f %l
\end_layout
-\begin_layout Subsubsection
-Things that work, but require more comment
-\end_layout
+\end_inset
-\begin_layout Standard
-The following items work, but require a little more discussion:
+ if you want to use the shell script above, or as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-g %f %l
\end_layout
-\begin_layout Itemize
-These items are reserved for use by the journal editors, but you can put
- them into the LaTeX preamble if you feel compelled to do so:
-\family typewriter
+\end_inset
-\backslash
-received
-\family default
-,
-\family typewriter
+ if you want to use the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-revised
-\family default
-,
-\family typewriter
+\begin_layout Plain Layout
+lyxclient
+\end_layout
-\backslash
-accepted
-\family default
-,
-\family typewriter
+\end_inset
-\backslash
-ccc
-\family default
-,
-\family typewriter
+ program.
+ Since yap is a native Windows application, the filename it provides should
+ be converted to POSIX style before being passed to
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-cpright
-\family default
- (all from 2.1.3)
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Itemize
-These items may be placed in the LaTeX preamble, and are included as blanks
- in the template file:
-\family typewriter
+\end_inset
-\backslash
-slugcomment
-\family default
- (2.1.4),
-\family typewriter
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-shorttitle
-\family default
- (2.1.5),
-\family typewriter
+\begin_layout Plain Layout
+lyxclient
+\end_layout
-\backslash
-shortauthors
-\family default
- (2.1.5)
+\end_inset
+
+, and this is the purpose of the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ wrapper, which is as follows:
+\end_layout
-\backslash
-email
-\family default
- (2.3) -- can only be used
-\begin_inset Quotes eld
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
\end_inset
-standalone
-\begin_inset Quotes erd
+if "%1" == "-g" goto lyxclient
+\begin_inset Newline newline
\end_inset
-, not in the middle of a paragraph.
- Use ERT if you need to embed it.
-\end_layout
+bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
+\begin_inset Newline newline
+\end_inset
-\begin_layout Itemize
+exit
+\begin_inset Newline newline
+\end_inset
-\family typewriter
+:lyxclient
+\begin_inset Newline newline
+\end_inset
-\backslash
-and
-\family default
- (2.3) -- will have extra {} after it.
- This should not cause an error.
+bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+You have to make sure that both
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+lyxeditor.sh
+\end_layout
-\backslash
-notetoeditor
-\family default
- (2.6) -- can only be used
-\begin_inset Quotes eld
\end_inset
-standalone
-\begin_inset Quotes erd
-\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+\begin_layout Plain Layout
+lyxclient.exe
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-placetable
-\family default
- (2.8) -- can't insert a cross-reference tag, you must type the tag name
- by hand
+ are in the command PATH, otherwise you have to use their full posix path
+ in the above batch file.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
-\family typewriter
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
-\backslash
-placefigure
-\family default
- (2.8) -- same as for
-\family typewriter
+\begin_layout Standard
+In SumatraPDF, you can set the name of the program that communicates with
+ LyX by simply launching SumatraPDF as
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-placetable
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ and then quit.
+ The program will remember the setting and using the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-acknowledgements
-\family default
- (2.9) -- will have extra {} after it.
- This should not cause an error.
+\begin_layout Plain Layout
+-inverse-search
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ option will not be needed from now on
+\begin_inset Foot
+status collapsed
-\backslash
-appendix
-\family default
- (2.11) -- will have extra {} after it.
- This should not cause an error.
-\end_layout
+\begin_layout Plain Layout
+It has been reported that SumatraPDF is not able to remember the settings
+ if it is installed in the Program Files system folder.
+ This problem can be avoided by installing it somewhere else, for example
+ in
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+/usr/local/bin
+\end_layout
-\family typewriter
+\end_inset
-\backslash
-figcaption
-\family default
- (2.14.2) -- you can insert an optional filename argument by placing the cursor
- at the beginning of the text and selecting
-\family sans
-Insert\SpecialChar \menuseparator
-Short Title
-\family default
.
-
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-Short Title
-\begin_inset Quotes erd
\end_inset
- inserts an optional argument of the type needed by
-\family typewriter
+ (in this way you will be using the lyxsocket; omit the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-figcaption
-\family default
-.
- Hopefully it will be renamed someday.
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-objectname
-\family default
- (2.17.1) -- same as
-\family typewriter
+ option if you want to use the lyxpipe and be sure that the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ script is in your command PATH).
+ If SumatraPDF is not your default PDF viewer, you should enter
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-dataset
-\family default
- (2.17.1) -- same as
-\family typewriter
+\begin_layout Plain Layout
+SumatraPDF.sh
+\end_layout
-\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
+\end_inset
+
+ in the viewer setting in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Subsubsection
-Things not implemented, use ERT
+\end_inset
+
+, where
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF.sh
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\end_inset
-\begin_layout Standard
+ is the following script (to be placed in your command PATH,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+/usr/local/bin
+\end_layout
-\backslash
-begin{sloppypar}
+\end_inset
+
+ being the best choice):
\end_layout
+\begin_layout LyX-Code
+#!/bin/bash
+\begin_inset Newline newline
\end_inset
+cd $(dirname $1)
+\begin_inset Newline newline
+\end_inset
+SumatraPDF.exe $(basename $1)
\end_layout
\begin_layout Standard
+This is needed because SumatraPDF is a native Windows application and does
+ not understand the posix paths used by the Cygwin version of LyX.
+\end_layout
-\family typewriter
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
-\backslash
-altaffilmark
-\family default
- (2.3),
-\family typewriter
+\begin_layout Chapter
+Special Document Classes
+\end_layout
-\backslash
-altaffiltext
-\family default
- (2.3),
-\family typewriter
+\begin_layout Section
+A&A Paper
+\end_layout
-\backslash
-eqnum
-\family default
- (2.12),
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Peter Sütterlin
+\end_layout
-\backslash
-setcounter{equation}
-\family default
- (2.12), Journal name abbreviations (2.13.4),
-\family typewriter
-
-\backslash
-figurenum
-\family default
- (2.14.1),
-\family typewriter
-
-\backslash
-epsscale
-\family default
- (2.14.1),
-\family typewriter
-
-\backslash
-plotone
-\family default
- (2.14.1),
-\family typewriter
-
-\backslash
-plottwo
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Subsection
+Introduction
+\end_layout
-\backslash
-tablenum
-\family default
- (2.15.4),
-\family typewriter
+\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
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
-\backslash
-tableline
-\family default
- (2.15.4, insert it as the first element in the lefthand cell after where
- you want it.
- Don't use any of LyX's rules in the table),
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-tablenotemark
-\family default
- (2.15.5),
-\family typewriter
+http://www.edpsciences.fr/aa/
+\end_layout
-\backslash
-tablenotetext
-\family default
- (2.15.5), much of Misc (2.17, except
-\family typewriter
+\end_inset
-\backslash
-objectname
-\family default
-,
+) using Version 5.01 of the document class
\family typewriter
-
-\backslash
-dataset
+aa.cls
\family default
-,
-\family typewriter
+.
+ This package can be downloaded from the ftp site
+\end_layout
-\backslash
-url
-\family default
-, and
-\family typewriter
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\backslash
-email
-\family default
-; see above),
-\family typewriter
-\backslash
-singlespace
-\family default
- (3.1),
-\family typewriter
+\end_layout
-\backslash
-doublespace
-\family default
- (3.1),
-\family typewriter
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-\backslash
-onecolumn
-\family default
- (3.2),
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-twocolumn
-\family default
- (3.2)
+ftp://ftp.edpsciences.org/pub/aa/readme.html
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
+\end_inset
-\backslash
-end{sloppypar}
\end_layout
+\begin_layout Standard
+\begin_inset VSpace medskip
\end_inset
\end_layout
-\begin_layout Subsubsection
-Things that cannot be implemented
+\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 Standard
-\SpecialChar \ldots{}
- at least in any meaningful sort of way, so I suggest ignoring them.
- They are the references environment (2.13.3), and the deluxetable environment
- (2.15).
- If you really, really need to use deluxetable, I suggest editing it in
- a separate file with a text editor, then using
+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
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-\InsetSpace ~
-Document
+article (A&A V4)
\family default
- to include it in your LyX document.
- See the
+.
+ Please refer to the comments in
\family typewriter
-aas_sample.lyx
+LyXDir/layouts/aapaper.layout
\family default
- file to see an example of this.
+.
\end_layout
\begin_layout Subsection
-FAQs, Tips, Tricks, and Other Ruminations
-\end_layout
-
-\begin_layout Subsubsection
-Getting LyX and AASTeX to cooperate
+Getting started
\end_layout
\begin_layout Standard
-It can be a bit tricky to get LyX to recognize a new layout and document
- class.
- When all else fails, do this:
+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 Enumerate
-Make certain that LaTeX can find AASTeX.
- Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
- a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
-\family typewriter
-sample.tex
+\begin_layout Itemize
+Select
+\family sans
+article (A&A)
\family default
-.
+ in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog (OK, that one was obvious).
\end_layout
-\begin_layout Enumerate
-Make certain that
-\family typewriter
-aastex.layout
-\family default
- appears in
-\family typewriter
-/usr/.../share/lyx/layouts
+\begin_layout Itemize
+Don't change the option
+\family sans
+Page
+\begin_inset space ~
+\end_inset
+
+style
\family default
- or
-\family typewriter
-~/.lyx/layouts
+: 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 Enumerate
-Rerun
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+\begin_layout Subsection
+The header block
+\end_layout
-\bar under
-R
-\bar default
-econfigure
-\family default
- in LyX, then restart LyX.
+\begin_layout Standard
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
\end_layout
-\begin_layout Enumerate
-Open a regular new file, not from a template.
- Does AASTeX appear in the class list in
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\begin_layout Itemize
-\bar under
-S
-\bar default
-ettings
+\family sans
+Title
\family default
-?
+: [required]
\end_layout
-\begin_layout Standard
-If you get a warning from an existing AASTeX document about not being able
- to find the AASTeX layout or a message about
-\begin_inset Quotes eld
-\end_inset
-
-You should not mix title layouts with normal ones
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-, things haven't been installed correctly.
+\family sans
+Subtitle
+\family default
+: [optional]
\end_layout
-\begin_layout Subsubsection
-LaTeX error processing a table
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-LyX, by default, attempts to center the table caption/title.
- This seems to produce a bad interaction in AASTeX so you should click somewhere
- in the caption/title, then select
\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
+Author
+\family default
+: [required]
+\end_layout
-\bar under
-P
-\bar default
-aragraph\InsetSpace ~
-Settings
+\begin_layout Itemize
+
+\family sans
+Address
\family default
-, then set the
+: [required]
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Alignment
+Offprints
\family default
- to
+: [optional] if more than one author: whom to contact for offprint requests.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-\bar under
-B
-\bar default
-lock
+Mail
\family default
-.
- This took care of it for me.
+: [optional] mail address for contacts.
\end_layout
-\begin_layout Subsubsection
-References
-\begin_inset LatexCommand label
-name "cite"
+\begin_layout Itemize
-\end_inset
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
+\end_layout
+\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 Standard
-A couple of things: 1) I have noticed some funny spacing in the reference
- entries in the text.
- When you enter the bibliography item data, make sure their is
-\emph on
-no
-\emph default
- space between the last author and the parenthesis setting off the year;
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+to state your present address, just use the standard footnote via the menu
-\emph on
-e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
+\family sans
+Insert\SpecialChar \menuseparator
+Footnote.
-\emph default
-type
-\family typewriter
-Ressler(1992)
\family default
-, not
+ LyX will automagically use the term
\family typewriter
-Ressler (1992)
-\family default
-.
- 2) Entering the references at all is not obvious.
- The easiest thing is to start typing your first reference at the end of
- the document, then mark it as type
-\family sans
-References
+
+\backslash
+thanks{}
\family default
-.
- That will put a small gray box in front of what you just typed.
- Click on the box to fill in the rest of the information.
- For new references, go to the end of an existing reference and press return.
- That will create a new line with its own box, etc.
+ in that case.
\end_layout
-\begin_layout Subsubsection
-Including EPS files
+\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 Standard
-Even though AASTeX provides its own figure commands (
-\family typewriter
+\begin_layout Itemize
-\backslash
-plotone
-\family default
-, for example), I much prefer LaTeX's standard figure commands (with the
- default graphicx).
- You can insert the
\family typewriter
\backslash
-plotone
+and
\family default
-, etc.\InsetSpace ~
-commands as ERT into a Figure Float box if you desire, but I never
- have much luck getting the layout right.
- With the standard graphics, LyX will insert a
+ to separate different names for more than one author and institute, respectivel
+y.
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-usepackage{graphicx}
+inst{<nr>}
\family default
- command into the LaTeX preamble and handle the figures in the standard
- LaTeX2e way, interspersing the figures in the text.
- I believe ApJ accepts figures exactly this way now; AJ might still use
- the
-\begin_inset Quotes eld
-\end_inset
+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
-stack everything at the end
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- technique.
-\end_layout
+\family typewriter
-\begin_layout Subsubsection
-Things I could have done, but didn't
+\backslash
+email{address}
+\family default
+ to supply an email address for fast contact.
\end_layout
\begin_layout Standard
-There are a few
-\begin_inset Quotes eld
-\end_inset
-
-pretty
-\begin_inset Quotes erd
-\end_inset
-
- things I could have implemented, but chose not to.
- For instance, I saw no point in double-spacing the text in the LyX window,
- even though it is double-spaced in the paper manuscript.
- Also, I chose not to make separate layouts for the preprint and preprint2
- styles.
- Since I assume you will spend most of your time in the plain manuscript
- mode anyway, I decided not to chew up more disk space with this.
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
\end_layout
\begin_layout Subsection
-Final Caveat
+The abstract
\end_layout
\begin_layout Standard
-Your mileage may vary.
- I've now had papers published by both ApJ and AJ that have had 98% of the
- effort done in LyX; the last 2% was the LaTeX post-processing and a few
- cleanups.
- I have had no trouble with the submission process, and I'm sure the journals
- were never aware that there might be a difference.
- So, go forth and publish!
-\end_layout
-
-\begin_layout Section
-qijmpc and ijmpd
-\end_layout
+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
-\begin_layout Standard
-by
-\noun on
-Panayotis Papasotiriou
+\backslash
+keywords{}
+\family default
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
\end_layout
\begin_layout Subsection
-Overview
+Supported environments
\end_layout
\begin_layout Standard
-The ijmpc package is a set of macros that facilitates electronic manuscript
- submission to the
-\emph on
-International Journal of Modern Physics C
-\emph default
-.
- Similarly, the ijmpd package is for creating manuscripts to be submitted
- to the
-\emph on
-International Journal of Modern Physics D
-\emph default
-.
- Both journals are published by World Scientific.
- The corresponding document classes are named
-\family typewriter
-ws-ijmpc.cls
-\family default
- and
-\family typewriter
-ws-ijmpd.cls
-\family default
-, 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"
+The A&A paper layout supports the following environments for structuring
+ your text:
+\end_layout
-\end_inset
+\begin_layout Itemize
- and
-\begin_inset LatexCommand url
-target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
+\family sans
+Standard
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
- Both packages are modified versions of the standard
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Section
+\end_layout
-article
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- package, and they are almost (but not exactly) identical.
- Most of their features are supported by LyX.
- I have used LyX successfully to write articles submitted to both journals
- without any problem.
+\family sans
+Subsection
\end_layout
-\begin_layout Subsection
-Writing a paper
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-As usual, the easiest way to write a paper is to start with a template.
- Click on
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New from
-\family default
-
-\family sans
-\bar under
-T
-\bar default
-emplate
-\family default
-, then choose the
-\family typewriter
-ijmpc.lyx
-\family default
- or
-\family typewriter
-ijmpd.lyx
-\family default
- template.
- This will give an (almost) empty document that includes the most common
- fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
-\family typewriter
-<>
-\family default
-) with your text.
- You should keep in mind the following remarks.
+Subsubsection
\end_layout
-\begin_layout Enumerate
-LyX won't let you change the font size and the page style of the document,
- because such modifications are not allowed by both packages.
-\end_layout
+\begin_layout Itemize
-\begin_layout Enumerate
-The language of the document should not be changed.
- Before previewing your paper, be sure that the babel package is not used.
- To do this, click on
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+Itemize
+\end_layout
+
+\begin_layout Itemize
-\bar under
-P
-\bar default
-references
-\family default
-, select the
-\family sans
-Lang Opts
-\family default
- tab, deselect the
-\family sans
-\bar under
-U
-\bar default
-se babel
-\family default
- checkbox in the language settings, and click on
-\family sans
-\bar under
-A
-\bar default
-pply
-\family default
- (or
\family sans
-Save
-\family default
-, if you wish to make this change permanent).
+Enumerate
\end_layout
-\begin_layout Enumerate
-The
-\begin_inset Quotes eld
-\end_inset
-
-Keywords
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- style must be used to define keywords.
+\family sans
+Description
\end_layout
-\begin_layout Enumerate
-The ijmpc package provides a style named
-\begin_inset Quotes eld
-\end_inset
-
-Classification Codes
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-, which can be used to define classification codes, such as PACS numbers.
- Note that this facility is not supported by the ijmpd package.
+\family sans
+Caption
\end_layout
-\begin_layout Enumerate
-Several new environments are available:
-\begin_inset Quotes eld
-\end_inset
-
-Definition
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Abstract
+\end_layout
-Step
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Acknowledgment
+\end_layout
-Example
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Bibliography
+\end_layout
-Remark
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family sans
+LaTeX
+\end_layout
-Notation
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Commands not supported by LyX
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+Some commands are not yet supported by the
+\family sans
+paper (A&A)
+\family default
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
+\end_layout
-Theorem
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
-Proof
-\begin_inset Quotes erd
-\end_inset
+\backslash
+and
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Corollary
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
-,
-\begin_inset Quotes eld
-\end_inset
+\backslash
+email
+\end_layout
-Lemma
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
-Proposition
-\begin_inset Quotes erd
-\end_inset
+\backslash
+appendix
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Prop
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
-,
-\begin_inset Quotes eld
-\end_inset
+\backslash
+authorrunning
+\end_layout
-Question
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
-Claim
-\begin_inset Quotes erd
-\end_inset
+\backslash
+inst{}
+\end_layout
-, and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Conjecture
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
-.
- Their use is more or less obvious.
- LyX supports all these environments; it will use the proper label, text
- style, and numbering scheme for each of them.
+\backslash
+keywords{}
\end_layout
-\begin_layout Enumerate
-Both packages use basic citations; the natbib package should not be used.
- In LyX, citation references are shown as usual; in the output, citations
- are shown as superscripts.
- If you want to use a citation as normal text, you should use the
+\begin_layout Itemize
+
\family typewriter
-refcite
-\family default
- command, e.\InsetSpace \thinspace{}
-g.,
-\begin_inset Quotes eld
-\end_inset
-See Ref.\InsetSpace ~
+\backslash
+object{}
+\end_layout
+
+\begin_layout Itemize
\family typewriter
\backslash
-refcite{key}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+titlerunning{}
\end_layout
-\begin_layout Enumerate
-There is no
-\begin_inset Quotes eld
-\end_inset
-
-Acknowledgments
-\begin_inset Quotes erd
-\end_inset
-
- section in both packages.
- To put acknowledgments, just use the
-\begin_inset Quotes eld
-\end_inset
-
-Section*
-\begin_inset Quotes erd
-\end_inset
+\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!
+\end_layout
- environment.
+\begin_layout Subsection
+Figure and Table Floats
\end_layout
-\begin_layout Enumerate
-Appendices may be added to the paper,
+\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
-after
-\emph default
- the Acknowledgments and
-\shape italic
-before
-\shape default
- the References.
- LyX provides a special environment, called
-\begin_inset Quotes eld
-\end_inset
-
-Appendices Section
-\begin_inset Quotes erd
-\end_inset
-
- which marks the beginning of the appendices.
- This environment should be left blank; it just sends a LaTeX command, but
- nothing is really printed.
- In LyX, the word
-\begin_inset Quotes eld
-\end_inset
-
-Appendix
-\begin_inset Quotes erd
-\end_inset
-
- is printed with blue letters, as a signal that all sections after that
- point are appendices.
- To write an appendix, use the
-\begin_inset Quotes eld
-\end_inset
-
-Appendix
-\begin_inset Quotes erd
+User's
+\begin_inset space ~
\end_inset
- environment.
- LyX will number each appendix with capital letters, as required by both
- journals.
- Note that
-\begin_inset Quotes eld
+Guide
+\emph default
+.
+ Just remember that tables should be left-aligned.
+ For that, select the table and change the alignment in
+\family sans
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
-Appendices Section
-\begin_inset Quotes erd
-\end_inset
+Settings.
+\end_layout
-
-\emph on
-must
-\emph default
- be present before the first appendix; if not, all appendices will be numbered
- as normal sections in the output.
+\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:
\end_layout
\begin_layout Enumerate
-The ijmpc and the ijmpd packages use the
-\family typewriter
-tbl
-\family default
- command to implement table captions.
- As a result, a table created by LyX is printed correctly, but its caption
- is ignored.
- However, you can use some ERT to overpass this problem, so that captions
- are printed as expected.
- To do so, create a float table as usual, remove the caption, and replace
- it with the ERT
-\family typewriter
-
-\backslash
-tbl{
-\emph on
-your table caption
-\emph default
-}{
-\family default
- (sic); you must also the ERT
-\family typewriter
-}
-\family default
- immediately after the tabular material.
- Study the example table included in the template files to see how this
- trick is implemented.
- Alternatively, If you need table captions, you should implement the whole
- table float in a
-\family typewriter
-.tex
+Create a wide figure float:
+\family sans
+Insert\SpecialChar \menuseparator
+Float\SpecialChar \menuseparator
+Figure
\family default
- file, then include this file to the LyX document (
+, then right click in the figure and select
\family sans
\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Fil
-\bar under
-e
-\bar default
-\SpecialChar \menuseparator
-Chil
-\bar under
-d
+S
\bar default
-\InsetSpace ~
-Document
-\family default
-).
- Details on how to create a table float can be found in the files
-\family typewriter
-ws-ijmpc.tex
-\family default
- and
-\family typewriter
-ws-ijmpd.tex
+pan
+\begin_inset space ~
+\end_inset
+
+columns
\family default
-, included in the corresponding packages.
+.
\end_layout
-\begin_layout Subsection
-Preparing a paper for submission
+\begin_layout Enumerate
+Enter your caption text.
\end_layout
-\begin_layout Standard
-Before you submit your paper you must export the LyX document as a LaTeX
- file (
+\begin_layout Enumerate
+Press
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+Return
+\family default
+ to move the cursor above the caption.
+\end_layout
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+\begin_layout Enumerate
+Insert your figure
+\end_layout
-\bar under
-L
-\bar default
-a
-\family default
-T
+\begin_layout Enumerate
+Position the cursor behind the figure and insert a horizontal fill:
\family sans
-eX
-\family default
-)
-\begin_inset Foot
-status open
+Insert\SpecialChar \menuseparator
+Special
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-Actually you have the choice between LaTeX (plain) and pdflatex.
- If you intend to use pdflatex to prepare the paper, you should use the
- pdflatex option so that included graphics are converted to PDF format,
- ready for use by pdflatex.
+Character\SpecialChar \menuseparator
+Horizontal
+\begin_inset space ~
+\end_inset
+
+Fill
+\family default
+.
\end_layout
+\begin_layout Enumerate
+Switch to LaTeX mode:
+\family sans
+M-c
+\begin_inset space ~
\end_inset
-, then make the following changes to the resulting
-\family typewriter
-.tex
+t
\family default
- file.
+.
\end_layout
\begin_layout Enumerate
-Remove the comment lines before the
+Enter
\family typewriter
\backslash
-documentclass
+parbox[b]{55mm}{
\family default
- command.
+.
+
+\series bold
+Do not close the brace!
\end_layout
\begin_layout Enumerate
-Remove everything between (and including) the
-\family typewriter
+Position the cursor behind the caption text, switch to LaTeX mode and insert
+ the closing brace:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-makeatletter
+t
\family default
- and
+
\family typewriter
-
-\backslash
-makeatother
+}
\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
+.
\end_layout
\begin_layout Standard
-The modified
-\family typewriter
-.tex
-\family default
- file should be saved and processed through LaTeX as many times as necessary.
- You may also want to check the resulting
-\family typewriter
-.dvi
-\family default
- document.
+Also, refer to the figures in the example paper.
\end_layout
\begin_layout Subsection
-Use of ERT
+Referee layout
\end_layout
\begin_layout Standard
-The use of ERT is reduced to two commands, which must be placed at the top
- of the document.
- If you started writing your paper by using 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
-ijmpc.lyx
+referee
\family default
- or the
-\family typewriter
-ijmpd.lyx
+ to the documentclass.
+ This must be done using the extra class options field in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
\family default
- template, the ERT needed is already in its place; you usually don't need
- to delete it.
- You may only modify the first ERT to specify the information printed to
- the top of odd and even pages (authors' names and short paper's title,
- respectively).
- This ERT must have the form
+ dialog.
+ Just enter the string
\family typewriter
+referee
+\family default
+ there.
+\end_layout
-\backslash
-markboth{Authors' Names}{Short Paper's Title}
+\begin_layout Subsection
+The example paper
+\end_layout
+
+\begin_layout Standard
+The
+\family sans
+Examples
\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
-iopart
+AASTeX
\end_layout
\begin_layout Standard
by
\noun on
-Uwe Stöhr
+Mike Ressler
\end_layout
\begin_layout Subsection
-Overview
+Introduction
\end_layout
\begin_layout Standard
-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 LatexCommand url
-target "ftp://ftp.iop.org/pub/journals/latex2e"
+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
+\begin_inset VSpace medskip
\end_inset
-.
-\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 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
+\align center
+\begin_inset Flex URL
+status collapsed
-\begin_layout Itemize
-To be able to compile your document to a PDF, PS, or DVI, assure that the
- two options
-\family sans
-Use AMS math package
-\family default
- in the document settings under
-\family sans
-Math Options
-\family default
- are not used!
+\begin_layout Plain Layout
+
+http://www.journals.uchicago.edu/AAS/AASTeX
\end_layout
-\begin_layout Itemize
+\end_inset
+
-\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
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\family sans
-\size normal
-Title
-\family default
- for a Paper
-\end_layout
-\begin_layout Itemize
+\end_layout
-\family sans
-\size normal
-Review
-\family default
- for a Review
+\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 Itemize
+\begin_layout Subsection
+Starting a New Paper
+\end_layout
+\begin_layout Standard
+I strongly suggest that you start with the AASTeX template file.
+ Click on
\family sans
-\size normal
-Topical
+File\SpecialChar \menuseparator
+New from
\family default
- for a Topical review
-\end_layout
-
-\begin_layout Itemize
-
+
\family sans
-\size normal
-Comment
+Template
\family default
- for a Comment
-\end_layout
+, enter the new file name, then choose the
+\family typewriter
+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
+<>
+\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
-\begin_layout Itemize
+\backslash
+altaffilmark
+\family default
+ and
+\family typewriter
-\family sans
-\size normal
-Note
+\backslash
+altaffiltext
\family default
- for a Note
+, 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 TeX code, or Evil Red Text.
+ I tried to minimize the amount of TeX code needed in an AASTeX document,
+ but there is still a bit more required than any of us would like.
\end_layout
-\begin_layout Itemize
-
-\family sans
-\size normal
-Paper
-\family default
- for a Paper (same as Title)
+\begin_layout Subsection
+Finishing Your Paper
\end_layout
-\begin_layout Itemize
+\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
-\size normal
-Prelim
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
- for a Preliminary communication
+).
+
\end_layout
-\begin_layout Itemize
-
-\family sans
-\size normal
-Rapid
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
\family default
- for a Rapid communication
+ file with your favorite text editor
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
+\family typewriter
-\family sans
-\size normal
-Letter
+\backslash
+documentclass
\family default
- for a Letter to the editor
+ command
\end_layout
-\end_deeper
-\begin_layout Itemize
+\begin_layout Enumerate
+remove the
+\family typewriter
-\size normal
-All title environments except of
-\family sans
-Letter
+\backslash
+usepackage...{fontenc}
\family default
- can have an optional short title.
-\end_layout
+ line if it appears (usually just after
+\family typewriter
-\begin_layout Itemize
-There is a general title environment
-\family sans
-Article
+\backslash
+documentclass
\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
+}; also remove the
+\family typewriter
-\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
+\backslash
+secnumdepth
+\family default
+ line if it appears.
\end_layout
-\begin_layout Subsection
-Overview
-\end_layout
+\begin_layout Enumerate
+remove everything between (and including) the
+\family typewriter
-\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
+\backslash
+makeatletter
+\family 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
+\family typewriter
-\begin_layout Standard
-LyX supports many features of the package but not everything.
- However, the ERT needed is reduced to some
+\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
-peculiar
+User specified LaTeX commands
\begin_inset Quotes erd
\end_inset
- commands of the package (see\InsetSpace ~
+ comment in the
+\family typewriter
+.tex
+\family default
+ file).
+\end_layout
-\begin_inset LatexCommand ref
-reference "subsec:kluwer_peculiarities"
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through LaTeX to make sure it still processes correctly.
+\end_layout
-\end_inset
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
+\end_layout
-).
- I have recently used LyX to write an article submitted to the
-\emph on
-Astrophysics and Space Science
-\emph default
- without any problem.
+\begin_layout Enumerate
+Submit it.
\end_layout
\begin_layout Subsection
-Writing a paper
+Comments On Specific Commands
\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,
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
\family typewriter
-<>
+aasguide.tex
\family default
-) with the correct information.
+) 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 Subsection
-Preparing a paper for submission
+\begin_layout Subsubsection
+Things that work as expected
\end_layout
\begin_layout Standard
-As in the AASTeX package, before you submit your paper to a journal you
- must
-\begin_inset Quotes eld
-\end_inset
+\begin_inset ERT
+status open
-postprocess
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
- it as follows.
+
+\backslash
+begin{sloppypar}
\end_layout
-\begin_layout Enumerate
-Export your paper as a LaTeX file.
- To do this, click on
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\end_inset
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-\bar under
-L
-\bar default
-aTeX
-\family default
-.
-
\end_layout
-\begin_layout Enumerate
-Edit the resulting
+\begin_layout Standard
+Because they work as you might expect, I simply list them and the section
+ they are found in:
\family typewriter
-.tex
-\family default
- file with a text editor and make the following changes
-\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
+\backslash
+documentclass
+\family default
+ (2.1.1),
\family typewriter
\backslash
-documentclass
+begin{document}
\family default
- command,
-\end_layout
+ (2.2),
+\family typewriter
-\begin_layout Enumerate
-remove everything between (and including) the
+\backslash
+title
+\family default
+ (2.3),
\family typewriter
\backslash
-makeatletter
+author
\family default
- and
+ (2.3),
\family typewriter
\backslash
-makeatother
+affil
\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
-\end_layout
+ (2.3),
+\family typewriter
-\begin_layout Standard
-Save the resulting
+\backslash
+abstract
+\family default
+ (2.4),
\family typewriter
-.tex
+
+\backslash
+keywords
\family default
- file.
-\end_layout
+ (2.5),
+\family typewriter
-\end_deeper
-\begin_layout Enumerate
-Run the
+\backslash
+section
+\family default
+ (2.7),
\family typewriter
-.tex
+
+\backslash
+subsection
\family default
- file through LaTeX as many times as necessary (usually up to three).
-\end_layout
+ (2.7),
+\family typewriter
-\begin_layout Enumerate
-View the resulting
+\backslash
+subsubsection
+\family default
+ (2.7),
\family typewriter
-.dvi
+
+\backslash
+paragraph
\family default
- document using, e.\InsetSpace \thinspace{}
-g.,
-\family sans
-xdvi
+ (2.7),
+\family typewriter
+
+\backslash
+facility
\family default
-, and check if everything is OK (it should, if you didn't make any mistake).
-\end_layout
+ (2.10),
+\family typewriter
-\begin_layout Subsection
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{displaymath}
+\family default
+ (2.12),
+\family typewriter
-Peculiarities
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{equation}
+\family default
+ (2.12),
+\family typewriter
- of the Kluwer package
-\begin_inset LatexCommand label
-name "subsec:kluwer_peculiarities"
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The Kluwer package has the following
-\begin_inset Quotes eld
-\end_inset
-
-peculiarities
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Enumerate
-It is possible to write multiple articles in the same LaTeX file
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-I can't imagine any good reason to do this.
-\end_layout
-
-\end_inset
-
-.
- Each article must be included in the environment
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{eqnarray}
+\family default
+ (2.12),
+\family typewriter
-article
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{mathletters}
+\family default
+ (2.12),
+\family typewriter
-.
- Unfortunately, this environment cannot be omitted, even if you write just
- one article.
- Therefore, each article starts with the command
+\backslash
+begin{thebibliography}
+\family default
+ (2.13.1),
\family typewriter
\backslash
-begin{article}
+bibitem
\family default
- and, obviously, ends with the command
+ (2.13.2), all the cite commands and their variations (2.13.2), the generic
+ graphicx figure commands (2.14.1),
\family typewriter
\backslash
-end{article}
+begin{table}
\family default
-.
- Although this can be implemented in LyX, I didn't included it, since it
- looks ugly and can confuse the novice user.
- Therefore, you need to enter them directly and mark them as LaTeX code
- (the well-known
-\begin_inset Quotes eld
-\end_inset
+ (2.15.4),
+\family typewriter
-ERT
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{tabular}
+\family default
+ (2.15.4),
+\family typewriter
-).
-\end_layout
+\backslash
+caption
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Enumerate
-Information given at the beginning of the article (i.e., title, subtitle,
- author, institution, running title, running author, abstract and keywords)
- must be included in an environment called
-\begin_inset Quotes eld
-\end_inset
+\backslash
+label
+\family default
+ (2.15.4, amongst other places),
+\family typewriter
-opening
-\begin_inset Quotes erd
-\end_inset
+\backslash
+tablerefs
+\family default
+ (2.15.5),
+\family typewriter
-.
- This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
-between
- two ERT lines (
+\backslash
+tablecomments
+\family default
+ (2.15.5),
\family typewriter
\backslash
-begin{opening}
+url
\family default
- and
+ (2.17.4),
\family typewriter
\backslash
-end{opening}
+end{document}
\family default
-).
+ (2.18).
\end_layout
-\begin_layout Enumerate
-According to the user manual, the label of each bibliography item must be
- written as
+\begin_layout Standard
+The following style options also work correctly:
\family typewriter
-
-\backslash
-protect
-\backslash
-citeauthoryear{
+longabstract
\family default
-\emph on
-author(s)
+ (2.4),
\family typewriter
-\emph default
-}{
+preprint
\family default
-\emph on
-year
+ (3.2.1),
\family typewriter
-\emph default
-}
+preprint2
+\family default
+ (3.2.2),
+\family typewriter
+eqsecnum
+\family default
+ (3.3),
+\family typewriter
+flushrt
+\family default
+ (3.4).
+ Simply put them in the
+\family sans
+Options
+\family default
+ box in
+\family sans
+Layout\SpecialChar \menuseparator
+Document
\family default
.
\end_layout
\begin_layout Standard
-The
-\family typewriter
-kluwer.lyx
-\family default
- template takes care of all these
-\begin_inset Quotes eld
-\end_inset
+\begin_inset ERT
+status open
-peculiarities
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-.
- If you start a new paper using this template you don't need to do anything
- special.
- Just
-\end_layout
-\begin_layout Enumerate
-don't delete the ERT included in the template, and
+\backslash
+end{sloppypar}
\end_layout
-\begin_layout Enumerate
-copy the example bibliography item included in the template and modify it
- as necessary to enter new bibliography items.
+\end_inset
+
+
\end_layout
-\begin_layout Section
-Koma-Script
+\begin_layout Subsubsection
+Things that work, but require more comment
\end_layout
\begin_layout Standard
-by
-\noun on
-Bernd Rellermeyer
+The following items work, but require a little more discussion:
\end_layout
-\begin_layout Subsection
-Overview
-\end_layout
+\begin_layout Itemize
+These items are reserved for use by the journal editors, but you can put
+ them into the LaTeX preamble if you feel compelled to do so:
+\family typewriter
-\begin_layout Standard
-The LyX document classes
-\emph on
-article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
+\backslash
+received
+\family default
,
-\emph on
-book
-\emph default
-
-\emph on
-(koma-script)
-\emph default
-, and
-\emph on
-letter
-\emph default
-
-\emph on
-(koma-script)
-\emph default
- correspond to the LaTeX document classes
\family typewriter
-scrartcl.cls
+
+\backslash
+revised
\family default
,
\family typewriter
-scrreprt.cls
+
+\backslash
+accepted
\family default
,
\family typewriter
-scrbook.cls
+
+\backslash
+ccc
\family default
-, and
+,
\family typewriter
-scrlettr.cls
+
+\backslash
+cpright
\family default
-, resp.\InsetSpace ~
-of the Koma-Script family.
- They are replacements for the standard document classes
+ (all from 2.1.3)
+\end_layout
+
+\begin_layout Itemize
+These items may be placed in the LaTeX preamble, and are included as blanks
+ in the template file:
\family typewriter
-article.cls
+
+\backslash
+slugcomment
\family default
-,
+ (2.1.4),
\family typewriter
-report.cls
+
+\backslash
+shorttitle
\family default
-,
+ (2.1.5),
\family typewriter
-book.cls
+
+\backslash
+shortauthors
\family default
- and
+ (2.1.5)
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
-letter.cls
+
+\backslash
+email
\family default
-, resp., and fit better to European typography conventions in a number of
- points.
+ (2.3) – can only be used
+\begin_inset Quotes eld
+\end_inset
+
+standalone
+\begin_inset Quotes erd
+\end_inset
+
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
\begin_layout Itemize
-Standard character size is 11pt in
-\emph on
-article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
-, and
-\emph on
-book (koma-script)
-\emph default
-, and 12pt in
-\emph on
-letter (koma-script)
-\emph default
-.
+
+\family typewriter
+
+\backslash
+and
+\family default
+ (2.3) – will have extra {} after it.
+ This should not cause an error.
\end_layout
\begin_layout Itemize
-Headings, labels of the description environment, and a number of elements
- of the
-\emph on
-letter (koma-script)
-\emph default
- document class are set in a bold sans serif font.
-\begin_inset Foot
-status collapsed
-\begin_layout Standard
-There is a big difference between the bold sans serif old cm fonts and new
- ec fonts, especially in the appearance of headings.
- In comparison, the ec bold sans serif fonts look a bit thin.
- Here the LaTeX package
\family typewriter
-cmsd.sty by
+
+\backslash
+notetoeditor
\family default
-
-\shape smallcaps
-Walter Schmidt
-\shape default
- helps to produce the
+ (2.6) – can only be used
\begin_inset Quotes eld
\end_inset
-usual
+standalone
\begin_inset Quotes erd
\end_inset
- appearance when using the ec fonts.
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
-\end_inset
+\begin_layout Itemize
- The numbering of chapter headings is made in the same way as the numbering
- of section headings, that is without the extra line
+\family typewriter
+
+\backslash
+placetable
+\family default
+ (2.8) – can't insert a cross-reference tag, you must type the tag name by
+ hand
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+placefigure
+\family default
+ (2.8) – same as for
+\family typewriter
+
+\backslash
+placetable
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+acknowledgements
+\family default
+ (2.9) – will have extra {} after it.
+ This should not cause an error.
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+appendix
+\family default
+ (2.11) – will have extra {} after it.
+ This should not cause an error.
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+figcaption
+\family default
+ (2.14.2) – you can insert an optional filename argument by placing the cursor
+ at the beginning of the text and selecting
+\family sans
+Insert\SpecialChar \menuseparator
+Short Title
+\family default
+.
+
\begin_inset Quotes eld
\end_inset
-Chapter\SpecialChar \ldots{}
-
+Short Title
\begin_inset Quotes erd
\end_inset
-.
- In addition, the appearance of the headings can be modified by using a
- number of options (in LyX to be entered in the field
-\family sans
-E
-\bar under
-x
-\bar default
-tra\InsetSpace ~
-Options
-\family default
- of the dialog
-\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
+ inserts an optional argument of the type needed by
+\family typewriter
-\bar under
-D
-\bar default
-ocument
+\backslash
+figcaption
\family default
-).
- A detailed German description of these options can be found in the Koma-Script
- documentation
-\emph on
-scrguide
-\emph default
.
+ Hopefully it will be renamed someday.
\end_layout
\begin_layout Itemize
-The main means in the Koma-Script document classes to design the type area
- are the options
-\family sans
-BCOR
+
+\family typewriter
+
+\backslash
+objectname
\family default
- and
-\family sans
-DIV
+ (2.17.1) – same as
+\family typewriter
+
+\backslash
+figcaption
\family default
- (in LyX to be entered in the extra class options field in the dialog
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ for the catalog ID optional parameter
+\end_layout
-\bar under
-S
-\bar default
-ettings
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+dataset
\family default
-).
- They make a clearer modification of page margins possible as do the options
- of the dialog
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ (2.17.1) – same as
+\family typewriter
-\bar under
-S
-\bar default
-ettings
+\backslash
+figcaption
\family default
-.
- A detailed German description of these and other type area options can
- be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Itemize
-The LaTeX document classes of the Koma-Script family define a number of
- additional commands.
- Those part of it which makes sense in LyX is implemented in corresponding
- paragraph types.
+\begin_layout Subsubsection
+Things not implemented, use TeX code
\end_layout
\begin_layout Standard
-A detailed German description of the LaTeX document classes of the Koma-Script
- family can be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
-\begin_inset Foot
-status collapsed
+\begin_inset ERT
+status open
-\begin_layout Standard
-There is an English translation
-\emph on
-screnggu
-\emph default
-, but it is not a complete one.
+\begin_layout Plain Layout
+
+
+\backslash
+begin{sloppypar}
\end_layout
\end_inset
- The following sections describe only those aspects, which are relevant
- in LyX.
-\end_layout
-
-\begin_layout Subsection
-article (koma-script), report (koma-script), and book (koma-script)
+
\end_layout
\begin_layout Standard
-The document classes
-\emph on
-article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
-, and
-\emph on
-book
-\emph default
-
-\emph on
-(koma-script)
-\emph default
- are implemented in the layout files
+
\family typewriter
-scrartcl.layout
+
+\backslash
+altaffilmark
\family default
-,
+ (2.3),
\family typewriter
-scrreprt.layout
+
+\backslash
+altaffiltext
\family default
-, and
+ (2.3),
\family typewriter
-scrbook.layout
-\family default
-, resp.
- They contain all the paragraph types of the corresponding standard document
- classes
-\emph on
-article
-\emph default
-,
-\emph on
-report
-\emph default
-, and
-\emph on
-book
-\emph default
-, resp., partly modified, with the exception of the LyX specific
-\family sans
-List
-\family default
--type, which is replaced by the new
-\family sans
-Labeling
+
+\backslash
+eqnum
\family default
--type having the same functionality.
- Beside the
-\family sans
-Labeling
+ (2.12),
+\family typewriter
+
+\backslash
+setcounter{equation}
\family default
--Type there is a number of new paragraph types added.
- They are
-\emph on
-not
-\emph default
- part of
-\emph on
-letter (koma-script)
-\emph default
-.
-\end_layout
+ (2.12), Journal name abbreviations (2.13.4),
+\family typewriter
-\begin_layout Itemize
+\backslash
+figurenum
+\family default
+ (2.14.1),
+\family typewriter
-\family sans
-Addpart, Addchap
+\backslash
+epsscale
\family default
-,
-\family sans
-Addsec
+ (2.14.1),
+\family typewriter
+
+\backslash
+plotone
\family default
-: are equivalents to
-\family sans
-Part*, Chapter*
+ (2.14.1),
+\family typewriter
+
+\backslash
+plottwo
\family default
- and
-\family sans
-Section*
+ (2.14.1),
+\family typewriter
+
+\backslash
+tablenum
\family default
-, resp., additionally inserting an entry in the table of contents.
-
-\family sans
-Addpart
+ (2.15.4),
+\family typewriter
+
+\backslash
+tableline
\family default
- and
-\family sans
-Addchap
+ (2.15.4, insert it as the first element in the lefthand cell after where
+ you want it.
+ Don't use any of LyX's rules in the table),
+\family typewriter
+
+\backslash
+tablenotemark
\family default
- are not contained in
-\emph on
-article (koma-script)
-\emph default
-.
-\end_layout
+ (2.15.5),
+\family typewriter
-\begin_layout Itemize
+\backslash
+tablenotetext
+\family default
+ (2.15.5), much of Misc (2.17, except
+\family typewriter
-\family sans
-Addchap*
+\backslash
+objectname
\family default
,
-\family sans
-Addsec*
+\family typewriter
+
+\backslash
+dataset
\family default
-: behave exactly as
-\family sans
-Addchap
+,
+\family typewriter
+
+\backslash
+url
\family default
- and
-\family sans
-Addsec
+, and
+\family typewriter
+
+\backslash
+email
\family default
-, resp., additionally clearing running heads.
-
-\family sans
-Addchap*
+; see above),
+\family typewriter
+
+\backslash
+singlespace
\family default
- is not contained in
-\emph on
-article (koma-script)
-\emph default
-.
-\begin_inset Foot
-status collapsed
+ (3.1),
+\family typewriter
-\begin_layout Standard
-There is also an
+\backslash
+doublespace
+\family default
+ (3.1),
\family typewriter
\backslash
-addpart*
+onecolumn
\family default
- command in
-\emph on
-book (koma-script)
-\emph default
- and in
-\emph on
-report (koma-script)
-\emph default
-, but since this is identical to
-\family sans
-Part*
+ (3.2),
+\family typewriter
+
+\backslash
+twocolumn
\family default
-, is has not been implemented in LyX.
+ (3.2)
\end_layout
-\end_inset
+\begin_layout Standard
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
+
+\backslash
+end{sloppypar}
\end_layout
-\begin_layout Itemize
+\end_inset
+
-\family sans
-Minisec
-\family default
-: generates a heading directly above the following paragraph in the standard
- character size without affecting the structure of the document.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection
+Things that cannot be implemented
+\end_layout
+\begin_layout Standard
+\SpecialChar \ldots{}
+ at least in any meaningful sort of way, so I suggest ignoring them.
+ They are the references environment (2.13.3), and the deluxetable environment
+ (2.15).
+ If you really, really need to use deluxetable, I suggest editing it in
+ a separate file with a text editor, then using
\family sans
-Captionabove
+Insert\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+Document
\family default
- and
-\family sans
-Captionbelow
+ to include it in your LyX document.
+ See the
+\family typewriter
+aas_sample.lyx
\family default
- are special captions which respect the different space settings needed
- for captions placed above or below an element (if you follow strict typographic
- rules, you might want to place table captions always above the table).
- You can also use the class option
+ file to see an example of this.
+\end_layout
+
+\begin_layout Subsection
+FAQs, Tips, Tricks, and Other Ruminations
+\end_layout
+
+\begin_layout Subsubsection
+Getting LyX and AASTeX to cooperate
+\end_layout
+
+\begin_layout Standard
+It can be a bit tricky to get LyX to recognize a new layout and document
+ class.
+ When all else fails, do this:
+\end_layout
+
+\begin_layout Enumerate
+Make certain that LaTeX can find AASTeX.
+ Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
+ a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
\family typewriter
-tablecaptionsabove
+sample.tex
\family default
-, which will switch
-\family sans
-caption
+.
+\end_layout
+
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
\family default
- to
-\family sans
-captionabove
+ appears in LyX's
+\family typewriter
+layouts
\family default
- for tables and
+ folder
+\end_layout
+
+\begin_layout Enumerate
+Rerun
\family sans
-captionbelow
+Tools\SpecialChar \menuseparator
+Reconfigure
\family default
- for figures.
- You need at least Koma-Script version 2.8q to use this.
+ in LyX, then restart LyX.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AASTeX appear in the class list in
\family sans
-Dictum
+Document\SpecialChar \menuseparator
+Settings
\family default
-: can be used to set a bonmot, e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-,
+?
\end_layout
+\begin_layout Standard
+If you get a warning from an existing AASTeX document about not being able
+ to find the AASTeX layout or a message about
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
+You should not mix title layouts with normal ones
+\begin_inset Quotes erd
+\end_inset
+, things haven't been installed correctly.
+\end_layout
-\backslash
-
+\begin_layout Subsubsection
+LaTeX error processing a table
\end_layout
+\begin_layout Standard
+LyX, by default, attempts to center the table caption/title.
+ This seems to produce a bad interaction in AASTeX so you should click somewhere
+ in the caption/title, then select
+\family sans
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
-at the beginning of a chapter.
- If you use the optional argument (
+Settings
+\family default
+, then set the
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Short\InsetSpace ~
-Title
+Alignment
\family default
-), you can insert the dictum's author there.
- Dictum and author are separated by a line.
- You need at least Koma-Script version 2.8q to use this.
-
+ to
\family sans
-Dictum
+Block
\family default
- is not contained in
-\emph on
-article (koma-script)
-\emph default
.
+ This took care of it for me.
+\end_layout
+
+\begin_layout Subsubsection
+References
\end_layout
\begin_layout Standard
-The following types, together with the standard types
-\family sans
-Title
+A couple of things: 1) I have noticed some funny spacing in the reference
+ entries in the text.
+ When you enter the bibliography item data, make sure their is
+\emph on
+no
+\emph default
+ space between the last author and the parenthesis setting off the year;
+
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\emph default
+type
+\family typewriter
+Ressler(1992)
\family default
-,
-\family sans
-Author
+, not
+\family typewriter
+Ressler (1992)
\family default
-, and
+.
+ 2) Entering the references at all is not obvious.
+ The easiest thing is to start typing your first reference at the end of
+ the document, then mark it as type
\family sans
-Date
+References
\family default
-, form the title area of the document.
- They must be entered ahead of the first
-\begin_inset Quotes eld
-\end_inset
-
-ordinary
-\begin_inset Quotes erd
-\end_inset
+.
+ That will put a small gray box in front of what you just typed.
+ Click on the box to fill in the rest of the information.
+ For new references, go to the end of an existing reference and press return.
+ That will create a new line with its own box, etc.
+\end_layout
- paragraph.
-\begin_inset Foot
-status collapsed
+\begin_layout Subsubsection
+Including EPS files
+\end_layout
\begin_layout Standard
-The corresponding LaTeX commands must appear before the
+Even though AASTeX provides its own figure commands (
\family typewriter
\backslash
-maketitle
+plotone
\family default
- command.
-\end_layout
+, for example), I much prefer LaTeX's standard figure commands (with the
+ default graphicx).
+ You can insert the
+\family typewriter
+\backslash
+plotone
+\family default
+, etc.
+\begin_inset space ~
\end_inset
- When such a type is used more than once, the latter usage overwrites the
- former one, that means, for every type only the latest usage is valid.
- The order of the different types however has, like
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-, and
-\family sans
-Date
+commands as TeX code into a Figure Float box if you desire, but I never
+ have much luck getting the layout right.
+ With the standard graphics, LyX will insert a
+\family typewriter
+
+\backslash
+usepackage{graphicx}
\family default
-, no effect on the appearance of the produced document.
-\end_layout
+ command into the LaTeX preamble and handle the figures in the standard
+ LaTeX2e way, interspersing the figures in the text.
+ I believe ApJ accepts figures exactly this way now; AJ might still use
+ the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+stack everything at the end
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Subject
-\family default
-: produces a centered paragraph above the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-) for the subject of the document.
+ technique.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Publishers
-\family default
-: produces a centered paragraph below the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-) for the publishers' name.
+\begin_layout Subsubsection
+Things I could have done, but didn't
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+There are a few
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Dedication
-\family default
-: in
-\emph on
-report (koma-script)
-\emph default
- and
-\emph on
-book (koma-script)
-\emph default
- produces a centered paragraph on its own page behind the title page, or
- in
-\emph on
-article (koma-script)
-\emph default
- produces a centered paragraph below the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-,
-\family sans
-Publishers
-\family default
-) for a dedication.
+pretty
+\begin_inset Quotes erd
+\end_inset
+
+ things I could have implemented, but chose not to.
+ For instance, I saw no point in double-spacing the text in the LyX window,
+ even though it is double-spaced in the paper manuscript.
+ Also, I chose not to make separate layouts for the preprint and preprint2
+ styles.
+ Since I assume you will spend most of your time in the plain manuscript
+ mode anyway, I decided not to chew up more disk space with this.
+
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Final Caveat
+\end_layout
-\family sans
-Titlehead
-\family default
-: produces a left aligned paragraph above the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-,
-\family sans
-Subject
-\family default
-) for a document`s head.
+\begin_layout Standard
+Your mileage may vary.
+ I've now had papers published by both ApJ and AJ that have had 98% of the
+ effort done in LyX; the last 2% was the LaTeX post-processing and a few
+ cleanups.
+ I have had no trouble with the submission process, and I'm sure the journals
+ were never aware that there might be a difference.
+ So, go forth and publish!
\end_layout
-\begin_layout Itemize
+\begin_layout Section
+AMS LaTeX
+\end_layout
-\family sans
-Uppertitleback
-\family default
-: produces in a double-sided print in
-\emph on
-report (koma-script)
-\emph default
- and
-\emph on
-book (koma-script)
-\emph default
- a left-aligned paragraph at the top of the title page`s back or has no
- effect in a single-sided print or in
-\emph on
-article (koma-script)
-\emph default
-.
+\begin_layout Standard
+by
+\noun on
+David Johnson; updated by Richard Heck
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-\family sans
-Lowertitleback
-\family default
-: produces in a double-sided print in
-\emph on
-report (koma-script)
-\emph default
- and
-\emph on
-book (koma-script)
-\emph default
- a left-aligned paragraph at the bottom of the title page`s back or has
- no effect in a single-sided print or in
-\emph on
-article (koma-script)
-\emph default
-.
\end_layout
-\begin_layout Itemize
+\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 Flex URL
+status open
+
+\begin_layout Plain Layout
+
+http://www.ams.org
+\end_layout
-\family sans
-Extratitle
-\family default
-: produces a special
-\begin_inset Quotes eld
\end_inset
-dirty
-\begin_inset Quotes erd
+ or by ftp at
+\begin_inset Flex URL
+status open
+
+\begin_layout Plain Layout
+
+ftp://ftp.ams.org/pub/tex/amslatex/
+\end_layout
+
\end_inset
- page ahead of the actual document containing a paragraph without special
- formatting.
+.
+ These layouts are appropriate, and useful, for any mathematical writing.
+
\end_layout
\begin_layout Standard
-The layout files for the document classes
-\emph on
-article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
-, and
-\emph on
-book (koma-script)
-\emph default
- do include the file
-\family typewriter
-scrmacros.inc
-\family default
-.
- This is thought of as a place to define your own types.
- Copy s
-\family typewriter
-crmacros.inc
-\family default
- in your personal layout directory and edit the file!
+There are two basic AMS LaTeX layouts:
\end_layout
-\begin_layout Subsection
-letter (koma-script)
+\begin_layout Itemize
+amsart: The standard AMS article format.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_layout Itemize
+amsbook: the standard AMS book (really, monograph) format.
+
+\end_layout
\begin_layout Standard
+The 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
-
-\backslash
-begin{sloppypar}
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
\end_inset
+ module, which is loaded by default when when you select one of the AMS
+ classes.
+ (It can also be used with other classes and can be removed, if you would
+ rather use something else.) Less commonly used environments are in the
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
-\begin_layout Standard
-\noindent
-The document class
-\emph on
-letter (koma-script)
-\emph default
- is implemented in the layout file
-\family typewriter
-scrlettr.layout
-\family default
-.
- It contains all the paragraph types of the corresponding standard document
- class
-\emph on
-letter
-\emph default
-, partly modified, with the exception of the LyX specific types
-\family sans
-LyX-Code
-\family default
- and
-\family sans
-Comment
-\family default
- and the
-\family sans
-List
-\family default
- type, which is replaced by the new
-\family sans
-Labeling
-\family default
- type.
- In addition, it contains, in contrast to the standard document class, the
- standard types
-\family sans
-LaTeX
-\family default
-,
-\family sans
-Quotation
-\family default
-,
-\family sans
-Quote
-\family default
-, and
-\family sans
-Verse
-\family default
-.
- Furthermore, there are a number of new letter specific types.
-\end_layout
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+ module, which must be loaded manually.
+\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
-
-\backslash
-end{sloppypar}
+\begin_layout Plain Layout
+Theorems (Order by Section)
\end_layout
\end_inset
+ or, if you are using
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+book (AMS)
\end_layout
-\begin_layout Standard
-The appearance of the letter produced by this document class can be controlled
- by a number of LaTeX commands, which you can put in the LaTeX preamble.
-\begin_inset Foot
+\end_inset
+
+, the module
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout Standard
-For example, the standard appearance of the letter`s heading, consisting
- of name and address, is quite self-willed.
- An
-\begin_inset Quotes eld
+\begin_layout Plain Layout
+Theorems (Order by Chapter)
+\end_layout
+
\end_inset
-ordinary
-\begin_inset Quotes erd
+.
+ These will number the results as
+\begin_inset Formula $n.m$
\end_inset
- heading is produced by the following LaTeX commands in the preamble:
+, 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 Plain Layout
+Theorems (Starred)
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-firsthead{
-\backslash
-parbox[b]{
-\backslash
-textwidth}
+ provides that option.
\end_layout
-\begin_layout LyX-Code
- {
-\backslash
-ignorespaces
-\backslash
-fromname
-\backslash
+\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
-\backslash
-
-\backslash
-ignorespaces
-\backslash
-fromaddress}}
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-nexthead{
-\backslash
-parbox[b]{
-\backslash
-textwidth}
+ module, and the others mentioned, with other classes, such as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article
\end_layout
-\begin_layout LyX-Code
- {
-\backslash
-ignorespaces
-\backslash
-fromname
-\backslash
-hfill
-\backslash
-ignorespaces
-\backslash
-pagename
-\backslash
-
-\backslash
-thepage}}
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+report
\end_layout
\end_inset
- A detailed German description of such LaTeX commands can be found in the
- Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
- With it, the letter's author can produce his personal letter layout.
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+book (KOMA-script)
+\end_layout
+
+\end_inset
+
+, and so forth.
+\end_layout
+
+\begin_layout Subsection
+What these layouts provide
\end_layout
\begin_layout Standard
-The types
-\family sans
-Letter
-\family default
- and
-\family sans
-Opening
-\family default
- define the beginning of the letter and must be used in every letter.
- To emphasize them in the LyX document class, they are marked with the letter
+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.
-\shape italic
-L
-\shape default
- or
-\shape italic
-O
-\shape default
-, resp.\InsetSpace ~
-in the left margin.
- It is possible to write any number of letters in one file.
- An
-\family sans
-Opening
-\family default
- type produces a new letter using the same addressee and a
-\family sans
-Letter
-\family default
- type produces a new addressee.
- The types
-\family sans
-Closing
-\family default
+\end_layout
+
+\begin_layout Standard
+The following environments—as well as the standard environments, such as
+
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+section
+\end_layout
+
+\end_inset
+
,
-\family sans
-PS
-\family default
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+bibliography
+\end_layout
+
+\end_inset
+
,
-\family sans
-CC
-\family default
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+title
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
, and
-\family sans
-Encl
-\family default
- are ordinary paragraph types and can also be used several times in one
- and the same letter.
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+date
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Letter
-\family default
-: produces a paragraph for the addressee and implicitly defines the beginning
- of the letter.
+—are provided by
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article (AMS)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Opening
-\family default
-: produces a paragraph for the form of address and implicitly produces a
- new letter.
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+book (AMS)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Closing
-\family default
-: produces a paragraph for a close.
+:
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+Address This should be the author's permanent address.
+\end_layout
-\family sans
-PS
-\family default
-: produces a paragraph for a postscript.
+\begin_layout Description
+Current
+\begin_inset space ~
+\end_inset
+
+Address This should be the author's temporary address at the time of submission,
+ if different from the Address.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+Email Author's e-mail address
+\end_layout
-\family sans
-CC
-\family default
-: produces a paragraph for a distribution list.
+\begin_layout Description
+URL Author's Web address, if desired.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
+\end_layout
-\family sans
-Encl
-\family default
-: produces a paragraph for enclosures.
+\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.
+\end_layout
+
+\begin_layout Description
+Thanks
+\end_layout
+
+\begin_layout Description
+Dedicatory
+\end_layout
+
+\begin_layout Description
+Translator
\end_layout
\begin_layout Standard
-The types
-\family sans
-Name
+The following environments are provided by both the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems
+\end_layout
+
+\end_inset
+
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+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 Plain Layout
+Theorems (Starred)
+\end_layout
+
+\end_inset
+
+ module:
+\end_layout
+
+\begin_layout Theorem
+This is typically used for the statements of major results.
+
+\end_layout
+
+\begin_layout Corollary*
+This is used for statements which follow fairly directly from previous statement
+s.
+ Again, these can be major results.
+
+\end_layout
+
+\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 Definition*
+Guess what this is for.
+ The font is different for this environment than for the previous ones.
+
+\end_layout
+
+\begin_layout Example*
+Used for examples illustrating proven results.
+\end_layout
+
+\begin_layout Problem
+It's not really known what this is for.
+ You should figure it out.
+\end_layout
+
+\begin_layout Exercise*
+Write a description for this one.
+\end_layout
+
+\begin_layout Remark
+This environment is also a type of theorem, usually a lesser sort of observation.
+\end_layout
+
+\begin_layout Claim*
+Often used in the course of giving a proof of a larger result.
+\end_layout
+
+\begin_layout Case
+Generally, these are used to break up long arguments, using specific instances
+ of some condition.
+
+\end_layout
+
+\begin_layout Case
+The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
+\end_layout
+
+\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 the section
+\emph on
+Nesting Environments
+\emph default
+ of the
+\emph on
+User's Guide
+\emph default
+ for information on nesting.
+\end_layout
+
+\begin_layout Standard
+And these environments are provided by
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
+\end_layout
+
+\end_inset
+
+:
+\end_layout
+
+\begin_layout Criterion*
+A required condition.
+\end_layout
+
+\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
+
+\begin_layout Note*
+Similar to a Remark.
+\end_layout
+
+\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
+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
+AGU journals (
+\family sans
+aguplus
\family default
-,
+)
+\end_layout
+
+\begin_layout Standard
+by
+\shape smallcaps
+Martin Vermeer
+\end_layout
+
+\begin_layout Subsection
+Description
+\end_layout
+
+\begin_layout Standard
+These are the layout files for some of the journals of the American Geophysical
+ Society.
+ It is assumed that you have both the AGU's own class files and AGUplus
+ installed (everything to be found at
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+ftp://ftp.agu.org/journals/latex/journals
+\end_layout
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Subsection
+New styles
+\end_layout
+
+\begin_layout Standard
+Redefined are
\family sans
-Signature
+Paragraph
\family default
,
\family sans
-Address
+Paragraph*
\family default
-,
+.
+ They are still called this in the LyX GUI, though their LaTeX equivalents
+ in the AGU classes are
\family sans
-Telephone
+Subsubsubsection
\family default
-,
+ and
\family sans
-Place
+Subsubsubsection*
\family default
-,
+.
+\end_layout
+
+\begin_layout Standard
+Newly defined styles are
\family sans
-Backaddress
+Left_Header
\family default
,
\family sans
-Specialmail
+Right_Header
\family default
,
\family sans
-Location
+Received
\family default
,
\family sans
-Title
+Revised
\family default
-, and
+,
\family sans
-Subject
+Accepted
\family default
- are input types provided with a label to enter information, which will
- be processed by the document class.
-\begin_inset Foot
-status open
-
-\begin_layout Standard
-It could be seen as a matter of inconsequence, that the types
+,
\family sans
-Letter
+CCC
\family default
- and
+,
\family sans
-Opening
+PaperId
\family default
- described above are not such input types as well.
- Because of the special meaning of those types, however, I have implemented
- them as ordinary paragraph types with a one letter mark in the left margin.
- Moreover, it would affect my feeling of symmetry, if the
+,
\family sans
-Opening
+AuthorAddr
\family default
- type and the
+,
\family sans
-Closing
+SlugComment
\family default
- type had such a serious different appearance.
+.
+ These are mostly manuscript attributes and defined in the AGU class documentati
+on.
\end_layout
-\end_inset
+\begin_layout Standard
+I suspect this is still badly incomplete.
+\end_layout
- The types must be used ahead of the corresponding
-\family sans
-Opening
-\family default
- type.
+\begin_layout Subsection
+New floats
\end_layout
\begin_layout Standard
-An implementation of these types in a WYSIWYG fashion does not seem to make
- sense, because the real appearance of the produced letter does not only
- depend on the usage of the particular type, but also on other factors.
- For example, a signature entered in the
+
\family sans
-Signature
+Planotable
\family default
- type will in the standard behavior appear in the produced letter only,
- when in the same letter also a
+ and
\family sans
-Closing
+Plate
\family default
- type is used.
- The entered value of the
+.
+ We also have a new
\family sans
-Telephone
+Table_Caption
\family default
- type will in the standard behavior not appear in the produced letter at
- all.
- The possibility to design the letter`s heading freely is already indicated
- in a footnote above.
+.
\end_layout
-\begin_layout Standard
-The input types can also be used as empty paragraphs.
- This makes sense e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-for the
-\family sans
-Signature
-\family default
- type.
- If the
-\family sans
-Signature
-\family default
- type is not used at all, in the standard behavior the value of the
-\family sans
-Name
-\family default
- type is used as signature, whereas if an empty
-\family sans
-Signature
-\family default
- type is used, no signature value is defined.
-\end_layout
-
-\begin_layout Standard
-By using the input types it is possible to write a letter template, containing
- filled input types with your personal dates (name, address, etc.) and empty
- input types for other dates you want to enter.
+\begin_layout Subsection
+Supported journals
\end_layout
\begin_layout Itemize
-\family sans
-Name
+\emph on
+Journal of Geophysical Research
+\emph default
+:
+\family typewriter
+jgrga.layout
\family default
-: sender's name, in the standard behavior appears as a centered paragraph
- in small caps in the letter`s heading.
+ — Martin Vermeer
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Add your own, it isn't so hard! Look at the
+\family typewriter
+jgrga.layout
+\family default
+ example and
+\family typewriter
+aguplus.inc
+\family default
+.
+\end_layout
+
+\begin_layout Subsection
+Bugs and things to remember
+\end_layout
+
+\begin_layout Standard
+In order to use the new layouts, you must remember to do the following for
+ a new document:
+\end_layout
+
+\begin_layout Enumerate
+\emph on
+Turn off babel
+\emph default
+.
+ This can be done in the
\family sans
-Signature
+Layout\SpecialChar \menuseparator
+Document
\family default
-: sender's signature, in the standard behavior appears below the
+ or
\family sans
-Closing
+Document\SpecialChar \menuseparator
+Settings
\family default
- type.
- If no
+ menu item.
+ (AGU articles are always in English, right? So
+\emph on
+don't
+\emph default
+ choose a language.)
+\end_layout
+
+\begin_layout Enumerate
+Enter
+\family typewriter
+jgrga
+\family default
+ into the document's
\family sans
-Signature
+Extra Options
\family default
- type is used, the value of the
+ field.
+ (Yes, this is a bug.)
+\end_layout
+
+\begin_layout Enumerate
+Make sure you use the
+\family typewriter
+agu.bst
+\family default
+ bibliography style, by entering
\family sans
-Name
+agu
\family default
- type appears instead.
+ into the second field of the BibTeX inset.
+ None of the standard styles will do.
\end_layout
-\begin_layout Itemize
+\begin_layout Section
+Broadway
+\end_layout
+
+\begin_layout Standard
+by
+\shape smallcaps
+Garst Reese
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\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
+
+\begin_layout Subsection
+Special problems
+\end_layout
+
+\begin_layout Standard
+The same as in Hollywood.
+\end_layout
+\begin_layout Subsection
+Special features
+\end_layout
+
+\begin_layout Standard
+Insert the
\family sans
-Address
+Speaker
\family default
-: sender's address, in the standard behavior appears in a centered paragraph
- in the letter`s heading below the sender's name.
+ 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 Subsection
+Paper size and Margins
+\end_layout
+
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
+
+\begin_layout Subsection
+Environments
+\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
\begin_layout Itemize
\family sans
-Telephone
-\family default
-: sender's telephone number, in the standard behavior only sets the LaTeX
- variable
-\family typewriter
+Standard
+\begin_inset Newline newline
+\end_inset
+
-\backslash
-telephonenum
\family default
-.
+You should not have to use this, but it is here for anything that does not
+ fit otherwise.
\end_layout
\begin_layout Itemize
\family sans
-Place
+Narrative
+\begin_inset space \hfill{}
+\end_inset
+
+M-z n
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: place of the letter`s making.
+Used to describe stage setting and the action.
+ First use of speaker names in all CAPs.
\end_layout
\begin_layout Itemize
\family sans
-Date
-\family default
-: date of the letter`s making.
-
-\family sans
-Place
-\family default
- and
-\family sans
-Date
-\family default
-, in the standard behavior, produce the place and the date in a right-aligned
- line below the addressee's field.
- If an empty
-\family sans
-Date
-\family default
- type is used, neither place nor date appear, independent of the value of
- the
-\family sans
-Place
-\family default
- type.
- If no
-\family sans
-Date
+ACT
+\begin_inset space \hfill{}
+\end_inset
+
+M-z a
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- type is used, the date of the letter `s production is used.
+Automatically numbered.
+ On screen it will be arabic, but will print as Roman.
\end_layout
\begin_layout Itemize
\family sans
-Backaddress
+ACT*
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S at
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: sender`s back address, in the standard behavior appears above the addressee's
- field in a small sans serif font.
+Subtitle for
+\family sans
+ACT.
+
+\family default
+ It is just centered text.
\end_layout
\begin_layout Itemize
\family sans
-Specialmail
+SCENE
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-S
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: special mail information, in the standard behavior appears underlined
- above the addressee's field below the back address.
+Not automatically numbered.
+ You supply the number.
+ This is because I couldn't figure out how.
\end_layout
\begin_layout Itemize
\family sans
-Location
+AT_RISE:
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-R
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: additional information, in the standard behavior appears on right side
- below the addressee`s field.
+A special case of Narrative to describe the setting and action as the curtain
+ rises.
\end_layout
\begin_layout Itemize
\family sans
-Title
+Speaker
+\begin_inset space \hfill{}
+\end_inset
+
+M-z s
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: the letter's title, in the standard behavior appears in a big, bold, sans
- serif font above the subject.
+The speaker's (actor's) title, centered in all CAPS.
\end_layout
\begin_layout Itemize
\family sans
-Subject
-\family default
-: the letter's subject, in the standard behavior appears in a bold font
- above the
-\family sans
-Opening
-\family default
- paragraph.
-\end_layout
-
-\begin_layout Standard
-The types
-\family sans
-Yourref
-\family default
-,
-\family sans
-Yourmail
-\family default
-,
-\family sans
-Myref
-\family default
-,
-\family sans
-Customer
-\family default
-, and
-\family sans
-Invoice
-\family default
- produce a business letter like line above the
-\family sans
-Title
-\family default
- line containing the fields
-\begin_inset Quotes eld
-\end_inset
-
-Your ref.
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
+Parenthetical
+\begin_inset space \hfill{}
\end_inset
-Your letter of
-\begin_inset Quotes erd
+M-z p
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Our ref.
-\begin_inset Quotes erd
-\end_inset
+\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
+.
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Customer no.
-\begin_inset Quotes erd
+\family sans
+Dialogue
+\begin_inset space \hfill{}
\end_inset
-,
-\begin_inset Quotes eld
+M-z d
+\begin_inset Newline newline
\end_inset
-Invoice no.
-\begin_inset Quotes erd
-\end_inset
-, and
-\begin_inset Quotes eld
-\end_inset
+\family default
+What the Speaker says.
+\end_layout
-Date
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-.
- For the date field, the value of the
\family sans
-Date
-\family default
- type is used.
- If one of these
-\begin_inset Quotes eld
+CURTAIN
+\begin_inset space \hfill{}
\end_inset
-business letter types
-\begin_inset Quotes erd
+M-z S-C
+\begin_inset Newline newline
\end_inset
- is used, the value of the
-\family sans
-Place
-\family default
- type however does not appear, but only the LaTeX variable
-\family typewriter
-\backslash
-fromplace
-\family default
- is set.
- The ordinary output of place and date in a right-aligned line below the
- addressee`s field is suppressed.
- The types are implemented as input types provided with a label and must
- be used ahead of the corresponding
-\family sans
-Opening
\family default
- type.
+The curtain comes down.
\end_layout
\begin_layout Itemize
\family sans
-Yourref
-\family default
-: Your ref.
+Title
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-T
\end_layout
\begin_layout Itemize
\family sans
-Yourmail
-\family default
-: Your letter of.
+Author
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-A
\end_layout
\begin_layout Itemize
\family sans
-Myref
-\family default
-: Our ref.
-\end_layout
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Itemize
+M-z r
+\end_layout
-\family sans
-Customer
-\family default
-: Customer no.
+\begin_layout Standard
+Hello there.
\end_layout
-\begin_layout Itemize
+\begin_layout Section
+Dinbrief
+\end_layout
+\begin_layout Standard
+The document class
\family sans
-Invoice
+dinbrief
\family default
-: Invoice no.
+ 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
-\begin_layout Subsection
-The new letter class: letter (koma-script v.2)
+\begin_layout Section
+EGS journals (
+\family sans
+egs
+\family default
+)
\end_layout
\begin_layout Standard
by
-\noun on
-Jürgen Spitzmüller
+\shape smallcaps
+Martin Vermeer
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
-
-
+\begin_layout Subsection
+Description
\end_layout
\begin_layout Standard
-\noindent
-Koma-Script version 2.8 has introduced a new letter class
-\family typewriter
-scrlttr2
-\family default
- which supersedes the now unsupported
+This is the layout file for the European Geophysical Society journals.
+ The needed
\family typewriter
-scrlettr
+egs.cls
\family default
+ can be downloaded from the web site of the EGS under
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+www.copernicus.org
+\end_layout
+
+\end_inset
+
.
- It has --- on the LaTeX side --- a completely new interface and is not
- compatible with the old class.
- Therefore, LyX supports both, though it is recommended to use the new class.
+\end_layout
+
+\begin_layout Subsection
+New styles
\end_layout
\begin_layout Standard
-This class covers the same functionality as
-\emph on
-letter (koma-script),
-\emph default
- and a few more.
- The basic items are
-\family sans
-Address
-\family default
- (receiver's address, same as
-\family sans
-Letter
-\family default
- in the old layout),
+
\family sans
-Opening
+Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
+ Accepted
\family default
-, and
+,
\family sans
-Closing
+Offsets
\family default
.
-
-\family sans
-NextAddress
+ The current layout file is unfortunately very unmodular and would benefit
+ from using the various
+\family typewriter
+std*.inc
\family default
- will start a new letter (i.
-\begin_inset ERT
-status collapsed
+ file inclusions.
+\end_layout
+
+\begin_layout Section
+Elsevier Journals
+\end_layout
+
+\begin_layout Standard
+By
+\noun on
+Rod Pinna
+\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 Plain Layout
-\backslash
-,
+http://authors.elsevier.com/
\end_layout
\end_inset
-e.
-\begin_inset ERT
-status collapsed
+.
+ 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 Standard
-
-
-\backslash
-
+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
+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
+
+clean
+\begin_inset Quotes erd
\end_inset
-you can write several letters per document).
- New elements are sender's
-\family sans
-E-Mail
-\family default
-,
-\family sans
-URL
-\family default
-,
-\family sans
-Fax
-\family default
-,
-\family sans
-Bank
-\family default
- and the possibility to use a
+ a LaTeX 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
+Foils [aka
\family sans
-Logo
+FoilTeX
\family default
- (via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foiltex"
+
+\end_inset
+
-\bar under
-G
-\bar default
-raphics
-\family default
-) in the header.
\end_layout
\begin_layout Standard
-The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
- This can be done via the preamble or with a special style file (Letter
- Class Option, extension
-\family typewriter
-*.lco
-\family default
-), that will be read in as a class option.
-\begin_inset Foot
-status collapsed
+by
+\noun on
+Allan Rae
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
\begin_layout Standard
-The KOMA package comes with some default
-\family typewriter
-*.lco
-\family default
- files.
- There is, for instance, a
-\family typewriter
-DIN.lco
-\family default
- file that follows german typesetting rules, or a
-\family typewriter
-KOMAold.lco
-\family default
- that provides the default layout of the old
-\family typewriter
-scrlettr
-\family default
- class.
- The latter can be loaded with the class option
-\family typewriter
-KOMAold
-\family default
-, inserted via the
+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
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-Extra Options
+FoilTeX
\family default
- field.
+ 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
- Have a look at the
-\emph on
-koma-letter2
-\emph default
- template that is included in LyX for examples.
- A detailed description is to be found in the Koma-Script documentation
- (
-\emph on
-scrguide
-\emph default
-).
-\end_layout
-\begin_layout Subsection
-Problems
\end_layout
\begin_layout Standard
-Visualizing the Koma-Script document classes in LyX, the LyX internals cause
- some problems.
-\end_layout
+\align center
+
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Itemize
-The chapter number of a
-\family sans
-Chapter
-\family default
- type appears on a line of its own above the chapter heading instead of
- appearing in the same line ahead of it.
- The cause for that is the LyX internal behavior for the labeltype
\family sans
-Counter_Chapter
+slides (FoilTeX)
\family default
- in the layout file.
+
+\begin_inset Quotes erd
+\end_inset
+
+
+\emph on
+only.
\end_layout
-\begin_layout Itemize
-The headings of the types
+\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
-Addchap
+slides (default)
\family default
- and
+
+\begin_inset Quotes erd
+\end_inset
+
+, check out section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slitex"
+
+\end_inset
+
+.
+ If your machine doesn't have the
\family sans
-Addsec
+foils
\family default
- are only put in the
+ class [
\begin_inset Quotes eld
\end_inset
-true
+
+\family sans
+slides (FoilTeX)
+\family default
+
\begin_inset Quotes erd
\end_inset
- LaTeX table of contents, but not in the LyX table of contents (
+] installed, you'll probably have to use the default
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+slides
+\family default
+ class, which isn't quite as good as
+\family sans
+foils.
+\end_layout
-\bar under
-T
-\bar default
-able\InsetSpace ~
-of\InsetSpace ~
-Contents
+\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 Itemize
-The paragraphs in a
-\emph on
-letter
-\emph default
- document class appear in a skip separation mode, not indented.
- This is the standard behavior, no special LaTeX commands are needed for
- that.
- But in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog the corresponding radio button indicates
-\family sans
-\bar under
-I
-\bar default
-ndent
-\family default
-.
- A
-\family sans
-S
-\bar under
-k
-\bar default
-ip
-\family default
- value always has the effect that extra LaTeX commands are inserted in the
- document to produce the gap, which is not what is wanted in this case.
-\end_layout
-
-\begin_layout Section
-Springer Journals (
-\family sans
-svjour
-\family default
-)
+\begin_layout Subsection
+Getting Started
\end_layout
\begin_layout Standard
-by
-\noun on
-Martin Vermeer
-\end_layout
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Description
-\end_layout
-\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"
+\family sans
+slides (FoilTeX)
+\family default
+\begin_inset Quotes erd
\end_inset
-, where you should also go to fetch the class files (yes, these are LaTeX2e
- now!).
- It is a modular system: the things common to all journals are implemented
- in
-\family typewriter
-svjour.inc
-\family default
-, which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
-g.,
-\family typewriter
-svjog.layout
+ from the
+\family sans
+Class
\family default
- for Journal of Geodesy) can include.
-\end_layout
+ entry in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-This means that implementing support for any other Springer journal on this
- list is as simple as writing your own
-\family typewriter
-sv
-\family default
-<myjournal>
-\family typewriter
-.layout
+Layout
\family default
- file following the outline given in
-\family typewriter
-svjog.layout
+ dialog.
+ There are some settings in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+
+Layout
\family default
-.
-
+ dialog that you should know about that are specific to this class:
\end_layout
-\begin_layout Standard
-It is reasonably well tested only for the Journal of Geodesy.
-
-\family typewriter
-svjour
+\begin_layout Itemize
+Don't change the options
+\family sans
+Sides
\family default
and
-\family typewriter
-svjog
+\family sans
+Columns
\family default
- come with the standard LyX distribution.
- Install the relevant class file (downloaded from Springer) in a proper
- directory, reconfigure LaTeX (in the teTeX case by running
-\family typewriter
-texhash
+ on the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+
+Layout
+\family default
+ dialog.
+ They're ignored by the
+\family sans
+foils
\family default
-, as root if necessary --- doesn't LyX take care of this?), reconfigure
- LyX and it should work.
+ class.
\end_layout
-\begin_layout Subsection
-New styles
+\begin_layout Itemize
+The default font size is 20
+\begin_inset space \thinspace{}
+\end_inset
+
+pt with the other options being 17
+\begin_inset space \thinspace{}
+\end_inset
+
+pt, 25
+\begin_inset space \thinspace{}
+\end_inset
+
+pt and 30
+\begin_inset space \thinspace{}
+\end_inset
+
+pt.
\end_layout
-\begin_layout Standard
-A large number of theorem-like styles ---
+\begin_layout Itemize
+The default font is
\family sans
-Claim, Conjecture,
+sans
\family default
\family sans
-\SpecialChar \ldots{}
-Theorem
+serif
\family default
-.
+ but all math equations are still typeset in the usual roman font.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
- Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
+FoilTeX
\family default
-.
- See the Springer class file documentation for details.
-\end_layout
+ supports A4 and Letter paper sizes as well as a special size for working
+ with 35
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
-Supported journals
+mm slides.
+ It doesn't support A5, B5, legal or executive paper sizes.
\end_layout
\begin_layout Itemize
-
-\emph on
-Journal of Geodesy
-\emph default
-:
-\family typewriter
-svjog.layout
+Don't bother changing the
+\family sans
+Float Placement
\family default
- --- Martin Vermeer
+ settings because they are ignored anyway.
+ All floats appear where they are defined in the text.
\end_layout
\begin_layout Itemize
-
-\emph on
-Probability Theory and Related Fields
-\emph default
-:
-\family typewriter
-svprobth.layout
+The
+\family sans
+Pagestyle
\family default
- --- Jean-Marc Lasgouttes
-\end_layout
+ setting behaves a bit differently for this class.
+
+\family sans
+FoilTeX
+\family default
+ provides extensive footer and header capabilities including a user-defined
+ logo.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-Add your own, it isn't so hard!
-\end_layout
-\begin_layout Subsection
-Credits
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foilfoot"
-\begin_layout Standard
-These files are partly based on the older
-\family typewriter
-ejour2.layout
-\family default
-, which was again based on a tinkered-with version of an old LaTeX 2.09 style
- file from Springer.
- All this, and the
-\family typewriter
-ejour2
-\family default
- layout, are now defunct.
- Jean-Marc Lasgouttes helped out big in making me find my way around the
- LyX layout file mechanism.
-\end_layout
+\end_inset
-\begin_layout Subsection
-Bugs
+ 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_layout Standard
-Probably.
- But probably less than in the old hacked-LaTeX
-\family typewriter
-ejour2
+\begin_deeper
+\begin_layout Labeling
+\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 Standard
-Limitations e.\InsetSpace \thinspace{}
-g.: does not display the number for theorem-like layouts, just
- #.
-\end_layout
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
-\begin_layout Section
-AGU journals (
\family sans
-aguplus
+\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 Standard
-by
-\shape smallcaps
-Martin Vermeer
+\begin_layout Labeling
+\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 Subsection
-Description
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+
+\series bold
+fancy
+\series default
+ Gives you access to the
+\family sans
+fancyheadings
+\family default
+ package although its use with
+\family sans
+FoilTeX
+\family default
+ is discouraged by the writer of the
+\family sans
+FoilTeX
+\family default
+ package because of some potential page layout clashes.
+\end_layout
+
+\end_deeper
+\begin_layout Subsubsection
+Extra Options
\end_layout
\begin_layout Standard
-These are the layout files for some of the journals of the American Geophysical
- 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"
+The following options may be used in the extra class options in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+35mmSlide
+\series default
+ This sets up the page layout for 7.33
+\begin_inset space \thinspace{}
+\end_inset
+in by 11
+\begin_inset space \thinspace{}
\end_inset
-).
+in paper, which is about the same aspect ratio as a 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slide, making it a bit easier to work with this medium.
\end_layout
-\begin_layout Subsection
-New styles
+\begin_layout Labeling
+\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 Standard
-Redefined are
+\begin_layout Labeling
+\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 Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+dvips
+\series default
+ This is automatically set each time you create a new
\family sans
-Paragraph
+foils
\family default
-,
+ document.
+ This option tells
\family sans
-Paragraph*
+FoilTeX
\family default
-.
- They are still called this in the LyX GUI, though their LaTeX equivalents
- in the AGU classes are
+ to use the dvips driver to rotate those pages that are set as landscape
+ foils.
+\end_layout
+
+\begin_layout Labeling
+\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
-Subsubsubsection
+Foilhead
\family default
and
\family sans
-Subsubsubsection*
+Rotatefoilhead
\family default
-.
+ environments (don't worry these are described in the next section).
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+leqno
+\series default
+ Equation numbers on the left.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+fleqn
+\series default
+ Flush-left equations.
+\end_layout
+
+\begin_layout Subsection
+Supported Environments
\end_layout
\begin_layout Standard
-Newly defined styles are
-\family sans
-Left_Header
-\family default
-,
-\family sans
-Right_Header
-\family default
-,
-\family sans
-Received
-\family default
-,
-\family sans
-Revised
-\family default
-,
-\family sans
-Accepted
-\family default
-,
-\family sans
-CCC
-\family default
-,
-\family sans
-PaperId
-\family default
-,
+Most of the environments commonly supported in other classes are also supported
+ by the
\family sans
-AuthorAddr
+foils
\family default
-,
+ class.
+ There are several additional environments provided by
\family sans
-SlugComment
+FoilTeX
\family default
-.
- These are mostly manuscript attributes and defined in the AGU class documentati
-on.
+ as well as a couple added by LyX.
+ The following environments are shared with other classes:
\end_layout
\begin_layout Standard
-I suspect this is still badly incomplete.
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+begin{multicols}{2}
\end_layout
-\begin_layout Subsection
-New floats
+\end_inset
+
+
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-Planotable
-\family default
- and
-\family sans
-Plate
-\family default
-.
- We also have a new
-\family sans
-Table_Caption
-\family default
-.
+Standard
\end_layout
-\begin_layout Subsection
-Supported journals
+\begin_layout Itemize
+
+\family sans
+Itemize
\end_layout
\begin_layout Itemize
-\emph on
-Journal of Geophysical Research
-\emph default
-:
-\family typewriter
-jgrga.layout
-\family default
- --- Martin Vermeer
+\family sans
+Enumerate
\end_layout
-\begin_layout Standard
-Add your own, it isn't so hard! Look at the
-\family typewriter
-jgrga.layout
-\family default
- example and
-\family typewriter
-aguplus.inc
-\family default
-.
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsection
-Bugs and things to remember
+\family sans
+Description
\end_layout
-\begin_layout Standard
-In order to use the new layouts, you must remember to do the following for
- a new document:
+\begin_layout Itemize
+
+\family sans
+List
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-\emph on
-Turn off babel
-\emph default
-.
- This can be done in the
\family sans
-layout\SpecialChar \menuseparator
-document
-\family default
- or
+LyX-Code
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-document\SpecialChar \menuseparator
-settings
-\family default
- menu item.
- (AGU articles are always in English, right? So
-\emph on
-don't
-\emph default
- choose a language.)
+Verse
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
-jgrga
-\family default
- into the document's
+\begin_layout Itemize
+
\family sans
-Extra Options
-\family default
- field.
- (Yes, this is a bug.)
+Quote
\end_layout
-\begin_layout Enumerate
-Make sure you use the
-\family typewriter
-agu.bst
-\family default
- bibliography style, by entering
+\begin_layout Itemize
+
\family sans
-agu
-\family default
- into the second field of the BibTeX inset.
- None of the standard styles will do.
+Quotation
\end_layout
-\begin_layout Section
-EGS journals (
+\begin_layout Itemize
+
\family sans
-egs
-\family default
-)
+Title
\end_layout
-\begin_layout Standard
-by
-\shape smallcaps
-Martin Vermeer
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsection
-Description
+\family sans
+Author
\end_layout
-\begin_layout Standard
-This is the layout file for the European Geophysical Society journals.
- The needed
-\family typewriter
-egs.cls
-\family default
- can be downloaded from the web site of the EGS under
-\begin_inset LatexCommand url
-target "www.copernicus.org"
-
-\end_inset
+\begin_layout Itemize
-.
+\family sans
+Date
\end_layout
-\begin_layout Subsection
-New styles
+\begin_layout Itemize
+
+\family sans
+Abstract
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
- Accepted
-\family default
-,
-\family sans
-Offsets
-\family default
-.
- The current layout file is unfortunately very unmodular and would benefit
- from using the various
-\family typewriter
-std*.inc
-\family default
- file inclusions.
+Bibliography
\end_layout
-\begin_layout Section
-Slides [aka
-\noun on
-Sli
-\noun default
-TeX]
-\begin_inset LatexCommand label
-name "sec:slitex"
+\begin_layout Itemize
-\end_inset
+\family sans
+Address
+\end_layout
+\begin_layout Itemize
+\family sans
+RightAddress
\end_layout
-\begin_layout Standard
-by
-\noun on
-John Weiss
-\noun default
-
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsection
-Introduction
+\family sans
+Caption
\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
+\begin_layout Itemize
+
\family sans
-Foil
-\family default
-TeX slides class.
- This section documents the former.
+Comment
\end_layout
\begin_layout Standard
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+end{multicols}
\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
+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
+FoilTeX
+\family default
+ provides specific commands for starting new foils and these are:
+\end_layout
+\begin_layout Itemize
\family sans
-slides (default)
-\family default
+Foilhead
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-
-\emph on
-only.
+\family sans
+Rotatefoilhead
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
+LyX also provides slightly modified versions of these two environments called:
+\end_layout
+\begin_layout Itemize
+\family sans
+ShortFoilhead
\end_layout
-\begin_layout Standard
-If you're looking for the documentation for
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
+
+\family sans
+ShortRotatefoilhead
+\end_layout
+\begin_layout Standard
+and the differences will be explained in the next section.
+\end_layout
+\begin_layout Standard
+Since foils are often used in presenting ideas or new theorems and such
+
\family sans
-slides (FoilTeX)
+FoilTeX
\family default
+ also provides a comprehensive box of goodies for presenting them:
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+\begin_inset ERT
+status open
-, check out section\InsetSpace ~
+\begin_layout Plain Layout
-\begin_inset LatexCommand ref
-reference "sec:foiltex"
-\end_inset
+\backslash
+begin{multicols}{2}
+\end_layout
-.
- The
-\family sans
-foils
-\family default
- class [
-\begin_inset Quotes eld
\end_inset
-\family sans
-slides (FoilTeX)
-\family default
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-] is actually somewhat better than the default
\family sans
-slides
-\family default
- class,
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-\SpecialChar \ldots{}
-or so I've been told repeatedly by its advocates.
- Having never used it, I have no idea if this claim is true or not.
+Theorem
\end_layout
-\end_inset
+\begin_layout Itemize
- which this section documents.
+\family sans
+Lemma
\end_layout
-\begin_layout Standard
-This class is the LaTeX2e improvement of the old
-\noun on
-Sli
-\noun default
-TeX package.
- Every LaTeX2e distribution includes this class [which I'll just refer to
- as
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Itemize
\family sans
-slides
-\family default
+Corollary
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from now on], so you're bound to have it.
- As I noted earlier, there are other classes, such as
-\family sans
-foils
-\family default
-, which also produce slides for overhead projectors and do a better job
- at it.
- However, there are some things which
\family sans
-slides
-\family default
- can do which the others can't, such as generate overlays.
- Read on to learn more!
+Proposition
\end_layout
-\begin_layout Subsection
-Getting Started
-\begin_inset LatexCommand label
-name "sec:slidesetup"
+\begin_layout Itemize
-\end_inset
+\family sans
+Definition
+\end_layout
+\begin_layout Itemize
+\family sans
+Proof
\end_layout
-\begin_layout Standard
-Obviously, to use this document class, you need to select
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-slides (default)
-\family default
-
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from the class list in the
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
- There are some other special things you should know about this class:
+Theorem*
\end_layout
\begin_layout Itemize
-Don't bother changing the options
-\family sans
-Sides and Columns
-\family default
-.
- They're not supported by the
-\family sans
-slides
-\family default
- class, anyways.
-\end_layout
-\begin_layout Itemize
-The option
\family sans
-\bar under
-P
-\bar default
-age\InsetSpace ~
-style
-\family default
- behaves a bit differently for this class.
- The possible choices and what they do are as follows:
+Lemma*
\end_layout
-\begin_deeper
-\begin_layout Description
+\begin_layout Itemize
\family sans
-plain
-\family default
- The final output contains page numbers in the lower right corner.
+Corollary*
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\family sans
-headings
-\family default
- Like
-\family sans
-plain
-\family default
-, but also prints out any time markers you've put in.
- This is the default.
+Proposition*
\end_layout
-\begin_layout Description
+\begin_layout Itemize
\family sans
-empty
-\family default
- The final output contains no page numbers, time markers, or alignment markers.
+Definition*
\end_layout
-\end_deeper
-\begin_layout Itemize
-The
-\family sans
-slides
-\family default
- class has an extra option:
-\family typewriter
-clock
-\family default
-.
- To use it, put
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Standard
+\begin_inset ERT
+status open
-\family typewriter
-clock
-\family default
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
- in the extra class options.
+\backslash
+end{multicols}
\end_layout
-\begin_deeper
-\begin_layout Standard
-Using this options allows you to add time markers to
-\family sans
-Note
-\family default
-s.
- See section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:slideNote"
-
\end_inset
- for more details.
+
\end_layout
-\end_deeper
\begin_layout Standard
-You can also use the template file
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-slides.lyx
-\family default
+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_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- to automatically set up a document to use the
-\family sans
-slides
-\family default
- class [using
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New\InsetSpace ~
-from\InsetSpace ~
-
-\bar under
-T
-\bar default
-emplate
-\family default
- to open your new document].
- The template file also contains some examples of the special paragraph
- environments used by this class.
- I'll describe those next.
+TickList
\end_layout
-\begin_layout Subsection
-Paragraph Environments
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsubsection
-Supported Environments
+\family sans
+CrossList
\end_layout
\begin_layout Standard
-The first thing you'll notice when you start up a new
-\family sans
-slides
-\family default
- document is the font size and type: it's the equivalent of the size
-\begin_inset Quotes eld
-\end_inset
-
\family sans
-Largest
+FoilTeX
\family default
-
-\begin_inset Quotes erd
+ 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, i.
+\begin_inset space \thinspace{}
\end_inset
- in the
-\family sans
-Sans\InsetSpace ~
-Serif
-\family default
- font.
- This is also what's used in the output.
- Think of this as a
-\begin_inset Quotes eld
-\end_inset
+g.
+\emph on
-visual cue
-\begin_inset Quotes erd
+\begin_inset space \space{}
\end_inset
- to remind you that this is a slide.
- Your final slides will use a larger font; ergo, you'll have less space.
- Of course, the larger default screen font isn't WYSIWYG, only a reminder.
+
+\emph default
+straight after the foilhead.
\end_layout
\begin_layout Standard
-The next thing that becomes obvious is the changes to the paragraph environment
- pull-down box [at the far-left end of the toolbar].
- Most of the paragraph environments you're used to seeing are missing.
- There are also five new ones.
- That's because the
-\family sans
-slides
-\family default
- class itself only supports certain paragraph environments:
+For this purpose, the following command styles are provided [
+\shape smallcaps
+Martin Vermeer
+\shape default
+]:
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset ERT
+status open
-\family sans
-Standard
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Itemize
-\family sans
-Itemize
+\backslash
+begin{multicols}{2}
\end_layout
-\begin_layout Itemize
+\end_inset
+
-\family sans
-Enumerate
\end_layout
\begin_layout Itemize
\family sans
-Description
+My
+\begin_inset space ~
+\end_inset
+
+Logo
\end_layout
\begin_layout Itemize
\family sans
-List
+Restriction
\end_layout
\begin_layout Itemize
\family sans
-Quotation
+Right
+\begin_inset space ~
+\end_inset
+
+Footer
\end_layout
\begin_layout Itemize
\family sans
-Quote
+Right
+\begin_inset space ~
+\end_inset
+
+Header
\end_layout
\begin_layout Itemize
\family sans
-Verse
+Left
+\begin_inset space ~
+\end_inset
+
+Header
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Standard
+\begin_inset space ~
+\end_inset
+
-\family sans
-Caption
\end_layout
-\begin_layout Itemize
+\end_deeper
+\begin_layout Standard
+\begin_inset ERT
+status open
-\family sans
-LyX-Code
+\begin_layout Plain Layout
+
+
+\backslash
+end{multicols}
\end_layout
-\begin_layout Itemize
+\end_inset
+
-\family sans
-Comment
\end_layout
\begin_layout Standard
-All of the other standard environments, including the section-heading environmen
-ts, aren't used in the
+There are also a few commands provided by
\family sans
-slides
+FoilTeX
\family default
- class.
-\end_layout
+ that aren't directly supported by LyX but I'll tell you what they do and
+ how to use them in section
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-On the other hand, you'll notice the following new environments:
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:unsuppfoils"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Building a Set of Foils
+\end_layout
-\family sans
-Slide
+\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 you find in LyX's
+\family typewriter
+examples
+\family default
+ folder.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection
+Give It a Title Page
+\end_layout
+\begin_layout Standard
+Unlike other classes that provide
\family sans
-Overlay
+Title
+\family default
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+ and
+\family sans
+Abstract
+\family default
+ environments,
+\family sans
+foils
+\family default
+ creates the title on a page of its own.
+ If you leave out the
+\family sans
+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
-Note
-\end_layout
+Foilhead
+\family default
+ or
+\family sans
+ShortFoilhead.
-\begin_layout Itemize
+\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
+Landscape foils are generated using the
\family sans
-InvisibleText
+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 Itemize
+\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
-\family sans
-VisibleText
+\begin_layout Subsubsection
+Theorems, Lemmas, Proofs and more
\end_layout
\begin_layout Standard
-These five are kind of quirky, due to 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
-feature
-\begin_inset Quotes erd
-\end_inset
- in LyX.
- You see, LyX doesn't permit you to nest any other paragraph environment
- into an empty environment.
- Now, that's fine and dandy, but it means that you wouldn't be able to start
- a slide with anything except plain text.
- To deal with this, I've performed a little
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
+%
+\family default
-LaTeX magic.
\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
-Quirks of the New Environments
-\begin_inset LatexCommand label
-name "sec:slideQuirk"
-
-\end_inset
-
-
+Lists
\end_layout
\begin_layout Standard
-All five of the new paragraph environments are somewhat quirky due to inherent
- limitiations in the current version of LyX.
- As I just mentioned, LyX forbids environments that begin with another environme
-nt.
- To get around this, the
-\family sans
-Slide
-\family default
- environment isn't a paragraph environment as described in 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
+User's Guide.
+
\emph default
-.
+ If you intend to use itemized lists you might also want to read about the
+\family sans
+Itemize
+\begin_inset space ~
+\end_inset
+
+Bullet
+\begin_inset space ~
+\end_inset
+
+Selection
+\family default
+ dialog described above in section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:bullet"
+
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-You should consider
+The two new list styles,
\family sans
-Slide
+TickList
\family default
-,
+ and
\family sans
-Overlay
+CrossList
\family default
-, and
+, 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
-Note
+Itemize
\family default
- to be
-\begin_inset Quotes eld
-\end_inset
-
-pseudo-environments.
-\begin_inset Quotes erd
-\end_inset
+ environment.
+ They do however require that you have the
+\family typewriter
+psnfss
+\family default
+ packages installed.
+\end_layout
- They look like a section heading or a
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
+Figures and Tables
+\end_layout
+\begin_layout Standard
\family sans
-Caption
+FoilTeX
\family default
-,
-\begin_inset Quotes erd
+ 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 Subsubsection
+Page Headers and Footers
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foilfoot"
+
\end_inset
- but really begin a [and, if necessary, end the previous] paragraph environment.
- Likewise, treat
+
+\end_layout
+
+\begin_layout Standard
+
\family sans
-InvisibleText
+My
+\begin_inset space ~
+\end_inset
+
+Logo
\family default
and
\family sans
-VisibleText
+Restriction
\family default
- as
+ 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
-pseudo-commands.
+-Typeset by
+\family sans
+FoilTeX
+\family default
+-
\begin_inset Quotes erd
\end_inset
- These two perform some action.
-\end_layout
-
+.
+ While the second is meant to provide a classification for the audience,
+
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\emph default
+
+\begin_inset space \space{}
+\end_inset
+
+Confidential.
+ It is empty by default.
+\end_layout
+
\begin_layout Standard
-A common feature of all five environments,
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
-\family default
-,
-\family sans
-Note
-\family default
-,
-\family sans
-InvisibleText
-\family default
- and
-\family sans
-VisibleText
-\family default
-, is a rather long-ish label.
- The text following this label --- ordinarily the contents of the paragraph
- environment --- is utterly irrelevant for
-\family sans
-Slide
-\family default
-,
+The remaining page corners can be filled by
\family sans
-Overlay
+Right
+\begin_inset space ~
+\end_inset
+
+Footer
\family default
-,
+ (which defaults to page numbers),
\family sans
-Note
+Right
+\begin_inset space ~
+\end_inset
+
+Header
\family default
-,
+ (top right) and
\family sans
-InvisibleText
+Left
+\begin_inset space ~
+\end_inset
+
+Header
\family default
- and
+ (top left).
+\end_layout
+
+\begin_layout Subsection
+Unsupported
\family sans
-VisibleText
+FoilTeX
\family default
-.
- LyX completely ignores it.
- In fact, you can leave these five environments completely empty.
-
+ Goodies
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:unsuppfoils"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-While you don't
-\emph on
-have
-\emph default
- to put any text after the rather long-ish label, you might want to.
- This could be a short description of the contents of the
+All the commands mentioned below need to be set in a
\family sans
-Slide
+LaTeX
\family default
-, for example.
- In that case, enter in your descriptive comment and hit
+ environment or as
\family sans
-Return
+TeX
\family default
- as you normally would.
+ within another environment.
\end_layout
-\begin_layout Standard
-If, on the other hand, you don't want to enter in any descriptive text,
- you'll hit another LyX quirk.
- LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
- environment until you put something in the old one.
- So, do this:
+\begin_layout Subsubsection
+Lengths
\end_layout
-\begin_layout Itemize
-Start entering the text that will
+\begin_layout Standard
+All lengths are adjusted using the
+\family typewriter
+
+\backslash
+setlength{
+\family default
\emph on
-follow
+lengthname
+\family typewriter
\emph default
- the new
-\family sans
-Slide
+}{
\family default
-,
-\family sans
-Overlay
+\emph on
+newlength
+\family typewriter
+\emph default
+}
\family default
-,
-\family sans
-Note
+ 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
-,
-\family sans
-InvisibleText
+), millimeters (
+\family typewriter
+mm
\family default
- or
-\family sans
-VisibleText
+) or points (
+\family typewriter
+pt
\family default
-.
-
-\end_layout
-
-\begin_layout Itemize
-Now move to the beginning of that paragraph.
-
-\end_layout
+) or relative to some document or font-based length such as
+\family typewriter
-\begin_layout Itemize
-Next, hit
-\family sans
-Return
+\backslash
+textwidth
\family default
.
\end_layout
-\begin_layout Itemize
-Finally, change this new, empty paragraph to a
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
-\family default
-,
-\family sans
-Note
-\family default
-,
-\family sans
-InvisibleText
-\family default
- or
-\family sans
-VisibleText
+\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
.
-
-\end_layout
+ For example, to make
+\emph on
+all
+\emph default
+ foilheads 0.5
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
+in closer to their bodies put the following in the preamble:
+\family typewriter
+\backslash
+setlength{
+\backslash
+foilheadskip}{-0.5in}
\end_layout
-\begin_layout Subsection
-Making a Presentation with
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
-\family default
- and
-\family sans
-Note
+\begin_layout Standard
+The spacings around floats can be adjusted by setting these lengths:
\end_layout
-\begin_layout Subsubsection
-Using the
-\family sans
-Slide
-\family default
- Environment
-\end_layout
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Standard
-If you're expecting this section to teach you how to actually make a presentatio
-n, you'll be sorely disappointed.
- Naturally, I'll describe all of the ways the
-\family sans
-slides
+\family typewriter
+
+\backslash
+abovefloatskip
\family default
- class can assist you in preparing the materials for a presentation.
- Filling in the contents, however, is up to you.
- [Then again, that
-\emph on
-is
-\emph default
- the LyX philosophy.]
+ Separation between the text and the top of the float
\end_layout
-\begin_layout Standard
-Choosing the
-\family sans
-Slide
-\family default
- environment [in the manner described in section\InsetSpace ~
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-\begin_inset LatexCommand ref
-reference "sec:slideQuirk"
+\family typewriter
-\end_inset
+\backslash
+abovecaptionskip
+\family default
+ Separation between the float and the caption
+\end_layout
-] tells LyX to begin a new slide [duh].
- The label for this environment/
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-pseudo-command
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- is an
-\begin_inset Quotes eld
-\end_inset
+\backslash
+belowcaptionskip
+\family default
+ Separation between the caption and the following text
+\end_layout
-ASCII line,
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
- in cool blue, followed by the label,
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
-NewSlide:
-\begin_inset Quotes erd
-\end_inset
+\backslash
+captionwidth
+\family default
+ You can make the captions narrower than the surrounding text by adjusting
+ this length.
+ Best done relative to
+\family typewriter
+\backslash
+textwidth
+\family default
.
- Any text or paragraph environments that follow this one go on the new slide.
- It's that simple.
\end_layout
\begin_layout Standard
-Slides are probably the only time you'll need to forcibly end pages in LyX
- (this can be specified in the
+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 Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+abovetitleskip
+\family default
+ Separation from headers to
\family sans
-Paragraph Layout
+Title
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+titleauthorskip
\family default
- dialog).
- In fact, you'll want to, once you finish entering the contents of one slide.
- If you've entered more text than can physically fit on a slide, the extra
- overflows onto a new slide.
- I don't recommend doing this, however, since the overflow slide won't have
- any page number on it.
- Furthermore, it may interfere with any
+ between
\family sans
-Overlay
+Title
\family default
- you've made to accompany the oversized
+ and
\family sans
-Slide
+Author
\family default
-.
+ environments
\end_layout
-\begin_layout Standard
-The
-\family sans
-Overlay
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+authorauthorskip
\family default
- and
+ between multiple
\family sans
-Note
+Author
\family default
- environments work the same way as the
+ lines
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+authordateskip
+\family default
+ between the
\family sans
-Slide
+Author
\family default
- environment.
- They both create an
-\begin_inset Quotes eld
-\end_inset
-
-ASCII line
-\begin_inset Quotes erd
-\end_inset
+ and the
+\family sans
+Date
+\end_layout
- followed by a label [
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-NewOverlay:
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- and
-\begin_inset Quotes eld
-\end_inset
+\backslash
+dateabstractskip
+\family default
+ between the
+\family sans
+Date
+\family default
+ and the
+\family sans
+Abstract
+\end_layout
-NewNote:
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The last length related command affects all the list environments.
+ If you place
+\family typewriter
-, respectively].
- The color is a stunning magenta instead of blue, and the
-\begin_inset Quotes eld
-\end_inset
+\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
-ASCII line
-\begin_inset Quotes erd
-\end_inset
+\backslash
+setlength
+\family default
+ like the stuff mentioned above.
+\end_layout
- will look different, in style and in length.
- The label fonts of all three also differ from one another.
+\begin_layout Subsubsection
+Headers and Footers
\end_layout
\begin_layout Standard
-As with a
-\family sans
-Slide
+The
+\family typewriter
+
+\backslash
+LogoOn
\family default
-, if the contents of a
-\family sans
-Note
+ and
+\family typewriter
+
+\backslash
+LogoOff
\family default
- or
+ commands control whether the logo in the
\family sans
-Overlay
+MyLogo
\family default
- exceed the physical size of a slide or sheet of paper, the extra will overflow
- onto a new sheet.
- Again, you should avoid this.
- It defeats the whole purpose of
-\family sans
-Note
+ definition appear on a given page.
+ If you put
+\family typewriter
+
+\backslash
+LogoOff
\family default
-s and
-\family sans
-Overlay
+ 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
+
+\backslash
+LogoOff
\family default
-s.
-\end_layout
+ directly after the foilhead of that page and the
+\family typewriter
-\begin_layout Subsubsection
-Using
-\family sans
-Overlay
+\backslash
+LogoOn
\family default
- with
-\family sans
-Slide
+ directly after the next foilhead.
\end_layout
\begin_layout Standard
-The idea behind an
-\family sans
-Overlay
-\family default
- is a slide that sits atop another slide.
- Perhaps you wish to discuss a figure on the main
+If you decide to use the
\family sans
-Slide
+fancy
\family default
- before displaying the text associated with it.
- One way to accomplish this is tape a flap of dark paper over the part of
- the
+ page style setting in the
\family sans
-Slide
+Document
+\begin_inset space ~
+\end_inset
+
+Layout
\family default
- you want to display later.
- This method fails, however, if you wish to overlap one graph with another,
- for example.
- You would then have to fumble while speaking to align the two separate,
- overlapping
+ 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
-Slide
+fancyheadings
\family default
-s to align the two graphs.
- The use of an
+ package and the
\family sans
-Overlay
+foils
\family default
- environment in both cases makes life much easier.
+ class.
+\end_layout
+
+\begin_layout Section
+Hollywood (Hollywood spec scripts)
\end_layout
\begin_layout Standard
-Each
-\family sans
-Overlay
-\family default
- receives the page number of its
+by
+\shape smallcaps
+Garst Reese
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+Getting the format of a Hollywood script right is a
\begin_inset Quotes eld
\end_inset
-parent
+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
+Speakers' lines should NEVER break in mid-sentence.
+ If a speaker's lines continue over a page break, repeat the
\family sans
-Slide
+Speaker
\family default
-, appended by
-\begin_inset Quotes eld
-\end_inset
+ title followed by (Cont'd).
+\end_layout
+\begin_layout Subsection
+Special features
+\end_layout
-\family typewriter
--a
+\begin_layout Standard
+Insert the
+\family sans
+Speaker
\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.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Paper size and Margins
+\end_layout
-.
-\begin_inset Foot
-status collapsed
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
+
+\begin_layout Subsection
+Environments
+\end_layout
\begin_layout Standard
-Presumably, mutliple
+The following environments are available.
+ You can use hollywood.bind to get the bind keys shown at the right.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Overlay
-\family default
-s would have
-\begin_inset Quotes eld
+Standard
+\begin_inset Newline newline
\end_inset
-\family typewriter
--a
\family default
+Used where nothing else works.
+ Try to avoid it.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
+\family sans
+FADE_IN
+\family default
+:
+\begin_inset space \hfill{}
\end_inset
-\family typewriter
--b
+\family sans
+M-z S-I
\family default
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
-,
+Usually followed by something like
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
--c
-\family default
-
+on Sally waking up.
\begin_inset Quotes erd
\end_inset
-, etc.\InsetSpace ~
-appended to the page number of the parent
-\family sans
-Slide
-\family default
-.
-
+
\end_layout
-\end_inset
+\begin_layout Itemize
- Clearly, you want the contents of both the
-\family sans
-Slide
-\family default
- and the
\family sans
-Overlay
-\family default
- to each fit on a single physical slide! You should probably consider an
-
-\family sans
-Overlay
-\family default
- as
-\begin_inset Quotes eld
+INT:
+\begin_inset space \hfill{}
\end_inset
-part of
-\begin_inset Quotes erd
+M-z i
+\begin_inset Newline newline
\end_inset
- a
-\family sans
-Slide
-\family default
-.
- Indeed, the LyX
-\family sans
-slides
-\family default
- class provides a visual cue for this: the label at the start of an
-\family sans
-Overlay
+
\family default
- is shorter than that at the start of a
+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
+
\family sans
-Slide
+EXT:
+\begin_inset space \hfill{}
+\end_inset
+
+M-z e
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-.
- Lastly, when you generate printable output, you'll find alignment markers
- in all four corners of both the
+Introduces a new EXTERIOR camera set-up.
+ Everthing on this line in CAPS.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Overlay
+Speaker
+\begin_inset space \hfill{}
+\end_inset
+
+M-z s
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- page and its parent
+The character speaking.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Slide
+Parenthetical
+\begin_inset space \hfill{}
+\end_inset
+
+M-z p
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-.
- These will assist you in lining up the two physical slides.
+Instructions to the speaker.
+ The () are automatically inserted, but only the ( will show in LyX.
+ Both will be printed.
\end_layout
-\begin_layout Standard
-The major problem in overlaying two slides is aligning the contents of the
- two transparencies.
- How much space should you leave for that graph on the second slide? Worse
- still, what if you want a graph and a sentence on second slide, but there
- is text on the main transparency that goes in between them? You could try
- and insert vertical space of the right size.
- The better way is to use
+\begin_layout Itemize
+
\family sans
-InvisibleText
+Dialogue
+\begin_inset space \hfill{}
+\end_inset
+
+M-z d
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- and
+What the
\family sans
-VisibleText
+Speaker
\family default
-.
+ says.
\end_layout
-\begin_layout Standard
-As their names imply,
-\family sans
-InvisibleText
-\family default
- and
-\family sans
-VisibleText
-\family default
- are two command-like paragraph environments that make all subsequent text
- invisible and visible, respectively.
- Note from section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:slideQuirk"
-
-\end_inset
+\begin_layout Itemize
- that you don't place anything
-\emph on
-into
-\emph default
- these two environments, however.
- When you create an
\family sans
-InvisibleText
-\family default
-, it inserts a centered, sky-blue label into the page reading
-\begin_inset Quotes eld
+Transition
+\begin_inset space \hfill{}
\end_inset
-<Invisible Text Follows>
-\begin_inset Quotes erd
+M-z t
+\begin_inset Newline newline
\end_inset
-.
- For paragraphs following this label, the parts of the
-\family sans
-Slide
-\family default
- [or
-\family sans
-Overlay
-\family default
-; it doesn't matter which] where they would be contain instead blank space.
-
-\end_layout
-\begin_layout Standard
-For
-\family sans
-VisibleText
\family default
-, the corresponding centered label is
-\begin_inset Quotes eld
+Camera movement instruction.
+ e.
+\begin_inset space \thinspace{}
\end_inset
-<Visible Text Follows>
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
- in blazing green.
- Paragraphs following this label behave normally.
- Note that the beginning of a new
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
-\family default
-, or
-\family sans
-Note
-\family default
- automatically shuts off an
-\family sans
-InvisibleText
-\family default
-.
- It's therefore not necessary to use
-\family sans
-VisibleText
-\family default
- at the end of a
-\family sans
-Slide
-\family default
-.
+CUT TO:
\end_layout
-\begin_layout Standard
-By now, it should be obvious how to create overlay transparencies using
- the proper combination of
-\family sans
-InvisibleText
-\family default
- and
-\family sans
-VisibleText
-\family default
- on a
-\family sans
-Slide
-\family default
- and
+\begin_layout Itemize
+
\family sans
-Overlay
-\family default
-:
+FADE OUT:
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-I
\end_layout
-\begin_layout Enumerate
-Create a
-\family sans
-Slide
-\family default
-, including everything that will appear on it, whether on the main slide
- or on the
+\begin_layout Itemize
+
\family sans
-Overlay
-\family default
-.
+Author
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-A
\end_layout
-\begin_layout Enumerate
-Before each figure or paragraph that will appear only on the
-\family sans
-Overlay
-\family default
-, insert an
-\family sans
-InvisibleText
-\family default
- environment.
- If necessary, insert a
-\family sans
-VisibleText
-\family default
- environment after the
+\begin_layout Itemize
+
\family sans
-Overlay
-\family default
--only text.
+Title
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-T
\end_layout
-\begin_layout Enumerate
-Start an
-\family sans
-Overlay
-\family default
- immediately following the
+\begin_layout Itemize
+
\family sans
-Slide
-\family default
-.
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
+
+M-z r
\end_layout
-\begin_layout Enumerate
-Copy the contents of this
-\family sans
-Slide
-\family default
- into the
-\family sans
-Overlay
-\family default
-.
+\begin_layout Subsection
+Script jargon
\end_layout
-\begin_layout Enumerate
-Within the
-\family sans
-Overlay
-\family default
-, change all of the
-\family sans
-InvisibleText
-\family default
- lines to
-\family sans
-VisibleText
-\family default
- and vice-versa.
+\begin_layout Itemize
+(O.S) — off screen
\end_layout
-\begin_layout Standard
-That's it.
- You've just made an
-\family sans
-Overlay
-\family default
-.
+\begin_layout Itemize
+(V.0) — voice over
\end_layout
-\begin_layout Standard
-There's one problem with the way I've designed the LyX
-\family sans
-slides
-\family default
- class: you can't make text in the middle of a paragraph invisible, nor
- make text in the middle of an invisible paragraph visible again.
- To accomplish this feat, you'll need to use some inlined LaTeX codes.
-\begin_inset Foot
-status collapsed
+\begin_layout Itemize
+b.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-The commands of interest are:
+g.
+ — background
\end_layout
\begin_layout Itemize
+C.U.
+ — close-up
+\end_layout
-\family typewriter
-{
-\backslash
-invisible \SpecialChar \ldots{}
- }
+\begin_layout Itemize
+PAN — camera movement
\end_layout
\begin_layout Itemize
+INSERT — cut to close-up of
+\end_layout
-\family typewriter
-{
-\backslash
-visible \SpecialChar \ldots{}
- }
+\begin_layout Section
+ijmpc and ijmpd
\end_layout
\begin_layout Standard
-\SpecialChar \ldots{}
-and need to be marked as TeX.
- The text whose
-\begin_inset Quotes eld
-\end_inset
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
-visibility
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Overview
+\end_layout
- you wish to change goes in between the brackets [and after the
+\begin_layout Standard
+The ijmpc package is a set of macros that facilitates electronic manuscript
+ submission to the
+\emph on
+International Journal of Modern Physics C
+\emph default
+.
+ Similarly, the ijmpd package is for creating manuscripts to be submitted
+ to the
+\emph on
+International Journal of Modern Physics D
+\emph default
+.
+ Both journals are published by World Scientific.
+ The corresponding document classes are named
\family typewriter
-
-\backslash
-invisible
+ws-ijmpc.cls
\family default
- or
+ and
\family typewriter
-
-\backslash
-visible
+ws-ijmpd.cls
\family default
- command].
- If you don't know how to mark text as TeX, see the appropriate section
- of the
-\emph on
-User's Guide
-\emph default
-.
+, respectively.
+ These files, together with instructions for the authors, can be downloaded
+ from the sites
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
\end_layout
\end_inset
+ and
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
\end_layout
-\begin_layout Subsubsection
-Using
-\family sans
-Note
-\family default
- with
-\family sans
-Slide
-\family default
+\end_inset
-\begin_inset LatexCommand label
-name "sec:slideNote"
+.
+ Both packages are modified versions of the standard
+\begin_inset Quotes eld
+\end_inset
+article
+\begin_inset Quotes erd
\end_inset
+ package, and they are almost (but not exactly) identical.
+ Most of their features are supported by LyX.
+ I have used LyX successfully to write articles submitted to both journals
+ without any problem.
+\end_layout
+\begin_layout Subsection
+Writing a paper
\end_layout
\begin_layout Standard
-Like an
-\family sans
-Overlay
-\family default
-, a
+As usual, the easiest way to write a paper is to start with a template.
+ Click on
\family sans
-Note
+File\SpecialChar \menuseparator
+New from
\family default
- is associated with a
-\begin_inset Quotes eld
-\end_inset
-
-parent
-\begin_inset Quotes erd
-\end_inset
-
\family sans
-Slide
+\bar under
+T
+\bar default
+emplate
\family default
-.
- Here, too, the LyX
-\family sans
-slides
+, then choose the
+\family typewriter
+ijmpc.lyx
\family default
- class provides visual cues.
- The label for a
+ or
+\family typewriter
+ijmpd.lyx
+\family default
+ template.
+ This will give an (almost) empty document that includes the most common
+ fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
+\family typewriter
+<>
+\family default
+) with your text.
+ You should keep in mind the following remarks.
+\end_layout
+
+\begin_layout Enumerate
+LyX won't let you change the font size and the page style of the document,
+ because such modifications are not allowed by both packages.
+\end_layout
+
+\begin_layout Enumerate
+The language of the document should not be changed.
+ Before previewing your paper, be sure that the babel package is not used.
+ To do this, click on
\family sans
-Note
+Tools\SpecialChar \menuseparator
+Preferences
\family default
- is shorter than that of a
+, select the
\family sans
-Slide
+Lang Opts
\family default
- [yet longer than that of an
+ tab, deselect the
\family sans
-Overlay
+Use babel
\family default
-] and, like the label of an
+ checkbox in the language settings, and click on
\family sans
-Overlay
+Apply
\family default
- is shockingly magenta.
- Additionally, the printed
+ (or
\family sans
-Note
+Save
\family default
- has the page number of its
+, if you wish to make this change permanent).
+\end_layout
+
+\begin_layout Enumerate
+The
\begin_inset Quotes eld
\end_inset
-parent
+Keywords
\begin_inset Quotes erd
\end_inset
-
-\family sans
-Slide
-\family default
-, appended by
+ style must be used to define keywords.
+\end_layout
+
+\begin_layout Enumerate
+The ijmpc package provides a style named
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
--
-\family default
-1
+Classification Codes
\begin_inset Quotes erd
\end_inset
-,
+, which can be used to define classification codes, such as PACS numbers.
+ Note that this facility is not supported by the ijmpd package.
+\end_layout
+
+\begin_layout Enumerate
+Several new environments are available:
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
--
-\family default
-2
+Definition
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
--
-\family default
-3
+Step
\begin_inset Quotes erd
\end_inset
-, etc.
- You can have multiple
-\family sans
-Note
-\family default
-s associated with a single
-\family sans
-Slide
-\family default
-, and, as with
-\family sans
-Slide
-\family default
- and
-\family sans
-Overlay
-\family default
-, you'll probably want to break up long
-\family sans
-Note
-\family default
-s so that they fit on a single sheet of paper.
-\end_layout
-
-\begin_layout Standard
-The purpose of a
-\family sans
-Note
-\family default
- is obvious: it contains anything additional you might want to say about
- a
-\family sans
-Slide
-\family default
-.
- It could also be used as a sheet of reminders for a particular
-\family sans
-Slide
-\family default
-.
- In the case of the latter, you might want to make use of time markers.
- Currently, the LyX
-\family sans
-slides
-\family default
- class has no
+,
\begin_inset Quotes eld
\end_inset
-native
+Example
\begin_inset Quotes erd
\end_inset
- support for time markers, a
-\noun on
-Sli
-\noun default
-TeX feature.
- So, you'll have to resort to using the LaTeX codes.
-\end_layout
-
-\begin_layout Standard
-To use time markers, you'll need to specify the extra class option
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-clock
-\family default
-
+Remark
\begin_inset Quotes erd
\end_inset
- [see section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:slidesetup"
+,
+\begin_inset Quotes eld
+\end_inset
+Notation
+\begin_inset Quotes erd
\end_inset
-].
- This option turns on timing marks, which will appear in the lower-left-hand
- corner of every
-\family sans
-Note
-\family default
- you generate.
- To set what appears in the time marker, you use the LaTeX commands
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-settime{}
-\family default
-
+Theorem
\begin_inset Quotes erd
\end_inset
- and
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-addtime{}
-\family default
-
+Proof
\begin_inset Quotes erd
\end_inset
-.
- The arguments of both commands are time measured in seconds.
-
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-settime{}
-\family default
-
+Corollary
\begin_inset Quotes erd
\end_inset
- sets the time marker to a given time.
-
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-addtime{}
-\family default
-
+Lemma
\begin_inset Quotes erd
\end_inset
- increments the time marker by the specified amount.
- Using time markers and
-\family sans
-Note
-\family default
-s in this fashion, you can remind yourself how much time to spend on a particula
-r
-\family sans
-Slide
-\family default
-.
-\end_layout
-
-\begin_layout Standard
-There's one last feature to describe.
- Clearly, you'd like to print out all of your
-\family sans
-Slide
-\family default
-s and
-\family sans
-Overlay
-\family default
-s on transparencies while printing all of your
-\family sans
-Note
-\family default
-s on plain paper.
- However, a
-\family sans
-Note
-\family default
-
-\emph on
-must
-\emph default
- follow the
-\family sans
-Slide
-\family default
- with which it is associated.
- What's a person to do?
-\end_layout
-
-\begin_layout Standard
-Luckily, there are two LaTeX commands that allow you to select what to print
- out.
- Both must be placed into the preamble of your document.
- The command
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-onlyslides{
-\backslash
-slides}
-\family default
-
+Proposition
\begin_inset Quotes erd
\end_inset
- will cause the output to contain only the
-\family sans
-Slide
-\family default
-s and
-\family sans
-Overlay
-\family default
-s.
- Correspondingly, the command
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-onlynotes{
-\backslash
-notes}
-\family default
-
+Prop
\begin_inset Quotes erd
\end_inset
- prevents the output of anything but
-\family sans
-Note
-\family default
-s.
- I'd advise placing both commands in the preamble and initially comment
- both out.
- You can then preview your entire presentation as you write.
- When you're done writing, you can then uncomment one of the two to select
- what you want to print.
- I like to uncomment
+,
\begin_inset Quotes eld
\end_inset
+Question
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-
-\backslash
-onlyslides{
-\backslash
-slides}
-\family default
+,
+\begin_inset Quotes eld
+\end_inset
+Claim
\begin_inset Quotes erd
\end_inset
- , print to a file with
+, and
\begin_inset Quotes eld
\end_inset
+Conjecture
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Their use is more or less obvious.
+ LyX supports all these environments; it will use the proper label, text
+ style, and numbering scheme for each of them.
+\end_layout
+\begin_layout Enumerate
+Both packages use basic citations; the natbib package should not be used.
+ In LyX, citation references are shown as usual; in the output, citations
+ are shown as superscripts.
+ If you want to use a citation as normal text, you should use the
\family typewriter
--slides
+refcite
\family default
+ command, e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
- in its name, comment it back out, then uncomment
+
\begin_inset Quotes eld
\end_inset
+See Ref.
+\begin_inset space \space{}
+\end_inset
+
\family typewriter
\backslash
-onlynotes{
-\backslash
-notes}
+refcite{key}
\family default
\begin_inset Quotes erd
\end_inset
- and print to a
+.
+\end_layout
+
+\begin_layout Enumerate
+There is no
\begin_inset Quotes eld
\end_inset
+Acknowledgments
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-*-notes.ps
-\family default
+ section in both packages.
+ To put acknowledgments, just use the
+\begin_inset Quotes eld
+\end_inset
+Section*
\begin_inset Quotes erd
\end_inset
- file.
- I can then send either file to a printer, loading transparencies or plain
- paper as appropriate.
+ environment.
\end_layout
-\begin_layout Standard
-You can also provide other arguments to the
+\begin_layout Enumerate
+Appendices may be added to the paper,
+\emph on
+after
+\emph default
+ the Acknowledgments and
+\shape italic
+before
+\shape default
+ the References.
+ LyX provides a special environment, called
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-onlyslides{}
-\family default
-
+Appendices Section
\begin_inset Quotes erd
\end_inset
- and
+ which marks the beginning of the appendices.
+ This environment should be left blank; it just sends a LaTeX command, but
+ nothing is really printed.
+ In LyX, the word
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-onlynotes{}
-\family default
-
+Appendix
\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,
+ is printed with blue letters, as a signal that all sections after that
+ point are appendices.
+ To write an appendix, use the
\begin_inset Quotes eld
\end_inset
+Appendix
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-slides.lyx
-\family default
+ environment.
+ LyX will number each appendix with capital letters, as required by both
+ journals.
+ Note that
+\begin_inset Quotes eld
+\end_inset
+Appendices Section
\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 ~
+
+\emph on
+must
+\emph default
+ be present before the first appendix; if not, all appendices will be numbered
+ as normal sections in the output.
+\end_layout
-\bar under
-T
-\bar default
-emplate
-\family default
-.
- Your new LyX presentation file will contain an example
-\family sans
-Slide
+\begin_layout Enumerate
+The ijmpc and the ijmpd packages use the
+\family typewriter
+tbl
\family default
- --
-\family sans
-Overlay
+ command to implement table captions.
+ As a result, a table created by LyX is printed correctly, but its caption
+ is ignored.
+ However, you can use some TeX code to overpass this problem, so that captions
+ are printed as expected.
+ To do so, create a float table as usual, remove the caption, and replace
+ it with the TeX code
+\family typewriter
+
+\backslash
+tbl{
+\emph on
+your table caption
+\emph default
+}{
\family default
- --
-\family sans
-Note
+ (sic); you must also the TeX code
+\family typewriter
+}
\family default
- triplet.
- The
-\family sans
-Slide
+ immediately after the tabular material.
+ Study the example table included in the template files to see how this
+ trick is implemented.
+ Alternatively, If you need table captions, you should implement the whole
+ table float in a
+\family typewriter
+.tex
\family default
- and
+ file, then include this file to the LyX document (
\family sans
-Overlay
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+Document
\family default
- additionally contain an example of the use of
-\family sans
-InvisibleText
+).
+ Details on how to create a table float can be found in the files
+\family typewriter
+ws-ijmpc.tex
\family default
and
-\family sans
-VisibleText
+\family typewriter
+ws-ijmpd.tex
\family default
-.
- Lastly, the preamble will contain:
+, included in the corresponding packages.
\end_layout
-\begin_layout LyX-Code
-% Uncomment to print out only slides and overlays
+\begin_layout Subsection
+Preparing a paper for submission
\end_layout
-\begin_layout LyX-Code
-%
-\end_layout
+\begin_layout Standard
+Before you submit your paper you must export the LyX document as a LaTeX
+ file (
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
+\family default
+)
+\begin_inset Foot
+status open
-\begin_layout LyX-Code
-%
-\backslash
-onlyslides{
-\backslash
-slides}
-\newline
-
+\begin_layout Plain Layout
+Actually you have the choice between LaTeX (plain) and pdflatex.
+ If you intend to use pdflatex to prepare the paper, you should use the
+ pdflatex option so that included graphics are converted to PDF format,
+ ready for use by pdflatex.
\end_layout
-\begin_layout LyX-Code
-% Uncomment to print out only notes
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-%
+, then make the following changes to the resulting
+\family typewriter
+.tex
+\family default
+ file.
\end_layout
-\begin_layout LyX-Code
-%
-\backslash
-onlynotes{
+\begin_layout Enumerate
+Remove the comment lines before the
+\family typewriter
+
\backslash
-notes}
+documentclass
+\family default
+ command.
\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
+\begin_layout Enumerate
+Remove everything between (and including) the
+\family typewriter
- 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
+\backslash
+makeatletter
\family default
- class [see section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:foiltex"
-
-\end_inset
-
-] or the
-\begin_inset Quotes eld
-\end_inset
-
-
+ and
\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
+\backslash
+makeatother
+\family default
+ commands, except for any commands you specifically put into the LaTeX preamble.
+\end_layout
\begin_layout Standard
-Perhaps you can take on the task\SpecialChar \ldots{}
-
+The modified
+\family typewriter
+.tex
+\family default
+ file should be saved and processed through LaTeX as many times as necessary.
+ You may also want to check the resulting
+\family typewriter
+.dvi
+\family default
+ document.
\end_layout
-\end_inset
-
- I know nothing about these other classes.
- Try them out to see what sort of alternative they provide.
+\begin_layout Subsection
+Use of TeX code
\end_layout
-\begin_layout Section
-Foils [aka
-\family sans
-Foil
+\begin_layout Standard
+The use of TeX code is reduced to two commands, which must be placed at
+ the top of the document.
+ If you started writing your paper by using the
+\family typewriter
+ijmpc.lyx
\family default
-\noun on
-TeX
-\noun default
-]
-\begin_inset LatexCommand label
-name "sec:foiltex"
-
-\end_inset
+ or the
+\family typewriter
+ijmpd.lyx
+\family default
+ template, the TeX code needed is already in its place; you usually don't
+ need to delete it.
+ You may only modify the first TeX code to specify the information printed
+ to the top of odd and even pages (authors' names and short paper's title,
+ respectively).
+ This TeX code must have the form
+\family typewriter
+\backslash
+markboth{Authors' Names}{Short Paper's Title}
+\family default
+.
+\end_layout
+\begin_layout Section
+iopart
\end_layout
\begin_layout Standard
by
\noun on
-Allan Rae
+Uwe Stöhr
\end_layout
\begin_layout Subsection
-Introduction
+Overview
\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
+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
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\begin_layout Plain Layout
+
+ftp://ftp.iop.org/pub/journals/latex2e
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
+.
+\end_layout
+\begin_layout Subsection
+Writing a paper
\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
-
-
+The easiest way to write a paper is to start with the file
\emph on
-only.
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
-
+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 Standard
-If you're looking for the documentation for
-\begin_inset Quotes eld
-\end_inset
-
-
+\begin_layout Itemize
+To be able to compile your document to a PDF, PS, or DVI, assure that the
+ two options
\family sans
-slides (default)
+Use AMS math package
\family default
+ in the document settings under
+\family sans
+Math Options
+\family default
+ are not used!
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-, check out section\InsetSpace ~
+\begin_layout Itemize
-\begin_inset LatexCommand ref
-reference "sec:slitex"
+\size normal
+The title environment defines the kind of your paper.
+ So use one of the following environments for the title:
+\end_layout
-\end_inset
+\begin_deeper
+\begin_layout Itemize
-.
- If your machine doesn't have the
\family sans
-foils
+\size normal
+Title
\family default
- class [
-\begin_inset Quotes eld
-\end_inset
+ for a Paper
+\end_layout
+\begin_layout Itemize
\family sans
-slides (FoilTeX)
+\size normal
+Review
\family default
+ for a Review
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-] installed, you'll probably have to use the default
\family sans
-slides
+\size normal
+Topical
\family default
- class, which isn't quite as good as
-\family sans
-foils.
+ for a Topical review
\end_layout
-\begin_layout Standard
-The
-\family sans
-foils
-\family default
- class is designed for use with version 2.1 of the
+\begin_layout Itemize
+
\family sans
-foils.cls
+\size normal
+Comment
\family default
- LaTeX class file which is now an integral part of LaTeX2e.
-\end_layout
-
-\begin_layout Subsection
-Getting Started
+ for a Comment
\end_layout
-\begin_layout Standard
-Obviously, to use this document class, you need to select
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Itemize
\family sans
-slides (FoilTeX)
+\size normal
+Note
\family default
+ for a Note
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- 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
+\size normal
+Paper
\family default
- dialog that you should know about that are specific to this class:
+ for a Paper (same as Title)
\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
+\size normal
+Prelim
\family default
- class.
+ for a Preliminary communication
\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
+\size normal
+Rapid
\family default
- but all math equations are still typeset in the usual roman font.
+ for a Rapid communication
\end_layout
\begin_layout Itemize
\family sans
-Foil
+\size normal
+Letter
\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.
+ for a Letter to the editor
\end_layout
+\end_deeper
\begin_layout Itemize
-Don't bother changing the
+
+\size normal
+All title environments except of
\family sans
-Float Placement
+Letter
\family default
- settings because they are ignored anyway.
- All floats appear where they are defined in the text.
+ can have an optional short title.
\end_layout
\begin_layout Itemize
-The
-\family sans
-\bar under
-P
-\bar default
-agestyle
-\family default
- setting behaves a bit differently for this class.
-
+There is a general title environment
\family sans
-Foil
+Article
\family default
-TeX provides extensive footer and header capabilities including a user-defined
- logo.
- See section\InsetSpace ~
+ which is not directly supported by the LyX.
+ This can be used as TeX code when your document doesn't fit into one of
+ the other title types.
+\end_layout
-\begin_inset LatexCommand ref
-reference "sec:foilfoot"
+\begin_layout Standard
+For more informations like hints for special table and formula formatting,
+ look at the IOP author guidelines.
+\end_layout
-\end_inset
+\begin_layout Section
+Kluwer
+\end_layout
- for more details.
- The title page is treated differently to all other pages in the document
- and is
+\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
-always
+Astrophysics and Space Science
\emph default
- unnumbered and
+ and
\emph on
-always
+Solar Physics
\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
+, but there are many others (see a complete list at
+\begin_inset Flex URL
+status collapsed
-\begin_deeper
-\begin_layout List
-\labelwidthstring MMMMMMM
+\begin_layout Plain Layout
-\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).
-
+http://www.wkap.nl/jrnllist.htm/JRNLHOME
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMM
+\end_inset
-\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
+).
+ The Kluwer package may be downloaded from the site
+\begin_inset Flex URL
+status collapsed
-\begin_layout List
-\labelwidthstring MMMMMMM
+\begin_layout Plain Layout
-\series bold
-foilheadings
-\series default
- Page numbers in lower right corner.
- Additional headers and footers are also shown.
- This is also the default.
+http://www.wkap.nl/kaphtml.htm/STYLEFILES
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMM
+\end_inset
-\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
+.
+ A complete user guide is contained in that package (but it can also be
+ downloaded separately).
\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
+LyX supports many features of the package but not everything.
+ However, the TeX code needed is reduced to some
+\begin_inset Quotes eld
+\end_inset
-\begin_layout List
-\labelwidthstring MMMMMMx
+peculiar
+\begin_inset Quotes erd
+\end_inset
-\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
+ commands of the package (see
+\begin_inset space ~
+\end_inset
-\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_inset CommandInset ref
+LatexCommand ref
+reference "subsec:kluwer_peculiarities"
-\begin_layout List
-\labelwidthstring MMMMMMx
+\end_inset
-\series bold
-footrule
-\series default
- Places a rule across the page above the footer on every page except the
- title page.
+).
+ 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 List
-\labelwidthstring MMMMMMx
+\begin_layout Subsection
+Writing a paper
+\end_layout
-\series bold
-dvips
-\series default
- This is automatically set each time you create a new
+\begin_layout Standard
+The easiest way to write a paper is to start with the Kluwer template file.
+ Click on
\family sans
-foils
+File\SpecialChar \menuseparator
+New from
\family default
- document.
- This option tells
+
\family sans
-Foil
+Template
\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
+, then choose the
+\family typewriter
+kluwer.lyx
\family default
- and
-\family sans
-Rotatefoilhead
+ 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
- environments (don't worry these are described in the next section).
+) with the correct information.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMx
-
-\series bold
-leqno
-\series default
- Equation numbers on the left.
+\begin_layout Subsection
+Preparing a paper for submission
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMx
+\begin_layout Standard
+As in the AASTeX package, before you submit your paper to a journal you
+ must
+\begin_inset Quotes eld
+\end_inset
-\series bold
-fleqn
-\series default
- Flush-left equations.
-\end_layout
+postprocess
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-Supported Environments
+ it as follows.
\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
+\begin_layout Enumerate
+Export your paper as a LaTeX file.
+ To do this, click on
\family sans
-Foil
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\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_layout Standard
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
+\family default
+ file with a text editor and make the following changes
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
+\family typewriter
\backslash
-begin{multicols}{2}
+documentclass
+\family default
+ command,
\end_layout
-\end_inset
+\begin_layout Enumerate
+remove everything between (and including) the
+\family typewriter
+\backslash
+makeatletter
+\family default
+ and
+\family typewriter
+\backslash
+makeatother
+\family default
+ commands, except for any commands you specifically put into the LaTeX preamble.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Standard
+\begin_layout Standard
+Save the resulting
+\family typewriter
+.tex
+\family default
+ file.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Itemize
+\end_deeper
+\begin_layout Enumerate
+Run the
+\family typewriter
+.tex
+\family default
+ file through LaTeX as many times as necessary (usually up to three).
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+View the resulting
+\family typewriter
+.dvi
+\family default
+ document using, e.
+\begin_inset space \thinspace{}
+\end_inset
-\family sans
-Enumerate
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Itemize
\family sans
-Description
+xdvi
+\family default
+, and check if everything is OK (it should, if you didn't make any mistake).
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+\begin_inset Quotes eld
+\end_inset
-\family sans
-List
-\end_layout
+Peculiarities
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ of the Kluwer package
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:kluwer_peculiarities"
-\family sans
-LyX-Code
-\end_layout
+\end_inset
-\begin_layout Itemize
-\family sans
-Verse
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The Kluwer package has the following
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Quote
+peculiarities
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Quotation
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Title
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Author
-\end_layout
-
-\begin_layout Itemize
+\begin_layout Enumerate
+It is possible to write multiple articles in the same LaTeX file
+\begin_inset Foot
+status collapsed
-\family sans
-Date
+\begin_layout Plain Layout
+I can't imagine any good reason to do this.
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Abstract
-\end_layout
+.
+ Each article must be included in the environment
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+article
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Bibliography
-\end_layout
+.
+ Unfortunately, this environment cannot be omitted, even if you write just
+ one article.
+ Therefore, each article starts with the command
+\family typewriter
-\begin_layout Itemize
+\backslash
+begin{article}
+\family default
+ and, obviously, ends with the command
+\family typewriter
-\family sans
-Address
-\end_layout
+\backslash
+end{article}
+\family default
+.
+ Although this can be implemented in LyX, I didn't included it, since it
+ looks ugly and can confuse the novice user.
+ Therefore, you need to enter them directly and mark them as LaTeX code
+ (the well-known
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+TeX code
+\begin_inset Quotes erd
+\end_inset
-\family sans
-RightAddress
+).
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+Information given at the beginning of the article (i.
+\begin_inset space \thinspace{}
+\end_inset
-\family sans
-Caption
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Itemize
+title, subtitle, author, institution, running title, running author, abstract
+ and keywords) must be included in an environment called
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Comment
-\end_layout
+opening
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+.
+ This is not implemented in LyX, so you must enter title, subtitle etc.
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
+between two TeX code lines (
+\family typewriter
+\backslash
+begin{opening}
+\family default
+ and
+\family typewriter
\backslash
-end{multicols}
+end{opening}
+\family default
+).
\end_layout
-\end_inset
-
+\begin_layout Enumerate
+According to the user manual, the label of each bibliography item must be
+ written as
+\family typewriter
+\backslash
+protect
+\backslash
+citeauthoryear{
+\family default
+\emph on
+author(s)
+\family typewriter
+\emph default
+}{
+\family default
+\emph on
+year
+\family typewriter
+\emph default
+}
+\family default
+.
\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,
-
-\family sans
-Foil
+The
+\family typewriter
+kluwer.lyx
\family default
-TeX provides specific commands for starting new foils and these are:
-\end_layout
+ template takes care of all these
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+peculiarities
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Foilhead
+.
+ If you start a new paper using this template you don't need to do anything
+ special.
+ Just
\end_layout
-\begin_layout Itemize
-
-\family sans
-Rotatefoilhead
+\begin_layout Enumerate
+don't delete the TeX code included in the template, and
\end_layout
-\begin_layout Standard
-LyX also provides slightly modified versions of these two environments called:
+\begin_layout Enumerate
+copy the example bibliography item included in the template and modify it
+ as necessary to enter new bibliography items.
\end_layout
-\begin_layout Itemize
-
-\family sans
-ShortFoilhead
+\begin_layout Section
+Koma-Script
\end_layout
-\begin_layout Itemize
-
-\family sans
-ShortRotatefoilhead
+\begin_layout Standard
+by
+\noun on
+Bernd Rellermeyer
\end_layout
-\begin_layout Standard
-and the differences will be explained in the next section.
+\begin_layout Subsection
+Overview
\end_layout
\begin_layout Standard
-Since foils are often used in presenting ideas or new theorems and such
+The LyX document classes
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+,
+\emph on
+book
+\emph default
-\family sans
-Foil
+\emph on
+(koma-script)
+\emph default
+, and
+\emph on
+letter
+\emph default
+
+\emph on
+(koma-script)
+\emph default
+ correspond to the LaTeX document classes
+\family typewriter
+scrartcl.cls
\family default
-TeX also provides a comprehensive box of goodies for presenting them:
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
+,
+\family typewriter
+scrreprt.cls
+\family default
+,
+\family typewriter
+scrbook.cls
+\family default
+, and
+\family typewriter
+scrlettr.cls
+\family default
+, resp.
+\begin_inset space ~
\end_inset
-
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Theorem
+of the Koma-Script family.
+ They are replacements for the standard document classes
+\family typewriter
+article.cls
+\family default
+,
+\family typewriter
+report.cls
+\family default
+,
+\family typewriter
+book.cls
+\family default
+ and
+\family typewriter
+letter.cls
+\family default
+, resp., and fit better to European typography conventions in a number of
+ points.
\end_layout
\begin_layout Itemize
-
-\family sans
-Lemma
+Standard character size is 11pt in
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+, and
+\emph on
+book (koma-script)
+\emph default
+, and 12pt in
+\emph on
+letter (koma-script)
+\emph default
+.
\end_layout
\begin_layout Itemize
+Headings, labels of the description environment, and a number of elements
+ of the
+\emph on
+letter (koma-script)
+\emph default
+ document class are set in a bold sans serif font.
+\begin_inset Foot
+status collapsed
-\family sans
-Corollary
-\end_layout
+\begin_layout Plain Layout
+There is a big difference between the bold sans serif old cm fonts and new
+ ec fonts, especially in the appearance of headings.
+ In comparison, the ec bold sans serif fonts look a bit thin.
+ Here the LaTeX package
+\family typewriter
+cmsd.sty by
+\family default
+
+\shape smallcaps
+Walter Schmidt
+\shape default
+ helps to produce the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+usual
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Proposition
+ appearance when using the ec fonts.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Definition
-\end_layout
+\end_inset
-\begin_layout Itemize
+ The numbering of chapter headings is made in the same way as the numbering
+ of section headings, that is without the extra line
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Proof
-\end_layout
+Chapter\SpecialChar \ldots{}
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+.
+ In addition, the appearance of the headings can be modified by using a
+ number of options (in LyX to be entered in the field
\family sans
-Theorem*
-\end_layout
-
-\begin_layout Itemize
+Extra
+\begin_inset space ~
+\end_inset
+Options
+\family default
+ of the dialog
\family sans
-Lemma*
+Layout\SpecialChar \menuseparator
+Document
+\family default
+).
+ A detailed German description of these options can be found in the Koma-Script
+ documentation
+\emph on
+scrguide
+\emph default
+.
\end_layout
\begin_layout Itemize
-
+The main means in the Koma-Script document classes to design the type area
+ are the options
\family sans
-Corollary*
-\end_layout
-
-\begin_layout Itemize
-
+BCOR
+\family default
+ and
\family sans
-Proposition*
+DIV
+\family default
+ (in LyX to be entered in the extra class options field in the dialog
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+).
+ They make a clearer modification of page margins possible as do the options
+ of the dialog
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+.
+ A detailed German description of these and other type area options can
+ be found in the Koma-Script documentation
+\emph on
+scrguide
+\emph default
+.
\end_layout
\begin_layout Itemize
-
-\family sans
-Definition*
+The LaTeX document classes of the Koma-Script family define a number of
+ additional commands.
+ Those part of it which makes sense in LyX is implemented in corresponding
+ paragraph types.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
+A detailed German description of the LaTeX document classes of the Koma-Script
+ family can be found in the Koma-Script documentation
+\emph on
+scrguide
+\emph default
+.
+\begin_inset Foot
+status collapsed
-\backslash
-end{multicols}
+\begin_layout Plain Layout
+There is an English translation
+\emph on
+screnggu
+\emph default
+, but it is not a complete one.
\end_layout
\end_inset
-
+ The following sections describe only those aspects, which are relevant
+ in LyX.
\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:
+\begin_layout Subsection
+article (koma-script), report (koma-script), and book (koma-script)
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+The document classes
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+, and
+\emph on
+book
+\emph default
+
+\emph on
+(koma-script)
+\emph default
+ are implemented in the layout files
+\family typewriter
+scrartcl.layout
+\family default
+,
+\family typewriter
+scrreprt.layout
+\family default
+, and
+\family typewriter
+scrbook.layout
+\family default
+, resp.
+ They contain all the paragraph types of the corresponding standard document
+ classes
+\emph on
+article
+\emph default
+,
+\emph on
+report
+\emph default
+, and
+\emph on
+book
+\emph default
+, resp., partly modified, with the exception of the LyX specific
\family sans
-TickList
-\end_layout
-
-\begin_layout Itemize
-
+List
+\family default
+-type, which is replaced by the new
\family sans
-CrossList
-\end_layout
-
-\begin_layout Standard
-
+Labeling
+\family default
+-type having the same functionality.
+ Beside the
\family sans
-Foil
+Labeling
\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,
+-Type there is a number of new paragraph types added.
+ They are
\emph on
-i.e.
-
+not
\emph default
- straight after the foilhead.
-\end_layout
-
-\begin_layout Standard
-For this purpose, the following command styles are provided [
-\shape smallcaps
-Martin Vermeer
-\shape default
-]:
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
-\end_inset
-
-
+ part of
+\emph on
+letter (koma-script)
+\emph default
+.
\end_layout
\begin_layout Itemize
\family sans
-My\InsetSpace ~
-Logo
+Addpart, Addchap
+\family default
+,
+\family sans
+Addsec
+\family default
+: are equivalents to
+\family sans
+Part*, Chapter*
+\family default
+ and
+\family sans
+Section*
+\family default
+, resp., additionally inserting an entry in the table of contents.
+
+\family sans
+Addpart
+\family default
+ and
+\family sans
+Addchap
+\family default
+ are not contained in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
\begin_layout Itemize
\family sans
-Restriction
-\end_layout
+Addchap*
+\family default
+,
+\family sans
+Addsec*
+\family default
+: behave exactly as
+\family sans
+Addchap
+\family default
+ and
+\family sans
+Addsec
+\family default
+, resp., additionally clearing running heads.
+
+\family sans
+Addchap*
+\family default
+ is not contained in
+\emph on
+article (koma-script)
+\emph default
+.
+\begin_inset Foot
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+There is also an
+\family typewriter
+\backslash
+addpart*
+\family default
+ command in
+\emph on
+book (koma-script)
+\emph default
+ and in
+\emph on
+report (koma-script)
+\emph default
+, but since this is identical to
\family sans
-Right\InsetSpace ~
-Footer
+Part*
+\family default
+, is has not been implemented in LyX.
\end_layout
-\begin_layout Itemize
+\end_inset
+
-\family sans
-Right\InsetSpace ~
-Header
\end_layout
\begin_layout Itemize
\family sans
-Left\InsetSpace ~
-Header
+Minisec
+\family default
+: generates a heading directly above the following paragraph in the standard
+ character size without affecting the structure of the document.
\end_layout
-\begin_deeper
-\begin_layout Standard
-\InsetSpace ~
+\begin_layout Itemize
+\family sans
+Captionabove
+\family default
+ and
+\family sans
+Captionbelow
+\family default
+ are special captions which respect the different space settings needed
+ for captions placed above or below an element (if you follow strict typographic
+ rules, you might want to place table captions always above the table).
+ You can also use the class option
+\family typewriter
+tablecaptionsabove
+\family default
+, which will switch
+\family sans
+caption
+\family default
+ to
+\family sans
+captionabove
+\family default
+ for tables and
+\family sans
+captionbelow
+\family default
+ for figures.
+ You need at least Koma-Script version 2.8q to use this.
\end_layout
-\end_deeper
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
+\begin_layout Itemize
-\backslash
-end{multicols}
-\end_layout
+\family sans
+Dictum
+\family default
+: can be used to set a bonmot, e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
\end_inset
+at the beginning of a chapter.
+ If you use the optional argument (
+\family sans
+Insert\SpecialChar \menuseparator
+Short
+\begin_inset space ~
+\end_inset
+Title
+\family default
+), you can insert the dictum's author there.
+ Dictum and author are separated by a line.
+ You need at least Koma-Script version 2.8q to use this.
+
+\family sans
+Dictum
+\family default
+ is not contained in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
\begin_layout Standard
-There are also a few commands provided by
+The following types, together with the standard types
\family sans
-Foil
+Title
\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"
-
+,
+\family sans
+Author
+\family default
+, and
+\family sans
+Date
+\family default
+, form the title area of the document.
+ They must be entered ahead of the first
+\begin_inset Quotes eld
\end_inset
-.
-\end_layout
+ordinary
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-Building a Set of Foils
-\end_layout
+ paragraph.
+\begin_inset Foot
+status collapsed
-\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
+\begin_layout Plain Layout
+The corresponding LaTeX commands must appear before the
\family typewriter
-Foils.lyx
+
+\backslash
+maketitle
\family default
- file accessible from the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+ command.
+\end_layout
-\bar under
-O
-\bar default
-pen\SpecialChar \ldots{}
+\end_inset
+ When such a type is used more than once, the latter usage overwrites the
+ former one, that means, for every type only the latest usage is valid.
+ The order of the different types however has, like
+\family sans
+Title
\family default
- dialog under the
+,
\family sans
-Examples
+Author
\family default
- button.
-
+, and
+\family sans
+Date
+\family default
+, no effect on the appearance of the produced document.
\end_layout
-\begin_layout Subsubsection
-Give It a Title Page
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Unlike other classes that provide
+\family sans
+Subject
+\family default
+: produces a centered paragraph above the ordinary title (
\family sans
Title
\family default
\family sans
Date
\family default
- and
+) for the subject of the document.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Abstract
+Publishers
\family default
- environments,
+: produces a centered paragraph below the ordinary title (
\family sans
-foils
+Title
\family default
- creates the title on a page of its own.
- If you leave out the
+,
+\family sans
+Author
+\family default
+,
\family sans
Date
\family default
- environment LaTeX will substitute the current date (every time you regenerate
- the output).
+) for the publishers' name.
\end_layout
-\begin_layout Subsubsection
-Start a New Foil
-\end_layout
+\begin_layout Itemize
-\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.
-
-\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
-Landscape foils are generated using the
-\family sans
-Rotatefoilhead
+Dedication
\family default
+: in
+\emph on
+report (koma-script)
+\emph default
and
+\emph on
+book (koma-script)
+\emph default
+ produces a centered paragraph on its own page behind the title page, or
+ in
+\emph on
+article (koma-script)
+\emph default
+ produces a centered paragraph below the ordinary title (
\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
-One problem with the support for landscape foils is the requirement that
- you have to use the
-\family typewriter
-dvips
+Title
\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 sans
+Author
\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_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
+Date
\family default
- environment between the two with just a
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-%
+,
+\family sans
+Publishers
\family default
-
-\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
+) for a dedication.
\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
+Titlehead
\family default
- dialog described above in section\InsetSpace ~
-
-\begin_inset LatexCommand ref
-reference "sec:bullet"
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-The two new list styles,
+: produces a left aligned paragraph above the ordinary title (
\family sans
-TickList
+Title
\family default
- and
+,
\family sans
-CrossList
+Author
\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
+Date
\family default
- environment.
- They do however require that you have the
-\family typewriter
-psnfss
+,
+\family sans
+Subject
\family default
- packages installed.
-\end_layout
-
-\begin_layout Subsubsection
-Figures and Tables
+) for a document`s head.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-Foil
+Uppertitleback
\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 Subsubsection
-Page Headers and Footers
-\begin_inset LatexCommand label
-name "sec:foilfoot"
-
-\end_inset
-
-
+: produces in a double-sided print in
+\emph on
+report (koma-script)
+\emph default
+ and
+\emph on
+book (koma-script)
+\emph default
+ a left-aligned paragraph at the top of the title page`s back or has no
+ effect in a single-sided print or in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-My\InsetSpace ~
-Logo
+Lowertitleback
\family default
+: produces in a double-sided print in
+\emph on
+report (koma-script)
+\emph default
and
+\emph on
+book (koma-script)
+\emph default
+ a left-aligned paragraph at the bottom of the title page`s back or has
+ no effect in a single-sided print or in
+\emph on
+article (koma-script)
+\emph default
+.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Restriction
+Extratitle
\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
+: produces a special
\begin_inset Quotes eld
\end_inset
--Typeset by
-\family sans
-Foil
-\family default
-TeX-
+dirty
\begin_inset Quotes erd
\end_inset
-.
- 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.
+ page ahead of the actual document containing a paragraph without special
+ formatting.
\end_layout
\begin_layout Standard
-The remaining page corners can be filled by
-\family sans
-Right\InsetSpace ~
-Footer
-\family default
- (which defaults to page numbers),
-\family sans
-Right\InsetSpace ~
-Header
+The layout files for the document classes
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+, and
+\emph on
+book (koma-script)
+\emph default
+ do include the file
+\family typewriter
+scrmacros.inc
\family default
- (top right) and
-\family sans
-Left\InsetSpace ~
-Header
+.
+ This is thought of as a place to define your own types.
+ Copy scrmacros
+\family typewriter
+.inc
\family default
- (top left).
+ in your personal layout directory and edit the file!
\end_layout
\begin_layout Subsection
-Unsupported
-\family sans
-Foil
-\family default
-TeX Goodies
-\begin_inset LatexCommand label
-name "sec:unsuppfoils"
+letter (koma-script)
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+begin{sloppypar}
+\end_layout
\end_inset
\end_layout
\begin_layout Standard
-All the commands mentioned below need to be set in a
-\family sans
-LaTeX
-\family default
- environment or as
-\family sans
-TeX
-\family default
- within another environment.
-\end_layout
-
-\begin_layout Subsubsection
-Lengths
-\end_layout
-
-\begin_layout Standard
-All lengths are adjusted using the
-\family typewriter
-
-\backslash
-setlength{
-\family default
+\noindent
+The document class
\emph on
-lengthname
-\family typewriter
+letter (koma-script)
\emph default
-}{
-\family default
-\emph on
-newlength
+ is implemented in the layout file
\family typewriter
-\emph default
-}
+scrlettr.layout
\family default
- command.
- Where
-\emph on
-lengthname
-\emph default
- should be replaced by the name given to the length you want to change and
-
+.
+ It contains all the paragraph types of the corresponding standard document
+ class
\emph on
-newlength
+letter
\emph default
- is the length value.
- All lengths should be specified in units of length such as inches (
-\family typewriter
-in
+, partly modified, with the exception of the LyX specific types
+\family sans
+LyX-Code
\family default
-), millimeters (
-\family typewriter
-mm
+ and
+\family sans
+Comment
\family default
-) or points (
-\family typewriter
-pt
+ and the
+\family sans
+List
\family default
-) or relative to some document or font-based length such as
-\family typewriter
-
-\backslash
-textwidth
+ type, which is replaced by the new
+\family sans
+Labeling
\family default
-.
-
-\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
+ type.
+ In addition, it contains, in contrast to the standard document class, the
+ standard types
+\family sans
+LaTeX
+\family default
+,
+\family sans
+Quotation
+\family default
+,
+\family sans
+Quote
+\family default
+, and
+\family sans
+Verse
\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
-
-\backslash
-setlength{
-\backslash
-foilheadskip}{-0.5in}
+ Furthermore, there are a number of new letter specific types.
\end_layout
\begin_layout Standard
-The spacings around floats can be adjusted by setting these lengths:
-\end_layout
+\begin_inset ERT
+status open
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Plain Layout
-\family typewriter
\backslash
-abovefloatskip
-\family default
- Separation between the text and the top of the float
+end{sloppypar}
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\end_inset
-\family typewriter
-\backslash
-abovecaptionskip
-\family default
- Separation between the float and the caption
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Standard
+The appearance of the letter produced by this document class can be controlled
+ by a number of LaTeX commands, which you can put in the LaTeX preamble.
+\begin_inset Foot
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+For example, the standard appearance of the letter`s heading, consisting
+ of name and address, is quite self-willed.
+ An
+\begin_inset Quotes eld
+\end_inset
-\backslash
-belowcaptionskip
-\family default
- Separation between the caption and the following text
-\end_layout
+ordinary
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+ heading is produced by the following LaTeX commands in the preamble:
+\end_layout
-\family typewriter
+\begin_layout LyX-Code
\backslash
-captionwidth
-\family default
- You can make the captions narrower than the surrounding text by adjusting
- this length.
- Best done relative to
-\family typewriter
-
+firsthead{
\backslash
-textwidth
-\family default
-.
+parbox[b]{
+\backslash
+textwidth}
\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:
+\begin_layout LyX-Code
+ {
+\backslash
+ignorespaces
+\backslash
+fromname
+\backslash
+
+\backslash
+
+\backslash
+ignorespaces
+\backslash
+fromaddress}}
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\begin_layout LyX-Code
-\family typewriter
+\backslash
+nexthead{
+\backslash
+parbox[b]{
+\backslash
+textwidth}
+\end_layout
+\begin_layout LyX-Code
+ {
\backslash
-abovetitleskip
-\family default
- Separation from headers to
-\family sans
-Title
+ignorespaces
+\backslash
+fromname
+\backslash
+hfill
+\backslash
+ignorespaces
+\backslash
+pagename
+\backslash
+
+\backslash
+thepage}}
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
+\end_inset
-\family typewriter
+ A detailed German description of such LaTeX commands can be found in the
+ Koma-Script documentation
+\emph on
+scrguide
+\emph default
+.
+ With it, the letter's author can produce his personal letter layout.
+\end_layout
-\backslash
-titleauthorskip
-\family default
- between
+\begin_layout Standard
+The types
\family sans
-Title
+Letter
\family default
and
\family sans
-Author
+Opening
\family default
- environments
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+ define the beginning of the letter and must be used in every letter.
+ To emphasize them in the LyX document class, they are marked with the letter
+
+\shape italic
+L
+\shape default
+ or
+\shape italic
+O
+\shape default
+, resp.
+\begin_inset space ~
+\end_inset
-\backslash
-authorauthorskip
+in the left margin.
+ It is possible to write any number of letters in one file.
+ An
+\family sans
+Opening
\family default
- between multiple
+ type produces a new letter using the same addressee and a
\family sans
-Author
+Letter
\family default
- lines
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
-
-\backslash
-authordateskip
+ type produces a new addressee.
+ The types
+\family sans
+Closing
\family default
- between the
+,
\family sans
-Author
+PS
\family default
- and the
+,
\family sans
-Date
+CC
+\family default
+, and
+\family sans
+Encl
+\family default
+ are ordinary paragraph types and can also be used several times in one
+ and the same letter.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-dateabstractskip
-\family default
- between the
\family sans
-Date
+Letter
\family default
- and the
+: produces a paragraph for the addressee and implicitly defines the beginning
+ of the letter.
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Abstract
+Opening
+\family default
+: produces a paragraph for the form of address and implicitly produces a
+ new letter.
\end_layout
-\begin_layout Standard
-The last length related command affects all the list environments.
- If you place
-\family typewriter
+\begin_layout Itemize
-\backslash
-zerolistvertdimens
+\family sans
+Closing
\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
+: produces a paragraph for a close.
+\end_layout
-\backslash
-setlength
+\begin_layout Itemize
+
+\family sans
+PS
\family default
- like the stuff mentioned above.
+: produces a paragraph for a postscript.
\end_layout
-\begin_layout Subsubsection
-Headers and Footers
+\begin_layout Itemize
+
+\family sans
+CC
+\family default
+: produces a paragraph for a distribution list.
\end_layout
-\begin_layout Standard
-The
-\family typewriter
+\begin_layout Itemize
-\backslash
-LogoOn
+\family sans
+Encl
\family default
- and
-\family typewriter
+: produces a paragraph for enclosures.
+\end_layout
-\backslash
-LogoOff
+\begin_layout Standard
+The types
+\family sans
+Name
\family default
- commands control whether the logo in the
+,
\family sans
-MyLogo
+Signature
\family default
- definition appear on a given page.
- If you put
-\family typewriter
-
-\backslash
-LogoOff
+,
+\family sans
+Address
\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
-
-\backslash
-LogoOff
+,
+\family sans
+Telephone
\family default
- directly after the foilhead of that page and the
-\family typewriter
-
-\backslash
-LogoOn
+,
+\family sans
+Place
\family default
- directly after the next foilhead.
-\end_layout
-
-\begin_layout Standard
-If you decide to use the
+,
\family sans
-fancy
+Backaddress
\family default
- page style setting in the
+,
\family sans
-Document\InsetSpace ~
-Layout
+Specialmail
\family default
- dialog you should probably add
-\family typewriter
-
-\backslash
-let
-\backslash
-headwidth
-\backslash
-textwidth
+,
+\family sans
+Location
\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
+Title
\family default
- package and the
+, and
\family sans
-foils
+Subject
\family default
- class.
-\end_layout
+ are input types provided with a label to enter information, which will
+ be processed by the document class.
+\begin_inset Foot
+status open
-\begin_layout Section
-Latex8 (IEEE Conference Papers)
+\begin_layout Plain Layout
+It could be seen as a matter of inconsequence, that the types
+\family sans
+Letter
+\family default
+ and
+\family sans
+Opening
+\family default
+ described above are not such input types as well.
+ Because of the special meaning of those types, however, I have implemented
+ them as ordinary paragraph types with a one letter mark in the left margin.
+ Moreover, it would affect my feeling of symmetry, if the
+\family sans
+Opening
+\family default
+ type and the
+\family sans
+Closing
+\family default
+ type had such a serious different appearance.
\end_layout
-\begin_layout Standard
-by
-\noun on
-Allan Rae
-\end_layout
+\end_inset
-\begin_layout Subsection
-Introduction
+ The types must be used ahead of the corresponding
+\family sans
+Opening
+\family default
+ type.
\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
+An implementation of these types in a WYSIWYG fashion does not seem to make
+ sense, because the real appearance of the produced letter does not only
+ depend on the usage of the particular type, but also on other factors.
+ For example, a signature entered in the
\family sans
-latex.sty
+Signature
\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
+ type will in the standard behavior appear in the produced letter only,
+ when in the same letter also a
+\family sans
+Closing
+\family default
+ type is used.
+ The entered value of the
+\family sans
+Telephone
+\family default
+ type will in the standard behavior not appear in the produced letter at
+ all.
+ The possibility to design the letter`s heading freely is already indicated
+ in a footnote above.
\end_layout
\begin_layout Standard
-[AR\SpecialChar \@.
- more to come]
-\end_layout
+The input types can also be used as empty paragraphs.
+ This makes sense e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
-Supported Environments
-\end_layout
-
-\begin_layout Itemize
+g.
+\begin_inset space \space{}
+\end_inset
+for the
\family sans
-Standard
-\end_layout
-
-\begin_layout Itemize
-
+Signature
+\family default
+ type.
+ If the
\family sans
-Title
+Signature
+\family default
+ type is not used at all, in the standard behavior the value of the
+\family sans
+Name
+\family default
+ type is used as signature, whereas if an empty
+\family sans
+Signature
+\family default
+ type is used, no signature value is defined.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Author
+\begin_layout Standard
+By using the input types it is possible to write a letter template, containing
+ filled input types with your personal dates (name, address, etc.) and empty
+ input types for other dates you want to enter.
\end_layout
\begin_layout Itemize
\family sans
-E-mail
+Name
+\family default
+: sender's name, in the standard behavior appears as a centered paragraph
+ in small caps in the letter`s heading.
\end_layout
\begin_layout Itemize
\family sans
-Affiliation
+Signature
+\family default
+: sender's signature, in the standard behavior appears below the
+\family sans
+Closing
+\family default
+ type.
+ If no
+\family sans
+Signature
+\family default
+ type is used, the value of the
+\family sans
+Name
+\family default
+ type appears instead.
\end_layout
\begin_layout Itemize
\family sans
-Abstract
+Address
+\family default
+: sender's address, in the standard behavior appears in a centered paragraph
+ in the letter`s heading below the sender's name.
\end_layout
\begin_layout Itemize
\family sans
-Section
+Telephone
+\family default
+: sender's telephone number, in the standard behavior only sets the LaTeX
+ variable
+\family typewriter
+
+\backslash
+telephonenum
+\family default
+.
\end_layout
\begin_layout Itemize
\family sans
-SubSection
+Place
+\family default
+: place of the letter`s making.
\end_layout
\begin_layout Itemize
\family sans
-Caption
-\end_layout
-
-\begin_layout Subsection
-Differences Between Screen and Paper
-\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)
-\end_layout
-
-\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-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
-Speakers' lines should NEVER break in mid-sentence.
- If a speaker's lines continue over a page break, repeat the
+Date
+\family default
+: date of the letter`s making.
+
\family sans
-Speaker
+Place
\family default
- title followed by (Cont'd).
-\end_layout
-
-\begin_layout Subsection
-Special features
-\end_layout
-
-\begin_layout Standard
-Insert the
+ and
\family sans
-Speaker
+Date
\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.
-\end_layout
-
-\begin_layout Subsection
-Paper size and Margins
-\end_layout
-
-\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
-
-\begin_layout Subsection
-Environments
-\end_layout
-
-\begin_layout Standard
-The following environments are available.
- You can use hollywood.bind to get the bind keys shown at the right.
-\end_layout
-
-\begin_layout Itemize
-
+, in the standard behavior, produce the place and the date in a right-aligned
+ line below the addressee's field.
+ If an empty
\family sans
-Standard
-\newline
-
+Date
\family default
-Used where nothing else works.
- Try to avoid it.
-\end_layout
-
-\begin_layout Itemize
-
+ type is used, neither place nor date appear, independent of the value of
+ the
\family sans
-FADE_IN
+Place
\family default
-:
-\hfill
-
+ type.
+ If no
\family sans
-M-z S-I
+Date
\family default
-
-\newline
-Usually followed by something like
-\begin_inset Quotes eld
-\end_inset
-
-on Sally waking up.
-\begin_inset Quotes erd
-\end_inset
-
-
+ type is used, the date of the letter `s production is used.
\end_layout
\begin_layout Itemize
\family sans
-INT:
-\hfill
-M-z i
-\newline
-
+Backaddress
\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.
+: sender`s back address, in the standard behavior appears above the addressee's
+ field in a small sans serif font.
\end_layout
\begin_layout Itemize
\family sans
-EXT:
-\hfill
-M-z e
-\newline
-
+Specialmail
\family default
-Introduces a new EXTERIOR camera set-up.
- Everthing on this line in CAPS.
+: special mail information, in the standard behavior appears underlined
+ above the addressee's field below the back address.
\end_layout
\begin_layout Itemize
\family sans
-Speaker
-\hfill
-M-z s
-\newline
-
+Location
\family default
-The character speaking.
+: additional information, in the standard behavior appears on right side
+ below the addressee`s field.
\end_layout
\begin_layout Itemize
\family sans
-Parenthetical
-\hfill
-M-z p
-\newline
-
+Title
\family default
-Instructions to the speaker.
- The () are automatically inserted, but only the ( will show in LyX.
- Both will be printed.
+: the letter's title, in the standard behavior appears in a big, bold, sans
+ serif font above the subject.
\end_layout
\begin_layout Itemize
\family sans
-Dialogue
-\hfill
-M-z d
-\newline
-
+Subject
\family default
-What the
+: the letter's subject, in the standard behavior appears in a bold font
+ above the
\family sans
-Speaker
+Opening
\family default
- says.
+ paragraph.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+The types
\family sans
-Transition
-\hfill
-M-z t
-\newline
-
+Yourref
\family default
-Camera movement instruction.
- e.\InsetSpace \thinspace{}
-g.\InsetSpace ~
-CUT TO:
-\end_layout
-
-\begin_layout Itemize
-
+,
\family sans
-FADE OUT:
-\hfill
-M-z S-I
-\end_layout
-
-\begin_layout Itemize
-
+Yourmail
+\family default
+,
\family sans
-Author
-\hfill
-M-z S-A
-\end_layout
-
-\begin_layout Itemize
-
+Myref
+\family default
+,
\family sans
-Title
-\hfill
-M-z S-T
-\end_layout
-
-\begin_layout Itemize
-
+Customer
+\family default
+, and
\family sans
-Right_Address
-\hfill
-M-z r
-\end_layout
-
-\begin_layout Subsection
-Script jargon
-\end_layout
-
-\begin_layout Itemize
-(O.S) --- off screen
-\end_layout
-
-\begin_layout Itemize
-(V.0) --- voice over
-\end_layout
+Invoice
+\family default
+ produce a business letter like line above the
+\family sans
+Title
+\family default
+ line containing the fields
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-b.g.
- --- background
-\end_layout
+Your ref.
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-C.U.
- --- close-up
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-PAN --- camera movement
-\end_layout
+Your letter of
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-INSERT --- cut to close-up of
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Section
-Broadway
-\end_layout
+Our ref.
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Introduction
-\end_layout
+Customer no.
+\begin_inset Quotes erd
+\end_inset
-\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
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Special problems
-\end_layout
+Invoice no.
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-The same as in Hollywood.
-\end_layout
+, and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Special features
-\end_layout
+Date
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-Insert the
+.
+ For the date field, the value of the
\family sans
-Speaker
+Date
\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.
-\end_layout
-
-\begin_layout Subsection
-Paper size and Margins
-\end_layout
-
-\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
-
-\begin_layout Subsection
-Environments
-\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
+ type is used.
+ If one of these
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+business letter types
+\begin_inset Quotes erd
+\end_inset
+ is used, the value of the
\family sans
-Standard
-\newline
+Place
+\family default
+ type however does not appear, but only the LaTeX variable
+\family typewriter
+\backslash
+fromplace
\family default
-You should not have to use this, but it is here for anything that does not
- fit otherwise.
+ is set.
+ The ordinary output of place and date in a right-aligned line below the
+ addressee`s field is suppressed.
+ The types are implemented as input types provided with a label and must
+ be used ahead of the corresponding
+\family sans
+Opening
+\family default
+ type.
\end_layout
\begin_layout Itemize
\family sans
-Narrative
-\hfill
-M-z n
-\newline
-
+Yourref
\family default
-Used to describe stage setting and the action.
- First use of speaker names in all CAPs.
+: Your ref.
\end_layout
\begin_layout Itemize
\family sans
-ACT
-\hfill
-M-z a
-\newline
-
+Yourmail
\family default
-Automatically numbered.
- On screen it will be arabic, but will print as Roman.
+: Your letter of.
\end_layout
\begin_layout Itemize
\family sans
-ACT*
-\hfill
-M-z S at
-\newline
-
-\family default
-Subtitle for
-\family sans
-ACT.
-
+Myref
\family default
- It is just centered text.
+: Our ref.
\end_layout
\begin_layout Itemize
\family sans
-SCENE
-\hfill
-M-z S-S
-\newline
-
+Customer
\family default
-Not automatically numbered.
- You supply the number.
- This is because I couldn't figure out how.
+: Customer no.
\end_layout
\begin_layout Itemize
\family sans
-AT_RISE:
-\hfill
-M-z S-R
-\newline
-
+Invoice
\family default
-A special case of Narrative to describe the setting and action as the curtain
- rises.
+: Invoice no.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Speaker
-\hfill
-M-z s
-\newline
+\begin_layout Subsection
+The new letter class: letter (koma-script v.2)
+\end_layout
-\family default
-The speaker's (actor's) title, centered in all CAPS.
+\begin_layout Standard
+by
+\noun on
+Jürgen Spitzmüller
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\family sans
-Parenthetical
-\hfill
-M-z p
-\newline
+\end_layout
+
+\begin_layout Standard
+\noindent
+Koma-Script version 2.8 has introduced a new letter class
+\family typewriter
+scrlttr2
\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
+ which supersedes the now unsupported
+\family typewriter
+scrlettr
\family default
.
+ It has — on the LaTeX side — a completely new interface and is not compatible
+ with the old class.
+ Therefore, LyX supports both, though it is recommended to use the new class.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+This class covers the same functionality as
+\emph on
+letter (koma-script),
+\emph default
+ and a few more.
+ The basic items are
\family sans
-Dialogue
-\hfill
-M-z d
-\newline
-
+Address
\family default
-What the Speaker says.
-\end_layout
-
-\begin_layout Itemize
-
+ (receiver's address, same as
\family sans
-CURTAIN
-\hfill
-M-z S-C
-\newline
-
+Letter
\family default
-The curtain comes down.
-\end_layout
-
-\begin_layout Itemize
-
+ in the old layout),
\family sans
-Title
-\hfill
-M-z S-T
-\end_layout
-
-\begin_layout Itemize
-
+Opening
+\family default
+, and
\family sans
-Author
-\hfill
-M-z S-A
-\end_layout
-
-\begin_layout Itemize
-
+Closing
+\family default
+.
+
\family sans
-Right_Address
-\hfill
-M-z r
-\end_layout
-
-\begin_layout Standard
-Hello there.
-\end_layout
-
-\begin_layout Section
-RevTeX4
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Amir Karger
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace bigskip
+NextAddress
+\family default
+ will start a new letter (i.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
-
-\begin_layout Standard
-\noindent
-The
+you can write several letters per document).
+ New elements are sender's
\family sans
-Revtex\InsetSpace ~
-4
+E-Mail
\family default
- textclass works with the American Physical Sociey's RevTeX 4.0 (the
-\begin_inset Formula $\beta$
-\end_inset
-
- release of May, 1999) class.
+,
+\family sans
+URL
+\family default
+,
+\family sans
+Fax
+\family default
+,
+\family sans
+Bank
+\family default
+ and the possibility to use a
+\family sans
+Logo
+\family default
+ (via
+\family sans
+Insert\SpecialChar \menuseparator
+Graphics
+\family default
+) in the header.
\end_layout
\begin_layout Standard
-LyX has a
-\family sans
-Revtex
+The biggest improvement is, though, that the letter's layout is configurable
+ at almost any needs.
+ This can be done via the preamble or with a special style file (Letter
+ Class Option, extension
+\family typewriter
+*.lco
\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
+), that will be read in as a class option.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The KOMA package comes with some default
+\family typewriter
+*.lco
+\family default
+ files.
+ There is, for instance, a
+\family typewriter
+DIN.lco
+\family default
+ file that follows german typesetting rules, or a
+\family typewriter
+KOMAold.lco
+\family default
+ that provides the default layout of the old
+\family typewriter
+scrlettr
+\family default
+ class.
+ The latter can be loaded with the class option
+\family typewriter
+KOMAold
+\family default
+, inserted via the
\family sans
-RevTeX\InsetSpace ~
-4
+\bar under
+L
+\bar default
+ayout\SpecialChar \menuseparator
+
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
+Extra Options
\family default
- textclass should also be pretty easy to use.
+ field.
\end_layout
-\begin_layout Standard
-These documents are supposed to be used in
+\end_inset
+
+ Have a look at the
\emph on
-addition
+koma-letter2
\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.
+ template that is included in LyX for examples.
+ A detailed description is to be found in the Koma-Script documentation
+ (
+\emph on
+scrguide
+\emph default
+).
\end_layout
\begin_layout Subsection
-Installation
+Problems
\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.
+Visualizing the Koma-Script document classes in LyX, the LyX internals cause
+ some problems.
\end_layout
-\begin_layout Standard
-Probably the easiest way to get started is either to import a RevTeX 4 document
- using
-\family typewriter
-tex2lyx
+\begin_layout Itemize
+The chapter number of a
+\family sans
+Chapter
\family default
-, or to use the
+ type appears on a line of its own above the chapter heading instead of
+ appearing in the same line ahead of it.
+ The cause for that is the LyX internal behavior for the labeltype
\family sans
-Revtex\InsetSpace ~
-4
+Counter_Chapter
\family default
- template, found in the templates directory.
-\end_layout
-
-\begin_layout Subsection
-Preamble Matter
+ in the layout file.
\end_layout
-\begin_layout Standard
-Optional arguments to
-\family typewriter
-
-\backslash
-documentclass
+\begin_layout Itemize
+The headings of the types
+\family sans
+Addchap
\family default
-, like
+ and
+\family sans
+Addsec
+\family default
+ are only put in the
\begin_inset Quotes eld
\end_inset
-preprint
+true
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
+ LaTeX table of contents, but not in the LyX table of contents (
+\family sans
+Document\SpecialChar \menuseparator
+Table
+\begin_inset space ~
\end_inset
-aps
-\begin_inset Quotes erd
+of
+\begin_inset space ~
\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
+Contents
\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
-draft
+\begin_layout Itemize
+The paragraphs in a
+\emph on
+letter
+\emph default
+ document class appear in a skip separation mode, not indented.
+ This is the standard behavior, no special LaTeX commands are needed for
+ that.
+ But in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
\family default
- etc.\InsetSpace ~
-goes in the
+ dialog the corresponding radio button indicates
\family sans
-La
+Indent
\family default
-T
+.
+ A
\family sans
-eX\InsetSpace ~
-Preamble
+Skip
\family default
- dialog, also as usual.
+ value always has the effect that extra LaTeX commands are inserted in the
+ document to produce the gap, which is not what is wanted in this case.
\end_layout
-\begin_layout Subsection
-Layouts
+\begin_layout Section
+Latex8 (IEEE Conference Papers)
\end_layout
\begin_layout Standard
-The layouts basically correspond to the commands in RevTeX4.0.
- For example, the Email layout corresponds to
-\family typewriter
+by
+\noun on
+Allan Rae
+\end_layout
-\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 Subsection
+Introduction
+\end_layout
\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
+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
-.
-\end_layout
-
-\end_inset
-
-
+ 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
-Important Notes
+Getting Started
\end_layout
\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.
+[AR\SpecialChar \@.
+ more to come]
\end_layout
-\begin_layout Standard
-In RevTeX, the
-\family typewriter
+\begin_layout Subsection
+Supported Environments
+\end_layout
-\backslash
-thanks
-\family default
- command goes
-\emph on
-outside
-\emph default
- the
-\family typewriter
+\begin_layout Itemize
-\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
\family sans
-Author
-\family default
- layout, or weird things may happen.
- See the RevTeX 4 documentation for more details.
+Standard
\end_layout
-\begin_layout Standard
-Also, the
-\family sans
-Author\InsetSpace ~
-Email
-\family default
-,
-\family sans
-Author\InsetSpace ~
-URL
-\family default
-, and
+\begin_layout Itemize
+
\family sans
-Thanks
-\family default
- layouts must be placed
-\emph on
-in between
-\emph default
- the
+Title
+\end_layout
+
+\begin_layout Itemize
+
\family sans
Author
-\family default
- layout and the corresponding
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Address
-\family default
- (or equivalent
+E-mail
+\end_layout
+
+\begin_layout Itemize
+
\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 Subsection
-Drawbacks
-\end_layout
+\begin_layout Itemize
-\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
+\family sans
+Abstract
+\end_layout
-\backslash
-altaffiliation
-\family default
- (and the equivalent
-\family typewriter
+\begin_layout Itemize
-\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
+\family sans
+Section
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-\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.
+\family sans
+SubSection
\end_layout
-\end_inset
+\begin_layout Itemize
-
+\family sans
+Caption
\end_layout
-\begin_layout Section
-Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
-status collapsed
+\begin_layout Subsection
+Differences Between Screen and Paper
+\end_layout
\begin_layout Standard
-The
-\family typewriter
-mw
-\family default
- Classes
+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
-\end_inset
+\begin_layout Section
+Memoir
+\end_layout
+\begin_layout Standard
+By
+\noun on
+Jürgen Spitzmüller
+\end_layout
+\begin_layout Subsection
+Overview
\end_layout
\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
-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.
-
-\end_layout
-
-\begin_layout Standard
-Basic differences:
-\end_layout
-
-\begin_layout Itemize
-Unnumbered titles (with star, eg.
-
-\family sans
-Section*
-\family default
-) are added into table of contents,
-\end_layout
-
-\begin_layout Itemize
-Additional page styles:
-\end_layout
-
-\begin_deeper
-\begin_layout Description
-uheadings header with separated lines,
-\end_layout
-
-\begin_layout Description
-myheadings custom header, contents headers via commands:
-\family typewriter
-
-\backslash
-markright
-\family default
- and
-\family typewriter
-
-\backslash
-markboth
-\family default
-,
-\end_layout
-
-\begin_layout Description
-myuheadings custom header with separated lines,
-\end_layout
-
-\begin_layout Description
-outer page number is placed on outer side of page
-\end_layout
-
-\end_deeper
-\begin_layout Itemize
-Options
-\end_layout
-
-\begin_deeper
-\begin_layout Description
-rmheadings serif titles --- default,
-\end_layout
-
-\begin_layout Description
-sfheadings sansserif titles,
-\end_layout
-
-\begin_layout Description
-authortitle on title page first placed is author next title --- default,
-\end_layout
-
-\begin_layout Description
-titleauthor on title page first placed is title next author,
-\end_layout
-
-\begin_layout Description
-withmarginpar reserve place on page for margins.
-\end_layout
-
-\end_deeper
-\begin_layout Section
-Elsevier Journals
-\end_layout
-
-\begin_layout Standard
-By
-\noun on
-Rod Pinna
-\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 LatexCommand url
-target "http://authors.elsevier.com/"
-
-\end_inset
-
-.
- 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 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
-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
-
-clean
-\begin_inset Quotes erd
-\end_inset
-
- a
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-LaTeX
-\end_layout
-
-\end_inset
-
- 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
-Memoir
-\end_layout
-
-\begin_layout Standard
-By
-\noun on
-Jürgen Spitzmüller
-\end_layout
-
-\begin_layout Subsection
-Overview
-\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).
+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
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
You are invited to send suggestions to
-\begin_inset LatexCommand url
-target "lyx-devel@lists.lyx.org"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+lyx-devel@lists.lyx.org
+\end_layout
\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
+ commands (TeX code
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Cf.
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\end_inset
-section\InsetSpace ~
+section
+\begin_inset space ~
+\end_inset
+
-\begin_inset LatexCommand ref
-reference "sec:Inserting-LaTeX-Code"
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
\end_inset
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Cf.
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\end_inset
-\begin_inset LatexCommand url
-target "CTAN:/macros/latex/memoir/memman.pdf"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+CTAN:/macros/latex/memoir/memman.pdf
+\end_layout
\end_inset
\end_layout
\begin_layout Description
-Font\InsetSpace ~
-sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
- 17
+Font
+\begin_inset space ~
+\end_inset
+
+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).
+Page
+\begin_inset space ~
+\end_inset
+
+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 ~
+Page
+\begin_inset space ~
+\end_inset
+
Style
\family default
).
chapterstyle
\family default
in the main text or in preamble (e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-,
-\end_layout
-
+\begin_inset space \thinspace{}
\end_inset
g.
-\begin_inset ERT
-status collapsed
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-
-\backslash
-
-\end_layout
-
-\end_inset
-
-
-\family typewriter
+\family typewriter
\backslash
chapterstyle{companion}
In LyX, you can do this via
\family sans
Insert\SpecialChar \menuseparator
-Short\InsetSpace ~
+Short
+\begin_inset space ~
+\end_inset
+
Title
\family default
at the beginning of a chapter/section.
\end_inset
, i.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-,
-\end_layout
-
+\begin_inset space \thinspace{}
\end_inset
-e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-
-\end_layout
-
+g.
+\begin_inset space \space{}
\end_inset
without pagina).
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
-Extra\InsetSpace ~
+Extra
+\begin_inset space ~
+\end_inset
+
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
-
+ new chapters, chapters don't start a new page (but are—in contrary to
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- article classes---still allowed), parts, though, use their own page, as
- in book.
+ 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
-
-
-\backslash
-,
-\end_layout
-
+\begin_inset space \thinspace{}
\end_inset
g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-
-\end_layout
-
+\begin_inset space \space{}
\end_inset
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Cf.
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\end_inset
-\begin_inset LatexCommand url
-target "CTAN:/macros/latex/memoir/memman.pdf"
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+CTAN:/macros/latex/memoir/memman.pdf
+\end_layout
\end_inset
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
-
-
-\backslash
-,
-\end_layout
-
+\begin_inset space \thinspace{}
\end_inset
g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-
-\backslash
-
-\end_layout
-
+\begin_inset space \space{}
\end_inset
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).
+ Memoir has some enhanced versions of verse, but you need to use TeX code,
+ 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_layout Section
+Article (mwart), book (mwbk) and report (mwrep)
\begin_inset OptArg
status collapsed
-\begin_layout Standard
-Importing and Exporting
+\begin_layout Plain Layout
+The
+\family typewriter
+mw
+\family default
+ Classes
\end_layout
\end_inset
\end_layout
-\begin_layout Section
-Considerations
+\begin_layout Standard
+by
+\noun on
+Tomasz Luczak
\end_layout
\begin_layout Standard
-Importing and exporting LyX documents from/to other formats has been touched
- on briefly in the
+The LyX document classes
\emph on
-User Guide
+article (mwart)
\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
+,
+\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 sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-E
-\bar under
-x
-\bar default
-port
+\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
- menu items.
+, resp., and fit better to Polish typography conventions in a number of points.
\end_layout
-\begin_layout Section
-Importing Other Formats
+\begin_layout Standard
+Basic differences:
\end_layout
-\begin_layout Subsection
-LaTeX
-\end_layout
+\begin_layout Itemize
+Unnumbered titles (with star, e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-Translating from LaTeX into LyX is performed by a converter program called
-
-\family typewriter
-tex2lyx
-\family default
-.
- 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 ~
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_inset LatexCommand ref
-reference "sec:Translating-LaTeX-files"
-\end_inset
+\family sans
+Section*
+\family default
+) are added into table of contents,
+\end_layout
- for a complete description.
+\begin_layout Itemize
+Additional page styles:
\end_layout
-\begin_layout Subsection
-ASCII Text
+\begin_deeper
+\begin_layout Description
+uheadings header with separated lines,
\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
+\begin_layout Description
+myheadings custom header, contents headers via commands:
+\family typewriter
-as lines
-\begin_inset Quotes erd
-\end_inset
+\backslash
+markright
+\family default
+ and
+\family typewriter
- preserves all the linebreaks in the ASCII; to LyX, then, each line looks
- like a paragraph.
- Importing
-\begin_inset Quotes eld
-\end_inset
+\backslash
+markboth
+\family default
+,
+\end_layout
-as paragraphs
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Description
+myuheadings custom header with separated lines,
+\end_layout
- 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.
+\begin_layout Description
+outer page number is placed on outer side of page
\end_layout
-\begin_layout Subsection
-Noweb
+\end_deeper
+\begin_layout Itemize
+Options
\end_layout
-\begin_layout Standard
+\begin_deeper
+\begin_layout Description
+rmheadings serif titles — default,
+\end_layout
-\emph on
-[Editor's note: Needs to be written, obviously - any volunteers? --- mer]
+\begin_layout Description
+sfheadings sansserif titles,
\end_layout
-\begin_layout Section
-Exporting Other Formats
+\begin_layout Description
+authortitle on title page first placed is author next title — default,
\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.
+\begin_layout Description
+titleauthor on title page first placed is title next author,
\end_layout
-\begin_layout Subsection
-LaTeX
+\begin_layout Description
+withmarginpar reserve place on page for margins.
+\end_layout
+
+\end_deeper
+\begin_layout Section
+Paper
\end_layout
\begin_layout Standard
-LyX generates two types of LaTeX files: stripped down versions for the normal
- processing (
+The document class
\family sans
-View DVI
+paper
\family default
-, etc.) which one normally never sees
-\begin_inset Foot
-status collapsed
+ 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
+RevTeX4
+\end_layout
\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.
+by
+\noun on
+Amir Karger
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\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
-
-\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 Subsection
-Device Independent Files
-\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
-\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
+\noindent
+The
\family sans
-\bar under
-F
-\bar default
-ile
-\family default
-\SpecialChar \menuseparator
+Revtex
+\begin_inset space ~
+\end_inset
-\family sans
-\bar under
-E
-\bar default
-xport
+4
\family default
-\SpecialChar \menuseparator
+ textclass works with the American Physical Sociey's RevTeX 4.0 (the
+\begin_inset Formula $\beta$
+\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
+ release of May, 1999) class.
+\end_layout
+\begin_layout Standard
+LyX has a
\family sans
-\bar under
-P
-\bar default
-rint
+Revtex
\family default
-.
- If you use the later, note that it is possible to configure, in
+ 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
-\bar under
-T
-\bar default
-ools
-\family default
-\SpecialChar \menuseparator
+RevTeX
+\begin_inset space ~
+\end_inset
-\family sans
-\bar under
-P
-\bar default
-references
+4
\family default
-, the options passed to the dvips program to achieve different effects.
-\end_layout
-
-\begin_layout Subsection
-ASCII text
+ textclass should also be pretty easy to use.
\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
-
- 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.
+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
\begin_layout Subsection
-HTML
+Installation
\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
+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
-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
+\begin_layout Plain Layout
-\begin_layout Subsection
-PDF
+http://publish.aps.org/revtex4/
\end_layout
-\begin_layout Standard
-by
-\noun on
-Dekel Tsur
-\noun default
- (mostly)
-\end_layout
+\end_inset
-\begin_layout Standard
-\begin_inset VSpace bigskip
+.
+ Install it somewhere that LaTeX can see it.
+ Test it by trying to LaTeX a short RevTeX 4 document in some random directory
+ (i.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
+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
\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
+Probably the easiest way to get started is either to import a RevTeX 4 document
+ using
\family typewriter
-ps2pdf
+tex2lyx
\family default
- command on it.
- Starting with version 1.1.6, the menu item
+, or to use the
\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 LatexCommand ref
-reference "sec:badfonts"
-
+Revtex
+\begin_inset space ~
\end_inset
-.
- Also, as of version 1.1.6, there is a better method that will generate much
- more sophisticated files.
+4
+\family default
+ template, found in the templates directory.
\end_layout
-\begin_layout Subsubsection
-Use pdfLaTeX
+\begin_layout Subsection
+Preamble Matter
\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.
-\end_layout
-
-\begin_layout Subsubsection
-Why does the text look so bad when viewed with Acrobat Reader?
-\begin_inset LatexCommand label
-name "sec:badfonts"
+Optional arguments to
+\family typewriter
+\backslash
+documentclass
+\family default
+, like
+\begin_inset Quotes eld
\end_inset
+preprint
+\begin_inset Quotes erd
+\end_inset
-\begin_inset OptArg
-status collapsed
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Bad Fonts in Acrobat Reader
-\end_layout
+aps
+\begin_inset Quotes erd
+\end_inset
+, go in the
+\family sans
+E
+\bar under
+x
+\bar default
+tra
+\begin_inset space ~
\end_inset
+Options
+\family default
+ field in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+Layout
+\family default
+ dialog, as usual.
+ Remember that in RevTeX, at least one optional argument is required!
\end_layout
\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
+Other preamble matter, like
\family typewriter
-~/.dvipsrc
+
+\backslash
+draft
\family default
- file
-\end_layout
+ etc.
+\begin_inset space ~
+\end_inset
-\begin_layout LyX-Code
-p+ psfonts.cmz
+goes in the
+\family sans
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Preamble
+\family default
+ dialog, also as usual.
\end_layout
-\begin_layout LyX-Code
-p+ psfonts.amz
+\begin_layout Subsection
+Layouts
\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
+The layouts basically correspond to the commands in RevTeX4.0.
+ For example, the Email layout corresponds to
\family typewriter
\backslash
-usepackage{ae,aecompl}
+email{}
\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
+.
+ Note that (at least as of RevTeX 4.0 Beta), the
\family sans
-\bar under
-T
-\bar default
-eX\InsetSpace ~
-encoding
+Address
\family default
- in preferences (tabs
+ and
\family sans
-Outputs
+Affiliation
\family default
-,
-\family sans
-Misc
+ layouts are exactly equivalent, so you shouldn't need to use both.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In case you're curious, both were included so that
+\family typewriter
+tex2lyx
\family default
-).
-
-\end_layout
+ would be able to translate both
+\family typewriter
-\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
+\backslash
+address
\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 ~
+ and
+\family typewriter
-\begin_inset LatexCommand ref
-reference "sec:pdfbold"
+\backslash
+affiliation
+\family default
+.
+\end_layout
\end_inset
-).
- The Postscript fonts also look different from the Computer Modern fonts.
+
\end_layout
-\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.
+\begin_layout Subsection
+Important Notes
\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_inset
-
-
-\begin_inset OptArg
-status collapsed
+\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
\begin_layout Standard
-
+In RevTeX, the
\family typewriter
\backslash
-boldsymbol{}
+thanks
\family default
- and
-\family typewriter
-pslatex
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The Postscript fonts do not have a bold symbol font.
- The solution is to use the
+ command goes
+\emph on
+outside
+\emph default
+ the
\family typewriter
\backslash
-pmb{}
+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
+\family sans
+Author
\family default
- (poor man's bold) command.
+ layout, or weird things may happen.
+ See the RevTeX 4 documentation for more details.
\end_layout
\begin_layout Standard
-It is possible to redefine the
-\family typewriter
+Also, the
+\family sans
+Author
+\begin_inset space ~
+\end_inset
-\backslash
-boldsymbol
+Email
\family default
- command to use
-\family typewriter
+,
+\family sans
+Author
+\begin_inset space ~
+\end_inset
-\backslash
-pmb
+URL
\family default
- by putting
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-renewcommand{
-\backslash
-boldsymbol}[1]{
-\backslash
-pmb{#1}}
+, and
+\family sans
+Thanks
+\family default
+ layouts must be placed
+\emph on
+in between
+\emph default
+ the
+\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
+\family sans
+Thanks
+\family default
+ after the
+\family sans
+Address
+\family default
+, the LaTeX won't compile.
\end_layout
-\begin_layout Standard
-in the preamble.
+\begin_layout Subsection
+Drawbacks
\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
-Conditionals with pdfLaTeX
-\end_layout
-
+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.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
-
-\begin_layout Standard
-Yes you can do this with the
+the running title for the page headers.
+ Lacking these layouts makes the
\family typewriter
-ifpdf.sty
-\family default
- package.
- Here is an example:
-\end_layout
-
-\begin_layout LyX-Code
-
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-usepackage{ifpdf}
-\end_layout
-
-\begin_layout LyX-Code
\backslash
-ifpdf
-\end_layout
+altaffiliation
+\family default
+ (and the equivalent
+\family typewriter
-\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
+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 LyX-Code
- }
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
-
-\backslash
-pdfcatalog { /PageMode (/UseNone)
+\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
-\begin_layout LyX-Code
- % /OpenAction (fitbh)
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- }
+
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-usepackage[pdftex]{hyperref}
+\begin_layout Section
+Springer Journals (
+\family sans
+svjour
+\family default
+)
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-else
+\begin_layout Standard
+by
+\noun on
+Martin Vermeer
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-usepackage[ps2pdf]{hyperref}
+\begin_layout Subsection
+Description
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-fi
-\end_layout
+\begin_layout Standard
+These are the layout files for some of the journal formats used by Springer
+ Verlag and listed on
+\begin_inset Flex URL
+status collapsed
-\begin_layout Subsubsection
-How can I make URLs clickable?
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-See the references here:
+http://www.springer.de/author/tex/help-journals.html
\end_layout
-\begin_layout Standard
-\begin_inset LatexCommand url
-target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
+\end_inset
+, where you should also go to fetch the class files (yes, these are LaTeX2e
+ now!).
+ It is a modular system: the things common to all journals are implemented
+ in
+\family typewriter
+svjour.inc
+\family default
+, which journal-specific layout files (such as, e.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
-\begin_layout Subsection
-Custom
+\family typewriter
+svjog.layout
+\family default
+ for Journal of Geodesy) can include.
\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
-\emph on
-input
-\emph default
- file can be chosen in the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-ustom
+This means that implementing support for any other Springer journal on this
+ list is as simple as writing your own
+\family typewriter
+sv
+\family default
+<myjournal>
+\family typewriter
+.layout
+\family default
+ file following the outline given in
+\family typewriter
+svjog.layout
\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.
+.
\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
+It is reasonably well tested only for the Journal of Geodesy.
\family typewriter
-$$FName
+svjour
\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
-While it is not possible to save this command using the
-\family sans
-Preferences
+ and
+\family typewriter
+svjog
\family default
- dialog, you can manually edit your
+ come with the standard LyX distribution.
+ Install the relevant class file (downloaded from Springer) in a proper
+ directory, reconfigure LaTeX (in the teTeX case by running
\family typewriter
-.lyx/preferences
+texhash
\family default
- to add a line like
+, as root if necessary — doesn't LyX take care of this?), reconfigure LyX
+ and it should work.
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-custom_export_command "mycommand $$FName"
+\begin_layout Subsection
+New styles
\end_layout
-\begin_layout Chapter
-LyX Features needing Extra Software
-\end_layout
-
-\begin_layout Section
-Checking TeX
+\begin_layout Standard
+A large number of theorem-like styles —
+\family sans
+Claim, Conjecture,
+\family default
+
+\family sans
+\SpecialChar \ldots{}
+Theorem
+\family default
+.
\end_layout
\begin_layout Standard
-by
-\noun on
-Asger Alstrup
+
+\family sans
+Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
+ Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
+\family default
+.
+ See the Springer class file documentation for details.
\end_layout
\begin_layout Subsection
-Introduction
+Supported journals
\end_layout
-\begin_layout Standard
-Under the
-\family sans
-\bar under
-T
-\bar default
-ools
-\family default
- menu, you'll find a
-\family sans
-\bar under
-C
-\bar default
-heck\InsetSpace ~
-TeX
-\family default
- command.
- This feature requires you to have the
+\begin_layout Itemize
+
+\emph on
+Journal of Geodesy
+\emph default
+:
\family typewriter
-chktex
+svjog.layout
\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/"
+ — Martin Vermeer
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
+\emph on
+Probability Theory and Related Fields
+\emph default
+:
+\family typewriter
+svprobth.layout
+\family default
+ — Jean-Marc Lasgouttes
\end_layout
\begin_layout Standard
-The
-\family sans
-ChkTeX
-\family default
- package is a program that was written by
-\noun on
-Jens T.
- Berger Thielemann
-\noun default
- in frustration because some constructs in LaTeX are sometimes non-intuitive,
- and easy to forget.
- The program runs over your LaTeX file and checks the integrity of the file,
- and flags some common errors.
- In other technical words, it is
-\family typewriter
-Lint
-\family default
- for LaTeX.
+Add your own, it isn't so hard!
+\end_layout
+
+\begin_layout Subsection
+Credits
\end_layout
\begin_layout Standard
-Well, what is a syntax checker doing in LyX which is supposed to produce
- correct LaTeX anyways? The answer is simple: Just as
+These files are partly based on the older
\family typewriter
-Lint
-\family default
- not only checks the
-\emph on
-syntax
-\emph default
- of C programs, but also does
-\emph on
-semantic
-\emph default
- checks for type-errors,
-\family sans
-ChkTeX
+ejour2.layout
\family default
- catches some common
-\emph on
-typographic
-\emph default
- errors, in addition to the syntactical ones.
- Specifically,
-\family sans
-ChkTeX
+, which was again based on a tinkered-with version of an old LaTeX 2.09 style
+ file from Springer.
+ All this, and the
+\family typewriter
+ejour2
\family default
- is capable of detecting several common errors, such as
+ layout, are now defunct.
+ Jean-Marc Lasgouttes helped out big in making me find my way around the
+ LyX layout file mechanism.
\end_layout
-\begin_layout Itemize
-Ellipsis detection:
-\newline
-Use \SpecialChar \ldots{}
- instead of ...
+\begin_layout Subsection
+Bugs
\end_layout
-\begin_layout Itemize
-No space in front of/after parenthesis:
-\newline
-( wrong spacing )
+\begin_layout Standard
+Probably.
+ But probably less than in the old hacked-LaTeX
+\family typewriter
+ejour2
+\family default
+.
\end_layout
-\begin_layout Itemize
-Enforcement of normal space after common abbreviations:
-\newline
-e.
- g.
- is too wide spacing.
-\end_layout
+\begin_layout Standard
+Limitations e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Itemize
-Enforcement of end-of-sentence space when the last sentence ends with a
- capital letter:
-\newline
-This is a TEST.
- And this is wrong spacing.
+g.: does not display the number for theorem-like layouts, just #.
\end_layout
-\begin_layout Itemize
-Space in front of labels and similar commands:
-\newline
-The label should stick right
- up to the text to avoid falling to a wrong page.
-
-\begin_inset LatexCommand label
-name "sec:chktex"
+\begin_layout Section
+Slides [aka
+\noun on
+SliTeX
+\noun default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slitex"
\end_inset
-
-\begin_inset Foot
-status collapsed
+
+\end_layout
\begin_layout Standard
-This footnote is in danger of falling off to a wrong page
+by
+\noun on
+John Weiss
+\noun default
+
\end_layout
-\end_inset
+\begin_layout Subsection
+Introduction
+\end_layout
- The label is separated too much.
+\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
+FoilTeX
+\family default
+ slides class.
+ This section documents the former.
\end_layout
-\begin_layout Itemize
-Space in front of references, instead of hard spaces:
-\newline
-In you are in bad luck,
- the text will break right between the referenced text and reference number,
- and that's a pity.
- See section
-\begin_inset LatexCommand ref
-reference "sec:chktex"
+\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 Itemize
-Use of
+\begin_layout Standard
+\align center
+
+\size large
+This section documents the class
\begin_inset Quotes eld
\end_inset
-x
+
+\family sans
+slides (default)
+\family default
+
\begin_inset Quotes erd
\end_inset
- instead of
-\begin_inset Formula $\times$
-\end_inset
+
+\emph on
+only.
+\end_layout
- between numbers:
-\newline
-2x2 looks cheap compared to
-\begin_inset Formula $2\times2$
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
-.
+
\end_layout
\begin_layout Standard
-and more \SpecialChar \ldots{}
- It is an invaluable tool when you are
+If you're looking for the documentation for
\begin_inset Quotes eld
\end_inset
-finishing up
+
+\family sans
+slides (FoilTeX)
+\family default
+
\begin_inset Quotes erd
\end_inset
- your document before printing, and you should run it right after the obligatory
- spelling check, and before you go fine tuning the typesetting.
-\end_layout
+, check out section
+\begin_inset space ~
+\end_inset
-\begin_layout Subsection
-How to use it
-\end_layout
-\begin_layout Standard
-If you have the program installed, usage is as simple as choosing
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foiltex"
+
+\end_inset
-\bar under
-C
-\bar default
-heck\InsetSpace ~
-TeX
-\family default
.
- This will make LyX generate a LaTeX file of your document, start
+ The
\family sans
-ChkTeX
+foils
\family default
- to check it, and then make LyX insert
+ class [
\begin_inset Quotes eld
\end_inset
-error boxes
+
+\family sans
+slides (FoilTeX)
+\family default
+
\begin_inset Quotes erd
\end_inset
- with the warnings from
+] is actually somewhat better than the default
\family sans
-ChkTeX
+slides
\family default
-, if there were any.
- The warnings will be placed close to the point of the mistake, and you
- can quickly find them by using the
-\family sans
-\bar under
-N
-\bar default
-avigate\SpecialChar \menuseparator
+ class,
+\begin_inset Foot
+status collapsed
-\bar under
-E
-\bar default
-rror
-\family default
- menu item, or the shortcut key
-\family sans
-C-g
-\family default
- from the default
-\family typewriter
-cua
-\family default
- bind file.
- Open the error boxes by clicking on them with the mouse, or use the shortcut
- key
-\family sans
-C-i
-\family default
- from
-\family typewriter
-cua
-\family default
- bindings, or the corresponding
-\family sans
-C-o
-\family default
- for the alternate
-\family typewriter
-emacs
-\family default
- bind file.
- Read the warning and correct the mistake, if it is a mistake.
- If you have trouble understanding what the warning is about, you can safely
- ignore it.
- Remember that there is a hidden layer between the document on screen and
- the technical details in invoking
-\family sans
-ChkTeX
-\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
+\begin_layout Plain Layout
+\SpecialChar \ldots{}
+or so I've been told repeatedly by its advocates.
+ Having never used it, I have no idea if this claim is true or not.
\end_layout
-\begin_layout Standard
-This document is an excellent testing bed for the feature, and it should
- provide quite a few warnings for you to fiddle with.
- Since computers are only so smart, expect most of the warnings to be false
- alarms, though.
-\end_layout
+\end_inset
-\begin_layout Subsection
-How to fine tune it
+ which this section documents.
\end_layout
\begin_layout Standard
-Sometimes, you'll find that
+This class is the LaTeX2e improvement of the old
+\noun on
+SliTeX
+\noun default
+ package.
+ Every LaTeX2e distribution includes this class [which I'll just refer to
+ as
+\begin_inset Quotes eld
+\end_inset
+
+
\family sans
-ChkTeX
+slides
\family default
- makes more noise than suits your mood.
- Then you can choose not to use it, wait until your mood changes, or try
- to customize
+
+\begin_inset Quotes erd
+\end_inset
+
+ from now on], so you're bound to have it.
+ As I noted earlier, there are other classes, such as
\family sans
-ChkTeX
+foils
\family default
- to get better along with you.
- Another choice in the most desperate situations is to use
+, which also produce slides for overhead projectors and do a better job
+ at it.
+ However, there are some things which
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-emove\InsetSpace ~
-All\InsetSpace ~
-Error\InsetSpace ~
-Boxes
+slides
\family default
-, which will get rid of all warnings instantly.
+ can do which the others can't, such as generate overlays.
+ Read on to learn more!
+\end_layout
+
+\begin_layout Subsection
+Getting Started
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slidesetup"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-Although
-\family sans
-ChkTeX
-\family default
-
-\emph on
-is
-\emph default
- very configurable and extensible, you shouldn't expect to solve all problems
- with
-\family sans
-ChkTeX
-\family default
- in LyX this way.
- Since LyX has to generate a somewhat special LaTeX file to be able to match
- the line numbers from the
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
+\end_inset
+
+
\family sans
-ChkTeX
+slides (default)
\family default
- output
-\begin_inset Foot
-status collapsed
-\begin_layout Standard
-You can inspect the specific output from
+\begin_inset Quotes erd
+\end_inset
+
+ from the class list in the
\family sans
-chktex
+Document\SpecialChar \menuseparator
+Settings
\family default
- by using
+ dialog.
+ There are some other special things you should know about this class:
+\end_layout
+
+\begin_layout Itemize
+Don't bother changing the options
\family sans
-Edit\SpecialChar \menuseparator
-View\InsetSpace ~
-LaTeX\InsetSpace ~
-Log
+Sides and Columns
\family default
- right after a
+.
+ They're not supported by the
\family sans
-chktex
+slides
\family default
- run.
+ class, anyways.
\end_layout
+\begin_layout Itemize
+The option
+\family sans
+Page
+\begin_inset space ~
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
- There are two things you can do about this:
+style
+\family default
+ behaves a bit differently for this class.
+ The possible choices and what they do are as follows:
\end_layout
-\begin_layout Itemize
-Fine tune the
-\family sans
-ChkTeX
-\family default
- invocation command line in
+\begin_deeper
+\begin_layout Description
+
\family sans
-Preferences
+plain
\family default
- (tabs
+ The final output contains page numbers in the lower right corner.
+\end_layout
+
+\begin_layout Description
+
\family sans
-Outputs
+headings
\family default
-,
+ Like
\family sans
-Misc
+plain
\family default
-), or the global
+, but also prints out any time markers you've put in.
+ This is the default.
+\end_layout
+
+\begin_layout Description
+
\family sans
-ChkTeX
-\family default
- installation configuration file (usually with the file
-\family typewriter
-/usr/local/share/chktexrc
+empty
\family default
-).
- See below to learn what warnings can be enabled and disabled on the command
- line.
-
+ The final output contains no page numbers, time markers, or alignment markers.
\end_layout
+\end_deeper
\begin_layout Itemize
-Export your document as a raw LaTeX file using
+The
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+slides
+\family default
+ class has an extra option:
+\family typewriter
+clock
+\family default
+.
+ To use it, put
+\begin_inset Quotes eld
+\end_inset
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-\bar under
-L
-\bar default
-aTeX
-\family default
- and run
\family typewriter
-chktex
+clock
\family default
- manually on that.
- Invoked in this way, it can be a hassle to find the corresponding place
- in the document inside LyX, but with a little patience, you should be able
- to do it.
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the extra class options.
\end_layout
+\begin_deeper
\begin_layout Standard
-Here follows the warning messages that can be enabled and disabled in
+Using this options allows you to add time markers to
+\family sans
+Note
+\family default
+s.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideNote"
+
+\end_inset
+
+ for more details.
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+You can also use the template file
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+slides.lyx
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ to automatically set up a document to use the
+\family sans
+slides
+\family default
+ class [using
+\family sans
+File\SpecialChar \menuseparator
+New
+\begin_inset space ~
+\end_inset
+
+from
+\begin_inset space ~
+\end_inset
+
+Template
+\family default
+ to open your new document].
+ The template file also contains some examples of the special paragraph
+ environments used by this class.
+ I'll describe those next.
+\end_layout
+
+\begin_layout Subsection
+Paragraph Environments
+\end_layout
+
+\begin_layout Subsubsection
+Supported Environments
+\end_layout
+
+\begin_layout Standard
+The first thing you'll notice when you start up a new
+\family sans
+slides
+\family default
+ document is the font size and type: it's the equivalent of the size
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+Largest
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ in the
+\family sans
+Sans
+\begin_inset space ~
+\end_inset
+
+Serif
+\family default
+ font.
+ This is also what's used in the output.
+ Think of this as a
+\begin_inset Quotes eld
+\end_inset
+
+visual cue
+\begin_inset Quotes erd
+\end_inset
+
+ to remind you that this is a slide.
+ Your final slides will use a larger font; ergo, you'll have less space.
+ Of course, the larger default screen font isn't WYSIWYG, only a reminder.
+\end_layout
+
+\begin_layout Standard
+The next thing that becomes obvious is the changes to the paragraph environment
+ pull-down box [at the far-left end of the toolbar].
+ Most of the paragraph environments you're used to seeing are missing.
+ There are also five new ones.
+ That's because the
+\family sans
+slides
+\family default
+ class itself only supports certain paragraph environments:
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Standard
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Itemize
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Enumerate
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Description
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+List
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Quotation
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Quote
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Verse
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Caption
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+LyX-Code
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Comment
+\end_layout
+
+\begin_layout Standard
+All of the other standard environments, including the section-heading environmen
+ts, aren't used in the
+\family sans
+slides
+\family default
+ class.
+\end_layout
+
+\begin_layout Standard
+On the other hand, you'll notice the following new environments:
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Slide
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Overlay
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Note
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+InvisibleText
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+VisibleText
+\end_layout
+
+\begin_layout Standard
+These five are kind of quirky, due to a
+\begin_inset Quotes eld
+\end_inset
+
+feature
+\begin_inset Quotes erd
+\end_inset
+
+ in LyX.
+ You see, LyX doesn't permit you to nest any other paragraph environment
+ into an empty environment.
+ Now, that's fine and dandy, but it means that you wouldn't be able to start
+ a slide with anything except plain text.
+ To deal with this, I've performed a little
+\begin_inset Quotes eld
+\end_inset
+
+LaTeX magic.
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Quirks of the New Environments
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slideQuirk"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+All five of the new paragraph environments are somewhat quirky due to inherent
+ limitiations in the current version of LyX.
+ As I just mentioned, LyX forbids environments that begin with another environme
+nt.
+ To get around this, the
+\family sans
+Slide
+\family default
+ environment isn't a paragraph environment as described in the
+\emph on
+User's Guide
+\emph default
+.
+
+\end_layout
+
+\begin_layout Standard
+You should consider
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+, and
+\family sans
+Note
+\family default
+ to be
+\begin_inset Quotes eld
+\end_inset
+
+pseudo-environments.
+\begin_inset Quotes erd
+\end_inset
+
+ They look like a section heading or a
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+Caption
+\family default
+,
+\begin_inset Quotes erd
+\end_inset
+
+ but really begin a [and, if necessary, end the previous] paragraph environment.
+ Likewise, treat
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+ as
+\begin_inset Quotes eld
+\end_inset
+
+pseudo-commands.
+\begin_inset Quotes erd
+\end_inset
+
+ These two perform some action.
+\end_layout
+
+\begin_layout Standard
+A common feature of all five environments,
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+, is a rather long-ish label.
+ The text following this label — ordinarily the contents of the paragraph
+ environment — is utterly irrelevant for
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+.
+ LyX completely ignores it.
+ In fact, you can leave these five environments completely empty.
+
+\end_layout
+
+\begin_layout Standard
+While you don't
+\emph on
+have
+\emph default
+ to put any text after the rather long-ish label, you might want to.
+ This could be a short description of the contents of the
+\family sans
+Slide
+\family default
+, for example.
+ In that case, enter in your descriptive comment and hit
+\family sans
+Return
+\family default
+ as you normally would.
+\end_layout
+
+\begin_layout Standard
+If, on the other hand, you don't want to enter in any descriptive text,
+ you'll hit another LyX quirk.
+ LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
+ environment until you put something in the old one.
+ So, do this:
+\end_layout
+
+\begin_layout Itemize
+Start entering the text that will
+\emph on
+follow
+\emph default
+ the new
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ or
+\family sans
+VisibleText
+\family default
+.
+
+\end_layout
+
+\begin_layout Itemize
+Now move to the beginning of that paragraph.
+
+\end_layout
+
+\begin_layout Itemize
+Next, hit
+\family sans
+Return
+\family default
+.
+
+\end_layout
+
+\begin_layout Itemize
+Finally, change this new, empty paragraph to a
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ or
+\family sans
+VisibleText
+\family default
+.
+
+\end_layout
+
+\begin_layout Standard
+Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
+
+\end_layout
+
+\begin_layout Subsection
+Making a Presentation with
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+ and
+\family sans
+Note
+\end_layout
+
+\begin_layout Subsubsection
+Using the
+\family sans
+Slide
+\family default
+ Environment
+\end_layout
+
+\begin_layout Standard
+If you're expecting this section to teach you how to actually make a presentatio
+n, you'll be sorely disappointed.
+ Naturally, I'll describe all of the ways the
+\family sans
+slides
+\family default
+ class can assist you in preparing the materials for a presentation.
+ Filling in the contents, however, is up to you.
+ [Then again, that
+\emph on
+is
+\emph default
+ the LyX philosophy.]
+\end_layout
+
+\begin_layout Standard
+Choosing the
+\family sans
+Slide
+\family default
+ environment [in the manner described in section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideQuirk"
+
+\end_inset
+
+] tells LyX to begin a new slide [duh].
+ The label for this environment/
+\begin_inset Quotes erd
+\end_inset
+
+pseudo-command
+\begin_inset Quotes erd
+\end_inset
+
+ is an
+\begin_inset Quotes eld
+\end_inset
+
+ASCII line,
+\begin_inset Quotes erd
+\end_inset
+
+ in cool blue, followed by the label,
+\begin_inset Quotes eld
+\end_inset
+
+NewSlide:
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Any text or paragraph environments that follow this one go on the new slide.
+ It's that simple.
+\end_layout
+
+\begin_layout Standard
+Slides are probably the only time you'll need to forcibly end pages in LyX
+ (this can be specified in the
+\family sans
+Paragraph Layout
+\family default
+ dialog).
+ In fact, you'll want to, once you finish entering the contents of one slide.
+ If you've entered more text than can physically fit on a slide, the extra
+ overflows onto a new slide.
+ I don't recommend doing this, however, since the overflow slide won't have
+ any page number on it.
+ Furthermore, it may interfere with any
+\family sans
+Overlay
+\family default
+ you've made to accompany the oversized
+\family sans
+Slide
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+The
+\family sans
+Overlay
+\family default
+ and
+\family sans
+Note
+\family default
+ environments work the same way as the
+\family sans
+Slide
+\family default
+ environment.
+ They both create an
+\begin_inset Quotes eld
+\end_inset
+
+ASCII line
+\begin_inset Quotes erd
+\end_inset
+
+ followed by a label [
+\begin_inset Quotes eld
+\end_inset
+
+NewOverlay:
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+NewNote:
+\begin_inset Quotes erd
+\end_inset
+
+, respectively].
+ The color is a stunning magenta instead of blue, and the
+\begin_inset Quotes eld
+\end_inset
+
+ASCII line
+\begin_inset Quotes erd
+\end_inset
+
+ will look different, in style and in length.
+ The label fonts of all three also differ from one another.
+\end_layout
+
+\begin_layout Standard
+As with a
+\family sans
+Slide
+\family default
+, if the contents of a
+\family sans
+Note
+\family default
+ or
+\family sans
+Overlay
+\family default
+ exceed the physical size of a slide or sheet of paper, the extra will overflow
+ onto a new sheet.
+ Again, you should avoid this.
+ It defeats the whole purpose of
+\family sans
+Note
+\family default
+s and
+\family sans
+Overlay
+\family default
+s.
+\end_layout
+
+\begin_layout Subsubsection
+Using
+\family sans
+Overlay
+\family default
+ with
+\family sans
+Slide
+\end_layout
+
+\begin_layout Standard
+The idea behind an
+\family sans
+Overlay
+\family default
+ is a slide that sits atop another slide.
+ Perhaps you wish to discuss a figure on the main
+\family sans
+Slide
+\family default
+ before displaying the text associated with it.
+ One way to accomplish this is tape a flap of dark paper over the part of
+ the
+\family sans
+Slide
+\family default
+ you want to display later.
+ This method fails, however, if you wish to overlap one graph with another,
+ for example.
+ You would then have to fumble while speaking to align the two separate,
+ overlapping
+\family sans
+Slide
+\family default
+s to align the two graphs.
+ The use of an
+\family sans
+Overlay
+\family default
+ environment in both cases makes life much easier.
+\end_layout
+
+\begin_layout Standard
+Each
+\family sans
+Overlay
+\family default
+ receives the page number of its
+\begin_inset Quotes eld
+\end_inset
+
+parent
+\begin_inset Quotes erd
+\end_inset
+
+
+\family sans
+Slide
+\family default
+, appended by
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-a
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Presumably, mutliple
+\family sans
+Overlay
+\family default
+s would have
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-a
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-b
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-c
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+, etc.
+\begin_inset space ~
+\end_inset
+
+appended to the page number of the parent
+\family sans
+Slide
+\family default
+.
+
+\end_layout
+
+\end_inset
+
+ Clearly, you want the contents of both the
+\family sans
+Slide
+\family default
+ and the
+\family sans
+Overlay
+\family default
+ to each fit on a single physical slide! You should probably consider an
+
+\family sans
+Overlay
+\family default
+ as
+\begin_inset Quotes eld
+\end_inset
+
+part of
+\begin_inset Quotes erd
+\end_inset
+
+ a
+\family sans
+Slide
+\family default
+.
+ Indeed, the LyX
+\family sans
+slides
+\family default
+ class provides a visual cue for this: the label at the start of an
+\family sans
+Overlay
+\family default
+ is shorter than that at the start of a
+\family sans
+Slide
+\family default
+.
+ Lastly, when you generate printable output, you'll find alignment markers
+ in all four corners of both the
+\family sans
+Overlay
+\family default
+ page and its parent
+\family sans
+Slide
+\family default
+.
+ These will assist you in lining up the two physical slides.
+\end_layout
+
+\begin_layout Standard
+The major problem in overlaying two slides is aligning the contents of the
+ two transparencies.
+ How much space should you leave for that graph on the second slide? Worse
+ still, what if you want a graph and a sentence on second slide, but there
+ is text on the main transparency that goes in between them? You could try
+ and insert vertical space of the right size.
+ The better way is to use
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+As their names imply,
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+ are two command-like paragraph environments that make all subsequent text
+ invisible and visible, respectively.
+ Note from section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideQuirk"
+
+\end_inset
+
+ that you don't place anything
+\emph on
+into
+\emph default
+ these two environments, however.
+ When you create an
+\family sans
+InvisibleText
+\family default
+, it inserts a centered, sky-blue label into the page reading
+\begin_inset Quotes eld
+\end_inset
+
+<Invisible Text Follows>
+\begin_inset Quotes erd
+\end_inset
+
+.
+ For paragraphs following this label, the parts of the
+\family sans
+Slide
+\family default
+ [or
+\family sans
+Overlay
+\family default
+; it doesn't matter which] where they would be contain instead blank space.
+
+\end_layout
+
+\begin_layout Standard
+For
+\family sans
+VisibleText
+\family default
+, the corresponding centered label is
+\begin_inset Quotes eld
+\end_inset
+
+<Visible Text Follows>
+\begin_inset Quotes erd
+\end_inset
+
+ in blazing green.
+ Paragraphs following this label behave normally.
+ Note that the beginning of a new
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+, or
+\family sans
+Note
+\family default
+ automatically shuts off an
+\family sans
+InvisibleText
+\family default
+.
+ It's therefore not necessary to use
+\family sans
+VisibleText
+\family default
+ at the end of a
+\family sans
+Slide
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+By now, it should be obvious how to create overlay transparencies using
+ the proper combination of
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+ on a
+\family sans
+Slide
+\family default
+ and
+\family sans
+Overlay
+\family default
+:
+\end_layout
+
+\begin_layout Enumerate
+Create a
+\family sans
+Slide
+\family default
+, including everything that will appear on it, whether on the main slide
+ or on the
+\family sans
+Overlay
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Before each figure or paragraph that will appear only on the
+\family sans
+Overlay
+\family default
+, insert an
+\family sans
+InvisibleText
+\family default
+ environment.
+ If necessary, insert a
+\family sans
+VisibleText
+\family default
+ environment after the
+\family sans
+Overlay
+\family default
+-only text.
+\end_layout
+
+\begin_layout Enumerate
+Start an
+\family sans
+Overlay
+\family default
+ immediately following the
+\family sans
+Slide
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Copy the contents of this
+\family sans
+Slide
+\family default
+ into the
+\family sans
+Overlay
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Within the
+\family sans
+Overlay
+\family default
+, change all of the
+\family sans
+InvisibleText
+\family default
+ lines to
+\family sans
+VisibleText
+\family default
+ and vice-versa.
+\end_layout
+
+\begin_layout Standard
+That's it.
+ You've just made an
+\family sans
+Overlay
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+There's one problem with the way I've designed the LyX
+\family sans
+slides
+\family default
+ class: you can't make text in the middle of a paragraph invisible, nor
+ make text in the middle of an invisible paragraph visible again.
+ To accomplish this feat, you'll need to use some inlined LaTeX codes.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The commands of interest are:
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+{
+\backslash
+invisible \SpecialChar \ldots{}
+ }
+\end_layout
+
+\begin_layout Itemize
+
+\family typewriter
+{
+\backslash
+visible \SpecialChar \ldots{}
+ }
+\end_layout
+
+\begin_layout Plain Layout
+\SpecialChar \ldots{}
+and need to be marked as TeX.
+ The text whose
+\begin_inset Quotes eld
+\end_inset
+
+visibility
+\begin_inset Quotes erd
+\end_inset
+
+ you wish to change goes in between the brackets [and after the
+\family typewriter
+
+\backslash
+invisible
+\family default
+ or
+\family typewriter
+
+\backslash
+visible
+\family default
+ command].
+ If you don't know how to mark text as TeX, see the appropriate section
+ of the
+\emph on
+User's Guide
+\emph default
+.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Using
+\family sans
+Note
+\family default
+ with
+\family sans
+Slide
+\family default
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slideNote"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Like an
+\family sans
+Overlay
+\family default
+, a
+\family sans
+Note
+\family default
+ is associated with a
+\begin_inset Quotes eld
+\end_inset
+
+parent
+\begin_inset Quotes erd
+\end_inset
+
+
+\family sans
+Slide
+\family default
+.
+ Here, too, the LyX
+\family sans
+slides
+\family default
+ class provides visual cues.
+ The label for a
+\family sans
+Note
+\family default
+ is shorter than that of a
+\family sans
+Slide
+\family default
+ [yet longer than that of an
+\family sans
+Overlay
+\family default
+] and, like the label of an
+\family sans
+Overlay
+\family default
+ is shockingly magenta.
+ Additionally, the printed
+\family sans
+Note
+\family default
+ has the page number of its
+\begin_inset Quotes eld
+\end_inset
+
+parent
+\begin_inset Quotes erd
+\end_inset
+
+
+\family sans
+Slide
+\family default
+, appended by
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-
+\family default
+1
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-
+\family default
+2
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-
+\family default
+3
+\begin_inset Quotes erd
+\end_inset
+
+, etc.
+ You can have multiple
+\family sans
+Note
+\family default
+s associated with a single
+\family sans
+Slide
+\family default
+, and, as with
+\family sans
+Slide
+\family default
+ and
+\family sans
+Overlay
+\family default
+, you'll probably want to break up long
+\family sans
+Note
+\family default
+s so that they fit on a single sheet of paper.
+\end_layout
+
+\begin_layout Standard
+The purpose of a
+\family sans
+Note
+\family default
+ is obvious: it contains anything additional you might want to say about
+ a
+\family sans
+Slide
+\family default
+.
+ It could also be used as a sheet of reminders for a particular
+\family sans
+Slide
+\family default
+.
+ In the case of the latter, you might want to make use of time markers.
+ Currently, the LyX
+\family sans
+slides
+\family default
+ class has no
+\begin_inset Quotes eld
+\end_inset
+
+native
+\begin_inset Quotes erd
+\end_inset
+
+ support for time markers, a
+\noun on
+SliTeX
+\noun default
+ feature.
+ So, you'll have to resort to using the LaTeX codes.
+\end_layout
+
+\begin_layout Standard
+To use time markers, you'll need to specify the extra class option
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+clock
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ [see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slidesetup"
+
+\end_inset
+
+].
+ This option turns on timing marks, which will appear in the lower-left-hand
+ corner of every
+\family sans
+Note
+\family default
+ you generate.
+ To set what appears in the time marker, you use the LaTeX commands
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+settime{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+addtime{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The arguments of both commands are time measured in seconds.
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+settime{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ sets the time marker to a given time.
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+addtime{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ increments the time marker by the specified amount.
+ Using time markers and
+\family sans
+Note
+\family default
+s in this fashion, you can remind yourself how much time to spend on a particula
+r
+\family sans
+Slide
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+There's one last feature to describe.
+ Clearly, you'd like to print out all of your
+\family sans
+Slide
+\family default
+s and
+\family sans
+Overlay
+\family default
+s on transparencies while printing all of your
+\family sans
+Note
+\family default
+s on plain paper.
+ However, a
+\family sans
+Note
+\family default
+
+\emph on
+must
+\emph default
+ follow the
+\family sans
+Slide
+\family default
+ with which it is associated.
+ What's a person to do?
+\end_layout
+
+\begin_layout Standard
+Luckily, there are two LaTeX commands that allow you to select what to print
+ out.
+ Both must be placed into the preamble of your document.
+ The command
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+onlyslides{
+\backslash
+slides}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ will cause the output to contain only the
+\family sans
+Slide
+\family default
+s and
+\family sans
+Overlay
+\family default
+s.
+ Correspondingly, the command
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+onlynotes{
+\backslash
+notes}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ prevents the output of anything but
+\family sans
+Note
+\family default
+s.
+ I'd advise placing both commands in the preamble and initially comment
+ both out.
+ You can then preview your entire presentation as you write.
+ When you're done writing, you can then uncomment one of the two to select
+ what you want to print.
+ I like to uncomment
+\begin_inset Quotes eld
+\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
+\begin_inset space ~
+\end_inset
+
+from
+\begin_inset space ~
+\end_inset
+
+
+\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}
+\begin_inset Newline newline
+\end_inset
+
+
+\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
+SliTeX
+\noun default
+ 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
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+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 Plain Layout
+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 Chapter
+LyX Features needing Extra Software
+\end_layout
+
+\begin_layout Section
+Checking TeX
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Asger Alstrup
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+If you have the
+\family typewriter
+chktex
+\family default
+ program installed
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+
+\family typewriter
+chktex
+\family default
+ is not yet available when you are using the LaTeX distribution MiKTeX.
+\end_layout
+
+\end_inset
+
+, you'll find in the
+\family sans
+Tools
+\family default
+ menu the entry:
+\family sans
+Check
+\begin_inset space ~
+\end_inset
+
+TeX
+\family default
+.
+ You can get
+\family typewriter
+chktex
+\family default
+ it from CTAN,
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+The
+\family sans
+ChkTeX
+\family default
+ package is a program that was written by
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+Jens T.
+\begin_inset space ~
+\end_inset
+
+Berger Thielemann
+\end_layout
+
+\end_inset
+
+ in frustration because some constructs in LaTeX are sometimes non-intuitive,
+ and easy to forget.
+ The program runs over your LaTeX file, checks the integrity of the file,
+ and flags some common errors.
+ In other technical words, it is
+\family typewriter
+lint
+\family default
+ for LaTeX.
+\end_layout
+
+\begin_layout Standard
+Well, what is a syntax checker doing in LyX which is supposed to produce
+ correct LaTeX anyways? The answer is simple: Just as
+\family typewriter
+Lint
+\family default
+ not only checks the
+\emph on
+syntax
+\emph default
+ of C programs, but also does
+\emph on
+semantic
+\emph default
+ checks for type-errors,
+\family sans
+ChkTeX
+\family default
+ catches some common
+\emph on
+typographic
+\emph default
+ errors, in addition to the syntactical ones.
+ Specifically,
+\family sans
+ChkTeX
+\family default
+ is capable of detecting several common errors, such as
+\end_layout
+
+\begin_layout Itemize
+Ellipsis detection:
+\begin_inset Newline newline
+\end_inset
+
+Use \SpecialChar \ldots{}
+ instead of ...
+\end_layout
+
+\begin_layout Itemize
+No space in front of/after parenthesis:
+\begin_inset Newline newline
+\end_inset
+
+( wrong spacing )
+\end_layout
+
+\begin_layout Itemize
+Enforcement of normal space after common abbreviations:
+\begin_inset Newline newline
+\end_inset
+
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+is too wide spacing.
+\end_layout
+
+\begin_layout Itemize
+Enforcement of end-of-sentence space when the last sentence ends with a
+ capital letter:
+\begin_inset Newline newline
+\end_inset
+
+This is a TEST.
+ And this is wrong spacing.
+\end_layout
+
+\begin_layout Itemize
+Space in front of labels and similar commands:
+\begin_inset Newline newline
+\end_inset
+
+The label should stick right up to the text to avoid falling to a wrong
+ page.
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:chktex"
+
+\end_inset
+
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This footnote is in danger of falling off to a wrong page
+\end_layout
+
+\end_inset
+
+ The label is separated too much.
+\end_layout
+
+\begin_layout Itemize
+Space in front of references, instead of hard spaces:
+\begin_inset Newline newline
+\end_inset
+
+In you are in bad luck, the text will break right between the referenced
+ text and reference number, and that's a pity.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:chktex"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+Use of
+\begin_inset Quotes eld
+\end_inset
+
+x
+\begin_inset Quotes erd
+\end_inset
+
+ instead of
+\begin_inset Formula $\times$
+\end_inset
+
+ between numbers:
+\begin_inset Newline newline
+\end_inset
+
+2x2 looks cheap compared to
+\begin_inset Formula $2\times2$
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+and more \SpecialChar \ldots{}
+ It is an invaluable tool when you are
+\begin_inset Quotes eld
+\end_inset
+
+finishing up
+\begin_inset Quotes erd
+\end_inset
+
+ your document before printing, and you should run it right after the obligatory
+ spelling check, and before you go fine tuning the typesetting.
+\end_layout
+
+\begin_layout Subsection
+How to use it
+\end_layout
+
+\begin_layout Standard
+If you have the program installed, usage is as simple as choosing
+\family sans
+Tools\SpecialChar \menuseparator
+Check
+\begin_inset space ~
+\end_inset
+
+TeX
+\family default
+.
+ This will make LyX generate a LaTeX file of your document, start
+\family sans
+ChkTeX
+\family default
+ to check it, and then make LyX insert
+\begin_inset Quotes eld
+\end_inset
+
+error boxes
+\begin_inset Quotes erd
+\end_inset
+
+ with the warnings from
+\family sans
+ChkTeX
+\family default
+, if there were any.
+ The warnings will be placed close to the point of the mistake, and you
+ can quickly find them by using the
+\family sans
+Navigate\SpecialChar \menuseparator
+Error
+\family default
+ menu item, or the shortcut key
+\family sans
+C-g
+\family default
+ from the default
+\family typewriter
+cua
+\family default
+ bind file.
+ Open the error boxes by clicking on them with the mouse, or use the shortcut
+ key
+\family sans
+C-i
+\family default
+ from
+\family typewriter
+cua
+\family default
+ bindings, or the corresponding
+\family sans
+C-o
+\family default
+ for the alternate
+\family typewriter
+emacs
+\family default
+ bind file.
+ Read the warning and correct the mistake, if it is a mistake.
+ If you have trouble understanding what the warning is about, you can safely
+ ignore it.
+ Remember that there is a hidden layer between the document on screen and
+ the technical details in invoking
+\family sans
+ChkTeX
+\family default
+, and this gap can make some warnings seem arcane or just right down plain
+ silly.
+\end_layout
+
+\begin_layout Standard
+This document is an excellent testing bed for the feature, and it should
+ provide quite a few warnings for you to fiddle with.
+ Since computers are only so smart, expect most of the warnings to be false
+ alarms, though.
+\end_layout
+
+\begin_layout Subsection
+How to fine tune it
+\end_layout
+
+\begin_layout Standard
+Sometimes, you'll find that
+\family sans
+ChkTeX
+\family default
+ makes more noise than suits your mood.
+ Then you can choose not to use it, wait until your mood changes, or try
+ to customize
+\family sans
+ChkTeX
+\family default
+ to get better along with you.
+ Another choice in the most desperate situations is to use
+\family sans
+View\SpecialChar \menuseparator
+Remove
+\begin_inset space ~
+\end_inset
+
+All
+\begin_inset space ~
+\end_inset
+
+Error
+\begin_inset space ~
+\end_inset
+
+Boxes
+\family default
+, which will get rid of all warnings instantly.
+\end_layout
+
+\begin_layout Standard
+Although
+\family sans
+ChkTeX
+\family default
+
+\emph on
+is
+\emph default
+ very configurable and extensible, you shouldn't expect to solve all problems
+ with
+\family sans
+ChkTeX
+\family default
+ in LyX this way.
+ Since LyX has to generate a somewhat special LaTeX file to be able to match
+ the line numbers from the
+\family sans
+ChkTeX
+\family default
+ output
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You can inspect the specific output from
+\family sans
+chktex
+\family default
+ by using
+\family sans
+Edit\SpecialChar \menuseparator
+View
+\begin_inset space ~
+\end_inset
+
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Log
+\family default
+ right after a
+\family sans
+chktex
+\family default
+ run.
+\end_layout
+
+\end_inset
+
+ to the internal document structure, some of the warnings will not seen
+ to appear correctly.
+ There are two things you can do about this:
+\end_layout
+
+\begin_layout Itemize
+Fine tune the
+\family sans
+ChkTeX
+\family default
+ invocation command line in
+\family sans
+Preferences
+\family default
+ (tabs
+\family sans
+Outputs
+\family default
+,
+\family sans
+Misc
+\family default
+), or the global
+\family sans
+ChkTeX
+\family default
+ installation configuration file (usually with the file
+\family typewriter
+chktexrc
+\family default
+).
+ See below to learn what warnings can be enabled and disabled on the command
+ line.
+
+\end_layout
+
+\begin_layout Itemize
+Export your document as a raw LaTeX file using
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
+\family default
+ and run
+\family typewriter
+chktex
+\family default
+ manually on that.
+ Invoked in this way, it can be a hassle to find the corresponding place
+ in the document inside LyX, but with a little patience, you should be able
+ to do it.
+\end_layout
+
+\begin_layout Standard
+Here follows the warning messages that can be enabled and disabled in
\family sans
Preferences
\family default
.
- Use
+ Use
+\family typewriter
+-n#
+\family default
+ to disable a warning, and
+\family typewriter
+-w#
+\family default
+ to enable a warning.
+ The emphasized entries are disabled by default, because the default is
+ "
+\family typewriter
+chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
+\family default
+".
+\end_layout
+
+\begin_layout Standard
+Notice that you should only use the options that enable and disable warnings,
+ because LyX relies on some of the other command line parameters to be set
+ in a specific way to have a chance to communicate with
+\family typewriter
+chktex
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Command terminated with space.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Non-breaking space (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+~
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) should have been used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+You should enclose the previous parenthesis with
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found in non-italic buffer.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found more than once.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+No italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Accent command
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+cmd
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ needs use of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+cmd
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Wrong length of dash may have been used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ expected, found
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Solo
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ to achieve an ellipsis.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Inter-word spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+
+\family default
+
+\begin_inset Quotes eld
+\end_inset
+
+) should perhaps be used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Inter-sentence spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+@
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) should perhaps be used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not find argument for command.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+No match found for
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Math mode still on at end of LaTeX file.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Number of
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
--n#
+char
\family default
- to disable a warning, and
+
+\begin_inset Quotes erd
+\end_inset
+
+ doesn't match the number of
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
--w#
+char
\family default
- to enable a warning.
- The emphasized entries are disabled by default, because the default is
- "
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use either
\family typewriter
-chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family default
+ or
+\family typewriter
+
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ as an alternative to
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+"
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use "
+\family typewriter
+'
+\family default
+" (ASCII 39) instead of "
+\family typewriter
+´
+\family default
+" (ASCII 180).
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+User-specified pattern found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This command might not be intended.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Comment displayed.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Either
+\family typewriter
+''
+\backslash
+,'
+\family default
+ or
+\family typewriter
+'
+\backslash
+,''
+\family default
+ will look better.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Delete this space to maintain correct page references.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+You might wish to put this between a pair of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You ought to remove spaces in front of punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not execute LaTeX command.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Don't use
+\family typewriter
+
+\backslash
+/
+\family default
+ in front of small punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\family typewriter
+\size small
+$
+\backslash
+times$
+\family default
+ may look prettier here.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Multiple spaces detected in output.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This text may be ignored.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Use
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family default
+ to begin quotation, not
+\family typewriter
+'
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Use
+\family typewriter
+'
\family default
-".
-\end_layout
-
-\begin_layout Standard
-Notice that you should only use the options that enable and disable warnings,
- because LyX relies on some of the other command line parameters to be set
- in a specific way to have a chance to communicate with
+ to end quotation, not
\family typewriter
-chktex
+
+\begin_inset Quotes eld
+\end_inset
+
+
\family default
.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-Command terminated with space.
+Don't mix quotes.
\end_layout
\begin_layout Enumerate
\size small
-Non-breaking space (
+You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
-~
+cmd
\family default
\begin_inset Quotes erd
\end_inset
-) should have been used.
+ instead.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should put a space in front of/after parenthesis.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should avoid spaces in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
\size small
\emph on
-You should enclose the previous parenthesis with
+You should not use punctuation in front of/after quotes.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Double space found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should put punctuation outside inner/inside display math mode.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You ought to not use primitive TeX in LaTeX code.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
\family typewriter
-{}
+%s
\family default
\begin_inset Quotes erd
\end_inset
-.
+
\end_layout
\begin_layout Enumerate
\size small
-Italic correction (
\begin_inset Quotes eld
\end_inset
\family typewriter
+%s
+\family default
-\backslash
-/
+\begin_inset Quotes erd
+\end_inset
+
+ is normally not followed by
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%c
\family default
\begin_inset Quotes erd
\end_inset
-) found in non-italic buffer.
+.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+In later versions of LyX, we hope to provide a more complete interface to
+ this tool (and it's smaller cousin
+\family typewriter
+lacheck
+\family default
+) to exploit the full power of it.
+ But it's not exactly useless as it is now: go try it on one of your existing
+ documents of a certain length and be surprised.
+\end_layout
-\size small
-Italic correction (
+\begin_layout Section
+Version Control in LyX
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+ Lars Gullik Bjønnes,
+\noun default
+updated by
+\noun on
+Pavel Sanda
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+A friend of mine wanted to try LyX for a group project.
+ When he didn't find support for version control or file locking, he dropped
+ it.
+ This angered me a bit, so I thought that I should at least make support
+ for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
+ This has now been done.
+ LyX now supports some of the most basic RCS commands.
+ If you need to something a bit more sophisticated you will have to do that
+ manually in an xterm.
+\end_layout
+
+\begin_layout Standard
+Before you begin to use the version control features in LyX, you should
+ read
\begin_inset Quotes eld
\end_inset
+rcsintro
+\begin_inset Quotes erd
+\end_inset
+ (a man file, read it with
+\family typewriter
+man rcsintro
+\family default
+).
+ This file describes all the basic features of RCS.
+ You should especially notice the comment about a RCS directory, and the
+ notion of a master RCS file (the file ending in
\family typewriter
+,v
+\family default
+).
+\end_layout
-\backslash
-/
+\begin_layout Standard
+Later basic CVS/SVN support was added.
+ You should be familiar with CVS/SVN usage before start using it under LyX.
+ Most of the log messages are not currently displayed after operations -
+ you can check them in terminal window if unsure.
+\end_layout
+
+\begin_layout Standard
+The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+ package—no guarantees are made for older versions.
+\end_layout
+
+\begin_layout Standard
+For introducing your own external commands consult vc-command in the manual
+ of LyX functions.
+\end_layout
+
+\begin_layout Subsection
+RCS commands in LyX
+\end_layout
+
+\begin_layout Standard
+The following sections describe the RCS commands supported by LyX.
+ You can find them in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
+
+Control
+\family default
+ submenu.
+ LyX was tested against RCS 5.7.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Register
+\end_layout
+
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+Register
+\family default
+ item is not visible.
+
+\end_layout
+
+\begin_layout Standard
+This command registers your document with RCS (unless you are under the
+ directory managed by CVS)\SpecialChar \@.
+ You are asked interactively to supply an initial
+ description of the document.
+ The document is now set in Read-Only mode and you have to
+\family sans
+Check
+\begin_inset space ~
+\end_inset
+
+Out
+\begin_inset space ~
+\end_inset
+
+For
+\begin_inset space ~
+\end_inset
+
+Edit
\family default
+, before making any changes to it.
+ A document under revision control has a
+\begin_inset Quotes eld
+\end_inset
+[RCS:<version> <locker>]
\begin_inset Quotes erd
\end_inset
-) found more than once.
+ item tagged to the filename in the minibuffer.
+\end_layout
+
+\begin_layout Standard
+RCS command that is run:
+\family typewriter
+ci -q -u -i -t-"<initial description>" <file-name>
+\end_layout
+
+\begin_layout Standard
+Read
+\family typewriter
+man ci
+\family default
+ to understand the switches.
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
+\end_layout
+
+\begin_layout Standard
+When you are finished editing a file, you check in your changes.
+ When you do this, you are asked for a description of the changes.
+ This is stored in the history log.
+ The version number is bumped, your changes are applied to the master RCS
+ file, the document is unlocked and set to Read-Only mode.
+
+\end_layout
+
+\begin_layout Standard
+RCS command:
+\family typewriter
+ci -q -u -m"<description>" <file-name>
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check Out For Edit
+\end_layout
+
+\begin_layout Standard
+By doing this you lock the document so that only you can edit it.
+ This will also make the document Read-Write only for you.
+ You will usually continue editing for a while and when you are finished
+ you check in your changes.
+ The status line is changed to reflect that you have locked the file.
+
+\end_layout
+
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -q -l <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-\emph on
-No italic correction (
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Revert To Repository Version
+\end_layout
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+\begin_layout Standard
+RCS command:
\family typewriter
+co -f -u<version> <file-name>
+\end_layout
-\backslash
-/
-\family default
+\begin_layout Subsubsection
-\begin_inset Quotes erd
-\end_inset
+\family sans
+Undo Last Checkin
+\end_layout
-) found.
+\begin_layout Standard
+This makes as if the last check in never happened.
+ No changes are made to the document loaded into LyX, but the last version
+ is removed from the master RCS file.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+RCS command:
+\family typewriter
+rcs -o<version> <file-name>
+\end_layout
-\size small
-Accent command
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
+\family sans
+Show History
+\end_layout
+\begin_layout Standard
+This show the complete history of the RCS document.
+ The output of
\family typewriter
-cmd
+rlog <file-name>
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- needs use of
-\begin_inset Quotes eld
-\end_inset
-
-
+ is shown in a browser.
+ See
\family typewriter
-cmd
+man rlog
\family default
+ for more info.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-.
+\begin_layout Subsection
+CVS commands in LyX
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+CVS is now partially supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
-\size small
-Wrong length of dash may have been used.
+Control
+\family default
+ submenu.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-\emph on
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Register
+\end_layout
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
+\end_layout
+\begin_layout Standard
+This command registers in CVS your document ONLY in case you have already
+ the documents directory under CVS control (in particular
\family typewriter
-%s
+CVS/Entries
\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
+\end_layout
+
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
+\begin_layout Standard
+CVS command that is run:
+\family typewriter
+cvs -q add -m
\begin_inset Quotes erd
\end_inset
- expected, found
+<entered message>"
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-%s
-\family default
-
+<file-name>
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Solo
-\begin_inset Quotes eld
-\end_inset
+\end_layout
+\begin_layout Standard
+Read
\family typewriter
-%s
+man svn
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- found.
+ to understand the switches.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-You should use
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Check In Changes
+\end_layout
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
+\begin_layout Standard
+CVS command:
\family typewriter
-%s
-\family default
+cvs -q commit -m"<description>" "<file-name>"
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
- to achieve an ellipsis.
+\family sans
+Revert To Repository Version
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
+\end_layout
-\size small
-Inter-word spacing (
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs update
\begin_inset Quotes eld
\end_inset
+<file-name>
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-\backslash
+\end_layout
-\family default
-
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
-) should perhaps be used.
+\family sans
+Show History
\end_layout
-\begin_layout Enumerate
-
-\size small
-Inter-sentence spacing (
+\begin_layout Standard
+This show the complete history of the CVS document.
+ The output of
+\family typewriter
+cvs log
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-@
-\family default
-
+<file-name>
\begin_inset Quotes erd
\end_inset
-) should perhaps be used.
-\end_layout
-
-\begin_layout Enumerate
-\size small
-Could not find argument for command.
+\family default
+ is shown in a browser.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsection
+SVN commands in LyX
+\end_layout
-\size small
-No match found for
-\begin_inset Quotes eld
+\begin_layout Standard
+SVN is now partially supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
-
-\family typewriter
-%s
+Control
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against SVN 1.4 and 1.5.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Math mode still on at end of LaTeX file.
+\family sans
+Register
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
+\end_layout
-\size small
-Number of
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+This command registers in SVN your document ONLY in case you have already
+ the documents directory under SVN control (in particular
+\family typewriter
+.svn/entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
+\end_layout
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
+\begin_layout Standard
+SVN command that is run:
\family typewriter
-char
-\family default
+snv add -q
+\begin_inset Quotes eld
+\end_inset
+<file-name>
\begin_inset Quotes erd
\end_inset
- doesn't match the number of
-\begin_inset Quotes eld
-\end_inset
+\end_layout
+\begin_layout Standard
+Read
\family typewriter
-char
+man svn
\family default
+ to understand the switches.
+
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Check In Changes
+\end_layout
+
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
+
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In case locking is not enabled.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:SVN-File-Locking"
-\begin_inset Quotes erd
\end_inset
.
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-You should use either
+
\family typewriter
+svn commit -q -m"<description>" <file-name>
+\end_layout
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
+\family sans
+Check Out For Edit
+\end_layout
-\family default
- or
-\family typewriter
+\begin_layout Standard
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be done manually by you!
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+Ditto.
+\end_layout
-\family default
- as an alternative to
-\begin_inset Quotes eld
\end_inset
-
+
\family typewriter
-"
-\family default
+svn update
+\begin_inset Quotes eld
+\end_inset
+<file-name>
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-\size small
-You should use "
-\family typewriter
-'
-\family default
-" (ASCII 39) instead of "
-\family typewriter
-´
-\family default
-" (ASCII 180).
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-User-specified pattern found.
+\family sans
+Revert To Repository Version
\end_layout
-\begin_layout Enumerate
-
-\size small
-This command might not be intended.
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+SVN command:
+\family typewriter
+svn revert -q
+\begin_inset Quotes eld
+\end_inset
-\size small
-\emph on
-Comment displayed.
-\end_layout
+<file-name>
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Enumerate
-\size small
-Either
-\family typewriter
-''
-\backslash
-,'
-\family default
- or
-\family typewriter
-'
-\backslash
-,''
-\family default
- will look better.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Delete this space to maintain correct page references.
+\family sans
+Show History
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-You might wish to put this between a pair of
+\begin_layout Standard
+This show the complete history of the SVN document.
+ The output of
+\family typewriter
+svn log
\begin_inset Quotes eld
\end_inset
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
-\family typewriter
-{}
\family default
+ is shown in a browser.
+\end_layout
+
+\begin_layout Subsubsection
+File Locking
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:SVN-File-Locking"
-\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-\begin_layout Enumerate
+\end_layout
-\size small
-You ought to remove spaces in front of punctuation.
+\begin_layout Standard
+The file exchange through various revision control systems brings the problem
+ of merge conflicts in case two different users try to edit the same (parts
+ of) document.
+ When such conflict happens it needs manual resolving and one reasonable
+ alternative is to provide some kind of locking mechanism, which guarantees
+ that only one user is allowed to edit file at the given time.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+SVN has two mechanisms to provide such kind of mutual exclusivity for file
+ access - locks and automatical setting of write permissions (see sec.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Automatical-Locking-Property"
-\size small
-Could not execute LaTeX command.
+\end_inset
+
+) based on
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svn:needs-lock
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-Don't use
-\family typewriter
+ file svn property
+\begin_inset Foot
+status open
-\backslash
-/
-\family default
- in front of small punctuation.
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
\end_layout
-\begin_layout Enumerate
+\end_inset
-\family typewriter
-\size small
-$
-\backslash
-times$
-\family default
- may look prettier here.
+.
+ In a case this property is detected for a given document LyX starts to
+ use SVN locks for document editing automatically and the whole check-in/out
+ mechanism switches to the same regimen as for RCS.
+ This in particular means there are two different modes how file is used
+ in LyX:
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
+Unlocked state.
+ The loaded file is in the read-only mode.
+ For editation on needs to check-out.
+
+\emph on
+Check-out
+\emph default
+ consists of update from repository and gaining write lock.
+ If the lock is not possible to obtain, we remain in unlocked state.
+\end_layout
-\size small
+\begin_layout Itemize
+Locked state.
+ The loaded file is in the 'normal' edit mode.
+ No other user is allowed to edit the file.
+
\emph on
-Multiple spaces detected in output.
+Check-in
+\emph default
+ consists of commiting changes and releasing write-lock.
+ If no changes have been made to the document, no commit will be produced
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Don't be puzzled by the fact that you will be asked for commit message anyway.
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-This text may be ignored.
+ and only the write-lock will be released.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+SVN commands:
+\end_layout
-\size small
-Use
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-in:
\family typewriter
-
-\begin_inset Quotes eld
+ svn commit -q -m"<description>" "<file-name>"
+\begin_inset Newline newline
\end_inset
+svn unlock "<file-name>"
+\end_layout
-\family default
- to begin quotation, not
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-out:
\family typewriter
-'
-\family default
-.
+svn update "<file-name>"
+\begin_inset Newline newline
+\end_inset
+
+svn lock "<file-name>"
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Use
-\family typewriter
-'
-\family default
- to end quotation, not
\family typewriter
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Automatical-Locking-Property"
-\begin_inset Quotes eld
\end_inset
\family default
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Don't mix quotes.
+Automatical Locking Property
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+The above mentioned automatical setting of write permissions of the .lyx
+ file can be set through
+\family sans
+\bar under
+ F
+\bar default
+ile\SpecialChar \menuseparator
-\size small
-You should perhaps use
-\begin_inset Quotes eld
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
\end_inset
+Control\SpecialChar \menuseparator
-\family typewriter
-cmd
+\bar under
+T
+\bar default
+oggle locking property
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- instead.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You should put a space in front of/after parenthesis.
+.
+ This command is active only when the file is not locked on the svn server
+ (i.e.
+ you need to check-out before proceeding).
\end_layout
-\begin_layout Enumerate
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
+\end_inset
-\size small
-You should avoid spaces in front of/after parenthesis.
+commands:
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-You should not use punctuation in front of/after quotes.
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Set:
+\family typewriter
+ svn propset svn:needs-lock ON "<file-name>"
\end_layout
-\begin_layout Enumerate
-
-\size small
-Double space found.
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Unset:
+\family typewriter
+svn propdel svn:needs-lock "<file-name>"
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
+Revision Information in Documents
+\end_layout
-\size small
-You should put punctuation outside inner/inside display math mode.
+\begin_layout Standard
+Currently there is no way how to provide such kind of information directly
+ from LyX.
+ There are possibilities how to activate it with the help of svn features,
+ but each has its own drawbacks.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+One possibility is to use svn keywords
+\begin_inset Foot
+status collapsed
-\size small
-You ought to not use primitive TeX in LaTeX code.
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should remove spaces in front of
-\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-%s
+.
+ In short -- you set file keywords property (e.g.
+
+\family sans
+svn propset svn:keywords 'Rev' file.lyx
\family default
+) and then paste keyword ERT
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This is an easy way how to ensure that LyX won't break the line in the middle
+ of keyword tag.
+\end_layout
-\begin_inset Quotes erd
\end_inset
+ tag in your document (e.g.
+
+\begin_inset ERT
+status open
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Enumerate
+$Rev$
+\end_layout
-\size small
-\begin_inset Quotes eld
\end_inset
+).
+ This way svn client will automatically substitute revision number (e.g.
+
+\begin_inset ERT
+status open
-\family typewriter
-%s
-\family default
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
+$Rev: 59 $
+\end_layout
- is normally not followed by
-\begin_inset Quotes eld
\end_inset
+) after each update and commit.
+ There are more problems with this approach.
+ Firstly, the '$' character is used in TeX world for math equations, so
+ any occurence of math formula
+\begin_inset Formula $Rev$
+\end_inset
-\family typewriter
-%c
-\family default
-
-\begin_inset Quotes erd
+ become
+\begin_inset Formula $Rev:59$
\end_inset
-.
+ in your LyX document.
+ Similarly for other keywords like Id, Date, Author, etc.
+ Secondly svn output is dependent on your locales, so its very easy that
+ svn would produce some problematic strings once Date is used.
+ Thirdly you get the whole 'Rev: 59' string in your document instead of
+ the plain number.
+ Until subversion implements user's custom keywords it will be hard to use
+ this approach reliably or let LyX to support it directly .
\end_layout
\begin_layout Standard
-In later versions of LyX, we hope to provide a more complete interface to
- this tool (and it's smaller cousin
-\family typewriter
-lacheck
-\family default
-) to exploit the full power of it.
- But it's not exactly useless as it is now: go try it on one of your existing
- documents of a certain length and be surprised.
+The second possibility would be to write your own external-material template
+ which calls either
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
\end_layout
-\begin_layout Section
-Version Control in LyX
+\end_inset
+
+ utility or parses the output of
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svn info file.lyx
\end_layout
-\begin_layout Standard
-by
-\noun on
- Lars Gullik Bjønnes
+\end_inset
+
+ command and returns the result back, when typeseting the document.
\end_layout
\begin_layout Subsection
-Introduction
+SVN and Windows Environment
\end_layout
-\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- it.
- This angered me a bit, so I thought that I should at least make support
- for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has now been done.
- LyX now supports some of the most basic RCS commands.
- If you need to something a bit more sophisticated you will have to do that
- manually in an xterm.
+\begin_layout Quote
+My inclination is to say that if the user cannot figure out the command
+ line operations on their own fairly quickly, they would be well advised
+ to use TortoiseSVN.
+ ---P.
+ A.
+ Rubin
+\end_layout
+
+\begin_layout Subsubsection
+Preparation
\end_layout
\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- read
-\begin_inset Quotes eld
+In addition to installing LyX, and having access to a Subversion repository,
+ the user will need to install the Subversion client program.
+ A Windows installer for the client program is available from
+\begin_inset CommandInset href
+LatexCommand href
+name "CollabNet"
+target "http://www.collab.net/nonav/downloads/subversion/"
+
\end_inset
-rcsintro
-\begin_inset Quotes erd
+.
+ The user may also want to install
+\begin_inset CommandInset href
+LatexCommand href
+name "TortoiseSVN"
+target "http://tortoisesvn.tigris.org/"
+
\end_inset
- (a man file, read it with
+, which integrates Subversion operations into the context (rightclick) menu
+ of Windows Explorer.
+ Operations done outside LyX will typically be more convenient using the
+ Explorer context menu.
+ Note that TortoiseSVN is not a replacement for the client program, which
+ is what LyX itself will use.
+\end_layout
+
+\begin_layout Subsubsection
+Bringing a document under Subversion control
+\end_layout
+
+\begin_layout Standard
+Before a LyX document can be brought under version control in Subversion,
+ its parent directory needs to be under version control.
+ If the document is being added to a project already in the repository,
+ this is accomplished by checking the project out to the directory where
+ the new document will be placed.
+ If the project itself is not yet under version control (for instance, if
+ this document starts a new project), the directory must be imported into
+ the repository.
+ This is done outside LyX.
+ Both import and checkout are easily accomplished from the Explorer context
+ menu using TortoiseSVN, or alternatively can be done using the command
+ line client at a DOS prompt.
+ The procedure for importing the project using TortoiseSVN is described
+ below, assuming an existing repository and a new project being started
+ in
\family typewriter
-man rcsintro
+C:
+\backslash
+new project
\family default
-).
- This file describes all the basic features of RCS.
- You should especially notice the comment about a RCS directory, and the
- notion of a master RCS file (the file ending in
+.
+ For information on using the Subversion client program, run
\family typewriter
-,v
+svn --help
\family default
-).
+in a DOS shell.
\end_layout
-\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS package---no
- guarantees are made for older versions.
+\begin_layout Enumerate
+Locate
+\family typewriter
+C:
+\backslash
+new project
+\family default
+in Windows Explorer, right click it, and select
+\family typewriter
+TortoiseSVN > Repo-browser
+\family default
+.
+ If necessary, adjust the URL for the repository, then click OK.
\end_layout
-\begin_layout Subsection
-RCS commands in LyX
+\begin_layout Enumerate
+Right click the level of the repository under which you want to place the
+ new project folder (typically the top level) and click
+\family typewriter
+Create folder\SpecialChar \ldots{}
+
+\family default
+ Supply a name for the project folder and click OK.
+ Add a message for the log file if desired, then click OK again.
+ The new project folder should appear in the repository.
+ Finally, click OK again to exit the repository browser.
\end_layout
-\begin_layout Standard
-The following sections describe the RCS commands supported by LyX.
- You can find them in the
+\begin_layout Enumerate
+Once again right click
+\family typewriter
+C:
+\backslash
+new project
+\family default
+, this time selecting SVN Checkout\SpecialChar \ldots{}
+ Select the URL of the project folder
+ you just created in the repository, and set the checkout directory to
+\family typewriter
+C:
+\backslash
+new project.
+
+\family default
+ Click OK.
+ You will be warned about a non-empty folder; click OK to proceed.
+ You should now have a
+\family typewriter
+.svn
+\family default
+ directory under
+\family typewriter
+C:
+\backslash
+new project.
+\end_layout
+
+\begin_layout Enumerate
+Create or open your document in LyX and click
\family sans
\bar under
F
\bar under
V
\bar default
-ersion\InsetSpace ~
-Control
-\family default
- submenu.
-\end_layout
-
-\begin_layout Subsubsection
+ersion
+\begin_inset space ~
+\end_inset
-\family sans
-Register
-\end_layout
+Control\SpecialChar \menuseparator
-\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
\bar under
R
\bar default
-egister
-\family default
- item is grayed out.
+egister.
+\family default
+Add a log message and click OK to commit the document to version control.
\end_layout
\begin_layout Standard
-This command registers your document with RCS\SpecialChar \@.
- You are asked interactively
- to supply an initial description of the document.
- The document is now set in Read-Only mode and you have to
+From this point onward, you should have full functionality in the
\family sans
-Check\InsetSpace ~
-Out\InsetSpace ~
-For\InsetSpace ~
-Edit
-\family default
-, before making any changes to it.
- A document under revision control has a
-\begin_inset Quotes eld
-\end_inset
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-[RCS:<version> <locker>]
-\begin_inset Quotes erd
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
\end_inset
- item tagged to the filename in the minibuffer.
-\end_layout
-
-\begin_layout Standard
-RCS command that is run:
-\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
-\end_layout
-
-\begin_layout Standard
-Read
-\family typewriter
-man ci
+Control
\family default
- to understand the switches.
-
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Check In Changes
-\end_layout
-
-\begin_layout Standard
-When you are finished editing a file, you check in your changes.
- When you do this, you are asked for a description of the changes.
- This is stored in the history log.
- The version number is bumped, your changes are applied to the master RCS
- file, the document is unlocked and set to Read-Only mode.
-
-\end_layout
-
-\begin_layout Standard
-RCS command:
-\family typewriter
-ci -q -u -m"<description>" <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Check Out For Edit
-\end_layout
-
-\begin_layout Standard
-By doing this you lock the document so that only you can edit it.
- This will also make the document Read-Write only for you.
- You will usually continue editing for a while and when you are finished
- you check in your changes.
- The status line is changed to reflect that you have locked the file.
-
-\end_layout
-
-\begin_layout Standard
-RCS command:
-\family typewriter
-co -q -l <file-name>
-\end_layout
-
-\begin_layout Subsubsection
+ menu.
+ You also have the option of checking the document in and out, viewing its
+ history, etc.
+ using the TortoiseSVN context menu in Windows Explorer or the Subversion
+ client program from a command prompt.
+\end_layout
-\family sans
-Revert To Last Version
+\begin_layout Subsection
+Further tuning
\end_layout
\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
+With the recent addition of the vc-command function LyX power users are
+ allowed to create their own commands for revision control.
\end_layout
\begin_layout Standard
-RCS command:
-\family typewriter
-co -f -u<version> <file-name>
+As an example you can see how two TortoiseSVN commands could be integrated
+ directly:
\end_layout
-\begin_layout Subsubsection
+\begin_layout Description
+Commit:
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Undo Last Checkin
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
\end_layout
-\begin_layout Standard
-This makes as if the last check in never happened.
- No changes are made to the document loaded into LyX, but the last version
- is removed from the master RCS file.
-
-\end_layout
+\end_inset
+
-\begin_layout Standard
-RCS command:
-\family typewriter
-rcs -o<version> <file-name>
\end_layout
-\begin_layout Subsubsection
+\begin_layout Description
+Revert:
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Show History
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
\end_layout
-\begin_layout Standard
-This show the complete history of the RCS document.
- The output of
-\family typewriter
-rlog <file-name>
-\family default
- is shown in a browser.
- See
-\family typewriter
-man rlog
-\family default
- for more info.
+\end_inset
+
+
\end_layout
\begin_layout Section
and documentation in a single file.
Literate programming tools then parse the file to produce either readable
documentation or compilable source.
- The WEB style of literate programming was created by D.E.
+ The WEB style of literate programming was created by D.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
Knuth during the development of his TeX typesetting software.
\end_layout
\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 Plain Layout
+
+http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-It has a open architecture, i.e., it is easy to plug in new filters and to
- perform special processing that you may need.
+It has a open architecture, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+it is easy to plug in new filters and to perform special processing that
+ you may need.
\end_layout
\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 Plain Layout
+
+http://www.cs.virginia.edu/~nr/noweb/
+\end_layout
\end_inset
\end_layout
\begin_layout Subsection
-\begin_inset LatexCommand label
-name "sub:LyX-and-Literate"
-
-\end_inset
-
LyX and Literate Programming
\end_layout
\begin_layout Standard
The LyX support for Literate Programming is provided by using the generic
- LyX convertors mechanism.
+ LyX converters mechanism.
This support is provided in a
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- way, i.e., you will be able to use this new LyX feature with some other literate
- programming tool of your choice by just changing your LyX preferences.
+ way, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+you will be able to use this new LyX feature with some other literate programmin
+g tool of your choice by just changing your LyX preferences.
\end_layout
\begin_layout Subsubsection
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
It is very simple, it involves the creation of a file with four lines, and
re-running of the auto configuration.
\end_layout
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
The equivalent Noweb term is
\begin_inset Quotes eld
\end_inset
\family typewriter
@
\family default
- must be taken literally, i.e., LyX should be prevented from making any special
- interpretation of what has been written.
+ must be taken literally, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+LyX should be prevented from making any special interpretation of what has
+ been written.
This is handled by a special layout named Scrap, that works like a normal
paragraph but has a free spacing capability.
\end_layout
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
If you have a printed version of this document you will not see any difference
between the previous example and this one.
\end_layout
\begin_layout LyX-Code
<<My scrap>>=
-\newline
+\begin_inset Newline newline
+\end_inset
+
code
-\newline
+\begin_inset Newline newline
+\end_inset
+
more code
-\newline
+\begin_inset Newline newline
+\end_inset
+
even more code
-\newline
+\begin_inset Newline newline
+\end_inset
+
@
\end_layout
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
It is in my list of
\begin_inset Quotes eld
\end_inset
\begin_layout LyX-Code
<<My scrap>>=
-\newline
+\begin_inset Newline newline
+\end_inset
+
def some_function(args):
-\newline
- "This is the doc string for this
- function."
-\newline
+\begin_inset Newline newline
+\end_inset
+
+ "This is the doc string for this function."
+\begin_inset Newline newline
+\end_inset
+
print "My args: ", args
\end_layout
class, and with some code and text on it.
How do I print it? The answer is simple, you select
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-VI,
+View\SpecialChar \menuseparator
+DVI,
\family default
etc.
Just like you would do for a plain document.
\begin_layout Enumerate
When the
\family sans
-\bar under
-U
-\bar default
-pdate\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-VI
+Update\SpecialChar \menuseparator
+DVI
\family default
menu option is chosen, a LaTeX file is generated.
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
The converters are defined in the
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\family default
panel, under the
\begin_inset Quotes eld
tab.
See section
-\begin_inset LatexCommand ref
-reference "sub:converters"
-
-\end_inset
-
+\emph on
+Converters
+\emph default
of the
\emph on
Customization
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
See section
-\begin_inset LatexCommand ref
-reference "sec:converters-etc"
-
-\end_inset
-
+\emph on
+Copiers
+\emph default
of the
\emph on
Customization
\begin_layout LyX-Code
<<build-script>>=
-\newline
+\begin_inset Newline newline
+\end_inset
+
#!/bin/sh
-\newline
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
-\newline
if [ -z "${NOWEB_SOURCE}" ]
-\newline
+\begin_inset Newline newline
+\end_inset
+
then
-\newline
+\begin_inset Newline newline
+\end_inset
+
NOWEB_SOURCE=myfile.nw
-\newline
+\begin_inset Newline newline
+\end_inset
fi
-\newline
+\begin_inset Newline newline
+\end_inset
+
[...
code to extract files ...]
-\newline
+\begin_inset Newline newline
+\end_inset
+
[...
code to compile files ...]
-\newline
+\begin_inset Newline newline
+\end_inset
+
@
\end_layout
\begin_layout Standard
All the Literate Programming support is configured by the
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
+Tools\SpecialChar \menuseparator
+Preferences
\family default
panel in the
\begin_inset Quotes eld
\end_layout
\begin_layout Description
-the\InsetSpace ~
+the
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-\InsetSpace ~
+
+\begin_inset space ~
+\end_inset
+
format Set up via the Formats tab, this is where the Noweb-specific pieces
are set up.
The
\end_layout
\begin_layout Description
-the\InsetSpace ~
+the
+\begin_inset space ~
+\end_inset
+
\family sans
Program
\family default
-\InsetSpace ~
+
+\begin_inset space ~
+\end_inset
+
format This is an empty format whose sole purpose is to be the endpoint
of a conversion (which then allows us to set up a converter for it).
\end_layout
It happens that you can define the editor command line invocation in ddd
by accessing the
\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
-
-\bar under
-H
-\bar default
-elpers
+Edit\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Helpers
\family default
dialog and changing the "Edit Sources" entry.
\end_layout
In my toolbar I like to combine the six short cuts above with two more:
One for
\family sans
-\bar under
-V
-\bar default
-iew
+View
\family default
\SpecialChar \menuseparator
\family sans
-\bar under
-U
-\bar default
-pdate
+Update
\family default
\SpecialChar \menuseparator
\family sans
-\bar under
-D
-\bar default
-VI
+DVI
\family default
and the other for
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-VI
+View\SpecialChar \menuseparator
+DVI
\family default
File menu entries.
Here is how it looks like:
\begin_layout Chapter
Secrets of the LaTeX Masters
-\begin_inset LatexCommand label
+\begin_inset CommandInset label
+LatexCommand label
name "cha:secrets"
\end_inset
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Editor's note: Lars' original chapter was a masterful description of how
to use the
\family typewriter
examples/multicol.lyx
\family default
.
- --- mer
+ — mer
\end_layout
\end_inset
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
The Adventure of the Empty House
\series default
-\newline
+\begin_inset Newline newline
+\end_inset
+
by
\noun on
Sir Arthur Conan Doyle
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\size footnotesize
-The youth moved in the best society--had, so far as was known, no enemies
+The youth moved in the best society–had, so far as was known, no enemies
and no particular vices.
He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
had been broken off by mutual consent some months before, and there was
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\size footnotesize
-Ronald Adair was fond of cards--playing continually, but never for such
- stakes as would hurt him.
+Ronald Adair was fond of cards–playing continually, but never for such stakes
+ as would hurt him.
He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
It was shown that, after dinner on the day of his death, he had played
a rubber of whist at the latter club.
\size default
\size footnotesize
-The evidence of those who had played with him-- Mr.
- Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
+The evidence of those who had played with him– Mr.
+ Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
and that there was a fairly equal fall of the cards.
Adair might have lost five pounds, but not more.
His fortune was a considerable one, and such a loss could not in any way
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_inset OptArg
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
Numbering in Enumerate
\end_layout
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes erd
\end_inset
-,\InsetSpace ~
+,
+\begin_inset space ~
+\end_inset
+
\begin_inset Quotes eld
\end_inset
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\noindent
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_inset Quotes erd
\end_inset
----those large capital letters which begin each new chapter or section.
+—those large capital letters which begin each new chapter or section.
Implementing them with plain LyX/LaTeX is straightforward (assuming you
know some plain TeX!) but does require a lot of work and many iterations,
as you can see by all the ugly TeX-mode stuff at the beginning of this
\begin_layout Standard
\begin_inset ERT
-status inlined
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_layout Standard
\begin_inset ERT
-status inlined
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.40
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.35
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.30
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.25
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.20
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.15
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.10
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.05
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.00
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.05
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.10
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.15
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.20
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.25
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.30
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.35
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.40
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
0.45
\backslash
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\end_layout
\begin_layout Standard
\begin_inset ERT
-status inlined
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\backslash
projects / lyx.git / blobdiff