-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 370
+#LyX 2.0 created this file. For more info see http://www.lyx.org/
+\lyxformat 413
\begin_document
\begin_header
\textclass scrbook
theorems-ams
theorems-ams-extended
\end_modules
+\maintain_unincluded_children false
\begin_local_layout
Format 7
InsetLayout CharStyle:MenuItem
End
\end_local_layout
\language english
+\language_package default
\inputencoding latin1
+\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\graphics default
\default_output_format default
+\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize 12
\use_geometry false
\use_amsmath 0
\use_esint 0
+\use_mhchem 1
+\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\use_refstyle 0
\index Index
\shortcut idx
\color #008000
\paperpagestyle headings
\tracking_changes false
\output_changes false
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict true
\end_header
\begin_body
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph default
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.
+ However, the LyX Team has worked to make LyX extensible through various
+ configuration files and external packages.
That means that if you want to support the Fizzwizzle LaTeX package, you
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 those get documented.
+ We've already had contributions of several new features this way, and some
+ of them are documented here.
+ There are also some more `advanced' features, such as how to control the
+ presentation of bibliographies and how to work with multi-part documents,
+ that are not covered in the
+\emph on
+User's Guide
+\emph default
+ and are discussed here.
\end_layout
\begin_layout Standard
This manual also documents some special features, like fax support, version
control, and SGML support, which require additional software to work properly.
- Lastly, there's a chapter of LaTeX tools and tips, things you can use to
- spruce up your documents by directly using the powerful features of LaTeX.
+ There is also a chapter on LyX's support for HTML.
+ And lastly, there's a chapter of LaTeX tools and tips, things you can use
+ to spruce up your documents by directly using the powerful features of
+ LaTeX.
After all, LyX
\emph on
is
\end_layout
\begin_layout Standard
-Since all the topics in this manual depend heavily on LyX's interaction
+Since many of the topics in this manual depend heavily on LyX's interaction
with LaTeX, this first chapter covers the inner workings of LyX and how
to direct LyX to generate exactly the LaTeX code you want.
It is obviously for more seasoned LyX users.
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
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
from the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu (or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
), then look at the preamble of the resulting
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Convert the document to LaTeX and save to a file with the extension
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in place of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Run LaTeX on the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file (maybe several times), and run any other commands (such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
If you've run LaTeX using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
, LyX then runs a DVI viewer to display the DVI-file.
If you've used
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run a PostScript viewer, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can import a LaTeX file into LyX by using the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
command in LyX.
This will call a program named
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
which will create a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
from the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
box, which you can insert into your document with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to include your file (you should select the type
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
).
We recommend that you only do this if you have a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Declare user defined commands (with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX adds its own set of definitions to the preamble of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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 by selecting
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
dialog.
LyX adds anything in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
There are two variables under LaTeX that control page position:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The default values for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
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,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
can save the day.
- Suppose you're left and top margins are always 0.5
+ Suppose your left and top margins are always 0.5
\begin_inset space \thinspace{}
\end_inset
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:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First, make sure you're using the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
around each label text.
This and other special features of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Some folks also like to look at the log file directly: It is available from
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
You can also enable the `draft' option in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
command, then one of the packages LyX tried to load is missing.
Use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
to get a list of packages that LyX knows about.
This file is updated whenever you reconfigure LyX (using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
If you did use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
misuse
\emph default
any of them, like trying to manually insert lots of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-The basics how to use BibTeX are explained in section
+The most basic information about how to use BibTeX with LyX is contained
+ in the section
\emph on
Bibliography databases (BibTeX)
\emph default
).
LyX supports two packages that provide this style,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, than the established
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package is probably your choice.
If you need special features like short title references, ibidem etc., you
might consider the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The handling of both packages in LyX is basically the same.
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and select under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and check under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and a second one for the database
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The titles for the sections can be added as ordinary sections or subsections.
Since
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
a bibliography for each section or chapter of the document, are not supported
by BibTeX itself.
But the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
An alternative approach is to use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
check
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
In the document, you have to enclose the sections, which shall contain
their own bibliography (including the BibTeX bibliography itself), between
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
(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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\series default
If you are using this approach, then every citation reference has to be
inside some
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Also, the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
everything up to and including the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
line as well as the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX allows you to include files quite easily with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Normally, spaces in this file are invisible, though two consecutive spaces
are conserved, unlike LyX's normal treatment of spaces.
However, setting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The default page layout is rather plain; for an
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For more information on fancy headers, see the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
package documentation.
- This can be found in the file
-\begin_inset Flex CharStyle:Code
+ (
+\begin_inset Flex URL
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/"
+http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
+\end_layout
\end_inset
-.
+)
\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
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
access LaTeX's section and page counters, and so print out the current
section and page numbers.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can switch the header/footer settings on and off for individual pages
using commands like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
\noindent
(you may need to preface this with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Open the dialog by selecting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu item and then select the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Use the LaTeX command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Specify each individual entry by starting each item with the bullet shape
enclosed in square brackets and set as
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
For example, this item was started with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Chapter
-The LyX Server
+LyX and the World Wide Web
\end_layout
-\begin_layout Section
-Introduction
+\begin_layout Standard
+LyX has long supported the export of documents to various web-friendly formats,
+ such as HTML.
+ Before verson 2.0, however, HTML export was always accomplished by the use
+ of external converters.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For details on the use of external converters with LyX, see the
+\emph on
+Converters
+\emph default
+ section of the Customization manual.
\end_layout
-\begin_layout Standard
-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
+ These fall into two large groups: there are converters that use LaTeX as
+ an intermediate format, such as
+\begin_inset Flex Code
+status collapsed
- citations to LyX.
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Section
-Starting the LyX Server
-\end_layout
+\end_inset
-\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
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir
+html2latex
\end_layout
\end_inset
-
-\begin_inset Foot
+, and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-On Windows,
-\emph on
-local
-\emph default
- named pipes are special objects located in
-\begin_inset Flex CharStyle:Code
-status collapsed
+plastex
+\end_layout
-\begin_layout Plain Layout
+\end_inset
-\backslash
+, relying upon LyX to produce the LaTeX; and there is a converter that works
+ directly on LyX files,
+\begin_inset Flex Code
+status collapsed
-\backslash
-.
-\backslash
-pipe
+\begin_layout Plain Layout
+eLyXer
\end_layout
\end_inset
.
+ All of these have different advantages and disadvantages.
+
\end_layout
-\end_inset
+\begin_layout Standard
+The LaTeX-based converters have the advantage that, in principle, they know
+ everything about the exported document that LaTeX does.
+ Such converters do not care, for example, if a certain block of code was
+ produced by LyX or was Evil Red Text.
+ These converters know about
+\begin_inset Flex Code
+status collapsed
- and have the names
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+aux
+\end_layout
+\end_inset
-\begin_inset Flex CharStyle:Code
+ files, counters, and references, and can often make use of the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+bbl
\end_layout
\end_inset
+ files generated by BibTeX.
+ On the other hand, LaTeX is a very hard language to parse---it is sometimes
+ said that only TeX itself understands TeX---and LaTeX-based converters
+ will often choke on what seem to be quite simple constructs; complex ones
+ can throw them completely, and as of this writing, for example, the
+\emph on
+Embedded Objects
+\emph default
+ manual will not export with
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+htlatex
+\end_layout
- and
-\begin_inset Quotes eld
\end_inset
+, though the others will.
+ The other issue concerns how math is handled.
+ These converters typically convert the formulae into little pictures that
+ are then linked from the HTML document.
+ Since these are actually generated by LaTeX, they are accurate.
+ But they do not scale well, and just getting them to look as if they are
+ actually meant to be in your document---so that the font sizes seem to
+ be roughly the same---can be a challenge.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Alex Fernandez's
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+eLyXer
\end_layout
\end_inset
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://elyxer.nongnu.org/"
+target "http://elyxer.nongnu.org/"
-\begin_inset Quotes erd
\end_inset
-.
- External programs write into
-\begin_inset Flex CharStyle:Code
+) solves some of these problems.
+ In particular, the formulae it produces scale perfectly, since it renders
+ math using a combination of HTML and CSS rather than converting the formulae
+ to images.
+ But even moderately complex formula are rendered less well than with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+htlatex
\end_layout
\end_inset
- and read back data from
-\begin_inset Flex CharStyle:Code
+; this reflects the limitations of HTML.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+That said,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+eLyXer
\end_layout
\end_inset
-.
- The stem of the pipe names can be defined in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences
+ can also use jsMath and MathJax for equations, but this setting is only
+ available globally and requires one to have access to a server that runs
+ the backend.
\end_layout
\end_inset
- dialog, for example
-\begin_inset Flex CharStyle:Code
+ More importantly (as of version 1.1.1, at least),
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"/home/myhome/lyxpipe"
+eLyXer
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+ has limited support for math macros and no support for user-defined paragraph
+ or character styles.
+ These limitations make
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe"
+eLyXer
\end_layout
\end_inset
- on Windows.
- You
-\emph on
-must
-\emph default
- configure this manually in order for the server to start.
+ unsuitable for many of the documents LyX users produce.
+ In principle, of course, these problems could be solved, but the LyX developers
+ have decided to follow a different path and have made LyX itself capable
+ of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
+ plaintext.
\end_layout
\begin_layout Standard
-LyX will add the '
-\begin_inset Flex CharStyle:Code
+As of this writing, XHTML output remains under development and should probably
+ be regarded as
+\begin_inset Quotes eld
+\end_inset
+
+experimental
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-.in
+The file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+development/HTML.notes
\end_layout
\end_inset
-' and '
-\begin_inset Flex CharStyle:Code
+, which can be found in the LyX source tree or
+\begin_inset CommandInset href
+LatexCommand href
+name "accessed online"
+target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
+
+\end_inset
+
+, usually contains up-to-date information about the state of XHTML output.
+ See also the list of XHTML bugs on
+\begin_inset CommandInset href
+LatexCommand href
+name "the bug tracker"
+target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+ Still, the developers have chosen this approach because it has several
+ potential advantages over the other two.
+\end_layout
+
+\begin_layout Standard
+These advantages are primarily due to the fact that the XHTML output routines,
+ since they are part of LyX, know everything LyX knows about the document
+ being exported.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-.out
+Another advantage is that, since these routines are internal to LyX, they
+ are immune to changes in LyX's file format, or to changes in the semantics
+ of existing insets.
\end_layout
\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.
- On POSIX (Unix like) systems, if for some other reason, an unused
+ So they know about the table of contents (as displayed in the outline),
+ about the counters associated with different paragraph styles, and about
+ user-defined styles.
+ The XHTML output routines know what LyX knows about internationalization,
+ too, so they will output
\begin_inset Quotes eld
\end_inset
-stale
+Chapter 1
\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.
- On Windows, pipes are deleted by the OS on program termination or crash,
- so
+ or
\begin_inset Quotes eld
\end_inset
-stale
+
+\lang ngerman
+Kapitel
+\lang english
+ 1
\begin_inset Quotes erd
\end_inset
- pipes should not be possible.
+, depending upon the language in effect at the time.
+
\end_layout
\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
+Quite generally, the output routines know what LyX knows about document
+ layout, that is, about how the document is to be rendered on screen.
+ We use this information when we output the document as XHTML.
+ In particular, LyX
+\emph on
+automatically
+\emph default
+ generates CSS style information corresponding to the layout information
+ it uses to render the document on screen: if section headings are supposed
+ to be sans-serif and bold as seen in LyX, then (by default) they will be
+ sans-serif and bold when viewed in a web browser, too.
+ And this is true not just for pre-defined styles, like Section, but for
+ any style, including user-defined styles.
+ Indeed, the XHTML output routines make no distinction between user-defined
+ paragraph and character styles and LyX's own pre-defined styles: in each
+ case, everything LyX knows about the styles is contained in the layout
+ files.
+ And much the same is true as regards pre-defined textual insets, such as
+ footnotes, and various custom insets.
+
+\end_layout
-\begin_layout Plain Layout
-preferences
+\begin_layout Standard
+The result is that XHTML output can be customized and extended in exactly
+ the same way LaTeX output can be customized and extended: through layout
+ files and modules.
+ See chapter five of the
+\emph on
+Customization
+\emph default
+manual for the details.
\end_layout
-\end_inset
+\begin_layout Standard
+The remainder of this chapter contains more detailed information on XHTML
+ output, its limitations, and ways to work around those limitations.
+\end_layout
- file, for each process.
+\begin_layout Section
+Math Output in XHTML
\end_layout
\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
+LyX offers four choices for how math is rendered.
+ These have various advantages and disadvantages:
+\end_layout
+
+\begin_layout Itemize
+MathML
+\begin_inset Newline newline
+\end_inset
+
+MathML is a dialect of XML designed specifically for mathematics on the
+ web, and it typically renders very well in browsers that support it.
+ The disadvantage is that not all browsers support MathML, and support is
+ not complete even in the Gecko-based browsers, such as Firefox.
+\begin_inset Newline newline
+\end_inset
+
+If LyX is unable to render a formula as MathML---for example, if the formula
+ uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyx -dbg lyxserver
+xymatrix
\end_layout
\end_inset
-.
+ package or ERT---then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+HTML
+\begin_inset Newline newline
+\end_inset
+
+As mentioned above,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-development/lyxserver/server_monitor.c
+elyxer
\end_layout
\end_inset
-.
-\end_layout
+ outputs math as HTML, styled by CSS.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
-Another useful tool is command-line based client you will find in
-\begin_inset Flex CharStyle:Code
+\begin_layout Plain Layout
+LyX has borrowed some of the CSS for its HTML output from
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src/client/lyxclient
+elyxer
\end_layout
\end_inset
.
\end_layout
-\begin_layout Section
-Normal communication
-\end_layout
+\end_inset
-\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:
+ For simple formulae, this can work quite well, though with more complicated
+ formulae it tends to break down.
+ Still, this method has the advantage that it is very widely supported and
+ so it may be appropriate for documents that contain only a little, fairly
+ simple math.
+\begin_inset Newline newline
+\end_inset
+
+If Lyx is unable to render a formula as HTML---for example, if the formula
+ uses the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+xymatrix
\end_layout
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-argument
+\end_inset
+
+ package or ERT---then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Description
-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
-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
-argument is an optional argument which is meaningful only to some functions
- (for instance, the
-\begin_inset Quotes eld
+\begin_layout Itemize
+Images
+\begin_inset Newline newline
\end_inset
-self-insert
-\begin_inset Quotes erd
-\end_inset
+Like
+\begin_inset Flex Code
+status collapsed
- LFUN will insert the argument as text at the cursor position).
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Standard
-The answer from LyX will arrive in the output pipe and be of the form
-\end_layout
+\end_inset
-\begin_layout Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
+, LyX will output formulae as images, the very same images, in fact, that
+ are used for instant preview.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Instant preview does
\emph on
-function
+not
\emph default
-:
-\emph on
-data
+have to be on for images to be output, however.
\end_layout
-\begin_layout Standard
-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
+\end_inset
+
+ The advantage to this method is that the images are simply generated by
+ LaTeX, so they are very accurate.
+ The disadvantage, as mentioned earlier, is that these are bitmapped images,
+ so they do not scale terribly well, and one cannot copy them, etc.
+ (As of this writing, there are also problems about equation numbering.
+ See
+\begin_inset CommandInset href
+LatexCommand href
+name "bug 6894"
+target "http://www.lyx.org/trac/ticket/6894"
+
+\end_inset
+
+.)
+\begin_inset Newline newline
+\end_inset
+
+The size of the images can be controlled by setting the
\begin_inset Quotes eld
\end_inset
-font-state
+Math Images Scaling
\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
+ parameter under
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-In case of errors, the response from LyX will have this form
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
\end_layout
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-error message
-\end_layout
+\end_inset
-\begin_layout Standard
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
-\end_layout
+.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
-Examples:
+\begin_layout Plain Layout
+For those who want to know, this controls the resolution of the image in
+ dots per inch and is based upon a default of 75 dpi.
\end_layout
-\begin_layout LyX-Code
-echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
-\begin_inset Newline newline
\end_inset
-echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+
\begin_inset Newline newline
\end_inset
-read a <~/.lyxpipe.out
+If LyX for some reason fails to create an image for a formula (e.g., if a
+ required LaTeX package is not installed), then it will fall back to outputing
+ the raw LaTeX.
+\end_layout
+
+\begin_layout Itemize
+LaTeX
\begin_inset Newline newline
\end_inset
-echo $a
-\end_layout
+Finally, LyX will happily output math as LaTeX.
+ As well as being the output of last resort, this method can be used with
+ such tools as
+\begin_inset CommandInset href
+LatexCommand href
+name "jsMath"
+target "http://www.math.union.edu/~dpvc/jsMath/"
-\begin_layout Section
-Notification
+\end_inset
+
+, which uses JavaScript to render LaTeX embedded in HTML documents.
+ LyX wraps the LaTeX in either a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
\end_layout
-\begin_layout Standard
-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
+ (for inline formulas) or
+\begin_inset Flex Code
+status collapsed
-.
- The format of the string LyX sends is as follows:
+\begin_layout Plain Layout
+div
\end_layout
-\begin_layout Quote
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ (for displayed formulas) with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-NOTIFY:
+class='math'
\end_layout
\end_inset
-
-\emph on
-key-sequence
+, as is required for jsMath.
\end_layout
\begin_layout Standard
-where
-\emph on
-key-sequence
-\emph default
- is the printed representation of the key sequence that was actually typed
- by the user.
+One of these output methods must be selected under
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
\end_layout
-\begin_layout Standard
-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
+.
+ By default, LyX outputs MathML.
+ This is a document-wide setting, therefore.
+\end_layout
+
+\begin_layout Standard
+Eventually, LyX will offer the user the option to select an alternate output
+ method for a particular inset, say, one that isn't being rendered very
+ well by MathML.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+That said, since LyX falls back to images if the inset contains ERT, then
+ one can force output as an image by putting some harmless ERT into the
+ math, for example:
+\begin_inset Formula $a=b\relax$
\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
+
+\end_inset
+
+
\end_layout
\begin_layout Section
-The simple LyX Server Protocol
+Bibliography and Citations
\end_layout
\begin_layout Standard
-LyX implements a simple protocol that can be used for session management.
- All messages are of the form
+XHTML output fully supports bibliographies and citations.
+
\end_layout
-\begin_layout Quote
-LYXSRV:
-\emph on
-clientname
-\emph default
-:
-\emph on
-protocol message
+\begin_layout Standard
+Citation labels are generated by the same machinery that generates LyX's
+ on-screen labels, so the labels will look in the output much as they do
+ in LyX, though better.
+ If you are using numerical citations, then LyX will output numerical labels,
+ such as [1] or [17], rather than simply showing the citation key in square
+ brackets, as it does on-screen.
+ If you are using author-year citations, then LyX will add lowercase letters
+ to the years, just as BibTeX does, if it finds more than one citation for
+ a given author-year combination.
+ The labels will be printed with the bibliography entries.
+ Note that there is, at present, no way to customize the appearance of the
+ labels, for example, to choose between square brackets and parentheses.
\end_layout
\begin_layout Standard
-where
+Bibliography output is handled by the same machinery that handles the presentati
+on of reference information in the citation dialog, so you will see in the
+ XHTML output pretty much what you would see if you were to look at a given
+ entry in the citation dialog.
+ The formatting can be customized in your layout file or, preferably, in
+ a module.
+ See the
\emph on
-protocol message
+Customization
\emph default
- can be
-\begin_inset Quotes eld
-\end_inset
+ manual for the details.
+\end_layout
-hello
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The main defect at present is that cross-referenced information is printed
+ with every entry with which it is associated.
+ So you can see things like this:
+\end_layout
- or
+\begin_layout Quote
+Jason Stanley,
\begin_inset Quotes eld
\end_inset
-bye
+Context and Logical Form
\begin_inset Quotes erd
\end_inset
-.
- If
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 30--68.
+\end_layout
+
+\begin_layout Quote
+Jason Stanley,
\begin_inset Quotes eld
\end_inset
-hello
+Semantics in Context
\begin_inset Quotes erd
\end_inset
- 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
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 201--30.
+\end_layout
-bye
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+This should be fixed before long.
+\end_layout
- sent from LyX will inform clients that LyX is closing.
+\begin_layout Standard
+There is no support at present for sectioned bibliographies.
+ If you have multiple bibliographies, then LyX will print the same bibliography
+ over and over.
\end_layout
\begin_layout Section
-Reverse DVI/PDF search
+Indexes
\end_layout
\begin_layout Standard
-Some DVI/PDF viewers
+LyX will happily export indexes as XHTML, but with certain limitations at
+ the moment.
+\end_layout
+
+\begin_layout Standard
+Index export will be most reliable when you do not attempt to use the fancy
+ constructs that are described in the section on indexes in the
+\emph on
+User's Guide
+\emph default
+.
\begin_inset Foot
status collapsed
\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.
+The main issue here is that LyX itself does not really handle these.
+ It just lets you enter what you would have to enter in raw LaTeX.
\end_layout
\end_inset
- 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
+ We'll describe how they are handled using the subsection headings from
+ that section.
+\end_layout
-\begin_layout Plain Layout
-lyxclient
+\begin_layout Itemize
+Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
+ these, but the entries must be separated by
+\begin_inset Quotes eld
+\end_inset
+
+ !
+\begin_inset Quotes erd
+\end_inset
+
+, that is, there must be spaces around the exclamation point.
+ This is because it is otherwise too difficult to check for escaped exclamation
+ points, ones in math, and so forth.
+\end_layout
+
+\begin_layout Itemize
+Page Ranges: There is no support at all for page ranges, since these make
+ no sense with XHMTL.
+ Instead, you will just get two index entries, one at either end.
\end_layout
+\begin_layout Itemize
+Cross-referencing: There is no support for cross-referencing.
+ If LyX finds an entry containing the
+\begin_inset Quotes eld
\end_inset
- 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.
+|see\SpecialChar \ldots{}
+
+\begin_inset Quotes erd
+\end_inset
+
+ construct, it is just dropped, and the rest is treated as an ordinary index
+ entry.
\end_layout
-\begin_layout Subsection
-Enabling reverse search
+\begin_layout Itemize
+Index Entry Order: LyX does support attempts to fix the sorting order.
+ It will take what is before the first `@' it finds and use that for sorting,
+ taking what follows the first `@' to be the actual entry.
+ At present, LyX does not check for escaped `@', so do not try to index
+ email addresses.
+\end_layout
+
+\begin_layout Itemize
+Index Entry Layout: You can format entries by using the text style dialog,
+ or by using any other method available within LyX itself.
+ There is no support for constructs like:
+\begin_inset Quotes eld
+\end_inset
+
+entry|textbf
+\begin_inset Quotes erd
+\end_inset
+
+.
+ Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
+ and everything that follows it.
+\end_layout
+
+\begin_layout Itemize
+Multiple Indexes: There is no support for multiple indexes.
+ Rather, all index entries will be printed as one large index.
+ To avoid our printing several versions of the index, we print only the
+ main index, so make sure you have one.
+\end_layout
+
+\begin_layout Section
+Nomenclature and Glossary
\end_layout
\begin_layout Standard
-LaTeX provides several different methods for reverse search.
- Some are built-in in the
-\begin_inset Flex CharStyle:Code
-status collapsed
+There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
+\end_layout
-\begin_layout Plain Layout
-latex/pdflatex
+\begin_layout Chapter
+The LyX Server
+\end_layout
+
+\begin_layout Section
+Introduction
\end_layout
+\begin_layout Standard
+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
- 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.
+push
+\begin_inset Quotes erd
+\end_inset
+
+ citations to LyX.
\end_layout
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
+\begin_layout Section
+Starting the LyX Server
\end_layout
\begin_layout Standard
-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
+The LyX server works through the use of a pair of named pipes.
+ These are usually located in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+UserDir
+\end_layout
+
+\end_inset
+
+, (except on Windows, where
+\emph on
+local
+\emph default
+ named pipes are special objects located in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{}
+\backslash
+
+\backslash
+.
+\backslash
+pipe
\end_layout
\end_inset
-eX (plain)->DVI
-\end_layout
-
+) and have the names
+\begin_inset Quotes eld
\end_inset
- or
-\begin_inset Flex CharStyle:MenuItem
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+lyxpipe.in
+\end_layout
+
+\end_inset
+
+
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+lyxpipe.out
\end_layout
\end_inset
-eX (plain)->DraftDVI
-\end_layout
+\begin_inset Quotes erd
\end_inset
- converter in
-\begin_inset Flex CharStyle:MenuItem
+.
+ External programs write into
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+lyxpipe.in
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+ and read back data from
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex -src-specials $$i
+lyxpipe.out
\end_layout
\end_inset
.
- If this doesn't work, check if your TeX engine needs different options
- (the syntax might differ in some distributions).
-\end_layout
+ The stem of the pipe names can be defined in the
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
-\begin_layout Standard
-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
+\end_inset
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+ dialog, for example
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-usepackage{pdfsync}
+"/home/myhome/lyxpipe"
\end_layout
\end_inset
- for reverse PDF search,
-\end_layout
-
-\begin_layout Itemize
-
-\begin_inset Flex CharStyle:Code
+, or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+"
+\backslash
\backslash
-usepackage[active]{srcltx}
+.
+\backslash
+pipe
+\backslash
+lyxpipe"
\end_layout
\end_inset
- for reverse DVI search.
+ on Windows (but any working path can be used).
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
\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
+LyX will add the '
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
+.in
+\end_layout
-\backslash
-usepackage{ifpdf}
-\begin_inset Newline newline
\end_inset
+' and '
+\begin_inset Flex Code
+status collapsed
-\backslash
-ifpdf
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+.out
+\end_layout
-
-\backslash
-usepackage{pdfsync}
-\begin_inset Newline newline
\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.
+ On POSIX (Unix like) systems, if for some other reason, an unused
+\begin_inset Quotes eld
+\end_inset
-\backslash
-else
-\begin_inset Newline newline
+stale
+\begin_inset Quotes erd
\end_inset
-
-\backslash
-usepackage[active]{srcltx}
-\begin_inset Newline newline
+ 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.
+ On Windows, pipes are deleted by the OS on program termination or crash,
+ so
+\begin_inset Quotes eld
\end_inset
+stale
+\begin_inset Quotes erd
+\end_inset
-\backslash
-fi
+ pipes should not be possible.
\end_layout
\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 Standard
-Note that PDFSync might affect the output layout of your document.
- It is therefore advised to disable PDFsync for final documents.
-\end_layout
-
-\begin_layout Subsubsection*
-Built-in reverse search via SyncTeX (DVI and PDF)
-\end_layout
-
-\begin_layout Standard
-Recent versions of
-\begin_inset Flex CharStyle:Code
+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 Code
status collapsed
\begin_layout Plain Layout
-(pdf)latex
+preferences
\end_layout
\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.
+ file, for each process.
\end_layout
\begin_layout Standard
-To enable SyncTeX for DVI output, change the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+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 Code
status collapsed
\begin_layout Plain Layout
-
-{}
+lyx -dbg lyxserver
\end_layout
\end_inset
-eX (plain) -> DVI
+.
\end_layout
-\end_inset
-
- or
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_layout Standard
+You can find a complete example client written in C in the source distribution
+ as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+development/lyxserver/server_monitor.c
\end_layout
\end_inset
-eX (plain) -> DraftDVI
+.
\end_layout
-\end_inset
-
- converter in
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+Another useful tool is command-line based client you will find in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+src/client/lyxclient
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-latex -synctex=1 $$i
+.
\end_layout
-\end_inset
+\begin_layout Section
+Normal communication
+\end_layout
-, and for PDF output, change the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\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 Plain Layout
-LaT
-\begin_inset ERT
-status collapsed
+\begin_layout Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
+\end_layout
-\begin_layout Plain Layout
+\begin_layout Description
+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
+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
+argument is an optional argument which is meaningful only to some functions
+ (for instance, the
+\begin_inset Quotes eld
\end_inset
-eX (pdflatex) -> PDF (pdflatex)
-\end_layout
-
+self-insert
+\begin_inset Quotes erd
\end_inset
- or converter to
-\begin_inset Flex CharStyle:Code
-status collapsed
+ LFUN will insert the argument as text at the cursor position).
+\end_layout
-\begin_layout Plain Layout
-pdflatex -synctex=1 $$i
+\begin_layout Standard
+The answer from LyX will arrive in the output pipe and be of the form
+\end_layout
+
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
\end_layout
+\begin_layout Standard
+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
-.
- Check the documentation of your viewer whether the viewer needs to be configure
-d for the use with SyncTeX.
-\begin_inset Foot
-status collapsed
+font-state
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
+, 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 Plain Layout
--synctex=1
+\begin_layout Standard
+In case of errors, the response from LyX will have this form
\end_layout
-\end_inset
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
+\end_layout
- option enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+where the
+\emph on
+error message
+\emph default
+ should contain an explanation of why the command failed.
+\end_layout
-\begin_layout Plain Layout
--synctex=-1
+\begin_layout Standard
+Examples:
\end_layout
+\begin_layout LyX-Code
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
+\begin_inset Newline newline
\end_inset
-.
-\end_layout
-
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+\begin_inset Newline newline
\end_inset
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
+\end_inset
+echo $a
\end_layout
-\begin_layout Subsection
-Configuring and using specific viewers
+\begin_layout Section
+Notification
\end_layout
-\begin_layout Subsubsection*
-Xdvi (all platforms)
+\begin_layout Standard
+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 Standard
-If you use
-\begin_inset Flex CharStyle:Code
+\begin_layout Quote
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-xdvi
+NOTIFY:
\end_layout
\end_inset
-, 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
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-lyxclient
+\emph on
+key-sequence
\end_layout
+\begin_layout Standard
+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
+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
- program.
- Just setup your document as described above (reverse search is triggered
- by Ctrl-click or Alt-click on Mac OSX, respectively).
+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 Section
+The simple LyX Server Protocol
\end_layout
\begin_layout Standard
-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
+LyX implements a simple protocol that can be used for session management.
+ All messages are of the form
+\end_layout
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats
+\begin_layout Quote
+LYXSRV:
+\emph on
+clientname
+\emph default
+:
+\emph on
+protocol message
\end_layout
+\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
+\begin_inset Quotes eld
\end_inset
- to
-\begin_inset Foot
-status collapsed
+hello
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-On Mac OSX you have to use
-\begin_inset Flex CharStyle:Code
-status collapsed
+ or
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
-\end_layout
+bye
+\begin_inset Quotes erd
+\end_inset
+.
+ If
+\begin_inset Quotes eld
\end_inset
+hello
+\begin_inset Quotes erd
+\end_inset
-\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
+bye
+\begin_inset Quotes erd
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ sent from LyX will inform clients that LyX is closing.
+\end_layout
+
+\begin_layout Section
+Reverse DVI/PDF search
+\end_layout
+
+\begin_layout Standard
+Some DVI/PDF viewers
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-xdvi -editor 'lyxeditor.sh %f %l'
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
+ Skim on Mac OSX and SumatraPDF on Windows.
\end_layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+ 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 Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.sh
+lyxclient
\end_layout
\end_inset
- is a suitable script.
- For example, a minimal shell script is the following one:
+ 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 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
+\begin_layout Subsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:rev-search"
-echo "$COMMAND" > "${LYXPIPE}".in || exit
-\begin_inset Newline newline
\end_inset
-read < "${LYXPIPE}".out || exit
+Automatic setup
\end_layout
\begin_layout Standard
-where
-\begin_inset Flex CharStyle:Code
+In most cases LyX will do the work for you by enabling
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-/path/to/lyxpipe
+Document\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Synchronize with Output
\end_layout
\end_inset
- is the Ly
-\begin_inset ERT
+.
+ In such a case LyX will automatically insert the necessary SyncTeX macro
+ (for PDF) or load the srcltx package (for DVI) respectively.
+ This option can be easily reached also on
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+View/Update
\end_layout
\end_inset
-XServer pipe path specified in
-\begin_inset Flex CharStyle:MenuItem
+ Toolbar.
+\end_layout
+
+\begin_layout Standard
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-Paths
+Document\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Synchronize with Output
\end_layout
\end_inset
.
-\begin_inset Foot
-status collapsed
+\end_layout
-\begin_layout Plain Layout
-In the
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Please note that including the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-development/tools
+srcltx
\end_layout
\end_inset
- folder of a source distribution you can find a
-\begin_inset Flex CharStyle:Code
+ package or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor
-\end_layout
-
-\end_inset
-
- script which is able to locate the
-\emph on
-lyxpipe
-\emph default
- based on your preferences.
+src-specials
\end_layout
\end_inset
+ sometimes has an undesired impact on the typesetting.
+ Thus, you should switch output synchronization off for the final typesetting
+ if you use the
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+srcltx
\end_layout
-\begin_layout Subsubsection*
-MacDviX (Mac OSX)
-\end_layout
+\end_inset
-\begin_layout Standard
-At the end of
-\begin_inset Flex CharStyle:Code
+ package or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/Applications/MacDviX_Folder/calleditor.script
+src-specials
\end_layout
\end_inset
-, add the following lines:
+.
\end_layout
-\begin_layout LyX-Code
-/Applications/Ly
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
+In case you need some more special settings that are not covered by the
+ automatic settings, read the next section about how to set up output synchroniz
+ation manually.
+ If the automatic setup suits your needs, you can readily jump to section
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-{}
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:configuring-viewers"
\end_inset
-X.app/Contents/MacOS/lyxeditor "$2" $1
-\begin_inset Newline newline
-\end_inset
+, where the necessary configuration steps in your viewer -- needed both
+ with the automatic and the manual setup -- are described.
+\end_layout
-exit 1
+\begin_layout Subsection
+Manual setup
\end_layout
\begin_layout Standard
-Modify the lines accordingly if you install LyX somewhere else than in the
- Applications folder.
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+latex/pdflatex
\end_layout
-\begin_layout Standard
-Reverse search is triggered by Alt-click (OPTION-click).
+\end_inset
+
+ 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*
-Skim (Mac OSX)
+Built-in DVI-search via src-specials (DVI only)
\end_layout
\begin_layout Standard
-Enter
-\begin_inset Flex CharStyle:Code
+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 MenuItem
status collapsed
\begin_layout Plain Layout
-open -a Skim.app $$i
-\end_layout
-
-\end_inset
-
- to the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+LaT
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+
+{}
\end_layout
\end_inset
-, and then in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Skim\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Sync
+eX (plain)->DVI
\end_layout
\end_inset
- select Ly
+ or
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaT
\begin_inset ERT
status collapsed
\end_inset
-X.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by COMMAND-SHIFT-click
+eX (plain)->DraftDVI
\end_layout
-\begin_layout Subsubsection*
-Okular (KDE)
-\end_layout
+\end_inset
-\begin_layout Standard
-Go to
-\begin_inset Flex CharStyle:MenuItem
+ converter in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Settings\SpecialChar \menuseparator
-Configure Okular\SpecialChar \ldots{}
-\SpecialChar \menuseparator
-Editor
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
\end_inset
-, select
-\begin_inset Quotes eld
-\end_inset
-
-Custom Text Editor
-\begin_inset Quotes erd
-\end_inset
-
- and add the command
-\begin_inset Flex CharStyle:Code
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient -g %f %l
+latex -src-specials $$i
\end_layout
\end_inset
.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by SHIFT-click.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
\end_layout
\begin_layout Subsubsection*
-YAP (Windows)
+External Packages (PDFSync and scrltx)
\end_layout
\begin_layout Standard
-Launch yap, choose its
-\begin_inset Flex CharStyle:MenuItem
+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 Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Options
+
+\backslash
+usepackage{pdfsync}
\end_layout
\end_inset
- menu and select the
-\begin_inset Quotes eld
-\end_inset
+ for reverse PDF search,
+\end_layout
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+
+\begin_inset Flex Code
+status collapsed
- tab.
- Click on the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-New\SpecialChar \ldots{}
+\backslash
+usepackage[active]{srcltx}
+\end_layout
-\begin_inset Quotes erd
\end_inset
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
+ for reverse DVI search.
+\end_layout
-LyX Editor
-\begin_inset Quotes erd
-\end_inset
+\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
- (or any other name you like) in the
-\begin_inset Quotes eld
+\begin_layout LyX-Code
+
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
\end_inset
-Name:
-\begin_inset Quotes erd
+
+\backslash
+ifpdf
+\begin_inset Newline newline
\end_inset
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
\end_inset
-\SpecialChar \ldots{}
-\begin_inset Quotes erd
+\backslash
+else
+\begin_inset Newline newline
\end_inset
- to open a file dialog and navigate to the directory containing the batch
- file
-\begin_inset Flex CharStyle:Code
-status collapsed
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
-\end_inset
+\backslash
+fi
+\end_layout
- (see below).
- Select
-\begin_inset Flex CharStyle:Code
-status collapsed
+\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 Plain Layout
-lyxeditor.bat
+\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
-\end_inset
+\begin_layout Subsubsection*
+Built-in reverse search via SyncTeX (DVI and PDF)
+\end_layout
- and then specify the program arguments as
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Recent versions of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%f %l
+(pdf)latex
\end_layout
\end_inset
-.
- The
-\begin_inset Flex CharStyle:Code
+ 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
+To enable SyncTeX for DVI output, change the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
+LaT
+\begin_inset ERT
+status collapsed
-\end_inset
+\begin_layout Plain Layout
- wrapper is used for communicating with LyX through the
-\emph on
-lyxpipe
-\emph default
- and is as follows:
+{}
\end_layout
-\begin_layout LyX-Code
-@echo off
-\begin_inset Newline newline
\end_inset
-echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
-\backslash
+eX (plain) -> DVI
+\end_layout
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.in
-\begin_inset Newline newline
\end_inset
-type
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.out
-\end_layout
+ or
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-Make sure that the LyXServer pipe path you specified in LyX is
-\begin_inset Flex CharStyle:Code
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-\backslash
+{}
+\end_layout
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe
+\end_inset
+
+eX (plain) -> DraftDVI
\end_layout
\end_inset
-, otherwise change the
-\begin_inset Flex CharStyle:Code
+ converter in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
\end_inset
- wrapper accordingly.
- You are advised to select in
-\begin_inset Flex CharStyle:MenuItem
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-Paths
+latex -synctex=1 $$i
\end_layout
\end_inset
- a temporary directory whose name does not contain spaces, otherwise inverse
- search will fail.
-\end_layout
-
-\begin_layout Standard
-In yap, reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Subsubsection*
-SumatraPDF (Windows)
-\end_layout
+, and for PDF output, change the
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-SumatraPDF -inverse-search "lyxeditor.bat %f %l"
+
+{}
\end_layout
\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)
+eX (pdflatex) -> PDF (pdflatex)
\end_layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+ or converter to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+pdflatex -synctex=1 $$i
\end_layout
\end_inset
- is the previous wrapper.
- If SumatraPDF.exe is not in your command PATH, use its full file name.
- Again, make sure that the LyX temporary directory name does not contain
- spaces, otherwise inverse search will fail.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by double-click.
-\end_layout
-
-\begin_layout Subsubsection*
-YAP (Cygwin)
-\end_layout
+.
+ Check the documentation of your viewer whether the viewer needs to be configure
+d for the use with SyncTeX.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
-First of all, make sure that yap is your default DVI viewer in the Windows
- environment, then launch it, choose its
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Plain Layout
+The
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Options
+-synctex=1
\end_layout
\end_inset
- menu and select the
-\begin_inset Quotes eld
-\end_inset
+ option enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+-synctex=-1
+\end_layout
- tab.
- Click on the
-\begin_inset Quotes eld
\end_inset
-New\SpecialChar \ldots{}
+.
+\end_layout
-\begin_inset Quotes erd
\end_inset
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
-LyX Editor
-\begin_inset Quotes erd
-\end_inset
+\end_layout
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsection
+Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:configuring-viewers"
-Name:
-\begin_inset Quotes erd
\end_inset
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
-\SpecialChar \ldots{}
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection*
+Xdvi (all platforms)
+\end_layout
- to open a file dialog and navigate to the directory containing the
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+If you use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+xdvi
\end_layout
\end_inset
- program.
- Select
-\begin_inset Flex CharStyle:Code
+, 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
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+lyxclient
\end_layout
\end_inset
- and then specify the program arguments as as
-\begin_inset Flex CharStyle:Code
+ 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
+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 MenuItem
status collapsed
\begin_layout Plain Layout
--g %f %l
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats
\end_layout
\end_inset
-.
- In this way, you will be using the
-\emph on
-lyxsocket
-\emph default
- for communicating with LyX.
- If, for whatever reason, you want to use the
-\emph on
-lyxpipe
-\emph default
-, select
-\begin_inset Flex CharStyle:Code
+ to
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-bash.exe
-\end_layout
-
-\end_inset
-
- instead of
-\begin_inset Flex CharStyle:Code
+On Mac OSX you have to use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
\end_inset
- and specify
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
--c 'lyxeditor.sh "%f" %l'
\end_layout
\end_inset
- as program arguments (here, don't forget the double quotes around
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%f
+xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
\end_inset
- as they are essential), where
-\begin_inset Flex CharStyle:Code
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- is the previously introduced shell script (make sure that
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxeditor.sh
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
+\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
- is in the bash command PATH, otherwise use its full posix name).
+read < "${LYXPIPE}".out || exit
\end_layout
\begin_layout Standard
-In yap, reverse search is triggered by double-click.
-\end_layout
+where
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsubsection*
-SumatraPDF (Cygwin)
+\begin_layout Plain Layout
+/path/to/lyxpipe
\end_layout
-\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ is the Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+
+{}
\end_layout
\end_inset
- in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+XServer pipe path specified in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+Paths
\end_layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+In the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+development/tools
\end_layout
\end_inset
- is the following script (to be placed in your command PATH,
-\begin_inset Flex CharStyle:Code
+ folder of a source distribution you can find a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/usr/local/bin
+lyxeditor
\end_layout
\end_inset
- being the best choice):
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
\end_layout
-\begin_layout LyX-Code
-#!/bin/bash
-\begin_inset Newline newline
\end_inset
-cd $(dirname $1)
-\begin_inset Newline newline
-\end_inset
-SumatraPDF -inverse-search "lyxclient -g %f %l" $(basename $1)
+\end_layout
+
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
\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.
- If SumatraPDF is not in your command PATH, use its full posix path in the
- script above.
- Again, if you want to use the
-\emph on
-lyxpipe
-\emph default
- instead of the
-\emph on
-lyxsocket
-\emph default
-, replace
-\begin_inset Flex CharStyle:Code
+At the end of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"lyxclient -g %f %l"
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
\end_inset
- with
-\begin_inset Flex CharStyle:Code
+, add the following lines:
+\end_layout
+
+\begin_layout LyX-Code
+/Applications/Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-"bash -c 'lyxeditor.sh
-\backslash
-"%f
-\backslash
-" %l'"
+
+{}
\end_layout
\end_inset
-.
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
+
+exit 1
\end_layout
\begin_layout Standard
-Reverse search is triggered by double-click.
+Modify the lines accordingly if you install LyX somewhere else than in the
+ Applications folder.
\end_layout
-\begin_layout Chapter
-Special Document Classes
+\begin_layout Standard
+Reverse search is triggered by Alt-click (OPTION-click).
\end_layout
-\begin_layout Section
-A&A Paper
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
-
-\begin_layout Subsection
-Introduction
+\begin_layout Subsubsection*
+Skim (Mac OSX)
\end_layout
\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (www.edpsciences.fr/aa/
-\begin_inset Flex URL
+Enter
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-http://www.edpsciences.fr/aa/
+open -a Skim.app $$i
\end_layout
\end_inset
-) using Version 5.01 of the document class
-\family typewriter
-aa.cls
-\family default
-.
- This package can be downloaded from the ftp site
+ to the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+, and then in
+\begin_inset Flex MenuItem
+status collapsed
+\begin_layout Plain Layout
+Skim\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Sync
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Flex URL
+\end_inset
+
+ select Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-ftp://ftp.edpsciences.org/pub/aa/readme.html
+{}
\end_layout
\end_inset
-
+X.
\end_layout
\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
-
-
+Reverse search is triggered by COMMAND-SHIFT-click
\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.
-
+\begin_layout Subsubsection*
+Okular (KDE)
\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
-.
-\end_layout
+Go to
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Subsection
-Getting started
+\begin_layout Plain Layout
+Settings\SpecialChar \menuseparator
+Configure Okular\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Editor
\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:
-\end_layout
+\end_inset
-\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).
+, select
+\begin_inset Quotes eld
+\end_inset
+
+Custom Text Editor
+\begin_inset Quotes erd
+\end_inset
+
+ and add the command
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient -g %f %l
\end_layout
-\begin_layout Itemize
-Don't change the option
-\family sans
-Page
-\begin_inset space ~
\end_inset
-style
-\family default
-: Leave it set to
-\family sans
-default
-\family default
.
- The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\begin_layout Subsection
-The header block
+\begin_layout Standard
+Reverse search is triggered by SHIFT-click.
\end_layout
-\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
+\begin_layout Subsubsection*
+YAP (Windows)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Launch yap, choose its
+\begin_inset Flex MenuItem
+status collapsed
-\family sans
-Title
-\family default
-: [required]
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subtitle
-\family default
-: [optional]
-\end_layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Author
-\family default
-: [required]
-\end_layout
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+New\SpecialChar \ldots{}
-\family sans
-Address
-\family default
-: [required]
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
-\end_layout
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
-\end_layout
+Name:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
-\end_layout
+\SpecialChar \ldots{}
-\begin_layout Standard
-There is no need to issue the
-\family typewriter
+\begin_inset Quotes erd
+\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.
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-If you want to place footnotes in the header block, e.
-\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space \space{}
+ (see below).
+ Select
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
+\end_layout
+
\end_inset
-to state your present address, just use the standard footnote via the menu
-
-\family sans
-Insert\SpecialChar \menuseparator
-Footnote.
-
-\family default
- LyX will automagically use the term
-\family typewriter
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-\backslash
-thanks{}
-\family default
- in that case.
+\begin_layout Plain Layout
+%f %l
\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
+
+.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ wrapper is used for communicating with LyX through the
+\emph on
+lyxpipe
+\emph default
+ and is as follows:
+\end_layout
+
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
+\end_inset
+echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
-\end_layout
-\begin_layout Itemize
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.in
+\begin_inset Newline newline
+\end_inset
-\family typewriter
+type
+\backslash
\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.
+.
+\backslash
+pipe
+\backslash
+lyxpipe.out
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Make sure that the LyXServer pipe path you specified in LyX is
+\begin_inset Flex Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
-\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.
-
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe
\end_layout
-\begin_layout Subsection
-The abstract
-\end_layout
+\end_inset
-\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
+, otherwise change the
+\begin_inset Flex Code
+status collapsed
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Subsection
-Supported environments
+\end_inset
+
+ wrapper accordingly.
\end_layout
\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Standard
+\begin_layout Subsubsection*
+SumatraPDF (Windows)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\family sans
-Section
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat %f %l"
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsection
+ in the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsubsection
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Itemize
+ is the previous wrapper.
+ If SumatraPDF.exe is not in your command PATH, use its full file name.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
-\family sans
-Enumerate
+\begin_layout Subsubsection*
+YAP (Cygwin)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+First of all, make sure that yap is your default DVI viewer in the Windows
+ environment, then launch it, choose its
+\begin_inset Flex MenuItem
+status collapsed
-\family sans
-Description
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Caption
-\end_layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Abstract
-\end_layout
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+New\SpecialChar \ldots{}
-\family sans
-Acknowledgment
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Bibliography
-\end_layout
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-LaTeX
-\end_layout
+Name:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-Commands not supported by LyX
-\end_layout
+ field.
+ Now click on the button labeled
+\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
+\SpecialChar \ldots{}
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+ to open a file dialog and navigate to the directory containing the
+\begin_inset Flex Code
+status collapsed
-\backslash
-and
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-email
+ program (which is installed by default on Cygwin along with the LyX executable).
+ Select
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-\backslash
-appendix
+\begin_layout Plain Layout
+-g %f %l
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+.
+ In this way, you will be using the
+\emph on
+lyxsocket
+\emph default
+ for communicating with LyX.
+ If, for whatever reason, you want to use the
+\emph on
+lyxpipe
+\emph default
+, omit the
+\begin_inset Flex Code
+status collapsed
-\backslash
-authorrunning
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ option and be sure to specify the LyXServer pipe path in the LyX preferences.
+\end_layout
-\backslash
-inst{}
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
-\family typewriter
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\backslash
-keywords{}
+\begin_layout Plain Layout
+SumatraPDF.sh
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ in the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
-\backslash
-object{}
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+, where
+\begin_inset Flex Code
+status collapsed
-\backslash
-titlerunning{}
+\begin_layout Plain Layout
+SumatraPDF.sh
\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
+
+ is the following script (to be placed in your command PATH,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+/usr/local/bin
\end_layout
-\begin_layout Subsection
-Figure and Table Floats
+\end_inset
+
+ being the best choice):
\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
-\begin_inset space ~
+\begin_layout LyX-Code
+#!/bin/bash
+\begin_inset Newline newline
\end_inset
-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 ~
+cd $(dirname $1)
+\begin_inset Newline newline
\end_inset
-Settings.
+SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $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:
+This wrapper script is needed because SumatraPDF is a native Windows application
+ and does not understand the posix paths used by the Cygwin version of LyX.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path in
+ the script above.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Enumerate
-Create a wide figure float:
-\family sans
-Insert\SpecialChar \menuseparator
-Float\SpecialChar \menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
-\bar under
-S
-\bar default
-pan
-\begin_inset space ~
\end_inset
-columns
-\family default
+ enables communication via the
+\emph on
+lyxsocket
+\emph default
.
+ Again, omit the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Enumerate
-Enter your caption text.
+\end_inset
+
+ option if you want to use the
+\emph on
+lyxpipe
+\emph default
+, and be sure to specify the LyXServer pipe path in the LyX preferences.
\end_layout
-\begin_layout Enumerate
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
+\begin_layout Standard
+Reverse search is triggered by double-click.
\end_layout
-\begin_layout Enumerate
-Insert your figure
+\begin_layout Section
+Forward search
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-Insert\SpecialChar \menuseparator
-Special
-\begin_inset space ~
+\begin_layout Standard
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
\end_inset
-Character\SpecialChar \menuseparator
-Horizontal
-\begin_inset space ~
+opposite
+\begin_inset Quotes erd
\end_inset
-Fill
-\family default
-.
+ to reverse search.
+ It allows you to let the viewer jump to a given position from within LyX.
+ If forward search is set up (as described in what follows), you can put
+ the cursor anywhere in your LyX document, and hit
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Navigate\SpecialChar \menuseparator
+Forward search
\end_layout
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c
-\begin_inset space ~
\end_inset
-t
-\family default
-.
+ (or select
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Forward search
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
+\end_inset
-\backslash
-parbox[b]{55mm}{
-\family default
-.
-
-\series bold
-Do not close the brace!
+ in the context menu via right mouse click), and then the viewer will jump
+ to that position as well.
+ This implies, of course, that your viewer supports this function.
\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
-\begin_inset space ~
+\begin_layout Standard
+To make forward search possible, you first need to provide the generated
+ output PDF/DVI file with additional information about the TeX sources.
+ This can be done via the methods described in the section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:rev-search"
+
\end_inset
-t
-\family default
-
-\family typewriter
-}
-\family default
.
\end_layout
\begin_layout Standard
-Also, refer to the figures in the example paper.
-\end_layout
+Additionally, you need to configure LyX for using your viewers in
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Subsection
-Referee layout
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+General
\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
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
-\end_layout
+\end_inset
-\begin_layout Subsection
-The example paper
+.
+ We provide a range of tested configurations for some viewers, which you
+ can select from the drop down list.
+ If none of these configurations suits you, you have to find out and enter
+ a suitable configuration yourself.
+ The definition syntax uses the following placeholders:
\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.
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$n
+\end_layout
+
+\end_inset
+
+: row number
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$t
+\end_layout
+
+\end_inset
+
+: name of the (temporary) exported .tex file
+\end_layout
+
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$o
+\end_layout
+
+\end_inset
+
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
+\end_layout
+
+\begin_layout Standard
+Note that only some of the viewers provide full forward search functionality,
+ among them yap, xdvi, okular and Sumatra PDF
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
+ip
+\end_layout
+
+\end_inset
+
+.
+ While many of the widespread PDF viewers (most notably Adobe Reader) do
+ not support forward search at all, some other viewers -- e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ evince and xpdf -- allow at least to reload the document and jump to a
+ specific page of the file, so you can at least navigate
+\begin_inset Quotes eld
+\end_inset
+
+near
+\begin_inset Quotes erd
+\end_inset
+
+.
+ These latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+
+\end_layout
+
+\begin_layout Standard
+Forward search works both with DVI and PDF output.
+ LyX simply checks which preview format you have used before (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
+
+\end_layout
+
+\begin_layout Chapter
+Special Document Classes
\end_layout
\begin_layout Section
-AASTeX
+A&A Paper
\end_layout
\begin_layout Standard
by
\noun on
-Mike Ressler
+Peter Sütterlin
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-AASTeX is a set of macros produced by the American Astronomical Society
- to facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- LyX has proven to be an excellent tool for generating these documents,
- especially given its equation, citation, and figure handling capabilities.
- LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
- incompatible with LyX.
- The AASTeX package may be downloaded from the AASTeX Web site
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.edpsciences.fr/aa/
+\end_layout
+
+\end_inset
+
+) using Version 5.01 of the document class
+\family typewriter
+aa.cls
+\family default
+.
+ This package can be downloaded from the ftp site
\end_layout
\begin_layout Standard
\begin_layout Plain Layout
-http://www.journals.uchicago.edu/AAS/AASTeX
+ftp://ftp.edpsciences.org/pub/aa/readme.html
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-A complete user guide is contained in that package and you should familiarize
- yourself with it thoroughly before embarking on writing a paper in LyX.
- LyX will not reduce the need to figure out all the AASTeX commands, it
- will only reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported LaTeX document
- conforms completely to the requirements of the journal to which you are
- submitting your paper.
+A manual comes together with that package, and this text is not meant to
+ replace the original manual but is merely a short guide in how to realize
+ the correct form of your paper.
+
+\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 involved also some slight changes to the style files, namely
+ the removal of the thesaurus command.
+ The LyX class aa supports the newest version of these style files, V 5.01.
+ If you have an older version installed, please upgrade.
+ For compatibility, the old (version 4) layout has been kept as
+\family sans
+article (A&A V4)
+\family default
+.
+ Please refer to the comments in
+\family typewriter
+LyXDir/layouts/aapaper.layout
+\family default
+.
\end_layout
\begin_layout Subsection
-Starting a New Paper
+Getting started
\end_layout
\begin_layout Standard
-I strongly suggest that you start with the AASTeX template file.
- Click on
+It is recommended you start from the example template distributed with LyX.
+ If you are not using a template, note the following settings:
+\end_layout
+
+\begin_layout Itemize
+Select
\family sans
-File\SpecialChar \menuseparator
-New from
+article (A&A)
\family default
-
+ in the
\family sans
-Template
-\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
-<>
+Document\SpecialChar \menuseparator
+Settings
\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
+ dialog (OK, that one was obvious).
+\end_layout
-\backslash
-altaffilmark
-\family default
- and
-\family typewriter
+\begin_layout Itemize
+Don't change the option
+\family sans
+Page
+\begin_inset space ~
+\end_inset
-\backslash
-altaffiltext
+style
\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 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.
+: Leave it set to
+\family sans
+default
+\family default
+.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
\begin_layout Subsection
-Finishing Your Paper
+The header block
\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
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
+\end_layout
-postprocessing
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- actions which need to be done before you submit it to the journals.
-
+\family sans
+Title
+\family default
+: [required]
\end_layout
-\begin_layout Enumerate
-Export your paper as a LaTeX file (
+\begin_layout Itemize
+
\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
+Subtitle
\family default
-).
-
+: [optional]
\end_layout
-\begin_layout Enumerate
-Edit the resulting
-\family typewriter
-.tex
+\begin_layout Itemize
+
+\family sans
+Author
\family default
- file with your favorite text editor
+: [required]
\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
-\family typewriter
+\begin_layout Itemize
-\backslash
-documentclass
+\family sans
+Address
\family default
- command
+: [required]
\end_layout
-\begin_layout Enumerate
-remove the
-\family typewriter
+\begin_layout Itemize
-\backslash
-usepackage...{fontenc}
+\family sans
+Offprints
\family default
- line if it appears (usually just after
+: [optional] if more than one author: whom to contact for offprint requests.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Mail
+\family default
+: [optional] mail address for contacts.
+\end_layout
+
+\begin_layout Itemize
+
+\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
-documentclass
+maketitle
\family default
-}; also remove the
+ command, this is done automatically by LyX when the header is finished.
+ Although the order of the single header entries doesn't matter it is advised
+ to keep the above sequence, just to get the best optics and meets the layout
+ of the real document.
+\end_layout
+
+\begin_layout Standard
+If you want to place footnotes in the header block, e.
+\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
+
+\family sans
+Insert\SpecialChar \menuseparator
+Footnote.
+
+\family default
+ LyX will automagically use the term
\family typewriter
\backslash
-secnumdepth
+thanks{}
\family default
- line if it appears.
+ in that case.
\end_layout
-\begin_layout Enumerate
-remove everything between (and including) the
+\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 Itemize
+
\family typewriter
\backslash
-makeatletter
+and
\family default
- and
+ to separate different names for more than one author and institute, respectivel
+y.
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-makeatother
+inst{<nr>}
\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
+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
-User specified LaTeX commands
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- comment in the
\family typewriter
-.tex
+
+\backslash
+email{address}
\family default
- file).
+ to supply an email address for fast contact.
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
+
\end_layout
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+\begin_layout Subsection
+The abstract
\end_layout
-\begin_layout Enumerate
-Submit it.
+\begin_layout Standard
+The abstract should immediately follow the header block.
+ With version 5 the abstract environment was changed to a command, and there
+ is now a resctriction to only one paragraph.
+ In addition, it should contain an entry with the keywords.
+ This is not yet implemented for LyX, therefore you have to enter the LaTeX
+ command
+\family typewriter
+
+\backslash
+keywords{}
+\family default
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
\end_layout
\begin_layout Subsection
-Comments On Specific Commands
+Supported environments
\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{}
+The A&A paper layout supports the following environments for structuring
+ your text:
+\end_layout
+
+\begin_layout Itemize
+\family sans
+Standard
\end_layout
-\begin_layout Subsubsection
-Things that work as expected
+\begin_layout Itemize
+
+\family sans
+Section
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
+\begin_layout Itemize
-\begin_layout Plain Layout
+\family sans
+Subsection
+\end_layout
+\begin_layout Itemize
-\backslash
-begin{sloppypar}
+\family sans
+Subsubsection
\end_layout
-\end_inset
+\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
+Caption
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Abstract
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Acknowledgment
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Bibliography
+\end_layout
+
+\begin_layout Itemize
+\family sans
+LaTeX
+\end_layout
+\begin_layout Subsection
+Commands not supported by LyX
\end_layout
\begin_layout Standard
-Because they work as you might expect, I simply list them and the section
- they are found in:
+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
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-documentclass
-\family default
- (2.1.1),
+and
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-begin{document}
-\family default
- (2.2),
+email
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-title
-\family default
- (2.3),
+appendix
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-author
-\family default
- (2.3),
-\family typewriter
-
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
-
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
-
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
-
-\backslash
-section
-\family default
- (2.7),
-\family typewriter
+authorrunning
+\end_layout
-\backslash
-subsection
-\family default
- (2.7),
-\family typewriter
+\begin_layout Itemize
-\backslash
-subsubsection
-\family default
- (2.7),
\family typewriter
\backslash
-paragraph
-\family default
- (2.7),
-\family typewriter
+inst{}
+\end_layout
-\backslash
-facility
-\family default
- (2.10),
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{displaymath}
-\family default
- (2.12),
\family typewriter
\backslash
-begin{equation}
-\family default
- (2.12),
-\family typewriter
+keywords{}
+\end_layout
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{mathletters}
-\family default
- (2.12),
\family typewriter
\backslash
-begin{thebibliography}
-\family default
- (2.13.1),
-\family typewriter
+object{}
+\end_layout
-\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_layout Itemize
-\backslash
-begin{table}
-\family default
- (2.15.4),
\family typewriter
\backslash
-begin{tabular}
-\family default
- (2.15.4),
-\family typewriter
+titlerunning{}
+\end_layout
-\backslash
-caption
-\family default
- (2.15.4),
-\family typewriter
+\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
-\backslash
-label
-\family default
- (2.15.4, amongst other places),
-\family typewriter
+\begin_layout Subsection
+Figure and Table Floats
+\end_layout
-\backslash
-tablerefs
+\begin_layout Standard
+LyX provides support for the necessary float environments
+\family sans
+figure, figure*, table
\family default
- (2.15.5),
-\family typewriter
-
-\backslash
-tablecomments
+ and
+\family sans
+table*
\family default
- (2.15.5),
-\family typewriter
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's
+\begin_inset space ~
+\end_inset
-\backslash
-url
-\family default
- (2.17.4),
-\family typewriter
+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
-\backslash
-end{document}
-\family default
- (2.18).
+Settings.
\end_layout
\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
+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
+Create a wide figure float:
\family sans
-Options
+Insert\SpecialChar \menuseparator
+Float\SpecialChar \menuseparator
+Figure
\family default
- box in
+, then right click in the figure and select
\family sans
-Layout\SpecialChar \menuseparator
-Document
+\bar under
+S
+\bar default
+pan
+\begin_inset space ~
+\end_inset
+
+columns
\family default
.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
+\begin_layout Enumerate
+Enter your caption text.
+\end_layout
+\begin_layout Enumerate
+Press
+\family sans
+Return
+\family default
+ to move the cursor above the caption.
+\end_layout
-\backslash
-end{sloppypar}
+\begin_layout Enumerate
+Insert your figure
\end_layout
+\begin_layout Enumerate
+Position the cursor behind the figure and insert a horizontal fill:
+\family sans
+Insert\SpecialChar \menuseparator
+Special
+\begin_inset space ~
\end_inset
+Character\SpecialChar \menuseparator
+Horizontal
+\begin_inset space ~
+\end_inset
+Fill
+\family default
+.
\end_layout
-\begin_layout Subsubsection
-Things that work, but require more comment
-\end_layout
+\begin_layout Enumerate
+Switch to LaTeX mode:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-The following items work, but require a little more discussion:
+t
+\family default
+.
\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:
+\begin_layout Enumerate
+Enter
\family typewriter
\backslash
-received
+parbox[b]{55mm}{
\family default
-,
-\family typewriter
-
-\backslash
-revised
-\family default
-,
-\family typewriter
+.
+
+\series bold
+Do not close the brace!
+\end_layout
-\backslash
-accepted
-\family default
-,
-\family typewriter
+\begin_layout Enumerate
+Position the cursor behind the caption text, switch to LaTeX mode and insert
+ the closing brace:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-ccc
+t
\family default
-,
+
\family typewriter
-
-\backslash
-cpright
+}
\family default
- (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
+\begin_layout Standard
+Also, refer to the figures in the example paper.
+\end_layout
-\backslash
-slugcomment
-\family default
- (2.1.4),
-\family typewriter
+\begin_layout Subsection
+Referee layout
+\end_layout
-\backslash
-shorttitle
+\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
- (2.1.5),
+ to the documentclass.
+ This must be done using the extra class options field in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
+ Just enter the string
\family typewriter
-
-\backslash
-shortauthors
+referee
\family default
- (2.1.5)
+ there.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Subsection
+The example paper
+\end_layout
-\backslash
-email
+\begin_layout Standard
+The
+\family sans
+Examples
\family default
- (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.
+ directory contains an example paper written with LyX.
+ It is the example paper from the original macro package, translated to
+ LyX.
+ Use it for inspiration, and compare the original LaTeX code with LyX way
+ of writing.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Section
+AASTeX
+\end_layout
-\backslash
-and
-\family default
- (2.3) – will have extra {} after it.
- This should not cause an error.
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Introduction
+\end_layout
-\family typewriter
+\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
+\end_layout
-\backslash
-notetoeditor
-\family default
- (2.6) – can only be used
-\begin_inset Quotes eld
+\begin_layout Standard
+\begin_inset VSpace medskip
\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
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-placetable
-\family default
- (2.8) – can't insert a cross-reference tag, you must type the tag name by
- hand
+http://www.journals.uchicago.edu/AAS/AASTeX
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-placefigure
-\family default
- (2.8) – same as for
-\family typewriter
-\backslash
-placetable
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\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.
+\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
-
-\family typewriter
+\begin_layout Subsection
+Starting a New Paper
+\end_layout
-\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
+\begin_layout Standard
+I strongly suggest that you start with the AASTeX template file.
+ Click on
\family sans
-Insert\SpecialChar \menuseparator
-Short Title
+File\SpecialChar \menuseparator
+New from
\family default
-.
-\begin_inset Quotes eld
-\end_inset
-
-Short Title
-\begin_inset Quotes erd
-\end_inset
-
- inserts an optional argument of the type needed by
+\family sans
+Template
+\family default
+, enter the new file name, then choose the
\family typewriter
-
-\backslash
-figcaption
+aastex.lyx
\family default
-.
- Hopefully it will be renamed someday.
-\end_layout
-
-\begin_layout Itemize
-
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
\family typewriter
-
-\backslash
-objectname
+<>
\family default
- (2.17.1) – same as
+) with the correct information.
+ Many of the AASTeX commands and environments can be implemented directly
+ in LyX, but some cannot: most noticeably
\family typewriter
\backslash
-figcaption
+altaffilmark
\family default
- for the catalog ID optional parameter
-\end_layout
-
-\begin_layout Itemize
-
+ and
\family typewriter
\backslash
-dataset
+altaffiltext
\family default
- (2.17.1) – same as
+, 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 Subsection
+Finishing Your Paper
+\end_layout
+
+\begin_layout Standard
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
+\begin_inset Quotes eld
+\end_inset
+
+postprocessing
+\begin_inset Quotes erd
+\end_inset
+
+ actions which need to be done before you submit it to the journals.
+
+\end_layout
+
+\begin_layout Enumerate
+Export your paper as a LaTeX file (
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
+\family default
+).
+
+\end_layout
+
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
+\family default
+ file with your favorite text editor
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
\family typewriter
\backslash
-figcaption
+documentclass
\family default
- for the catalog ID optional parameter
+ command
+\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
+
+\backslash
+secnumdepth
+\family default
+ line if it appears.
+\end_layout
+
+\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
+ (which should appear immediately after the
+\begin_inset Quotes eld
+\end_inset
+
+User specified LaTeX commands
+\begin_inset Quotes erd
+\end_inset
+
+ comment in the
+\family typewriter
+.tex
+\family default
+ file).
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through LaTeX to make sure it still processes correctly.
+\end_layout
+
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
+\end_layout
+
+\begin_layout Enumerate
+Submit it.
+\end_layout
+
+\begin_layout Subsection
+Comments On Specific Commands
+\end_layout
+
+\begin_layout Standard
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
+\family typewriter
+aasguide.tex
+\family default
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar \ldots{}
+
\end_layout
\begin_layout Subsubsection
-Things not implemented, use TeX code
+Things that work as expected
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
+Because they work as you might expect, I simply list them and the section
+ they are found in:
+\family typewriter
+
+\backslash
+documentclass
+\family default
+ (2.1.1),
+\family typewriter
+\backslash
+begin{document}
+\family default
+ (2.2),
\family typewriter
\backslash
-altaffilmark
+title
\family default
(2.3),
\family typewriter
\backslash
-altaffiltext
+author
\family default
(2.3),
\family typewriter
\backslash
-eqnum
+affil
\family default
- (2.12),
+ (2.3),
\family typewriter
\backslash
-setcounter{equation}
+abstract
\family default
- (2.12), Journal name abbreviations (2.13.4),
+ (2.4),
\family typewriter
\backslash
-figurenum
+keywords
\family default
- (2.14.1),
+ (2.5),
\family typewriter
\backslash
-epsscale
+section
\family default
- (2.14.1),
+ (2.7),
\family typewriter
\backslash
-plotone
+subsection
\family default
- (2.14.1),
+ (2.7),
\family typewriter
\backslash
-plottwo
+subsubsection
\family default
- (2.14.1),
+ (2.7),
\family typewriter
\backslash
-tablenum
+paragraph
\family default
- (2.15.4),
+ (2.7),
\family typewriter
\backslash
-tableline
+facility
\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),
+ (2.10),
\family typewriter
\backslash
-tablenotemark
+begin{displaymath}
\family default
- (2.15.5),
+ (2.12),
\family typewriter
\backslash
-tablenotetext
+begin{equation}
\family default
- (2.15.5), much of Misc (2.17, except
+ (2.12),
\family typewriter
\backslash
-objectname
+begin{eqnarray}
\family default
-,
+ (2.12),
\family typewriter
\backslash
-dataset
+begin{mathletters}
\family default
-,
+ (2.12),
\family typewriter
\backslash
-url
+begin{thebibliography}
\family default
-, and
+ (2.13.1),
\family typewriter
\backslash
-email
+bibitem
\family default
-; see above),
+ (2.13.2), all the cite commands and their variations (2.13.2), the generic
+ graphicx figure commands (2.14.1),
\family typewriter
\backslash
-singlespace
+begin{table}
\family default
- (3.1),
+ (2.15.4),
\family typewriter
\backslash
-doublespace
+begin{tabular}
\family default
- (3.1),
+ (2.15.4),
\family typewriter
\backslash
-onecolumn
+caption
\family default
- (3.2),
+ (2.15.4),
\family typewriter
\backslash
-twocolumn
+label
\family default
- (3.2)
-\end_layout
+ (2.15.4, amongst other places),
+\family typewriter
-\begin_layout Standard
-\begin_inset ERT
-status open
+\backslash
+tablerefs
+\family default
+ (2.15.5),
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+tablecomments
+\family default
+ (2.15.5),
+\family typewriter
+\backslash
+url
+\family default
+ (2.17.4),
+\family typewriter
\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Things that cannot be implemented
+end{document}
+\family default
+ (2.18).
\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
-Insert\SpecialChar \menuseparator
-Child
-\begin_inset space ~
-\end_inset
-
-Document
+The following style options also work correctly:
+\family typewriter
+longabstract
\family default
- to include it in your LyX document.
- See the
+ (2.4),
\family typewriter
-aas_sample.lyx
+preprint
\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
-\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
+ (3.2.1),
\family typewriter
-sample.tex
+preprint2
\family default
-.
-\end_layout
-
-\begin_layout Enumerate
-Make certain that
+ (3.2.2),
\family typewriter
-aastex.layout
+eqsecnum
\family default
- appears in LyX's
+ (3.3),
\family typewriter
-layouts
+flushrt
\family default
- folder
-\end_layout
-
-\begin_layout Enumerate
-Rerun
+ (3.4).
+ Simply put them in the
\family sans
-Tools\SpecialChar \menuseparator
-Reconfigure
+Options
\family default
- in LyX, then restart LyX.
-\end_layout
-
-\begin_layout Enumerate
-Open a regular new file, not from a template.
- Does AASTeX appear in the class list in
+ box in
\family sans
-Document\SpecialChar \menuseparator
-Settings
+Layout\SpecialChar \menuseparator
+Document
\family default
-?
+.
\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
+\begin_inset ERT
+status open
-You should not mix title layouts with normal ones
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-, things haven't been installed correctly.
-\end_layout
-\begin_layout Subsubsection
-LaTeX error processing a table
+\backslash
+end{sloppypar}
\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
-Settings
-\family default
-, then set the
-\family sans
-Alignment
-\family default
- to
-\family sans
-Block
-\family default
-.
- This took care of it for me.
+
\end_layout
\begin_layout Subsubsection
-References
+Things that work, but require more comment
\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;
-
-\emph on
-e.
-\begin_inset space \thinspace{}
-\end_inset
+The following items work, but require a little more discussion:
+\end_layout
-g.
-\begin_inset space \space{}
-\end_inset
+\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
+\backslash
+received
+\family default
+,
+\family typewriter
-\emph default
-type
+\backslash
+revised
+\family default
+,
\family typewriter
-Ressler(1992)
+
+\backslash
+accepted
\family default
-, not
+,
\family typewriter
-Ressler (1992)
+
+\backslash
+ccc
\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
+,
+\family typewriter
+
+\backslash
+cpright
\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.
+ (all from 2.1.3)
\end_layout
-\begin_layout Subsubsection
-Including EPS files
-\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
-\begin_layout Standard
-Even though AASTeX provides its own figure commands (
+\backslash
+slugcomment
+\family default
+ (2.1.4),
\family typewriter
\backslash
-plotone
+shorttitle
\family default
-, for example), I much prefer LaTeX's standard figure commands (with the
- default graphicx).
- You can insert the
+ (2.1.5),
\family typewriter
\backslash
-plotone
+shortauthors
\family default
-, etc.
-\begin_inset space ~
-\end_inset
+ (2.1.5)
+\end_layout
+
+\begin_layout Itemize
-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}
+email
\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
+ (2.3) – can only be used
\begin_inset Quotes eld
\end_inset
-stack everything at the end
+standalone
\begin_inset Quotes erd
\end_inset
- technique.
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
-\begin_layout Subsubsection
-Things I could have done, but didn't
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+and
+\family default
+ (2.3) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\begin_layout Standard
-There are a few
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+notetoeditor
+\family default
+ (2.6) – can only be used
\begin_inset Quotes eld
\end_inset
-pretty
+standalone
\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.
-
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
-\begin_layout Subsection
-Final Caveat
-\end_layout
+\begin_layout Itemize
-\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
+\family typewriter
-\begin_layout Section
-AMS LaTeX
+\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 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 typewriter
+\backslash
+placefigure
+\family default
+ (2.8) – same as for
+\family typewriter
+\backslash
+placetable
\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 Flex URL
-status open
+\begin_layout Itemize
-\begin_layout Plain Layout
+\family typewriter
-http://www.ams.org
+\backslash
+acknowledgements
+\family default
+ (2.9) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
-
- or by ftp at
-\begin_inset Flex URL
-status open
+\begin_layout Itemize
-\begin_layout Plain Layout
+\family typewriter
-ftp://ftp.ams.org/pub/tex/amslatex/
+\backslash
+appendix
+\family default
+ (2.11) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
+\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
.
- These layouts are appropriate, and useful, for any mathematical writing.
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-There are two basic AMS LaTeX layouts:
-\end_layout
+Short Title
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-amsart: The standard AMS article format.
+ inserts an optional argument of the type needed by
+\family typewriter
+
+\backslash
+figcaption
+\family default
+.
+ Hopefully it will be renamed someday.
\end_layout
\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
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS)
+\backslash
+objectname
+\family default
+ (2.17.1) – same as
+\family typewriter
+
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
\end_layout
-\end_inset
+\begin_layout Itemize
- 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
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS-Extended)
-\end_layout
+\backslash
+dataset
+\family default
+ (2.17.1) – same as
+\family typewriter
-\end_inset
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
+\end_layout
- module, which must be loaded manually.
+\begin_layout Subsubsection
+Things not implemented, use TeX code
\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
+\begin_inset ERT
+status open
\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)
+\backslash
+begin{sloppypar}
\end_layout
\end_inset
-, the module
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-Theorems (Order by Chapter)
\end_layout
-\end_inset
+\begin_layout Standard
-.
- These will number the results as
-\begin_inset Formula $n.m$
-\end_inset
+\family typewriter
-, 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
+\backslash
+altaffilmark
+\family default
+ (2.3),
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Starred)
-\end_layout
+\backslash
+altaffiltext
+\family default
+ (2.3),
+\family typewriter
-\end_inset
+\backslash
+eqnum
+\family default
+ (2.12),
+\family typewriter
- provides that option.
-\end_layout
+\backslash
+setcounter{equation}
+\family default
+ (2.12), Journal name abbreviations (2.13.4),
+\family typewriter
-\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
+figurenum
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS)
-\end_layout
+\backslash
+epsscale
+\family default
+ (2.14.1),
+\family typewriter
-\end_inset
+\backslash
+plotone
+\family default
+ (2.14.1),
+\family typewriter
- module, and the others mentioned, with other classes, such as
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+plottwo
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Plain Layout
-article
-\end_layout
-
-\end_inset
+\backslash
+tablenum
+\family default
+ (2.15.4),
+\family typewriter
-,
-\begin_inset Flex CharStyle:Code
-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
-report
-\end_layout
+\backslash
+tablenotemark
+\family default
+ (2.15.5),
+\family typewriter
-\end_inset
+\backslash
+tablenotetext
+\family default
+ (2.15.5), much of Misc (2.17, except
+\family typewriter
+\backslash
+objectname
+\family default
,
-\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
-There is a long list of included environments provided by these layouts.
- In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
- variety of `theorem' environments.
- However, the AMS recommends the environments that are available in LyX.
-
-\end_layout
-
-\begin_layout Standard
-The following environments—as well as the standard environments, such as
-
-\begin_inset Flex CharStyle:Noun
-status collapsed
-
-\begin_layout Plain Layout
-section
-\end_layout
-
-\end_inset
+\family typewriter
+\backslash
+dataset
+\family default
,
-\begin_inset Flex CharStyle:Noun
-status collapsed
-
-\begin_layout Plain Layout
-bibliography
-\end_layout
+\family typewriter
-\end_inset
+\backslash
+url
+\family default
+, and
+\family typewriter
-,
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\backslash
+email
+\family default
+; see above),
+\family typewriter
-\begin_layout Plain Layout
-title
-\end_layout
+\backslash
+singlespace
+\family default
+ (3.1),
+\family typewriter
-\end_inset
+\backslash
+doublespace
+\family default
+ (3.1),
+\family typewriter
-,
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\backslash
+onecolumn
+\family default
+ (3.2),
+\family typewriter
-\begin_layout Plain Layout
-author
+\backslash
+twocolumn
+\family default
+ (3.2)
\end_layout
-\end_inset
-
-, and
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\begin_layout Standard
+\begin_inset ERT
+status open
\begin_layout Plain Layout
-date
-\end_layout
-
-\end_inset
-—are provided by
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-article (AMS)
+\backslash
+end{sloppypar}
\end_layout
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-book (AMS)
-\end_layout
-
-\end_inset
-:
\end_layout
-\begin_layout Description
-Address This should be the author's permanent address.
+\begin_layout Subsubsection
+Things that cannot be implemented
\end_layout
-\begin_layout Description
-Current
+\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
+Insert\SpecialChar \menuseparator
+Child
\begin_inset space ~
\end_inset
-Address This should be the author's temporary address at the time of submission,
- if different from the Address.
+Document
+\family default
+ to include it in your LyX document.
+ See the
+\family typewriter
+aas_sample.lyx
+\family default
+ file to see an example of this.
\end_layout
-\begin_layout Description
-Email Author's e-mail address
+\begin_layout Subsection
+FAQs, Tips, Tricks, and Other Ruminations
\end_layout
-\begin_layout Description
-URL Author's Web address, if desired.
+\begin_layout Subsubsection
+Getting LyX and AASTeX to cooperate
\end_layout
-\begin_layout Description
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
+\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 Description
-Subjectclass These refer to the AMS Subject Classifications, published and
- described in
-\emph on
-Mathematical Reviews
-\emph default
+\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
+\family default
.
- These are also available online at the AMS cites listed above.
\end_layout
-\begin_layout Description
-Thanks
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
+\family default
+ appears in LyX's
+\family typewriter
+layouts
+\family default
+ folder
\end_layout
-\begin_layout Description
-Dedicatory
+\begin_layout Enumerate
+Rerun
+\family sans
+Tools\SpecialChar \menuseparator
+Reconfigure
+\family default
+ in LyX, then restart LyX.
\end_layout
-\begin_layout Description
-Translator
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AASTeX appear in the class list in
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+?
\end_layout
\begin_layout Standard
-The following environments are provided by both the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Theorems
-\end_layout
-
+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
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
+You should not mix title layouts with normal ones
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-Theorems (AMS)
+, things haven't been installed correctly.
\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
+\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
- module:
+Settings
+\family default
+, then set the
+\family sans
+Alignment
+\family default
+ to
+\family sans
+Block
+\family default
+.
+ This took care of it for me.
\end_layout
-\begin_layout Theorem
-This is typically used for the statements of major results.
-
+\begin_layout Subsubsection
+References
\end_layout
-\begin_layout Corollary*
-This is used for statements which follow fairly directly from previous statement
-s.
- Again, these can be major results.
+\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;
-\end_layout
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Lemma
-These are smaller results needed to prove other statements.
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\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).
+\emph default
+type
+\family typewriter
+Ressler(1992)
+\family default
+, not
+\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
+\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.
\end_layout
-\begin_layout Definition*
-Guess what this is for.
- The font is different for this environment than for the previous ones.
-
+\begin_layout Subsubsection
+Including EPS files
\end_layout
-\begin_layout Example*
-Used for examples illustrating proven results.
+\begin_layout Standard
+Even though AASTeX provides its own figure commands (
+\family typewriter
+
+\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
+\family default
+, etc.
+\begin_inset space ~
+\end_inset
+
+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
+ 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
+
+stack everything at the end
+\begin_inset Quotes erd
+\end_inset
+
+ technique.
\end_layout
-\begin_layout Problem
-It's not really known what this is for.
- You should figure it out.
+\begin_layout Subsubsection
+Things I could have done, but didn't
\end_layout
-\begin_layout Exercise*
-Write a description for this one.
+\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.
+
\end_layout
-\begin_layout Remark
-This environment is also a type of theorem, usually a lesser sort of observation.
+\begin_layout Subsection
+Final Caveat
\end_layout
-\begin_layout Claim*
-Often used in the course of giving a proof of a larger result.
+\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 Case
-Generally, these are used to break up long arguments, using specific instances
- of some condition.
-
+\begin_layout Section
+AMS LaTeX
\end_layout
-\begin_layout Case
-The numbering scheme for cases is on its own, not together with other numbered
- statements.
-
+\begin_layout Standard
+by
+\noun on
+David Johnson; updated by Richard Heck
\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.
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
-And these environments are provided by
-\begin_inset Flex CharStyle:Code
-status collapsed
+\noindent
+The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
+ papers to be submitted to American Mathematical Society publications.
+ The layouts are not tailored to a specific journal, but easily can be.
+ You should refer to the AMS documentation for specific instructions for
+ each journal (usually it will entail only changing a single line in the
+ TeX output).
+ That documentation is available on the Web at
+\begin_inset Flex URL
+status open
\begin_layout Plain Layout
-Theorems (AMS-Extended)
+
+http://www.ams.org
\end_layout
\end_inset
-:
-\end_layout
-
-\begin_layout Criterion*
-A required condition.
-\end_layout
+ or by ftp at
+\begin_inset Flex URL
+status open
-\begin_layout Algorithm*
-A general procedure to be used.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Axiom*
-This is a property or statement taken as true within the system being discussed.
+ftp://ftp.ams.org/pub/tex/amslatex/
\end_layout
-\begin_layout Condition*
-Sometimes used to state a condition assumed within the present context of
- discussion.
-\end_layout
+\end_inset
-\begin_layout Note*
-Similar to a Remark.
+.
+ These layouts are appropriate, and useful, for any mathematical writing.
+
\end_layout
-\begin_layout Notation*
-Used for the explanation of, yes, notation.
+\begin_layout Standard
+There are two basic AMS LaTeX layouts:
\end_layout
-\begin_layout Summary
-Do we really need to tell you?
+\begin_layout Itemize
+amsart: The standard AMS article format.
\end_layout
-\begin_layout Acknowledgement*
-Acknowledgement.
+\begin_layout Itemize
+amsbook: the standard AMS book (really, monograph) format.
+
\end_layout
-\begin_layout Conclusion*
-Sometimes used at the end of a long train of argument.
-\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 Code
+status collapsed
-\begin_layout Fact
-Used in a way similar to Proposition, though perhaps lower on the scale.
+\begin_layout Plain Layout
+Theorems (AMS)
\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
+\end_inset
-\begin_layout Section
-AGU journals (
-\family sans
-aguplus
-\family default
-)
-\end_layout
+ 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 Code
+status collapsed
-\begin_layout Standard
-by
-\shape smallcaps
-Martin Vermeer
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
-\begin_layout Subsection
-Description
+\end_inset
+
+ module, which must be loaded manually.
\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
+By default, theorems and the like are numbered consecutively throughout
+ the document, but this may be modified by loading the module
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-ftp://ftp.agu.org/journals/latex/journals
+Theorems (Order by Section)
\end_layout
\end_inset
-).
+ or, if you are using
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+book (AMS)
\end_layout
-\begin_layout Subsection
-New styles
+\end_inset
+
+, the module
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (Order by Chapter)
\end_layout
-\begin_layout Standard
-Redefined are
-\family sans
-Paragraph
-\family default
-,
-\family sans
-Paragraph*
-\family default
-.
- They are still called this in the LyX GUI, though their LaTeX equivalents
- in the AGU classes are
-\family sans
-Subsubsubsection
-\family default
- and
-\family sans
-Subsubsubsection*
-\family default
+\end_inset
+
.
+ These will number the results as
+\begin_inset Formula $n.m$
+\end_inset
+
+, 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 module
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (Starred)
\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
-,
-\family sans
-AuthorAddr
-\family default
-,
-\family sans
-SlugComment
-\family default
-.
- These are mostly manuscript attributes and defined in the AGU class documentati
-on.
+\end_inset
+
+ provides that option.
\end_layout
\begin_layout Standard
-I suspect this is still badly incomplete.
-\end_layout
+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 Code
+status collapsed
-\begin_layout Subsection
-New floats
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Standard
+\end_inset
-\family sans
-Planotable
-\family default
- and
-\family sans
-Plate
-\family default
-.
- We also have a new
-\family sans
-Table_Caption
-\family default
-.
+ module, and the others mentioned, with other classes, such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+article
\end_layout
-\begin_layout Subsection
-Supported journals
+\end_inset
+
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+report
\end_layout
-\begin_layout Itemize
+\end_inset
-\emph on
-Journal of Geophysical Research
-\emph default
-:
-\family typewriter
-jgrga.layout
-\family default
- — Martin Vermeer
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+book (KOMA-script)
\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_inset
+
+, and so forth.
\end_layout
\begin_layout Subsection
-Bugs and things to remember
+What these layouts provide
\end_layout
\begin_layout Standard
-In order to use the new layouts, you must remember to do the following for
- a new document:
+There is a long list of included environments provided by these layouts.
+ In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
+ variety of `theorem' environments.
+ However, the AMS recommends the environments that are available in LyX.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+The following environments—as well as the standard environments, such as
+
+\begin_inset Flex Noun
+status collapsed
-\emph on
-Turn off babel
-\emph default
-.
- This can be done in the
-\family sans
-Layout\SpecialChar \menuseparator
-Document
-\family default
- or
-\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.)
+\begin_layout Plain Layout
+section
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
-jgrga
-\family default
- into the document's
-\family sans
-Extra Options
-\family default
- field.
- (Yes, this is a bug.)
-\end_layout
+\end_inset
-\begin_layout Enumerate
-Make sure you use the
-\family typewriter
-agu.bst
-\family default
- bibliography style, by entering
-\family sans
-agu
-\family default
- into the second field of the BibTeX inset.
- None of the standard styles will do.
-\end_layout
+,
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Section
-Broadway
+\begin_layout Plain Layout
+bibliography
\end_layout
-\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
-\end_layout
+\end_inset
-\begin_layout Subsection
-Introduction
-\end_layout
+,
+\begin_inset Flex Noun
+status collapsed
-\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.
+\begin_layout Plain Layout
+title
\end_layout
-\begin_layout Subsection
-Special problems
-\end_layout
+\end_inset
-\begin_layout Standard
-The same as in Hollywood.
-\end_layout
+,
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Subsection
-Special features
+\begin_layout Plain Layout
+author
\end_layout
-\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.
-\end_layout
+\end_inset
-\begin_layout Subsection
-Paper size and Margins
-\end_layout
+, and
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\begin_layout Plain Layout
+date
\end_layout
-\begin_layout Subsection
-Environments
-\end_layout
+\end_inset
-\begin_layout Standard
-The following environments are available.
- You can use broadway.bind to get the bind keys shown at the right.
-\end_layout
+—are provided by
+\begin_inset Flex Code
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+article (AMS)
+\end_layout
-\family sans
-Standard
-\begin_inset Newline newline
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
-\family default
-You should not have to use this, but it is here for anything that does not
- fit otherwise.
+\begin_layout Plain Layout
+book (AMS)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Narrative
-\begin_inset space \hfill{}
-\end_inset
-
-M-z n
-\begin_inset Newline newline
\end_inset
-
-\family default
-Used to describe stage setting and the action.
- First use of speaker names in all CAPs.
+:
\end_layout
-\begin_layout Itemize
-
-\family sans
-ACT
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Description
+Address This should be the author's permanent address.
+\end_layout
-M-z a
-\begin_inset Newline newline
+\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
-\family default
-Automatically numbered.
- On screen it will be arabic, but will print as Roman.
+\begin_layout Description
+Email Author's e-mail address
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+URL Author's Web address, if desired.
+\end_layout
-\family sans
-ACT*
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
+\end_layout
-M-z S at
-\begin_inset Newline newline
-\end_inset
+\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
-\family default
-Subtitle for
-\family sans
-ACT.
+\begin_layout Description
+Dedicatory
+\end_layout
-\family default
- It is just centered text.
+\begin_layout Description
+Translator
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The following environments are provided by both the
+\begin_inset Flex Code
+status collapsed
-\family sans
-SCENE
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Plain Layout
+Theorems
+\end_layout
-M-z S-S
-\begin_inset Newline newline
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
-\family default
-Not automatically numbered.
- You supply the number.
- This is because I couldn't figure out how.
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Itemize
-
-\family sans
-AT_RISE:
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-R
-\begin_inset Newline newline
\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 Code
+status collapsed
-\family default
-A special case of Narrative to describe the setting and action as the curtain
- rises.
+\begin_layout Plain Layout
+Theorems (Starred)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Speaker
-\begin_inset space \hfill{}
-\end_inset
-
-M-z s
-\begin_inset Newline newline
\end_inset
+ module:
+\end_layout
-\family default
-The speaker's (actor's) title, centered in all CAPS.
+\begin_layout Theorem
+This is typically used for the statements of major results.
+
\end_layout
-\begin_layout Itemize
+\begin_layout Corollary*
+This is used for statements which follow fairly directly from previous statement
+s.
+ Again, these can be major results.
+
+\end_layout
-\family sans
-Parenthetical
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Lemma
+These are smaller results needed to prove other statements.
+\end_layout
-M-z p
-\begin_inset Newline newline
-\end_inset
+\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
-\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
-.
+\begin_layout Definition*
+Guess what this is for.
+ The font is different for this environment than for the previous ones.
+
\end_layout
-\begin_layout Itemize
+\begin_layout Example*
+Used for examples illustrating proven results.
+\end_layout
-\family sans
-Dialogue
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Problem
+It's not really known what this is for.
+ You should figure it out.
+\end_layout
-M-z d
-\begin_inset Newline newline
-\end_inset
+\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
-\family default
-What the Speaker says.
+\begin_layout Claim*
+Often used in the course of giving a proof of a larger result.
\end_layout
-\begin_layout Itemize
+\begin_layout Case
+Generally, these are used to break up long arguments, using specific instances
+ of some condition.
+
+\end_layout
-\family sans
-CURTAIN
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Case
+The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
+\end_layout
-M-z S-C
-\begin_inset Newline newline
-\end_inset
+\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 Code
+status collapsed
-\family default
-The curtain comes down.
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Title
-\begin_inset space \hfill{}
\end_inset
-M-z S-T
+:
\end_layout
-\begin_layout Itemize
+\begin_layout Criterion*
+A required condition.
+\end_layout
-\family sans
-Author
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Algorithm*
+A general procedure to be used.
+\end_layout
-M-z S-A
+\begin_layout Axiom*
+This is a property or statement taken as true within the system being discussed.
\end_layout
-\begin_layout Itemize
+\begin_layout Condition*
+Sometimes used to state a condition assumed within the present context of
+ discussion.
+\end_layout
-\family sans
-Right_Address
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Note*
+Similar to a Remark.
+\end_layout
-M-z r
+\begin_layout Notation*
+Used for the explanation of, yes, notation.
\end_layout
-\begin_layout Standard
-Hello there.
+\begin_layout Summary
+Do we really need to tell you?
\end_layout
-\begin_layout Section
-Dinbrief
+\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
-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.
+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
-EGS journals (
+AGU journals (
\family sans
-egs
+aguplus
\family default
)
\end_layout
\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
+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
-www.copernicus.org
+ftp://ftp.agu.org/journals/latex/journals
\end_layout
\end_inset
-.
+).
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-
+Redefined are
\family sans
-Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
- Accepted
+Paragraph
\family default
,
\family sans
-Offsets
+Paragraph*
\family default
.
- The current layout file is unfortunately very unmodular and would benefit
- from using the various
-\family typewriter
-std*.inc
+ They are still called this in the LyX GUI, though their LaTeX equivalents
+ in the AGU classes are
+\family sans
+Subsubsubsection
\family default
- file inclusions.
-\end_layout
-
-\begin_layout Section
-Elsevier Journals
+ and
+\family sans
+Subsubsubsection*
+\family default
+.
\end_layout
\begin_layout Standard
-By
-\noun on
-Rod Pinna
+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
+,
+\family sans
+AuthorAddr
+\family default
+,
+\family sans
+SlugComment
+\family default
+.
+ These are mostly manuscript attributes and defined in the AGU class documentati
+on.
\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
-
-http://authors.elsevier.com/
+I suspect this is still badly incomplete.
\end_layout
-\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.
+\begin_layout Subsection
+New floats
\end_layout
\begin_layout Standard
-To make use of
-\family typewriter
-elsart.cls
-\family default
-, a file
+
+\family sans
+Planotable
+\family default
+ and
+\family sans
+Plate
+\family default
+.
+ We also have a new
+\family sans
+Table_Caption
+\family default
+.
+\end_layout
+
+\begin_layout Subsection
+Supported journals
+\end_layout
+
+\begin_layout Itemize
+
+\emph on
+Journal of Geophysical Research
+\emph default
+:
\family typewriter
-elsart.layout
+jgrga.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.
+ — Martin Vermeer
\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
+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
-clean
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Bugs and things to remember
+\end_layout
- 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.
+\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 Section
-Foils [aka
+\begin_layout Enumerate
+
+\emph on
+Turn off babel
+\emph default
+.
+ This can be done in the
\family sans
-FoilTeX
+Layout\SpecialChar \menuseparator
+Document
\family default
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:foiltex"
+ or
+\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.)
+\end_layout
-\end_inset
+\begin_layout Enumerate
+Enter
+\family typewriter
+jgrga
+\family default
+ into the document's
+\family sans
+Extra Options
+\family default
+ 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
+agu
+\family default
+ into the second field of the BibTeX inset.
+ None of the standard styles will do.
+\end_layout
+\begin_layout Section
+Broadway
\end_layout
\begin_layout Standard
by
-\noun on
-Allan Rae
+\shape smallcaps
+Garst Reese
\end_layout
\begin_layout Subsection
\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
-FoilTeX
-\family default
- slides class.
- This section documents the latter.
+Broadway is for writing plays.
+ The format is more decorative than Hollywood, and much less standardized.
+ This format should be suitable for workshops.
\end_layout
-\begin_layout Standard
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\begin_layout Subsection
+Special problems
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
+The same as in Hollywood.
+\end_layout
+\begin_layout Subsection
+Special features
\end_layout
\begin_layout Standard
-\align center
-
-\size large
-This section documents the class
-\begin_inset Quotes eld
-\end_inset
-
-
+Insert the
\family sans
-slides (FoilTeX)
+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.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-
-\emph on
-only.
+\begin_layout Subsection
+Paper size and Margins
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
+\begin_layout Subsection
+Environments
\end_layout
\begin_layout Standard
-If you're looking for the documentation for
-\begin_inset Quotes eld
-\end_inset
+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
-slides (default)
+Standard
+\begin_inset Newline newline
+\end_inset
+
+
\family default
+You should not have to use this, but it is here for anything that does not
+ fit otherwise.
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Itemize
+
+\family sans
+Narrative
+\begin_inset space \hfill{}
\end_inset
-, check out section
-\begin_inset space ~
+M-z n
+\begin_inset Newline newline
\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:slitex"
+\family default
+Used to describe stage setting and the action.
+ First use of speaker names in all CAPs.
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
- If your machine doesn't have the
\family sans
-foils
-\family default
- class [
-\begin_inset Quotes eld
+ACT
+\begin_inset space \hfill{}
+\end_inset
+
+M-z a
+\begin_inset Newline newline
\end_inset
-\family sans
-slides (FoilTeX)
\family default
+Automatically numbered.
+ On screen it will be arabic, but will print as Roman.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-] installed, you'll probably have to use the default
\family sans
-slides
+ACT*
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S at
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- class, which isn't quite as good as
+Subtitle for
\family sans
-foils.
-\end_layout
+ACT.
-\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.
+ It is just centered text.
\end_layout
-\begin_layout Subsection
-Getting Started
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Obviously, to use this document class, you need to select
-\begin_inset Quotes eld
+\family sans
+SCENE
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-S
+\begin_inset Newline newline
\end_inset
-\family sans
-slides (FoilTeX)
\family default
+Not automatically numbered.
+ You supply the number.
+ This is because I couldn't figure out how.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from the
-\family sans
-Class
-\family default
- entry in the
\family sans
-Document
-\begin_inset space ~
+AT_RISE:
+\begin_inset space \hfill{}
\end_inset
-Layout
-\family default
- dialog.
- There are some settings in the
-\family sans
-Document
-\begin_inset space ~
+M-z S-R
+\begin_inset Newline newline
\end_inset
-Layout
+
\family default
- dialog that you should know about that are specific to this class:
+A special case of Narrative to describe the setting and action as the curtain
+ rises.
\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
-\begin_inset space ~
+Speaker
+\begin_inset space \hfill{}
\end_inset
-Layout
-\family default
- dialog.
- They're ignored by the
-\family sans
-foils
+M-z s
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- class.
+The speaker's (actor's) title, centered in all CAPS.
\end_layout
\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{}
+\family sans
+Parenthetical
+\begin_inset space \hfill{}
\end_inset
-pt and 30
-\begin_inset space \thinspace{}
+M-z p
+\begin_inset Newline newline
\end_inset
-pt.
-\end_layout
-\begin_layout Itemize
-The default font is
-\family sans
-sans
\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
-serif
+Dialogue
\family default
- but all math equations are still typeset in the usual roman font.
+.
\end_layout
\begin_layout Itemize
\family sans
-FoilTeX
-\family default
- supports A4 and Letter paper sizes as well as a special size for working
- with 35
-\begin_inset space \thinspace{}
+Dialogue
+\begin_inset space \hfill{}
+\end_inset
+
+M-z d
+\begin_inset Newline newline
\end_inset
-mm slides.
- It doesn't support A5, B5, legal or executive paper sizes.
-\end_layout
-\begin_layout Itemize
-Don't bother changing the
-\family sans
-Float Placement
\family default
- settings because they are ignored anyway.
- All floats appear where they are defined in the text.
+What the Speaker says.
\end_layout
\begin_layout Itemize
-The
-\family sans
-Pagestyle
-\family default
- 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 ~
+CURTAIN
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-C
+\begin_inset Newline newline
\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:foilfoot"
+\family default
+The curtain comes down.
+\end_layout
+
+\begin_layout Itemize
+\family sans
+Title
+\begin_inset space \hfill{}
\end_inset
- for more details.
- The title page is treated differently to all other pages in the document
- and is
-\emph on
-always
-\emph default
- unnumbered and
-\emph on
-always
-\emph default
- has the logo centered at the bottom of the page (if one is defined).
- The possible page style choices and what they do are as follows:
+M-z S-T
\end_layout
-\begin_deeper
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
\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).
-
+Author
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-A
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
\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
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+M-z r
+\end_layout
-\series bold
-foilheadings
-\series default
- Page numbers in lower right corner.
- Additional headers and footers are also shown.
- This is also the default.
+\begin_layout Standard
+Hello there.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Section
+Dinbrief
+\end_layout
-\series bold
-fancy
-\series default
- Gives you access to the
+\begin_layout Standard
+The document class
\family sans
-fancyheadings
+dinbrief
\family default
- package although its use with
-\family sans
-FoilTeX
+ can be used to type letters according to German conventions.
+ A template file is included in
+\family typewriter
+.../lyx/share/templates
\family default
- is discouraged by the writer of the
+ for you to use as a starting point.
+\end_layout
+
+\begin_layout Section
+EGS journals (
\family sans
-FoilTeX
+egs
\family default
- package because of some potential page layout clashes.
+)
\end_layout
-\end_deeper
-\begin_layout Subsubsection
-Extra Options
+\begin_layout Standard
+by
+\shape smallcaps
+Martin Vermeer
\end_layout
-\begin_layout Standard
-The following options may be used in the extra class options in the
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog.
+\begin_layout Subsection
+Description
\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
+\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 Flex URL
+status collapsed
-in paper, which is about the same aspect ratio as a 35
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
-mm slide, making it a bit easier to work with this medium.
+www.copernicus.org
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\end_inset
-\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 Labeling
-\labelwidthstring MMMMMMx
-
-\series bold
-footrule
-\series default
- Places a rule across the page above the footer on every page except the
- title page.
+\begin_layout Subsection
+New styles
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Standard
-\series bold
-dvips
-\series default
- This is automatically set each time you create a new
-\family sans
-foils
-\family default
- document.
- This option tells
\family sans
-FoilTeX
+Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
+ Accepted
\family default
- 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
-Foilhead
+Offsets
\family default
- and
-\family sans
-Rotatefoilhead
+.
+ The current layout file is unfortunately very unmodular and would benefit
+ from using the various
+\family typewriter
+std*.inc
\family default
- environments (don't worry these are described in the next section).
+ file inclusions.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Section
+Elsevier Journals
+\end_layout
-\series bold
-leqno
-\series default
- Equation numbers on the left.
+\begin_layout Standard
+By
+\noun on
+Rod Pinna
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\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
-\series bold
-fleqn
-\series default
- Flush-left equations.
+\begin_layout Plain Layout
+
+http://www.elsevier.com/wps/find/authorsview.authors/latex
\end_layout
-\begin_layout Subsection
-Supported Environments
+\end_inset
+
+.
+ Instructions are supplied along with the class file, which details the
+ requirements of the publishers.
+ LyX includes a 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
-Most of the environments commonly supported in other classes are also supported
- by the
-\family sans
-foils
+To make use of
+\family typewriter
+elsart.cls
\family default
- class.
- There are several additional environments provided by
-\family sans
-FoilTeX
+, a file
+\family typewriter
+elsart.layout
\family default
- as well as a couple added by LyX.
- The following environments are shared with other classes:
+ 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
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
+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
-\backslash
-begin{multicols}{2}
+ 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
+FoilTeX
+\family default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foiltex"
+
\end_inset
\end_layout
-\begin_layout Itemize
-
-\family sans
-Standard
+\begin_layout Standard
+by
+\noun on
+Allan Rae
\end_layout
-\begin_layout Itemize
-
-\family sans
-Itemize
+\begin_layout Subsection
+Introduction
\end_layout
-\begin_layout Itemize
-
+\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
-Enumerate
+FoilTeX
+\family default
+ slides class.
+ This section documents the latter.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Description
+\begin_layout Standard
+I'm going to say this again, nice and clear, so that there's no misunderstanding
+:
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-\family sans
-List
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\align center
-\family sans
-LyX-Code
-\end_layout
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Verse
-\end_layout
+slides (FoilTeX)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Quote
+
+\emph on
+only.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Quotation
-\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-\begin_layout Itemize
-\family sans
-Title
\end_layout
-\begin_layout Itemize
-
-\family sans
-Author
-\end_layout
+\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Date
-\end_layout
+slides (default)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Abstract
-\end_layout
+, check out section
+\begin_inset space ~
+\end_inset
-\begin_layout Itemize
-\family sans
-Bibliography
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slitex"
-\begin_layout Itemize
+\end_inset
+.
+ If your machine doesn't have the
\family sans
-Address
-\end_layout
+foils
+\family default
+ class [
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-RightAddress
-\end_layout
+slides (FoilTeX)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+] installed, you'll probably have to use the default
\family sans
-Caption
-\end_layout
-
-\begin_layout Itemize
-
+slides
+\family default
+ class, which isn't quite as good as
\family sans
-Comment
+foils.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
+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
-\backslash
-end{multicols}
+\begin_layout Subsection
+Getting Started
\end_layout
+\begin_layout Standard
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
\end_inset
-\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
-FoilTeX
+slides (FoilTeX)
\family default
- provides specific commands for starting new foils and these are:
-\end_layout
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+ from the
\family sans
-Foilhead
-\end_layout
-
-\begin_layout Itemize
+Class
+\family default
+ entry in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+Layout
+\family default
+ dialog.
+ There are some settings in the
\family sans
-Rotatefoilhead
-\end_layout
+Document
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-LyX also provides slightly modified versions of these two environments called:
+Layout
+\family default
+ dialog that you should know about that are specific to this class:
\end_layout
\begin_layout Itemize
-
+Don't change the options
\family sans
-ShortFoilhead
-\end_layout
-
-\begin_layout Itemize
-
+Sides
+\family default
+ and
\family sans
-ShortRotatefoilhead
-\end_layout
-
-\begin_layout Standard
-and the differences will be explained in the next section.
-\end_layout
+Columns
+\family default
+ on the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-Since foils are often used in presenting ideas or new theorems and such
-
+Layout
+\family default
+ dialog.
+ They're ignored by the
\family sans
-FoilTeX
+foils
\family default
- also provides a comprehensive box of goodies for presenting them:
+ class.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
+\begin_layout Itemize
+The default font size is 20
+\begin_inset space \thinspace{}
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+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 Itemize
-
+The default font is
\family sans
-Theorem
-\end_layout
-
-\begin_layout Itemize
-
+sans
+\family default
+
\family sans
-Lemma
+serif
+\family default
+ but all math equations are still typeset in the usual roman font.
\end_layout
\begin_layout Itemize
\family sans
-Corollary
-\end_layout
-
-\begin_layout Itemize
+FoilTeX
+\family default
+ supports A4 and Letter paper sizes as well as a special size for working
+ with 35
+\begin_inset space \thinspace{}
+\end_inset
-\family sans
-Proposition
+mm slides.
+ It doesn't support A5, B5, legal or executive paper sizes.
\end_layout
\begin_layout Itemize
-
+Don't bother changing the
\family sans
-Definition
+Float Placement
+\family default
+ settings because they are ignored anyway.
+ All floats appear where they are defined in the text.
\end_layout
\begin_layout Itemize
-
+The
\family sans
-Proof
-\end_layout
-
-\begin_layout Itemize
-
+Pagestyle
+\family default
+ setting behaves a bit differently for this class.
+
\family sans
-Theorem*
-\end_layout
+FoilTeX
+\family default
+ provides extensive footer and header capabilities including a user-defined
+ logo.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Itemize
-\family sans
-Lemma*
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foilfoot"
-\begin_layout Itemize
+\end_inset
-\family sans
-Corollary*
+ 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 Itemize
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
\family sans
-Proposition*
+\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 Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
\family sans
-Definition*
+\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
-\begin_inset ERT
-status open
+\begin_layout Labeling
+\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.
+\end_layout
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
-\backslash
-end{multicols}
+\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
+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 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 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 Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\family sans
-TickList
+\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 Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+\series bold
+dvips
+\series default
+ This is automatically set each time you create a new
\family sans
-CrossList
+foils
+\family default
+ document.
+ This option tells
+\family sans
+FoilTeX
+\family default
+ to use the dvips driver to rotate those pages that are set as landscape
+ foils.
\end_layout
-\begin_layout Standard
+\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
-FoilTeX
+Foilhead
\family default
- 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
+ and
+\family sans
+Rotatefoilhead
+\family default
+ environments (don't worry these are described in the next section).
+\end_layout
-g.
-\emph on
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\begin_inset space \space{}
-\end_inset
+\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
-\emph default
-straight after the foilhead.
+\begin_layout Subsection
+Supported Environments
\end_layout
\begin_layout Standard
-For this purpose, the following command styles are provided [
-\shape smallcaps
-Martin Vermeer
-\shape default
-]:
+Most of the environments commonly supported in other classes are also supported
+ by the
+\family sans
+foils
+\family default
+ class.
+ There are several additional environments provided by
+\family sans
+FoilTeX
+\family default
+ as well as a couple added by LyX.
+ The following environments are shared with other classes:
\end_layout
\begin_layout Standard
\begin_layout Itemize
\family sans
-My
-\begin_inset space ~
-\end_inset
-
-Logo
+Standard
\end_layout
\begin_layout Itemize
\family sans
-Restriction
+Itemize
\end_layout
\begin_layout Itemize
\family sans
-Right
-\begin_inset space ~
-\end_inset
-
-Footer
+Enumerate
\end_layout
\begin_layout Itemize
\family sans
-Right
-\begin_inset space ~
-\end_inset
-
-Header
+Description
\end_layout
\begin_layout Itemize
\family sans
-Left
-\begin_inset space ~
-\end_inset
-
-Header
+List
\end_layout
-\begin_deeper
-\begin_layout Standard
-\begin_inset space ~
-\end_inset
-
+\begin_layout Itemize
+\family sans
+LyX-Code
\end_layout
-\end_deeper
-\begin_layout Standard
-\begin_inset ERT
-status open
+\begin_layout Itemize
-\begin_layout Plain Layout
+\family sans
+Verse
+\end_layout
+\begin_layout Itemize
-\backslash
-end{multicols}
+\family sans
+Quote
\end_layout
-\end_inset
-
+\begin_layout Itemize
+\family sans
+Quotation
\end_layout
-\begin_layout Standard
-There are also a few commands provided by
-\family sans
-FoilTeX
-\family default
- 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_inset CommandInset ref
-LatexCommand ref
-reference "sec:unsuppfoils"
-
-\end_inset
+\begin_layout Itemize
-.
+\family sans
+Title
\end_layout
-\begin_layout Subsection
-Building a Set of Foils
-\end_layout
+\begin_layout Itemize
-\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.
+\family sans
+Author
\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
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
\family sans
Date
-\family default
- and
+\end_layout
+
+\begin_layout Itemize
+
\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 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.
+Bibliography
\end_layout
-\begin_layout Standard
-Landscape foils are generated using the
+\begin_layout Itemize
+
\family sans
-Rotatefoilhead
-\family default
- and
+Address
+\end_layout
+
+\begin_layout Itemize
+
\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.
-
+RightAddress
\end_layout
-\begin_layout Standard
-One problem with the support for landscape foils is the requirement that
- you have to use the
-\family typewriter
-dvips
-\family default
- driver to generate the PostScript output otherwise the foils won't be rotated.
- It is possible to get landscape foils even if you haven't got the
-\family typewriter
-dvips
-\family default
- driver provided you can feed your foils sideways through your printer ;-)
+\begin_layout Itemize
+
+\family sans
+Caption
\end_layout
-\begin_layout Subsubsection
-Theorems, Lemmas, Proofs and more
+\begin_layout Itemize
+
+\family sans
+Comment
\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
-\family default
- environment between the two with just a
-\begin_inset Quotes eld
-\end_inset
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
-\family typewriter
-%
-\family default
-\begin_inset Quotes erd
+\backslash
+end{multicols}
+\end_layout
+
\end_inset
- in it.
- This will force LyX to produce two separate environments and hence the
- correct LaTeX output.
- An example is provided in the example file included with the LyX distribution.
- Remember, this problem only occurs if you are trying to place two of the
- same type of theorem-like environments one directly after the other.
-\end_layout
-\begin_layout Subsubsection
-Lists
\end_layout
\begin_layout Standard
-You get all the commonly supported list styles found in other classes as
- well as two new ones.
- I'll only describe the new ones here.
- If you want to find out more about the other list environments check out
- the
-\emph on
-User's Guide.
-
-\emph default
- If you intend to use itemized lists you might also want to read about the
+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
-Itemize
-\begin_inset space ~
-\end_inset
-
-Bullet
-\begin_inset space ~
-\end_inset
-
-Selection
+FoilTeX
\family default
- dialog described above in section
-\begin_inset space ~
-\end_inset
+ provides specific commands for starting new foils and these are:
+\end_layout
+\begin_layout Itemize
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:bullet"
+\family sans
+Foilhead
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
+\family sans
+Rotatefoilhead
\end_layout
\begin_layout Standard
-The two new list styles,
-\family sans
-TickList
-\family default
- and
-\family sans
-CrossList
-\family default
-, are designed to make it easier for you to create lists of do's and don'ts
- or right and wrong by providing dedicated environments that use a tick
- or a cross as the label of the list.
- These lists are in fact dedicated variants of the
+LyX also provides slightly modified versions of these two environments called:
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Itemize
-\family default
- environment.
- They do however require that you have the
-\family typewriter
-psnfss
-\family default
- packages installed.
+ShortFoilhead
\end_layout
-\begin_layout Subsubsection
-Figures and Tables
+\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
FoilTeX
\family default
- 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.
+ also provides a comprehensive box of goodies for presenting them:
\end_layout
-\begin_layout Subsubsection
-Page Headers and Footers
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:foilfoot"
+\begin_layout Standard
+\begin_inset ERT
+status open
-\end_inset
+\begin_layout Plain Layout
+\backslash
+begin{multicols}{2}
\end_layout
-\begin_layout Standard
-
-\family sans
-My
-\begin_inset space ~
\end_inset
-Logo
-\family default
- and
+
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Restriction
-\family default
- are two commands used to control the left-footer text string.
- The first is meant to allow you to include a graphic logo on your foils
- and defaults to
-\begin_inset Quotes eld
-\end_inset
+Theorem
+\end_layout
+
+\begin_layout Itemize
--Typeset by
\family sans
-FoilTeX
-\family default
--
-\begin_inset Quotes erd
-\end_inset
+Lemma
+\end_layout
-.
- While the second is meant to provide a classification for the audience,
-
-\emph on
-e.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Itemize
-g.
-\emph default
+\family sans
+Corollary
+\end_layout
-\begin_inset space \space{}
-\end_inset
+\begin_layout Itemize
-Confidential.
- It is empty by default.
+\family sans
+Proposition
\end_layout
-\begin_layout Standard
-The remaining page corners can be filled by
+\begin_layout Itemize
+
\family sans
-Right
-\begin_inset space ~
-\end_inset
+Definition
+\end_layout
+
+\begin_layout Itemize
-Footer
-\family default
- (which defaults to page numbers),
\family sans
-Right
-\begin_inset space ~
-\end_inset
+Proof
+\end_layout
+
+\begin_layout Itemize
-Header
-\family default
- (top right) and
\family sans
-Left
-\begin_inset space ~
-\end_inset
+Theorem*
+\end_layout
-Header
-\family default
- (top left).
+\begin_layout Itemize
+
+\family sans
+Lemma*
\end_layout
-\begin_layout Subsection
-Unsupported
+\begin_layout Itemize
+
\family sans
-FoilTeX
-\family default
- Goodies
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:unsuppfoils"
+Corollary*
+\end_layout
-\end_inset
+\begin_layout Itemize
+
+\family sans
+Proposition*
+\end_layout
+\begin_layout Itemize
+\family sans
+Definition*
\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.
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+end{multicols}
\end_layout
-\begin_layout Subsubsection
-Lengths
+\end_inset
+
+
\end_layout
\begin_layout Standard
-All lengths are adjusted using the
-\family typewriter
+The starred versions are unnumbered while the unstarred versions are numbered.
+ There are also two list environments added by LyX and these are:
+\end_layout
-\backslash
-setlength{
-\family default
-\emph on
-lengthname
-\family typewriter
-\emph default
-}{
-\family default
-\emph on
-newlength
-\family typewriter
-\emph default
-}
-\family default
- command.
- Where
-\emph on
-lengthname
-\emph default
- should be replaced by the name given to the length you want to change and
-
-\emph on
-newlength
-\emph default
- is the length value.
- All lengths should be specified in units of length such as inches (
-\family typewriter
-in
-\family default
-), millimeters (
-\family typewriter
-mm
-\family default
-) or points (
-\family typewriter
-pt
-\family default
-) or relative to some document or font-based length such as
-\family typewriter
+\begin_layout Itemize
-\backslash
-textwidth
-\family default
-.
-
+\family sans
+TickList
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+CrossList
\end_layout
\begin_layout Standard
-It's possible to change the spacing between a foilhead and the body of the
- foil by adjusting the length specified by
-\family typewriter
-\backslash
-foilheadskip
+\family sans
+FoilTeX
\family default
-.
- For example, to make
+ 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
+
+g.
\emph on
-all
-\emph default
- foilheads 0.5
+
\begin_inset space \space{}
\end_inset
-in closer to their bodies put the following in the preamble:
-\family typewriter
-\backslash
-setlength{
-\backslash
-foilheadskip}{-0.5in}
+\emph default
+straight after the foilhead.
\end_layout
\begin_layout Standard
-The spacings around floats can be adjusted by setting these lengths:
+For this purpose, the following command styles are provided [
+\shape smallcaps
+Martin Vermeer
+\shape default
+]:
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
-
-\backslash
-abovefloatskip
-\family default
- Separation between the text and the top of the float
-\end_layout
+\begin_layout Standard
+\begin_inset ERT
+status open
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Plain Layout
-\family typewriter
\backslash
-abovecaptionskip
-\family default
- Separation between the float and the caption
+begin{multicols}{2}
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\end_inset
-\family typewriter
-\backslash
-belowcaptionskip
-\family default
- Separation between the caption and the following text
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Itemize
-\family typewriter
-
-\backslash
-captionwidth
-\family default
- You can make the captions narrower than the surrounding text by adjusting
- this length.
- Best done relative to
-\family typewriter
+\family sans
+My
+\begin_inset space ~
+\end_inset
-\backslash
-textwidth
-\family default
-.
+Logo
\end_layout
-\begin_layout Standard
-There are also several title page related lengths that you may find useful
- if you have a long title or several authors:
-\end_layout
+\begin_layout Itemize
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\family sans
+Restriction
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-abovetitleskip
-\family default
- Separation from headers to
\family sans
-Title
-\end_layout
+Right
+\begin_inset space ~
+\end_inset
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+Footer
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-titleauthorskip
-\family default
- between
\family sans
-Title
-\family default
- and
+Right
+\begin_inset space ~
+\end_inset
+
+Header
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Author
-\family default
- environments
+Left
+\begin_inset space ~
+\end_inset
+
+Header
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\begin_deeper
+\begin_layout Standard
+\begin_inset space ~
+\end_inset
-\family typewriter
-\backslash
-authorauthorskip
-\family default
- between multiple
-\family sans
-Author
-\family default
- lines
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\end_deeper
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
-\family typewriter
\backslash
-authordateskip
-\family default
- between the
-\family sans
-Author
-\family default
- and the
-\family sans
-Date
+end{multicols}
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\end_inset
-\family typewriter
-\backslash
-dateabstractskip
-\family default
- between the
-\family sans
-Date
-\family default
- and the
-\family sans
-Abstract
\end_layout
\begin_layout Standard
-The last length related command affects all the list environments.
- If you place
-\family typewriter
-
-\backslash
-zerolistvertdimens
+There are also a few commands provided by
+\family sans
+FoilTeX
\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
+ 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
-\backslash
-setlength
-\family default
- like the stuff mentioned above.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:unsuppfoils"
+
+\end_inset
+
+.
\end_layout
-\begin_layout Subsubsection
-Headers and Footers
+\begin_layout Subsection
+Building a Set of Foils
\end_layout
\begin_layout Standard
-The
-\family typewriter
-
-\backslash
-LogoOn
-\family default
- and
-\family typewriter
-
-\backslash
-LogoOff
-\family default
- commands control whether the logo in the
-\family sans
-MyLogo
-\family default
- definition appear on a given page.
- If you put
+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
-
-\backslash
-LogoOff
+Foils.lyx
\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
+ file you find in LyX's
\family typewriter
-
-\backslash
-LogoOff
+examples
\family default
- directly after the foilhead of that page and the
-\family typewriter
+ folder.
+\end_layout
-\backslash
-LogoOn
-\family default
- directly after the next foilhead.
+\begin_layout Subsubsection
+Give It a Title Page
\end_layout
\begin_layout Standard
-If you decide to use the
+Unlike other classes that provide
\family sans
-fancy
+Title
\family default
- page style setting in the
+,
\family sans
-Document
-\begin_inset space ~
-\end_inset
-
-Layout
+Author
\family default
- dialog you should probably add
-\family typewriter
-
-\backslash
-let
-\backslash
-headwidth
-\backslash
-textwidth
+,
+\family sans
+Date
\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
+ and
\family sans
-fancyheadings
+Abstract
\family default
- package and the
+ environments,
\family sans
foils
\family default
- class.
+ 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 Section
-Hollywood (Hollywood spec scripts)
+\begin_layout Subsubsection
+Start a New Foil
\end_layout
\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
+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 Subsection
-Introduction
+\begin_layout Standard
+Landscape foils are generated using the
+\family sans
+Rotatefoilhead
+\family default
+ and
+\family sans
+ShortRotatefoilhead
+\family default
+ environments.
+ Again the only difference is the spacing between foilhead and body.
+ Both of the short versions have 0.5 inches less separation between the foilhead
+ and the body.
+
\end_layout
\begin_layout Standard
-Getting the format of a Hollywood script right is a
+One problem with the support for landscape foils is the requirement that
+ you have to use the
+\family typewriter
+dvips
+\family default
+ driver to generate the PostScript output otherwise the foils won't be rotated.
+ It is possible to get landscape foils even if you haven't got the
+\family typewriter
+dvips
+\family default
+ driver provided you can feed your foils sideways through your printer ;-)
+\end_layout
+
+\begin_layout Subsubsection
+Theorems, Lemmas, Proofs and more
+\end_layout
+
+\begin_layout Standard
+Due to a small bug in LyX you can't have two of the same type of these environme
+nts directly following each other.
+ They must be separated by something.
+ If you try, you will just be extending the previous environment as if you
+ had merged the two environments together.
+ So, how do you get around this problem? The simplest option is to insert
+ some text between the two environments or add a
+\family sans
+LaTeX
+\family default
+ environment between the two with just a
\begin_inset Quotes eld
\end_inset
-rite of passage.
+
+\family typewriter
+%
+\family default
+
\begin_inset Quotes erd
\end_inset
- It is designed to make the readers focus on content and to be easy and
- familiar for the actors to read.
- Each page of a script should be one minute of film.
- Nothing goes in a script that you cannot see or hear on screen.
- The courier 12 pt font should be used throughout.
- No italics.
+ in it.
+ This will force LyX to produce two separate environments and hence the
+ correct LaTeX output.
+ An example is provided in the example file included with the LyX distribution.
+ Remember, this problem only occurs if you are trying to place two of the
+ same type of theorem-like environments one directly after the other.
\end_layout
-\begin_layout Subsection
-Special problems
+\begin_layout Subsubsection
+Lists
\end_layout
\begin_layout Standard
-Speakers' lines should NEVER break in mid-sentence.
- If a speaker's lines continue over a page break, repeat the
+You get all the commonly supported list styles found in other classes as
+ well as two new ones.
+ I'll only describe the new ones here.
+ If you want to find out more about the other list environments check out
+ the
+\emph on
+User's Guide.
+
+\emph default
+ If you intend to use itemized lists you might also want to read about the
+
\family sans
-Speaker
+Itemize
+\begin_inset space ~
+\end_inset
+
+Bullet
+\begin_inset space ~
+\end_inset
+
+Selection
\family default
- title followed by (Cont'd).
-\end_layout
+ dialog described above in section
+\begin_inset space ~
+\end_inset
-\begin_layout Subsection
-Special features
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:bullet"
+
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-Insert the
+The two new list styles,
\family sans
-Speaker
+TickList
\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
- You can use this to insert the speaker name in narratives also.
+ and
+\family sans
+CrossList
+\family default
+, are designed to make it easier for you to create lists of do's and don'ts
+ or right and wrong by providing dedicated environments that use a tick
+ or a cross as the label of the list.
+ These lists are in fact dedicated variants of the
+\family sans
+Itemize
+\family default
+ environment.
+ They do however require that you have the
+\family typewriter
+psnfss
+\family default
+ packages installed.
\end_layout
-\begin_layout Subsection
-Paper size and Margins
+\begin_layout Subsubsection
+Figures and Tables
\end_layout
\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
-
-\begin_layout Subsection
-Environments
-\end_layout
-\begin_layout Standard
-The following environments are available.
- You can use hollywood.bind to get the bind keys shown at the right.
+\family sans
+FoilTeX
+\family default
+ 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 Itemize
+\begin_layout Subsubsection
+Page Headers and Footers
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foilfoot"
-\family sans
-Standard
-\begin_inset Newline newline
\end_inset
-\family default
-Used where nothing else works.
- Try to avoid it.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
\family sans
-FADE_IN
-\family default
-:
-\begin_inset space \hfill{}
+My
+\begin_inset space ~
\end_inset
-
+Logo
+\family default
+ and
\family sans
-M-z S-I
+Restriction
\family default
-
-\begin_inset Newline newline
-\end_inset
-
-Usually followed by something like
+ 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
-on Sally waking up.
+-Typeset by
+\family sans
+FoilTeX
+\family default
+-
\begin_inset Quotes erd
\end_inset
+.
+ While the second is meant to provide a classification for the audience,
+
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\emph default
-\end_layout
+\begin_inset space \space{}
+\end_inset
-\begin_layout Itemize
+Confidential.
+ It is empty by default.
+\end_layout
+\begin_layout Standard
+The remaining page corners can be filled by
\family sans
-INT:
-\begin_inset space \hfill{}
+Right
+\begin_inset space ~
\end_inset
-M-z i
-\begin_inset Newline newline
+Footer
+\family default
+ (which defaults to page numbers),
+\family sans
+Right
+\begin_inset space ~
\end_inset
+Header
+\family default
+ (top right) and
+\family sans
+Left
+\begin_inset space ~
+\end_inset
+Header
\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.
+ (top left).
\end_layout
-\begin_layout Itemize
-
+\begin_layout Subsection
+Unsupported
\family sans
-EXT:
-\begin_inset space \hfill{}
-\end_inset
+FoilTeX
+\family default
+ Goodies
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:unsuppfoils"
-M-z e
-\begin_inset Newline newline
\end_inset
-\family default
-Introduces a new EXTERIOR camera set-up.
- Everthing on this line in CAPS.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+All the commands mentioned below need to be set in a
\family sans
-Speaker
-\begin_inset space \hfill{}
-\end_inset
+LaTeX
+\family default
+ environment or as
+\family sans
+TeX
+\family default
+ within another environment.
+\end_layout
-M-z s
-\begin_inset Newline newline
-\end_inset
+\begin_layout Subsubsection
+Lengths
+\end_layout
+\begin_layout Standard
+All lengths are adjusted using the
+\family typewriter
+\backslash
+setlength{
\family default
-The character speaking.
-\end_layout
+\emph on
+lengthname
+\family typewriter
+\emph default
+}{
+\family default
+\emph on
+newlength
+\family typewriter
+\emph default
+}
+\family default
+ command.
+ Where
+\emph on
+lengthname
+\emph default
+ should be replaced by the name given to the length you want to change and
+
+\emph on
+newlength
+\emph default
+ is the length value.
+ All lengths should be specified in units of length such as inches (
+\family typewriter
+in
+\family default
+), millimeters (
+\family typewriter
+mm
+\family default
+) or points (
+\family typewriter
+pt
+\family default
+) or relative to some document or font-based length such as
+\family typewriter
-\begin_layout Itemize
+\backslash
+textwidth
+\family default
+.
+
+\end_layout
-\family sans
-Parenthetical
-\begin_inset space \hfill{}
-\end_inset
+\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
-M-z p
-\begin_inset Newline newline
+\backslash
+foilheadskip
+\family default
+.
+ For example, to make
+\emph on
+all
+\emph default
+ foilheads 0.5
+\begin_inset space \space{}
\end_inset
+in closer to their bodies put the following in the preamble:
+\family typewriter
-\family default
-Instructions to the speaker.
- The () are automatically inserted, but only the ( will show in LyX.
- Both will be printed.
+\backslash
+setlength{
+\backslash
+foilheadskip}{-0.5in}
\end_layout
-\begin_layout Itemize
-
-\family sans
-Dialogue
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Standard
+The spacings around floats can be adjusted by setting these lengths:
+\end_layout
-M-z d
-\begin_inset Newline newline
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+\family typewriter
+\backslash
+abovefloatskip
\family default
-What the
-\family sans
-Speaker
-\family default
- says.
+ Separation between the text and the top of the float
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-\family sans
-Transition
-\begin_inset space \hfill{}
-\end_inset
+\family typewriter
-M-z t
-\begin_inset Newline newline
-\end_inset
+\backslash
+abovecaptionskip
+\family default
+ Separation between the float and the caption
+\end_layout
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+\backslash
+belowcaptionskip
\family default
-Camera movement instruction.
- e.
-\begin_inset space \thinspace{}
-\end_inset
+ Separation between the caption and the following text
+\end_layout
-g.
-\begin_inset space \space{}
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-CUT TO:
-\end_layout
+\family typewriter
-\begin_layout Itemize
+\backslash
+captionwidth
+\family default
+ You can make the captions narrower than the surrounding text by adjusting
+ this length.
+ Best done relative to
+\family typewriter
-\family sans
-FADE OUT:
-\begin_inset space \hfill{}
-\end_inset
+\backslash
+textwidth
+\family default
+.
+\end_layout
-M-z S-I
+\begin_layout Standard
+There are also several title page related lengths that you may find useful
+ if you have a long title or several authors:
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-\family sans
-Author
-\begin_inset space \hfill{}
-\end_inset
+\family typewriter
-M-z S-A
+\backslash
+abovetitleskip
+\family default
+ Separation from headers to
+\family sans
+Title
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+\backslash
+titleauthorskip
+\family default
+ between
\family sans
Title
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-T
+\family default
+ and
+\family sans
+Author
+\family default
+ environments
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-\family sans
-Right_Address
-\begin_inset space \hfill{}
-\end_inset
+\family typewriter
-M-z r
+\backslash
+authorauthorskip
+\family default
+ between multiple
+\family sans
+Author
+\family default
+ lines
\end_layout
-\begin_layout Subsection
-Script jargon
-\end_layout
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-\begin_layout Itemize
-(O.S) — off screen
-\end_layout
+\family typewriter
-\begin_layout Itemize
-(V.0) — voice over
+\backslash
+authordateskip
+\family default
+ between the
+\family sans
+Author
+\family default
+ and the
+\family sans
+Date
\end_layout
-\begin_layout Itemize
-b.
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-g.
- — background
-\end_layout
-
-\begin_layout Itemize
-C.U.
- — close-up
-\end_layout
+\family typewriter
-\begin_layout Itemize
-PAN — camera movement
+\backslash
+dateabstractskip
+\family default
+ between the
+\family sans
+Date
+\family default
+ and the
+\family sans
+Abstract
\end_layout
-\begin_layout Itemize
-INSERT — cut to close-up of
-\end_layout
+\begin_layout Standard
+The last length related command affects all the list environments.
+ If you place
+\family typewriter
-\begin_layout Section
-ijmpc and ijmpd
-\end_layout
+\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
-\begin_layout Standard
-by
-\noun on
-Panayotis Papasotiriou
+\backslash
+setlength
+\family default
+ like the stuff mentioned above.
\end_layout
-\begin_layout Subsection
-Overview
+\begin_layout Subsubsection
+Headers and Footers
\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
+The
\family typewriter
-ws-ijmpc.cls
+
+\backslash
+LogoOn
\family default
and
\family typewriter
-ws-ijmpd.cls
+
+\backslash
+LogoOff
\family default
-, respectively.
- These files, together with instructions for the authors, can be downloaded
- from the sites
-\begin_inset Flex URL
-status collapsed
+ commands control whether the logo in the
+\family sans
+MyLogo
+\family default
+ definition appear on a given page.
+ If you put
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+LogoOff
+\family default
+ in the preamble then none of the foils will have the logo on them.
+ If you don't want the logo on a particular page place the
+\family typewriter
-http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
+\backslash
+LogoOff
+\family default
+ directly after the foilhead of that page and the
+\family typewriter
+
+\backslash
+LogoOn
+\family default
+ directly after the next foilhead.
\end_layout
+\begin_layout Standard
+If you decide to use the
+\family sans
+fancy
+\family default
+ page style setting in the
+\family sans
+Document
+\begin_inset space ~
\end_inset
- and
-\begin_inset Flex URL
-status collapsed
+Layout
+\family default
+ dialog you should probably add
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+let
+\backslash
+headwidth
+\backslash
+textwidth
+\family default
+ to your preamble so headers and footers on landscape pages are correctly
+ placed when rotated.
+ This is due to some clashes between the page layouts provided by the
+\family sans
+fancyheadings
+\family default
+ package and the
+\family sans
+foils
+\family default
+ class.
+\end_layout
-http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
+\begin_layout Section
+Hollywood (Hollywood spec scripts)
\end_layout
-\end_inset
+\begin_layout Standard
+by
+\shape smallcaps
+Garst Reese
+\end_layout
-.
- Both packages are modified versions of the standard
+\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
-article
+rite of passage.
\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.
+ 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
-Writing a paper
+Special problems
\end_layout
\begin_layout Standard
-As usual, the easiest way to write a paper is to start with a template.
- Click on
-\family sans
-File\SpecialChar \menuseparator
-New from
-\family default
-
+Speakers' lines should NEVER break in mid-sentence.
+ If a speaker's lines continue over a page break, repeat the
\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
-<>
+Speaker
\family default
-) with your text.
- You should keep in mind the following remarks.
+ title followed by (Cont'd).
\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.
+\begin_layout Subsection
+Special features
\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
-Tools\SpecialChar \menuseparator
-Preferences
-\family default
-, select the
-\family sans
-Lang Opts
-\family default
- tab, deselect the
-\family sans
-Use babel
-\family default
- checkbox in the language settings, and click on
-\family sans
-Apply
-\family default
- (or
+\begin_layout Standard
+Insert the
\family sans
-Save
+Speaker
\family default
-, if you wish to make this change permanent).
+ 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 Enumerate
-The
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsection
+Paper size and Margins
+\end_layout
-Keywords
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
- style must be used to define keywords.
+\begin_layout Subsection
+Environments
\end_layout
-\begin_layout Enumerate
-The ijmpc package provides a style named
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+The following environments are available.
+ You can use hollywood.bind to get the bind keys shown at the right.
+\end_layout
-Classification Codes
-\begin_inset Quotes erd
+\begin_layout Itemize
+
+\family sans
+Standard
+\begin_inset Newline newline
\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.
+
+\family default
+Used where nothing else works.
+ Try to avoid it.
\end_layout
-\begin_layout Enumerate
-Several new environments are available:
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Definition
-\begin_inset Quotes erd
+\family sans
+FADE_IN
+\family default
+:
+\begin_inset space \hfill{}
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Step
-\begin_inset Quotes erd
+\family sans
+M-z S-I
+\family default
+
+\begin_inset Newline newline
\end_inset
-,
+Usually followed by something like
\begin_inset Quotes eld
\end_inset
-Example
+on Sally waking up.
\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Remark
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Notation
-\begin_inset Quotes erd
+\family sans
+INT:
+\begin_inset space \hfill{}
\end_inset
-,
-\begin_inset Quotes eld
+M-z i
+\begin_inset Newline newline
\end_inset
-Theorem
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+\family default
+Introduces a new INTERIOR camera set-up.
+ Always followed by DAY or NIGHT, or something similar to define the lighting
+ required.
+ Everthing on this line in CAPS.
+\end_layout
-Proof
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Quotes eld
+\family sans
+EXT:
+\begin_inset space \hfill{}
\end_inset
-Corollary
-\begin_inset Quotes erd
+M-z e
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Lemma
-\begin_inset Quotes erd
-\end_inset
+\family default
+Introduces a new EXTERIOR camera set-up.
+ Everthing on this line in CAPS.
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Proposition
-\begin_inset Quotes erd
+\family sans
+Speaker
+\begin_inset space \hfill{}
\end_inset
-,
-\begin_inset Quotes eld
+M-z s
+\begin_inset Newline newline
\end_inset
-Prop
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
+\family default
+The character speaking.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Parenthetical
+\begin_inset space \hfill{}
\end_inset
-Question
-\begin_inset Quotes erd
+M-z p
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset Quotes eld
+
+\family default
+Instructions to the speaker.
+ The () are automatically inserted, but only the ( will show in LyX.
+ Both will be printed.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Dialogue
+\begin_inset space \hfill{}
\end_inset
-Claim
-\begin_inset Quotes erd
+M-z d
+\begin_inset Newline newline
\end_inset
-, and
-\begin_inset Quotes eld
+
+\family default
+What the
+\family sans
+Speaker
+\family default
+ says.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Transition
+\begin_inset space \hfill{}
\end_inset
-Conjecture
-\begin_inset Quotes erd
+M-z t
+\begin_inset Newline newline
\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
-refcite
\family default
- command, e.
+Camera movement instruction.
+ e.
\begin_inset space \thinspace{}
\end_inset
\begin_inset space \space{}
\end_inset
+CUT TO:
+\end_layout
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-See Ref.
-\begin_inset space \space{}
+\family sans
+FADE OUT:
+\begin_inset space \hfill{}
\end_inset
+M-z S-I
+\end_layout
-\family typewriter
-
-\backslash
-refcite{key}
-\family default
+\begin_layout Itemize
-\begin_inset Quotes erd
+\family sans
+Author
+\begin_inset space \hfill{}
\end_inset
-.
+M-z S-A
\end_layout
-\begin_layout Enumerate
-There is no
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Acknowledgments
-\begin_inset Quotes erd
+\family sans
+Title
+\begin_inset space \hfill{}
\end_inset
- section in both packages.
- To put acknowledgments, just use the
-\begin_inset Quotes eld
-\end_inset
+M-z S-T
+\end_layout
-Section*
-\begin_inset Quotes erd
+\begin_layout Itemize
+
+\family sans
+Right_Address
+\begin_inset space \hfill{}
\end_inset
- environment.
+M-z r
\end_layout
-\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
+\begin_layout Subsection
+Script jargon
+\end_layout
-Appendices Section
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+(O.S) — off screen
+\end_layout
- 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
+\begin_layout Itemize
+(V.0) — voice over
+\end_layout
-Appendix
-\begin_inset Quotes erd
+\begin_layout Itemize
+b.
+\begin_inset space \thinspace{}
\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
+g.
+ — background
+\end_layout
-Appendix
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+C.U.
+ — close-up
+\end_layout
- environment.
- LyX will number each appendix with capital letters, as required by both
- journals.
- Note that
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
+PAN — camera movement
+\end_layout
-Appendices Section
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
+INSERT — cut to close-up of
+\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 Section
+ijmpc and ijmpd
\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 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
+\begin_layout Standard
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
-\backslash
-tbl{
+\begin_layout Subsection
+Overview
+\end_layout
+
+\begin_layout Standard
+The ijmpc package is a set of macros that facilitates electronic manuscript
+ submission to the
\emph on
-your table caption
+International Journal of Modern Physics C
\emph default
-}{
-\family default
- (sic); you must also the TeX code
-\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
-\family default
- file, then include this file to the LyX document (
-\family sans
-Insert\SpecialChar \menuseparator
-File\SpecialChar \menuseparator
-Child
-\begin_inset space ~
-\end_inset
-
-Document
-\family default
-).
- Details on how to create a table float can be found in the files
+.
+ 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.tex
+ws-ijmpc.cls
\family default
and
\family typewriter
-ws-ijmpd.tex
-\family default
-, included in the corresponding packages.
-\end_layout
-
-\begin_layout Subsection
-Preparing a paper for submission
-\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
+ws-ijmpd.cls
\family default
-)
-\begin_inset Foot
-status open
+, 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
-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.
+
+http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
\end_layout
\end_inset
-, then make the following changes to the resulting
-\family typewriter
-.tex
-\family default
- file.
-\end_layout
+ and
+\begin_inset Flex URL
+status collapsed
-\begin_layout Enumerate
-Remove the comment lines before the
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-documentclass
-\family default
- command.
+http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
\end_layout
-\begin_layout Enumerate
-Remove everything between (and including) the
-\family typewriter
+\end_inset
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
+.
+ Both packages are modified versions of the standard
+\begin_inset Quotes eld
+\end_inset
-\backslash
-makeatother
-\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
-\end_layout
+article
+\begin_inset Quotes erd
+\end_inset
-\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.
+ 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
-Use of TeX code
+Writing a paper
\end_layout
\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
+As usual, the easiest way to write a paper is to start with a template.
+ 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
ijmpc.lyx
\family default
- or the
+ or
\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
+ 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
-
-\backslash
-markboth{Authors' Names}{Short Paper's Title}
+<>
\family default
-.
-\end_layout
-
-\begin_layout Section
-iopart
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Uwe Stöhr
+) with your text.
+ You should keep in mind the following remarks.
\end_layout
-\begin_layout Subsection
-Overview
+\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 Standard
+\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
+Tools\SpecialChar \menuseparator
+Preferences
+\family default
+, select the
+\family sans
+Lang Opts
+\family default
+ tab, deselect the
+\family sans
+Use babel
+\family default
+ checkbox in the language settings, and click on
+\family sans
+Apply
+\family default
+ (or
+\family sans
+Save
+\family default
+, if you wish to make this change permanent).
+\end_layout
+
+\begin_layout Enumerate
+The
+\begin_inset Quotes eld
+\end_inset
+
+Keywords
+\begin_inset Quotes erd
+\end_inset
+
+ 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
+
+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
+
+Definition
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Step
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Example
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Remark
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Notation
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Theorem
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Proof
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Corollary
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Lemma
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Proposition
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Prop
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Question
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Claim
+\begin_inset Quotes erd
+\end_inset
+
+, 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
+refcite
+\family default
+ command, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\begin_inset Quotes eld
+\end_inset
+
+See Ref.
+\begin_inset space \space{}
+\end_inset
+
+
+\family typewriter
+
+\backslash
+refcite{key}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\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
+
+ environment.
+\end_layout
+
+\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
+
+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
+\end_inset
+
+ 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
+
+
+\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
+
+\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 TeX code to overcome 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
+ (sic); you must also the TeX code
+\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
+\family default
+ file, then include this file to the LyX document (
+\family sans
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
+
+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
+\family default
+, included in the corresponding packages.
+\end_layout
+
+\begin_layout Subsection
+Preparing a paper for submission
+\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 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
+
+\end_inset
+
+, then make the following changes to the resulting
+\family typewriter
+.tex
+\family default
+ file.
+\end_layout
+
+\begin_layout Enumerate
+Remove the comment lines before the
+\family typewriter
+
+\backslash
+documentclass
+\family default
+ command.
+\end_layout
+
+\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 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.
+\end_layout
+
+\begin_layout Subsection
+Use of TeX code
+\end_layout
+
+\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
+ 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
+Uwe Stöhr
+\end_layout
+
+\begin_layout Subsection
+Overview
+\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
\end_layout
\begin_layout Itemize
-To be able to compile your document to a PDF, PS, or DVI, assure that the
+To be able to compile your document to a PDF, PS, or DVI, ensure that the
two options
\family sans
Use AMS math package
\emph default
, but there are many others (see a complete list at
\begin_inset Flex URL
-status collapsed
+status open
\begin_layout Plain Layout
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
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
\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
+Detailed descriptions 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_layout Plain Layout
-There is an English translation
+ (German) and
\emph on
-screnggu
+scrguien
\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.
+ (English).
\end_layout
\begin_layout Subsection
.
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.
+ Therefore, LyX supports both, though it is recommended you use the new
+ class.
\end_layout
\begin_layout Standard
\begin_layout Standard
The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
+ to meet almost any needs.
This can be done via the preamble or with a special style file (Letter
Class Option, extension
\family typewriter
).
In this section, we can only list those features which are natively supported
by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
+ For detailed descriptions (and for the rest of features) we recommend you
+ have a look at the detailed manual of the Memoir class
\begin_inset Foot
status collapsed
\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
+ Memoir and the fancyhdr package (they both define a command with the same
+ name, which confuses LaTeX).
+ Instead, Memoir comes with a number of its own page styles (see
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
\end_layout
\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
+Sectioning: Sectionings (chapter, section, subsection etc.) come with an
+ optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
In LyX, you can do this via
\end_layout
\begin_layout Description
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
+Chapterprecis: You may know this older typesetting style: The contents of
+ a chapter are summarized below the title and also in the table of contents
(e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
\begin_inset Foot
status collapsed
-\begin_layout Plain Layout
+\begin_layout Plain Layout
+
+\emph on
+Note from JMarc:
+\emph default
+ actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
+ has not been updated yet to take advantage of it.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Section
+Springer Journals (
+\family sans
+svjour
+\family default
+)
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Martin Vermeer
+\end_layout
+
+\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 Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.springer.de/author/tex/help-journals.html
+\end_layout
+
+\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
+
+
+\family typewriter
+svjog.layout
+\family default
+ for Journal of Geodesy) can include.
+\end_layout
+
+\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
+\family default
+ file following the outline given in
+\family typewriter
+svjog.layout
+\family default
+.
+
+\end_layout
+
+\begin_layout Standard
+It is reasonably well tested only for the Journal of Geodesy.
+
+\family typewriter
+svjour
+\family default
+ and
+\family typewriter
+svjog
+\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
+\family default
+, as root if necessary — doesn't LyX take care of this?), reconfigure LyX
+ and it should work.
+\end_layout
+
+\begin_layout Subsection
+New styles
+\end_layout
+
+\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
+
+\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
+Supported journals
+\end_layout
+
+\begin_layout Itemize
+
+\emph on
+Journal of Geodesy
+\emph default
+:
+\family typewriter
+svjog.layout
+\family default
+ — Martin Vermeer
+\end_layout
+
+\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
+Add your own, it isn't so hard!
+\end_layout
+
+\begin_layout Subsection
+Credits
+\end_layout
+
+\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
+
+\begin_layout Subsection
+Bugs
+\end_layout
+
+\begin_layout Standard
+Probably.
+ But probably less than in the old hacked-LaTeX
+\family typewriter
+ejour2
+\family default
+.
+\end_layout
+
+\begin_layout Standard
+Limitations e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.: does not display the number for theorem-like layouts, just #.
+\end_layout
+
+\begin_layout Section
+Slides [aka
+\noun on
+SliTeX
+\noun default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slitex"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+John Weiss
+\noun default
+
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+This section describes how to use LyX to make slides for overhead projectors.
+ There are two document classes that can do this: the default slides class
+ and the
+\family sans
+FoilTeX
+\family default
+ slides class.
+ This section documents the former.
+\end_layout
-\emph on
-Note from JMarc:
-\emph default
- actually, LyX 1.3.0 supports some forms of optional arguments, but this layout
- has not been updated yet to take advantage of it.
+\begin_layout 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 Section
-Springer Journals (
+\begin_layout Standard
+\align center
+
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
+
+
\family sans
-svjour
+slides (default)
\family default
-)
-\end_layout
-\begin_layout Standard
-by
-\noun on
-Martin Vermeer
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-Description
+
+\emph on
+only.
\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_inset VSpace bigskip
+\end_inset
-\begin_layout Plain Layout
-http://www.springer.de/author/tex/help-journals.html
\end_layout
+\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
\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 sans
+slides (FoilTeX)
\family default
-, which journal-specific layout files (such as, e.
-\begin_inset space \thinspace{}
+
+\begin_inset Quotes erd
\end_inset
-g.
-\begin_inset space \space{}
+, check out section
+\begin_inset space ~
\end_inset
-\family typewriter
-svjog.layout
-\family default
- for Journal of Geodesy) can include.
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foiltex"
-\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
+\end_inset
+
+.
+ The
+\family sans
+foils
\family default
-<myjournal>
-\family typewriter
-.layout
+ class [
+\begin_inset Quotes eld
+\end_inset
+
+
+\family sans
+slides (FoilTeX)
\family default
- file following the outline given in
-\family typewriter
-svjog.layout
+
+\begin_inset Quotes erd
+\end_inset
+
+] is actually somewhat better than the default
+\family sans
+slides
\family default
-.
-
+ class,
+\begin_inset Foot
+status collapsed
+
+\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
+
+\end_inset
+
+ which this section documents.
\end_layout
\begin_layout Standard
-It is reasonably well tested only for the Journal of Geodesy.
-
-\family typewriter
-svjour
+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
+slides
\family default
- and
-\family typewriter
-svjog
+
+\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
+foils
\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
+, 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
-, as root if necessary — doesn't LyX take care of this?), reconfigure LyX
- and it should work.
+ can do which the others can't, such as generate overlays.
+ Read on to learn more!
\end_layout
\begin_layout Subsection
-New styles
+Getting Started
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slidesetup"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-A large number of theorem-like styles —
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
+\end_inset
+
+
\family sans
-Claim, Conjecture,
+slides (default)
\family default
-
+
+\begin_inset Quotes erd
+\end_inset
+
+ from the class list in the
\family sans
-\SpecialChar \ldots{}
-Theorem
+Document\SpecialChar \menuseparator
+Settings
\family default
-.
+ dialog.
+ There are some other special things you should know about this class:
\end_layout
-\begin_layout Standard
-
+\begin_layout Itemize
+Don't bother changing the options
\family sans
-Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
- Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
+Sides and Columns
\family default
.
- See the Springer class file documentation for details.
-\end_layout
-
-\begin_layout Subsection
-Supported journals
+ They're not supported by the
+\family sans
+slides
+\family default
+ class, anyways.
\end_layout
\begin_layout Itemize
+The option
+\family sans
+Page
+\begin_inset space ~
+\end_inset
-\emph on
-Journal of Geodesy
-\emph default
-:
-\family typewriter
-svjog.layout
+style
\family default
- — Martin Vermeer
+ behaves a bit differently for this class.
+ The possible choices and what they do are as follows:
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Description
-\emph on
-Probability Theory and Related Fields
-\emph default
-:
-\family typewriter
-svprobth.layout
+\family sans
+plain
\family default
- — Jean-Marc Lasgouttes
-\end_layout
-
-\begin_layout Standard
-Add your own, it isn't so hard!
+ The final output contains page numbers in the lower right corner.
\end_layout
-\begin_layout Subsection
-Credits
-\end_layout
+\begin_layout Description
-\begin_layout Standard
-These files are partly based on the older
-\family typewriter
-ejour2.layout
+\family sans
+headings
\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
+ Like
+\family sans
+plain
\family default
- layout, are now defunct.
- Jean-Marc Lasgouttes helped out big in making me find my way around the
- LyX layout file mechanism.
+, but also prints out any time markers you've put in.
+ This is the default.
\end_layout
-\begin_layout Subsection
-Bugs
+\begin_layout Description
+
+\family sans
+empty
+\family default
+ The final output contains no page numbers, time markers, or alignment markers.
\end_layout
-\begin_layout Standard
-Probably.
- But probably less than in the old hacked-LaTeX
+\end_deeper
+\begin_layout Itemize
+The
+\family sans
+slides
+\family default
+ class has an extra option:
\family typewriter
-ejour2
+clock
\family default
.
-\end_layout
-
-\begin_layout Standard
-Limitations e.
-\begin_inset space \thinspace{}
+ To use it, put
+\begin_inset Quotes eld
\end_inset
-g.: does not display the number for theorem-like layouts, just #.
-\end_layout
-\begin_layout Section
-Slides [aka
-\noun on
-SliTeX
-\noun default
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:slitex"
+\family typewriter
+clock
+\family default
+\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-John Weiss
-\noun default
-
-\end_layout
-
-\begin_layout Subsection
-Introduction
+ in the extra class options.
\end_layout
+\begin_deeper
\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
+Using this options allows you to add time markers to
\family sans
-FoilTeX
+Note
\family default
- slides class.
- This section documents the former.
-\end_layout
+s.
+ See section
+\begin_inset space ~
+\end_inset
-\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
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideNote"
+\end_inset
+ for more details.
\end_layout
+\end_deeper
\begin_layout Standard
-\align center
-
-\size large
-This section documents the class
+You can also use the template file
\begin_inset Quotes eld
\end_inset
-\family sans
-slides (default)
+\family typewriter
+slides.lyx
\family default
\begin_inset Quotes erd
\end_inset
-
-\emph on
-only.
-\end_layout
+ 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
-\begin_layout Standard
-\begin_inset VSpace bigskip
+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
-If you're looking for the documentation for
+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
-slides (FoilTeX)
+Largest
\family default
\begin_inset Quotes erd
\end_inset
-, check out section
+ in the
+\family sans
+Sans
\begin_inset space ~
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:foiltex"
-
-\end_inset
-
-.
- The
-\family sans
-foils
+Serif
\family default
- class [
+ font.
+ This is also what's used in the output.
+ Think of this as a
\begin_inset Quotes eld
\end_inset
-
-\family sans
-slides (FoilTeX)
-\family default
-
+visual cue
\begin_inset Quotes erd
\end_inset
-] is actually somewhat better than the default
+ 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,
-\begin_inset Foot
-status collapsed
+ class itself only supports certain paragraph environments:
+\end_layout
-\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.
+\begin_layout Itemize
+
+\family sans
+Standard
\end_layout
-\end_inset
+\begin_layout Itemize
- which this section documents.
+\family sans
+Itemize
\end_layout
-\begin_layout Standard
-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
+\begin_layout Itemize
+
+\family sans
+Enumerate
+\end_layout
+\begin_layout Itemize
\family sans
-slides
-\family default
+Description
+\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
+List
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-slides
-\family default
- can do which the others can't, such as generate overlays.
- Read on to learn more!
+Quotation
\end_layout
-\begin_layout Subsection
-Getting Started
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:slidesetup"
+\begin_layout Itemize
-\end_inset
+\family sans
+Quote
+\end_layout
+\begin_layout Itemize
+\family sans
+Verse
\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 (default)
-\family default
+Caption
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from the class list in the
\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog.
- There are some other special things you should know about this class:
+LyX-Code
\end_layout
\begin_layout Itemize
-Don't bother changing the options
+
\family sans
-Sides and Columns
-\family default
-.
- They're not supported by the
+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, anyways.
+ class.
+\end_layout
+
+\begin_layout Standard
+On the other hand, you'll notice the following new environments:
\end_layout
\begin_layout Itemize
-The option
-\family sans
-Page
-\begin_inset space ~
-\end_inset
-style
-\family default
- behaves a bit differently for this class.
- The possible choices and what they do are as follows:
+\family sans
+Slide
\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.
+Overlay
\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.
+Note
\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.
+InvisibleText
\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
+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
-\family typewriter
-clock
-\family default
+ 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
- in the extra class options.
+
+\end_layout
+
+\begin_layout Subsubsection
+Quirks of the New Environments
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slideQuirk"
+
+\end_inset
+
+
\end_layout
-\begin_deeper
\begin_layout Standard
-Using this options allows you to add time markers to
+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
-s.
- See section
-\begin_inset space ~
+ to be
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:slideNote"
-
+pseudo-environments.
+\begin_inset Quotes erd
\end_inset
- for more details.
-\end_layout
-
-\end_deeper
-\begin_layout Standard
-You can also use the template file
+ They look like a section heading or a
\begin_inset Quotes eld
\end_inset
-\family typewriter
-slides.lyx
+\family sans
+Caption
\family default
-
+,
\begin_inset Quotes erd
\end_inset
- to automatically set up a document to use the
+ but really begin a [and, if necessary, end the previous] paragraph environment.
+ Likewise, treat
\family sans
-slides
+InvisibleText
\family default
- class [using
+ and
\family sans
-File\SpecialChar \menuseparator
-New
-\begin_inset space ~
+VisibleText
+\family default
+ as
+\begin_inset Quotes eld
\end_inset
-from
-\begin_inset space ~
+pseudo-commands.
+\begin_inset Quotes erd
\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
+ These two perform some action.
\end_layout
\begin_layout Standard
-The first thing you'll notice when you start up a new
+A common feature of all five environments,
\family sans
-slides
+Slide
\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
+Overlay
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- in the
+,
\family sans
-Sans
-\begin_inset space ~
-\end_inset
-
-Serif
+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
- 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.
+ 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
-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
+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
-slides
+Slide
\family default
- class itself only supports certain paragraph environments:
-\end_layout
-
-\begin_layout Itemize
-
+, for example.
+ In that case, enter your descriptive comment and hit
\family sans
-Standard
+Return
+\family default
+ as you normally would.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Itemize
+\begin_layout Standard
+If, on the other hand, you don't want to enter 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
-Enumerate
-\end_layout
-
-\begin_layout Itemize
-
+Slide
+\family default
+,
\family sans
-Description
-\end_layout
-
-\begin_layout Itemize
-
+Overlay
+\family default
+,
\family sans
-List
-\end_layout
-
-\begin_layout Itemize
-
+Note
+\family default
+,
\family sans
-Quotation
-\end_layout
-
-\begin_layout Itemize
-
+InvisibleText
+\family default
+ or
\family sans
-Quote
+VisibleText
+\family default
+.
+
\end_layout
\begin_layout Itemize
-
-\family sans
-Verse
+Now move to the beginning of that paragraph.
+
\end_layout
\begin_layout Itemize
-
+Next, hit
\family sans
-Caption
+Return
+\family default
+.
+
\end_layout
\begin_layout Itemize
-
+Finally, change this new, empty paragraph to a
\family sans
-LyX-Code
-\end_layout
-
-\begin_layout Itemize
-
+Slide
+\family default
+,
\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
+Overlay
+\family default
+,
\family sans
-slides
+Note
\family default
- class.
+,
+\family sans
+InvisibleText
+\family default
+ or
+\family sans
+VisibleText
+\family default
+.
+
\end_layout
\begin_layout Standard
-On the other hand, you'll notice the following new environments:
-\end_layout
+Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
-\begin_layout Itemize
+\end_layout
+\begin_layout Subsection
+Making a Presentation with
\family sans
Slide
-\end_layout
-
-\begin_layout Itemize
-
+\family default
+,
\family sans
Overlay
-\end_layout
-
-\begin_layout Itemize
-
+\family default
+ and
\family sans
Note
\end_layout
-\begin_layout Itemize
-
+\begin_layout Subsubsection
+Using the
\family sans
-InvisibleText
+Slide
+\family default
+ Environment
\end_layout
-\begin_layout Itemize
-
+\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
-VisibleText
+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
-These five are kind of quirky, due to a
-\begin_inset Quotes eld
+Choosing the
+\family sans
+Slide
+\family default
+ environment [in the manner described in section
+\begin_inset space ~
\end_inset
-feature
-\begin_inset Quotes erd
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideQuirk"
+
\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
+] tells LyX to begin a new slide [duh].
+ The label for this environment/
+\begin_inset Quotes erd
\end_inset
-LaTeX magic.
+pseudo-command
\begin_inset Quotes erd
\end_inset
-
-\end_layout
+ is an
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsubsection
-Quirks of the New Environments
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:slideQuirk"
+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
-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
+Slides are probably the only time you'll need to forcibly end pages in LyX
+ (this can be specified in the
\family sans
-Slide
+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
- 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
-,
+The
\family sans
Overlay
\family default
-, and
+ and
\family sans
Note
\family default
- to be
+ environments work the same way as the
+\family sans
+Slide
+\family default
+ environment.
+ They both create an
\begin_inset Quotes eld
\end_inset
-pseudo-environments.
+ASCII line
\begin_inset Quotes erd
\end_inset
- They look like a section heading or a
+ followed by a label [
\begin_inset Quotes eld
\end_inset
-
-\family sans
-Caption
-\family default
-,
+NewOverlay:
\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.
+NewNote:
\begin_inset Quotes erd
\end_inset
- These two perform some action.
+, 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
-A common feature of all five environments,
+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
-InvisibleText
+Overlay
\family default
- and
+s.
+\end_layout
+
+\begin_layout Subsubsection
+Using
\family sans
-VisibleText
+Overlay
\family default
-, is a rather long-ish label.
- The text following this label — ordinarily the contents of the paragraph
- environment — is utterly irrelevant for
+ with
\family sans
Slide
-\family default
-,
+\end_layout
+
+\begin_layout Standard
+The idea behind an
\family sans
Overlay
\family default
-,
-\family sans
-Note
-\family default
-,
+ is a slide that sits atop another slide.
+ Perhaps you wish to discuss a figure on the main
\family sans
-InvisibleText
+Slide
\family default
- and
+ 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
-VisibleText
+Slide
\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
+ 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
-, for example.
- In that case, enter in your descriptive comment and hit
+s to align the two graphs.
+ The use of an
\family sans
-Return
+Overlay
\family default
- as you normally would.
+ environment in both cases makes life much easier.
\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
+Each
+\family sans
+Overlay
+\family default
+ receives the page number of its
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-Start entering the text that will
-\emph on
-follow
-\emph default
- the new
+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
-,
-\family sans
-Note
+s would have
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-a
\family default
+
+\begin_inset Quotes erd
+\end_inset
+
,
-\family sans
-InvisibleText
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-b
\family default
- or
-\family sans
-VisibleText
+
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+-c
\family default
-.
-
-\end_layout
-\begin_layout Itemize
-Now move to the beginning of that paragraph.
-
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-Next, hit
+, etc.
+\begin_inset space ~
+\end_inset
+
+appended to the page number of the parent
\family sans
-Return
+Slide
\family default
.
\end_layout
-\begin_layout Itemize
-Finally, change this new, empty paragraph to a
+\end_inset
+
+ Clearly, you want the contents of both the
\family sans
Slide
\family default
-,
+ and the
\family sans
Overlay
\family default
-,
-\family sans
-Note
-\family default
-,
-\family sans
-InvisibleText
-\family default
- or
+ to each fit on a single physical slide! You should probably consider an
+
\family sans
-VisibleText
+Overlay
\family default
-.
-
-\end_layout
-
-\begin_layout Standard
-Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
+ as
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+part of
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
-Making a Presentation with
+ 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
- and
+ is shorter than that at the start of a
\family sans
-Note
-\end_layout
-
-\begin_layout Subsubsection
-Using the
+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
- Environment
+.
+ These will assist you in lining up the two physical slides.
\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
+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
-slides
+InvisibleText
\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.]
+ and
+\family sans
+VisibleText
+\family default
+.
\end_layout
\begin_layout Standard
-Choosing the
+As their names imply,
\family sans
-Slide
+InvisibleText
\family default
- environment [in the manner described in section
+ 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
\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
+ 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
-ASCII line,
+<Invisible Text Follows>
\begin_inset Quotes erd
\end_inset
- in cool blue, followed by the label,
+.
+ 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
-NewSlide:
+<Visible Text Follows>
\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
+ in blazing green.
+ Paragraphs following this label behave normally.
+ Note that the beginning of a new
\family sans
-Paragraph Layout
+Slide
\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
+, 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
-The
+By now, it should be obvious how to create overlay transparencies using
+ the proper combination of
\family sans
-Overlay
+InvisibleText
\family default
and
\family sans
-Note
+VisibleText
\family default
- environments work the same way as the
+ on a
\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.
+\family sans
+Overlay
+\family default
+:
\end_layout
-\begin_layout Standard
-As with a
+\begin_layout Enumerate
+Create a
\family sans
Slide
\family default
-, if the contents of a
+, including everything that will appear on it, whether on the main slide
+ or on the
\family sans
-Note
+Overlay
\family default
- or
+.
+\end_layout
+
+\begin_layout Enumerate
+Before each figure or paragraph that will appear only on the
\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
+, insert an
\family sans
-Note
+InvisibleText
\family default
-s and
+ environment.
+ If necessary, insert a
+\family sans
+VisibleText
+\family default
+ environment after the
\family sans
Overlay
\family default
-s.
+-only text.
\end_layout
-\begin_layout Subsubsection
-Using
+\begin_layout Enumerate
+Start an
\family sans
Overlay
\family default
- with
+ immediately following the
\family sans
Slide
+\family default
+.
\end_layout
-\begin_layout Standard
-The idea behind an
+\begin_layout Enumerate
+Copy the contents of this
\family sans
-Overlay
+Slide
\family default
- is a slide that sits atop another slide.
- Perhaps you wish to discuss a figure on the main
+ into the
\family sans
-Slide
+Overlay
\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
+.
+\end_layout
+
+\begin_layout Enumerate
+Within the
\family sans
-Slide
+Overlay
\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
+, change all of the
\family sans
-Slide
+InvisibleText
\family default
-s to align the two graphs.
- The use of an
+ lines to
\family sans
-Overlay
+VisibleText
\family default
- environment in both cases makes life much easier.
+ and vice-versa.
\end_layout
\begin_layout Standard
-Each
+That's it.
+ You've just made an
\family sans
Overlay
\family default
- receives the page number of its
-\begin_inset Quotes eld
-\end_inset
-
-parent
-\begin_inset Quotes erd
-\end_inset
+.
+\end_layout
-
+\begin_layout Standard
+There's one problem with the way I've designed the LyX
\family sans
-Slide
-\family default
-, appended by
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
--a
+slides
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ 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
-Presumably, mutliple
-\family sans
-Overlay
-\family default
-s would have
-\begin_inset Quotes eld
-\end_inset
+The commands of interest are:
+\end_layout
+\begin_layout Itemize
\family typewriter
--a
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
+{
+\backslash
+invisible \SpecialChar \ldots{}
+ }
+\end_layout
+\begin_layout Itemize
\family typewriter
--b
-\family default
+{
+\backslash
+visible \SpecialChar \ldots{}
+ }
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Plain Layout
+\SpecialChar \ldots{}
+and need to be marked as TeX.
+ The text whose
+\begin_inset Quotes eld
\end_inset
-,
-\begin_inset Quotes eld
+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
--c
+
+\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
-\begin_inset Quotes erd
\end_inset
-, etc.
-\begin_inset space ~
-\end_inset
-appended to the page number of the parent
+\end_layout
+
+\begin_layout Subsubsection
+Using
+\family sans
+Note
+\family default
+ with
\family sans
Slide
\family default
-.
-
-\end_layout
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slideNote"
\end_inset
- Clearly, you want the contents of both the
-\family sans
-Slide
-\family default
- and the
+
+\end_layout
+
+\begin_layout Standard
+Like an
\family sans
Overlay
\family default
- to each fit on a single physical slide! You should probably consider an
-
+, a
\family sans
-Overlay
+Note
\family default
- as
+ is associated with a
\begin_inset Quotes eld
\end_inset
-part of
+parent
\begin_inset Quotes erd
\end_inset
- a
+
\family sans
Slide
\family default
.
- Indeed, the LyX
+ Here, too, the LyX
\family sans
slides
\family default
- class provides a visual cue for this: the label at the start of an
+ class provides visual cues.
+ The label for a
\family sans
-Overlay
+Note
\family default
- is shorter than that at the start of a
+ is shorter than that 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
+ [yet longer than that of an
\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,
+] and, like the label of an
\family sans
-InvisibleText
+Overlay
\family default
- and
+ is shockingly magenta.
+ Additionally, the printed
\family sans
-VisibleText
+Note
\family default
- are two command-like paragraph environments that make all subsequent text
- invisible and visible, respectively.
- Note from section
-\begin_inset space ~
+ has the page number of its
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:slideQuirk"
-
+parent
+\begin_inset Quotes erd
\end_inset
- that you don't place anything
-\emph on
-into
-\emph default
- these two environments, however.
- When you create an
+
\family sans
-InvisibleText
+Slide
\family default
-, it inserts a centered, sky-blue label into the page reading
+, appended by
\begin_inset Quotes eld
\end_inset
-<Invisible Text Follows>
+
+\family typewriter
+-
+\family default
+1
\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_inset Quotes eld
+\end_inset
-\begin_layout Standard
-For
-\family sans
-VisibleText
+
+\family typewriter
+-
\family default
-, the corresponding centered label is
+2
+\begin_inset Quotes erd
+\end_inset
+
+,
\begin_inset Quotes eld
\end_inset
-<Visible Text Follows>
+
+\family typewriter
+-
+\family default
+3
\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
-,
+, etc.
+ You can have multiple
\family sans
-Overlay
+Note
\family default
-, or
+s associated with a single
\family sans
-Note
+Slide
\family default
- automatically shuts off an
+, and, as with
\family sans
-InvisibleText
+Slide
\family default
-.
- It's therefore not necessary to use
+ and
\family sans
-VisibleText
+Overlay
\family default
- at the end of a
+, you'll probably want to break up long
\family sans
-Slide
+Note
\family default
-.
+s so that they fit on a single sheet of paper.
\end_layout
\begin_layout Standard
-By now, it should be obvious how to create overlay transparencies using
- the proper combination of
+The purpose of a
\family sans
-InvisibleText
+Note
\family default
- and
+ is obvious: it contains anything additional you might want to say about
+ a
\family sans
-VisibleText
+Slide
\family default
- on a
+.
+ It could also be used as a sheet of reminders for a particular
\family sans
Slide
\family default
- and
+.
+ In the case of the latter, you might want to make use of time markers.
+ Currently, the LyX
\family sans
-Overlay
+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 Enumerate
-Create a
-\family sans
-Slide
+\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
-, including everything that will appear on it, whether on the main slide
- or on the
+
+\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
-Overlay
+Note
\family default
-.
-\end_layout
+ you generate.
+ To set what appears in the time marker, you use the LaTeX commands
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Enumerate
-Before each figure or paragraph that will appear only on the
-\family sans
-Overlay
+
+\family typewriter
+
+\backslash
+settime{}
\family default
-, insert an
-\family sans
-InvisibleText
+
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+addtime{}
\family default
- environment.
- If necessary, insert a
-\family sans
-VisibleText
+
+\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
- environment after the
-\family sans
-Overlay
+
+\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
--only text.
-\end_layout
-\begin_layout Enumerate
-Start an
+\begin_inset Quotes erd
+\end_inset
+
+ increments the time marker by the specified amount.
+ Using time markers and
\family sans
-Overlay
+Note
\family default
- immediately following the
+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 Enumerate
-Copy the contents of this
+\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
- into the
+s and
\family sans
Overlay
\family default
-.
-\end_layout
-
-\begin_layout Enumerate
-Within the
+s on transparencies while printing all of your
\family sans
-Overlay
+Note
\family default
-, change all of the
+s on plain paper.
+ However, a
\family sans
-InvisibleText
+Note
\family default
- lines to
+
+\emph on
+must
+\emph default
+ follow the
\family sans
-VisibleText
+Slide
\family default
- and vice-versa.
+ with which it is associated.
+ What's a person to do?
\end_layout
\begin_layout Standard
-That's it.
- You've just made an
-\family sans
-Overlay
+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
-.
-\end_layout
-\begin_layout Standard
-There's one problem with the way I've designed the LyX
+\begin_inset Quotes erd
+\end_inset
+
+ will cause the output to contain only the
\family sans
-slides
+Slide
\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
+s and
+\family sans
+Overlay
+\family default
+s.
+ Correspondingly, the command
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family typewriter
-{
-\backslash
-invisible \SpecialChar \ldots{}
- }
-\end_layout
-
-\begin_layout Itemize
-\family typewriter
-{
\backslash
-visible \SpecialChar \ldots{}
- }
-\end_layout
+onlynotes{
+\backslash
+notes}
+\family default
-\begin_layout Plain Layout
-\SpecialChar \ldots{}
-and need to be marked as TeX.
- The text whose
-\begin_inset Quotes eld
+\begin_inset Quotes erd
\end_inset
-visibility
-\begin_inset Quotes erd
+ 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
- you wish to change goes in between the brackets [and after the
-\family typewriter
-\backslash
-invisible
-\family default
- or
\family typewriter
\backslash
-visible
+onlyslides{
+\backslash
+slides}
\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
+\begin_inset Quotes erd
\end_inset
+ , print to a file with
+\begin_inset Quotes eld
+\end_inset
-\end_layout
-\begin_layout Subsubsection
-Using
-\family sans
-Note
-\family default
- with
-\family sans
-Slide
+\family typewriter
+-slides
\family default
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:slideNote"
+\begin_inset Quotes erd
+\end_inset
+ in its name, comment it back out, then uncomment
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\family typewriter
-\begin_layout Standard
-Like an
-\family sans
-Overlay
-\family default
-, a
-\family sans
-Note
+\backslash
+onlynotes{
+\backslash
+notes}
\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
+ and print to a
\begin_inset Quotes eld
\end_inset
-parent
+
+\family typewriter
+*-notes.ps
+\family default
+
\begin_inset Quotes erd
\end_inset
-
-\family sans
-Slide
-\family default
-, appended by
+ 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
-1
+
\begin_inset Quotes erd
\end_inset
-,
+ and
\begin_inset Quotes eld
\end_inset
\family typewriter
--
+
+\backslash
+onlynotes{}
\family default
-2
+
\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
-3
+
\begin_inset Quotes erd
\end_inset
-, etc.
- You can have multiple
+, with the
\family sans
-Note
+slides
\family default
-s associated with a single
+ class.
+ To use it, begin your new presentation with
\family sans
-Slide
+\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
-, and, as with
+.
+ Your new LyX presentation file will contain an example
\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
+ triplet.
+ The
\family sans
-Note
+Slide
\family default
- is obvious: it contains anything additional you might want to say about
- a
+ and
\family sans
-Slide
+Overlay
\family default
-.
- It could also be used as a sheet of reminders for a particular
+ additionally contain an example of the use of
\family sans
-Slide
+InvisibleText
\family default
-.
- In the case of the latter, you might want to make use of time markers.
- Currently, the LyX
+ and
\family sans
-slides
+VisibleText
\family default
- class has no
-\begin_inset Quotes eld
+.
+ 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
-native
-\begin_inset Quotes erd
-\end_inset
+
+\end_layout
- support for time markers, a
-\noun on
-SliTeX
-\noun default
- feature.
- So, you'll have to resort to using the LaTeX codes.
+\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
-To use time markers, you'll need to specify the extra class option
+One final thing: I created this class to support the LaTeX2e
\begin_inset Quotes eld
\end_inset
-\family typewriter
-clock
-\family default
-
+\noun on
+SliTeX
+\noun default
+ emulation
\begin_inset Quotes erd
\end_inset
- [see section
+ 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:slidesetup"
+reference "sec:foiltex"
\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
+] or the
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-settime{}
+seminar
\family default
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
-
+ package [present on some TeX distributions].
+ The latter is not yet supported under LyX.
+\begin_inset Foot
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+Perhaps you can take on the task\SpecialChar \ldots{}
-\backslash
-addtime{}
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- The arguments of both commands are time measured in seconds.
-
-\begin_inset Quotes eld
-\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
-\family typewriter
+\begin_layout Section
+Checking TeX
+\end_layout
-\backslash
-settime{}
-\family default
+\begin_layout Standard
+by
+\noun on
+Asger Alstrup
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Introduction
+\end_layout
- sets the time marker to a given time.
-
-\begin_inset Quotes eld
-\end_inset
+\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
-
-\backslash
-addtime{}
+chktex
\family default
+ is not yet available when you are using the LaTeX distribution MiKTeX.
+\end_layout
-\begin_inset Quotes erd
\end_inset
- increments the time marker by the specified amount.
- Using time markers and
+, you'll find in the
\family sans
-Note
+Tools
\family default
-s in this fashion, you can remind yourself how much time to spend on a particula
-r
+ menu the entry:
\family sans
-Slide
+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
-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
+The
\family sans
-Slide
+ChkTeX
\family default
- with which it is associated.
- What's a person to do?
-\end_layout
+ package is a program that was written by
+\begin_inset Flex Noun
+status collapsed
-\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
+\begin_layout Plain Layout
+Jens T.
+\begin_inset space ~
\end_inset
+Berger Thielemann
+\end_layout
-\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
+ 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
-s.
- Correspondingly, the command
-\begin_inset Quotes eld
-\end_inset
-
+ 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
-
-\backslash
-onlynotes{
-\backslash
-notes}
+Lint
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- prevents the output of anything but
+ 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
-Note
+ChkTeX
\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
+ 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
-\family typewriter
+\begin_layout Itemize
+No space in front of/after parenthesis:
+\begin_inset Newline newline
+\end_inset
-\backslash
-onlyslides{
-\backslash
-slides}
-\family default
+( wrong spacing )
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Itemize
+Enforcement of normal space after common abbreviations:
+\begin_inset Newline newline
\end_inset
- , print to a file with
-\begin_inset Quotes eld
+e.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\family typewriter
--slides
-\family default
+is too wide spacing.
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Itemize
+Enforcement of end-of-sentence space when the last sentence ends with a
+ capital letter:
+\begin_inset Newline newline
\end_inset
- in its name, comment it back out, then uncomment
-\begin_inset Quotes eld
+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
-\family typewriter
+
+\begin_inset Foot
+status collapsed
-\backslash
-onlynotes{
-\backslash
-notes}
-\family default
+\begin_layout Plain Layout
+This footnote is in danger of falling off to a wrong page
+\end_layout
-\begin_inset Quotes erd
\end_inset
- and print to a
-\begin_inset Quotes eld
-\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
-\family typewriter
-*-notes.ps
-\family default
+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"
-\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_layout Itemize
+Use of
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-onlyslides{}
-\family default
-
+x
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
+ instead of
+\begin_inset Formula $\times$
\end_inset
+ between numbers:
+\begin_inset Newline newline
+\end_inset
-\family typewriter
+2x2 looks cheap compared to
+\begin_inset Formula $2\times2$
+\end_inset
-\backslash
-onlynotes{}
-\family default
+.
+\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
- commands.
- See a good LaTeX book for details.
+ 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
-The
-\family sans
-slides
-\family default
- Class Template File
+How to use it
\end_layout
\begin_layout Standard
-I have also provided a template file,
-\begin_inset Quotes eld
+If you have the program installed, usage is as simple as choosing
+\family sans
+Tools\SpecialChar \menuseparator
+Check
+\begin_inset space ~
\end_inset
-
-\family typewriter
-slides.lyx
+TeX
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, with the
+.
+ This will make LyX generate a LaTeX file of your document, start
\family sans
-slides
+ChkTeX
\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 ~
+ to check it, and then make LyX insert
+\begin_inset Quotes eld
\end_inset
-from
-\begin_inset space ~
+error boxes
+\begin_inset Quotes erd
\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
- –
+ with the warnings from
\family sans
-Note
+ChkTeX
\family default
- triplet.
- The
+, 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
-Slide
+Navigate\SpecialChar \menuseparator
+Error
\family default
- and
+ menu item, or the shortcut key
\family sans
-Overlay
+C-g
\family default
- additionally contain an example of the use of
-\family sans
-InvisibleText
+ from the default
+\family typewriter
+cua
\family default
- and
+ bind file.
+ Open the error boxes by clicking on them with the mouse, or use the shortcut
+ key
\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
+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 LyX-Code
-%
+\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 LyX-Code
-%
-\backslash
-onlynotes{
-\backslash
-notes}
+\begin_layout Subsection
+How to fine tune it
\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
-
+Sometimes, you'll find that
\family sans
-Foils
+ChkTeX
\family default
- class [see section
+ 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
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:foiltex"
-
+All
+\begin_inset space ~
\end_inset
-] or the
-\begin_inset Quotes eld
+Error
+\begin_inset space ~
\end_inset
-
-\family typewriter
-seminar
+Boxes
\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
+, which will get rid of all warnings instantly.
\end_layout
\begin_layout Standard
-If you have the
-\family typewriter
-chktex
+Although
+\family sans
+ChkTeX
\family default
- program installed
+
+\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
-
-\family typewriter
+You can inspect the specific output from
+\family sans
chktex
\family default
- is not yet available when you are using the LaTeX distribution MiKTeX.
-\end_layout
-
+ by using
+\family sans
+Edit\SpecialChar \menuseparator
+View
+\begin_inset space ~
\end_inset
-, you'll find in the
-\family sans
-Tools
-\family default
- menu the entry:
-\family sans
-Check
+LaTeX
\begin_inset space ~
\end_inset
-TeX
+Log
\family default
-.
- You can get
-\family typewriter
+ right after a
+\family sans
chktex
\family default
- it from CTAN,
-\begin_inset CommandInset href
-LatexCommand href
-target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
+ 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 Standard
-The
+\begin_layout Itemize
+Fine tune 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
+ 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
-\end_inset
+\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
- 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
+\begin_layout Standard
+Here follows the warning messages that can be enabled and disabled in
+\family sans
+Preferences
+\family default
+.
+ 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
-lint
+chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
\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
+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
-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
+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
+\begin_layout Enumerate
-( wrong spacing )
+\size small
+\emph on
+Command terminated with space.
\end_layout
-\begin_layout Itemize
-Enforcement of normal space after common abbreviations:
-\begin_inset Newline newline
-\end_inset
+\begin_layout Enumerate
-e.
-\begin_inset space \thinspace{}
+\size small
+Non-breaking space (
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset space \space{}
-\end_inset
-is too wide spacing.
-\end_layout
+\family typewriter
+~
+\family default
-\begin_layout Itemize
-Enforcement of end-of-sentence space when the last sentence ends with a
- capital letter:
-\begin_inset Newline newline
+\begin_inset Quotes erd
\end_inset
-This is a TEST.
- And this is wrong spacing.
+) should have been used.
\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"
+\begin_layout Enumerate
+\size small
+\emph on
+You should enclose the previous parenthesis with
+\begin_inset Quotes eld
\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
+\family typewriter
+{}
+\family default
+\begin_inset Quotes erd
\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
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
\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"
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
\end_inset
-.
+) found in non-italic buffer.
\end_layout
-\begin_layout Itemize
-Use of
+\begin_layout Enumerate
+
+\size small
+Italic correction (
\begin_inset Quotes eld
\end_inset
-x
-\begin_inset Quotes erd
-\end_inset
- instead of
-\begin_inset Formula $\times$
-\end_inset
+\family typewriter
- between numbers:
-\begin_inset Newline newline
-\end_inset
+\backslash
+/
+\family default
-2x2 looks cheap compared to
-\begin_inset Formula $2\times2$
+\begin_inset Quotes erd
\end_inset
-.
+) found more than once.
\end_layout
-\begin_layout Standard
-and more \SpecialChar \ldots{}
- It is an invaluable tool when you are
+\begin_layout Enumerate
+
+\size small
+\emph on
+No italic correction (
\begin_inset Quotes eld
\end_inset
-finishing up
+
+\family typewriter
+
+\backslash
+/
+\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.
+) found.
\end_layout
-\begin_layout Subsection
-How to use it
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
-If you have the program installed, usage is as simple as choosing
-\family sans
-Tools\SpecialChar \menuseparator
-Check
-\begin_inset space ~
+\size small
+Accent command
+\begin_inset Quotes eld
\end_inset
-TeX
-\family default
-.
- This will make LyX generate a LaTeX file of your document, start
-\family sans
-ChkTeX
+
+\family typewriter
+cmd
\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
+ needs use of
+\begin_inset Quotes eld
+\end_inset
+
+
\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
+cmd
+\family default
-\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.
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Subsection
-How to fine tune it
+\begin_layout Enumerate
+
+\size small
+Wrong length of dash may have been used.
\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 ~
+\begin_layout Enumerate
+
+\size small
+\emph on
+\begin_inset Quotes eld
\end_inset
-All
-\begin_inset space ~
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
\end_inset
-Error
-\begin_inset space ~
+ expected, found
+\begin_inset Quotes eld
\end_inset
-Boxes
+
+\family typewriter
+%s
\family default
-, which will get rid of all warnings instantly.
+
+\begin_inset Quotes erd
+\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
-\family sans
-ChkTeX
-\family default
- output
-\begin_inset Foot
-status collapsed
+\begin_layout Enumerate
-\begin_layout Plain Layout
-You can inspect the specific output from
-\family sans
-chktex
+\size small
+Solo
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
\family default
- by using
-\family sans
-Edit\SpecialChar \menuseparator
-View
-\begin_inset space ~
+
+\begin_inset Quotes erd
\end_inset
-LaTeX
-\begin_inset space ~
+ found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use
+\begin_inset Quotes eld
\end_inset
-Log
-\family default
- right after a
-\family sans
-chktex
+
+\family typewriter
+%s
\family default
- run.
-\end_layout
+\begin_inset Quotes erd
\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:
+ to achieve an ellipsis.
\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
+\begin_layout Enumerate
+
+\size small
+Inter-word spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-chktexrc
+
+\backslash
+
\family default
-).
- See below to learn what warnings can be enabled and disabled on the command
- line.
+\begin_inset Quotes eld
+\end_inset
+
+) should perhaps be used.
\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
+\begin_layout Enumerate
+
+\size small
+Inter-sentence spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-chktex
+
+\backslash
+@
\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
+
+) should perhaps be used.
\end_layout
-\begin_layout Standard
-Here follows the warning messages that can be enabled and disabled in
-\family sans
-Preferences
-\family default
-.
- 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
-".
+\begin_layout Enumerate
+
+\size small
+Could not find argument for command.
\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
+\begin_layout Enumerate
+
+\size small
+No match found for
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-chktex
+%s
\family default
+
+\begin_inset Quotes erd
+\end_inset
+
.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-Command terminated with space.
+Math mode still on at end of LaTeX file.
\end_layout
\begin_layout Enumerate
\size small
-Non-breaking space (
+Number of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+char
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ doesn't match the number of
\begin_inset Quotes eld
\end_inset
\family typewriter
-~
+char
\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
+You should use either
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-\family typewriter
-{}
\family default
+ or
+\family typewriter
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-\size small
-Italic correction (
+\family default
+ as an alternative to
\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
-
-
+You should use "
\family typewriter
-
-\backslash
-/
+'
+\family default
+" (ASCII 39) instead of "
+\family typewriter
+´
\family default
+" (ASCII 180).
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-) found more than once.
+\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
-No italic correction (
-\begin_inset Quotes eld
-\end_inset
+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_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-) found.
+\size small
+Delete this space to maintain correct page references.
\end_layout
\begin_layout Enumerate
\size small
-Accent command
+\emph on
+You might wish to put this between a pair of
\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
+.
+\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
-cmd
+
+\backslash
+/
\family default
+ in front of small punctuation.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-.
+\family typewriter
+\size small
+$
+\backslash
+times$
+\family default
+ may look prettier here.
\end_layout
\begin_layout Enumerate
\size small
-Wrong length of dash may have been used.
+\emph on
+Multiple spaces detected in output.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-\begin_inset Quotes eld
-\end_inset
+This text may be ignored.
+\end_layout
+\begin_layout Enumerate
+\size small
+Use
\family typewriter
-%s
-\family default
-
-\begin_inset Quotes erd
-\end_inset
- expected, found
\begin_inset Quotes eld
\end_inset
+\family default
+ to begin quotation, not
\family typewriter
-%s
+'
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
\begin_layout Enumerate
\size small
-Solo
+Use
+\family typewriter
+'
+\family default
+ to end quotation, not
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-\family typewriter
-%s
\family default
+.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
- found.
+\size small
+Don't mix quotes.
\end_layout
\begin_layout Enumerate
\size small
-You should use
+You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+cmd
\family default
\begin_inset Quotes erd
\end_inset
- to achieve an ellipsis.
+ instead.
\end_layout
\begin_layout Enumerate
\size small
-Inter-word spacing (
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
+You should put a space in front of/after parenthesis.
+\end_layout
-\family default
-
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
-) should perhaps be used.
+\size small
+You should avoid spaces in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
\size small
-Inter-sentence spacing (
-\begin_inset Quotes eld
-\end_inset
-
+\emph on
+You should not use punctuation in front of/after quotes.
+\end_layout
-\family typewriter
+\begin_layout Enumerate
-\backslash
-@
-\family default
+\size small
+Double space found.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-) should perhaps be used.
+\size small
+You should put punctuation outside inner/inside display math mode.
\end_layout
\begin_layout Enumerate
\size small
-Could not find argument for command.
+You ought to not use primitive TeX in LaTeX code.
\end_layout
\begin_layout Enumerate
\size small
-No match found for
+You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
\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
-char
+%s
\family default
\begin_inset Quotes erd
\end_inset
- doesn't match the number of
+ is normally not followed by
\begin_inset Quotes eld
\end_inset
\family typewriter
-char
+%c
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\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.
+\end_layout
+
+\begin_layout Section
+Version Control in LyX
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+ Lars Gullik Bjønnes
+\noun default
+and
+\noun on
+Pavel Sanda
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\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 been done.
+ LyX now supports some of the most basic RCS/CVS/SVN commands.
+ If you need something a bit more sophisticated you will have to do that
+ manually in a terminal.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+Before you begin to use the version control features in LyX, you should
+ be familiar with RCS/CVS/SVN usage before start using it under LyX.
+ Also note that CVS support is not as good as subversion support so we advice
+ using SVN instead.
+ Good place to start with Subversion is SVN Book
+\begin_inset Foot
+status open
-\size small
-You should use either
-\family typewriter
+\begin_layout Plain Layout
+\begin_inset CommandInset href
+LatexCommand href
+target "http://svnbook.red-bean.com/"
-\begin_inset Quotes eld
\end_inset
-\family default
- or
-\family typewriter
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
-\family default
- as an alternative to
+.
+ In case of RCS you should read
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-"
-\family default
-
+rcsintro
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You should use "
+ (a man file, read it with
\family typewriter
-'
+man rcsintro
\family default
-" (ASCII 39) instead of "
+).
+ 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
-" (ASCII 180).
+).
\end_layout
-\begin_layout Enumerate
-
-\size small
-User-specified pattern found.
+\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.
+ Most of the log messages are not currently displayed after operations —
+ you can check them in Messages pane if unsure.
\end_layout
-\begin_layout Enumerate
-
-\size small
-This command might not be intended.
+\begin_layout Standard
+For introducing your own external commands consult vc-command in the manual
+ of LyX functions.
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-Comment displayed.
+\begin_layout Subsection
+RCS commands in LyX
\end_layout
-\begin_layout Enumerate
+\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
-\size small
-Either
-\family typewriter
-''
-\backslash
-,'
-\family default
- or
-\family typewriter
-'
-\backslash
-,''
+Control
\family default
- will look better.
+ submenu.
+ LyX was tested against RCS 5.7.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Delete this space to maintain correct page references.
+\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
+Register
+\family default
+ item is not visible.
+
+\end_layout
-\size small
-\emph on
-You might wish to put this between a pair of
-\begin_inset Quotes eld
+\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
-\family typewriter
-{}
+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
-.
+ item tagged to the filename in the minibuffer.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+RCS command that is run:
+\family typewriter
+ci -q -u -i -t-"<initial description>" <file-name>
+\end_layout
-\size small
-You ought to remove spaces in front of punctuation.
+\begin_layout Standard
+Read
+\family typewriter
+man ci
+\family default
+ to understand the switches.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Could not execute LaTeX command.
+\family sans
+Check In Changes
\end_layout
-\begin_layout Enumerate
+\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
-\size small
-Don't use
+\begin_layout Standard
+RCS command:
\family typewriter
-
-\backslash
-/
-\family default
- in front of small punctuation.
+ci -q -u -m"<description>" <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\family typewriter
-\size small
-$
-\backslash
-times$
-\family default
- may look prettier here.
+\family sans
+Check Out For Edit
\end_layout
-\begin_layout Enumerate
+\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
-\size small
-\emph on
-Multiple spaces detected in output.
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -q -l <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-This text may be ignored.
+\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.
+\end_layout
-\size small
-Use
+\begin_layout Standard
+RCS command:
\family typewriter
+co -f -u<version> <file-name>
+\end_layout
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
+\family sans
+Undo Last Checkin
+\end_layout
-\family default
- to begin quotation, not
+\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 Standard
+RCS command:
\family typewriter
-'
-\family default
-.
+rcs -o<version> <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Use
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the RCS document.
+ The output of
\family typewriter
-'
+rlog <file-name>
\family default
- to end quotation, not
+ is shown in a browser.
+ See
\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
-
+man rlog
\family default
-.
+ for more info.
\end_layout
-\begin_layout Enumerate
-
-\size small
-Don't mix quotes.
+\begin_layout Subsubsection
+Revision info
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+LyX supports RCS version number information (only), see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
-\size small
-You should perhaps use
-\begin_inset Quotes eld
\end_inset
+ for details.
+\end_layout
-\family typewriter
-cmd
-\family default
+\begin_layout Subsection
+CVS commands in LyX
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Standard
+A subset of CVS operations is supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
- instead.
+Control
+\family default
+ submenu.
+ The version control system SVN is more powerful, so please use it instead
+ of CVS if possible.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-You should put a space in front of/after parenthesis.
+\family sans
+General CVS usage
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should avoid spaces in front of/after parenthesis.
+\begin_layout Standard
+If you start from scratch with CVS you have to create your repository and
+ checkout the working copy with external tools.
+ If you're using a client-server setup you may need to login before doing
+ the first repository checkout.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+If your documents are under revision control and others are using the same
+ repository problems arise when different changes to the same document at
+ the same location happen.
+ Standard CVS repositories doesn't operate with a file locking mechanism.
+ This may be surprising, but conflicts only occur if people disagree on
+ the proper content of the same part of a document.
+ So, if co-workers are used to communicate regularly, these conflicts occur
+ rarely.
+ If they don't communicate they have a fundamental problem anyway.
+ Nevertheless some people like to work with so called
+\begin_inset Quotes eld
+\end_inset
-\size small
-\emph on
-You should not use punctuation in front of/after quotes.
-\end_layout
+reserved checkouts
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Enumerate
+.
+ If they do so the working copy of all files is readonly when checked out
+ first and the user starts editing after using a special command to make
+ the working copy writable.
+ When the changes are checked in the working copy returns to readonly state.
+ With LyX one has to edit the
+\begin_inset Flex Code
+status collapsed
-\size small
-Double space found.
+\begin_layout Plain Layout
+.cvsrc
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-You should put punctuation outside inner/inside display math mode.
+ file and add the line
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -r
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-You ought to not use primitive TeX in LaTeX code.
+ to work with reserved checkouts.
+ The benefit is the possibility to see who is using a writable copy of some
+ document.
+ It's not guaranteed only one user makes a copy writable.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+LyX tries to guess if you're using reserved or non-reserved checkouts.
+ If your working copy is readonly or it is writable and an additional copy
+ of your document exists in the CVS/Base sub-directory a reserved otherwise
+ a non-reserved checkout is assumed.
+ When a reserved checkout is detected you have to use
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check Out
+\end_layout
-\size small
-You should remove spaces in front of
-\begin_inset Quotes eld
\end_inset
+ to make your working copy writable if it's readonly.
+ After doing so the
+\begin_inset Flex MenuItem
+status collapsed
-\family typewriter
-%s
-\family default
+\begin_layout Plain Layout
+Check In
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
+ operation is possible and that makes your working copy readonly again after
+ transferring your changes to the repository.
\end_layout
-\begin_layout Enumerate
-
-\size small
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+More information about CVS can be found here
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family typewriter
-%s
-\family default
+http://www.nongnu.org/cvs
+\end_layout
-\begin_inset Quotes erd
\end_inset
- is normally not followed by
-\begin_inset Quotes eld
-\end_inset
+ and here
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family typewriter
-%c
-\family default
+http://ximbiot.com/cvs
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
\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
+Read
\family typewriter
-lacheck
+man cvs
\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.
+ to understand the sub-commands and the switches mentioned below.
\end_layout
-\begin_layout Section
-Version Control in LyX
-\end_layout
+\begin_layout Subsubsection
-\begin_layout Standard
-by
-\noun on
- Lars Gullik Bjønnes,
-\noun default
-updated by
-\noun on
-Pavel Sanda
+\family sans
+Register
\end_layout
-\begin_layout Subsection
-Introduction
+\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
-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.
+This command registers in CVS your document
+\emph on
+
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+only
\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
+\emph default
+ in case you have already the documents directory under CVS control (in
+ particular
\family typewriter
-,v
+CVS/Entries
\family default
-).
+ file exists).
+ This means you have to create or checkout the archive by yourself using
+ external tools.
+ (In case you forget that step LyX registers the document with RCS.)
\end_layout
\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.
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet checked in.
\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.
+CVS command that is run:
+\family typewriter
+cvs -q add -m"<entered message>" "<file-name>"
\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
+The term
+\family typewriter
+"<file-name>"
+\family default
+ above and for all other CVS commands is an abbreviation for
+\begin_inset Quotes eld
+\end_inset
-\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 ~
+change the current working directory to file location and use the file name
+ without path component as argument
+\begin_inset Quotes erd
\end_inset
-Control
-\family default
- submenu.
- LyX was tested against RCS 5.7.
+.
\end_layout
\begin_layout Subsubsection
\family sans
-Register
+Check In Changes
\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.
-
+When you are finished editing a file, you commit your changes.
+ When you do this and you had changed the document, you are asked for a
+ description of the changes.
+ After that changes are written to the repository.
+ In case you didn't change the document and a reserved checkout is detected
+ the reservation made on
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check Out
\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
+ is undone.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
\begin_inset space ~
\end_inset
-For
+command:
\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
+\begin_inset Newline newline
\end_inset
- item tagged to the filename in the minibuffer.
-\end_layout
-\begin_layout Standard
-RCS command that is run:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs
\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
+-q commit -m"<description>" "<file-name>"
\end_layout
-\begin_layout Standard
-Read
+\end_inset
+
+ or
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q unedit
\family typewriter
-man ci
-\family default
- to understand the switches.
-
+"<file-name>"
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\family sans
-Check In Changes
+Check Out 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.
-
+When you are sharing a repository with others, you may have to incorporate
+ their changes into your working copy.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-ci -q -u -m"<description>" <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Check Out For Edit
+cvs -q update "<file-name>"
\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.
-
+If a readonly checkout is detected the working copy is made writable and
+ reserved.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-co -q -l <file-name>
+cvs -q edit "<file-name>"
\end_layout
\begin_layout Subsubsection
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
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-co -f -u<version> <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Undo Last Checkin
+cvs -q update "<file-name>"
\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.
-
+If a reserved checkout is detected and the working copy has no changes only
+ the reservation is undone.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-rcs -o<version> <file-name>
+cvs -q unedit "<file-name>"
\end_layout
\begin_layout Subsubsection
-
-\family sans
-Show History
+Update of the local directory checkout from repository
\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.
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
\end_layout
-\begin_layout Subsection
-CVS commands in LyX
+\end_inset
+
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
\end_layout
\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 ~
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
\end_inset
-Control
-\family default
- submenu.
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<<<<<<<
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Register
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>>>>>>>
\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_inset
+
+ separated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+=======
\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
-CVS/Entries
-\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
+\end_inset
+
+.
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>
\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_inset
+
+ signs.
\end_layout
-\begin_layout Standard
-CVS command that is run:
-\family typewriter
-cvs -q add -m
-\begin_inset Quotes erd
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
-<entered message>"
-\begin_inset Quotes eld
+commands:
+\begin_inset space ~
\end_inset
-<file-name>
-\begin_inset Quotes erd
+
+\begin_inset Newline newline
\end_inset
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Read
+\begin_layout Plain Layout
+cd $path; cvs diff
\family typewriter
-man svn
-\family default
- to understand the switches.
-
+"."
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Check In Changes
-\end_layout
+ (Ask if changes are detected.)
+\begin_inset Newline newline
+\end_inset
-\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:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs -q update
\family typewriter
-cvs -q commit -m"<description>" "<file-name>"
+"."
\end_layout
-\begin_layout Subsubsection
+\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.
- Firstly the file is deleted, secondly CVS update command is run.
\end_layout
\begin_layout Standard
-CVS command:
-\family typewriter
-cvs update
-\begin_inset Quotes eld
-\end_inset
+where
+\begin_inset Flex Code
+status collapsed
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+$path
+\end_layout
+\end_inset
+ stands for the path to the document.
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-This show the complete history of the CVS document.
+This shows the complete history of the CVS document.
The output of
\family typewriter
-cvs log
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
-\end_inset
-
-
+cvs log "<file-name>"
\family default
is shown in a browser.
\end_layout
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.
+ LyX was tested against SVN 1.5 and 1.6
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Most of the commands will work with 1.4 too, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:SVN-Repo-Update"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\family typewriter
-svn update
+svn update --non-interactive
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsubsection
-Synchronization of local directory checkout with repository
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:SVN-Repo-Update"
+
+\end_inset
+
+Update of the local directory checkout from repository
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this command will work only with subversion
+\begin_inset Formula $\geqq1.5$
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
All the commands above have one shortcomming - they deal with the current
document only.
Once your document contains pictures, includes external
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- files and so on administration becomes more complicate.
+ files and so on administration becomes more complicated.
LyX now supports updating the whole tree in which resides the document
\begin_inset Foot
status collapsed
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Synchronize local directory with repository
+Update local directory from repository
\end_layout
\end_inset
- command firstly reverts all local changes (to avoid merge conflicts aftwards)
- and then updates the whole directory structure from the archive.
- If local changes are detected user is warned before reversion starts.
+ command updates the whole directory and in case of merge conflicts local
+ version of the files are left, so no unintended data loss occurs.
+ If local changes are detected user is warned before update starts.
\end_layout
\begin_layout Labeling
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn revert -R $path
-\begin_inset Newline newline
-\end_inset
-
-svn update $path
+svn update --accept mine-full $path
\end_layout
\end_inset
\begin_layout Standard
where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-This show the complete history of the SVN document.
+This shows the complete history of the SVN document.
The output of
\family typewriter
svn log
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
+ When such a 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 Standard
-SVN has two mechanisms to provide such kind of mutual exclusivity for file
- access - locks and automatical setting of write permissions (see sec.
+SVN has two such mechanisms to provide mutual exclusivity for file access
+ - locks and automatic setting of write permissions (see sec.
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
) based on
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
.
- 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:
+ If 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 of file use in LyX:
\end_layout
\begin_layout Itemize
Unlocked state.
The loaded file is in the read-only mode.
- For editation on needs to check-out.
+ For editing on needs to check-out.
\emph on
Check-out
\emph default
- consists of update from repository and gaining write lock.
+ consists of updating from the repository and gaining write lock.
If the lock is not possible to obtain, we remain in unlocked state.
\end_layout
\family default
-Automatical Locking Property
+Automatic Locking Property
\end_layout
\begin_layout Standard
-The above mentioned automatical setting of write permissions of the .lyx
- file can be set through
+The above mentioned automatic setting of write permissions of the .lyx file
+ can be set through
\family sans
\bar under
F
\end_layout
\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:VCS-Revision-Information"
+
+\end_inset
+
Revision Information in Documents
\end_layout
\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.
+There are more possibilities how to activate revision information in our
+ document.
+\end_layout
+
+\begin_layout Itemize
+LyX supports directly:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+tree revision information (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-tree-revision
+\end_layout
+
+\end_inset
+
+).
+ The result is the output of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
+\end_layout
+
+\end_inset
+
+ command, the following table gives you an idea, how to read the results.
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="6" columns="2">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Output
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Meaning
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123:4168
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mixed revision working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4168M
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+modified working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123S
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+switched working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123P
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+partial working copy, from a sparse checkout
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123:4168MS
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mixed revision, modified, switched working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+file revision information.
+ The result comes from parsing the output of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn
+\begin_inset space ~
+\end_inset
+
+info
+\begin_inset space ~
+\end_inset
+
+--xml
+\begin_inset space ~
+\end_inset
+
+file.lyx
+\end_layout
+
+\end_inset
+
+.
+ Supported flags are:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+version number of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-revision
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+author of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-author
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+date of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-date
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+time of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-time
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+You can obtain this info via InsetInfo (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+info-insert buffer vcs-date
+\end_layout
+
+\end_inset
+
+).
+ The information will be available only when you have the file stored under
+ svn managment (i.e.
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.svn
+\end_layout
+
+\end_inset
+
+ directory is available with your document).
\end_layout
-\begin_layout Standard
-One possibility is to use svn keywords
+\end_deeper
+\begin_layout Itemize
+Another---a hacking one---possibility is to use svn keywords
\begin_inset Foot
status collapsed
\family sans
svn propset svn:keywords 'Rev' file.lyx
\family default
-) and then paste keyword ERT
+) and then paste keyword TeX code
\begin_inset Foot
status collapsed
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
-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
-
-\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
-
-\end_inset
-
- command and returns the result back, when typeseting the document.
+ this approach reliably or let LyX to support it directly.
\end_layout
\begin_layout Subsection
client program from a command prompt.
\end_layout
+\begin_layout Subsubsection
+SSH tunnel used with SVN under Windows
+\end_layout
+
+\begin_layout Standard
+Compared with Linux setting up svn client to communicate over ssh under
+ Windows is a rather troublesome task.
+ We will at least offer some hints how to setup the client side but prior
+ knowledge about ssh and the Windows command line is needed, also be prepared
+ for a great deal of frustration\SpecialChar \ldots{}
+
+\end_layout
+
+\begin_layout Enumerate
+Get a svn client for windows, as described in the previous sections.
+ When it is a fresh install run some svn command (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn --version
+\end_layout
+
+\end_inset
+
+) to create config files, which you will need to change later on.
+\end_layout
+
+\begin_layout Enumerate
+Choose a ssh client for Windows.
+ There are several possibilities, we will use the one from Putty tools
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+.
+ You will need to set the connection up so that the client doesn't ask for
+ any password from you.
+ To keep things easy we will use only keys without any additional password
+ protection etc.
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+Generate keys by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+puttygen
+\end_layout
+
+\end_inset
+
+.
+ Save your private .ppk key file and put the public one on the server side.
+ If the SVN server runs on Linux, note that the format of the public key
+ is not compatible with Linux openssh and you will need to direcly copy-paste
+ the key from the “
+\emph on
+Public key for pasting into OpenSSH authorized_keys file
+\emph default
+:” edit field into the server's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+~/.ssh/authorized_keys
+\end_layout
+
+\end_inset
+
+/
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+authorized_keys2
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_layout Enumerate
+Get the Putty's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+plink
+\end_layout
+
+\end_inset
+
+.
+ In the SVN config file
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Exact path depends on Windows version, usually somewhere around
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+c:
+\backslash
+Documents and Settings
+\backslash
+user
+\backslash
+Application Data
+\backslash
+Subversion
+\backslash
+config
+\end_layout
+
+\end_inset
+
+ /
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AppData
+\backslash
+Roaming
+\backslash
+Subversion
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+, section [tunnels], setup ssh command, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ssh=c:/path/plink.exe -i c:/path/private_key.ppk
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+It will usually take a lot of time to get exact command right and it depends
+ on many things.
+ For example do not have some remote server saved as a default session in
+ Putty etc.
+ If things fail, try to connect via plink without SVN first.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Checkout the SVN archive, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn co svn+ssh://user@server/repository_path
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+End-of-Line Conversions
+\end_layout
+
+\begin_layout Standard
+When the collsraborators are mixing Linux and Windows environments, LyX
+ will use different line endings inside the .lyx files.
+ This is not a problem as far as LyX functionality is concerned, but the
+ commit diffs will be huge and merge-conflicts prone.
+ Fortunately SVN itself knows
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ how to deal with CR/LF problems when switching .lyx files to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+native
+\end_layout
+
+\end_inset
+
+ mode.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For the lazy guys:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn propset svn:eol-style native FILE_NAME
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
\begin_layout Subsection
Further tuning
\end_layout
\begin_layout Description
Commit:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Description
Revert:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
+\begin_layout Subsection
+Version control and Document comparison
+\end_layout
+
+\begin_layout Standard
+One of the typical uses of version control is to inspect the changes between
+ revisions, usually by creating
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+diff
+\end_layout
+
+\end_inset
+
+ dumps.
+ While this is useful for plain text files, it is much less useful in the
+ case of LyX files, which have more complicated structure.
+ Hence we provide binding to the Document comparison feature.
+ They are two ways of calling this feature - either by direct call of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+VC_COMPARE
+\end_layout
+
+\end_inset
+
+ LyX function (for details see LyX functions manual) or by icon/menu item
+
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Compare with older revision...
+\end_layout
+
+\end_inset
+
+.
+ One can either compare two chosen revisions of the document or he can simply
+ compare the current version of edited text with older revisions (where
+ '
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+' revisions back means comparison of the edited file with last commited
+ revision).
+
+\end_layout
+
+\begin_layout Standard
+This feature is supported for SVN and RCS though due to the more complicated
+ versioning scheme of RCS there is a constraint -- when addressing the revisions
+ in dialog, numbers always point to the last number in RCS revision number,
+ i.e.
+ '35' in '1.2.35'.
+\end_layout
+
\begin_layout Section
Literate Programming
\end_layout
\begin_layout Standard
The main purpose of this documentation is to show you how to use LyX for
- literate programming.
- Where it is assumed that you are familiar with this programming technique,
- and know what
+ literate programming, where it is assumed that you are familiar with this
+ programming technique, and know what
\begin_inset Quotes eld
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+E.
Knuth during the development of his TeX typesetting software.
\end_layout
\begin_layout Plain Layout
-http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+http://www.literateprogramming.com/lpfaq.pdf
\end_layout
\end_inset
\begin_layout Standard
Most ideas in this section require less common files in your LaTeX installation.
- If you have a system like teTeX, most will already be available.
+ If you have a system like TeXLive, most will already be available.
A few, however, will need to be downloaded from one of the CTAN archives.
Often, there are several ways to do something, or several LaTeX style files
which do the same thing.
Enumerate
\family default
Paragraph Environment
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
\end_layout
-\begin_layout Standard
-
-\end_layout
-
\begin_layout Section
Dropped Capitals
\end_layout
dropping
\family default
) package from CTAN allows a simple way to add such letters to your documents.
- Since this package is not a standard part of teTeX, I can't demonstrate
+ Since this package is not a standard part of TeXLive, I can't demonstrate
it within this document, but if you copy this paragraph to a new document,
delete the
\begin_inset Quotes eld
projects / lyx.git / blobdiff