-#LyX 1.3 created this file. For more info see http://www.lyx.org/
-\lyxformat 221
+#LyX 1.5.0rc1 created this file. For more info see http://www.lyx.org/
+\lyxformat 271
+\begin_document
+\begin_header
\textclass book
\begin_preamble
\usepackage{multicol}
\end_preamble
\language english
\inputencoding latin1
-\fontscheme default
+\font_roman default
+\font_sans default
+\font_typewriter default
+\font_default_family default
+\font_sc false
+\font_osf false
+\font_sf_scale 100
+\font_tt_scale 100
\graphics default
\paperfontsize default
-\spacing single
-\papersize Default
-\paperpackage a4
-\use_geometry 0
+\spacing single
+\papersize default
+\use_geometry false
\use_amsmath 0
-\use_natbib 0
-\use_numerical_citations 0
+\use_esint 0
+\cite_engine basic
+\use_bibtopic false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\defskip medskip
\quotes_language english
-\quotes_times 2
\papercolumns 1
\papersides 2
\paperpagestyle headings
+\tracking_changes false
+\output_changes false
+\author "usti"
+\author "Richard Heck"
+\end_header
-\layout Title
+\begin_body
+\begin_layout Title
Extended LyX Features
-\layout Author
+\end_layout
+\begin_layout Author
by the LyX Team
\begin_inset Foot
-collapsed true
+status collapsed
-\layout Standard
-\noindent
+\begin_layout Standard
+\noindent
Principal maintainer of this file is
-\noun on
+\noun on
Mike Ressler
-\noun default
+\noun default
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list, <lyx-docs@lists.lyx.org>.
-\end_inset
+\end_layout
-
-\layout Standard
+\end_inset
+
+\end_layout
-\begin_inset LatexCommand \tableofcontents{}
+\begin_layout Standard
+\begin_inset LatexCommand tableofcontents
-\end_inset
+\end_inset
-\layout Chapter
+\end_layout
+\begin_layout Chapter
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\emph on
+\emph on
Extended LyX Features
-\emph default
+\emph default
manual, which you are now reading, is essentially Part II of the
-\emph on
+\emph on
User's Guide\SpecialChar \@.
-\emph default
+\emph default
The reason for splitting this document is simple: the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
is already huge, and it contains all of the basic features one needs to
know in order to prepare most documents.
However, the LyX Team has a long-term goal of making LyX extensible through
can create a layout file for it without having to alter LyX itself.
We've already had contributions of several new features this way.
This is the place where all of that gets documented.
-\layout Standard
+\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.
After all, LyX
-\emph on
+\emph on
is
-\emph default
+\emph default
only WYSIWYM, and will only ever interface to certain LaTeX features.
-\layout Standard
+\end_layout
+\begin_layout Standard
Of course, with all of this extra documentation,
-\emph on
+\emph on
Extended LyX Features
-\emph default
+\emph default
may itself grow too big for its britches.
In that case, you can just call it the
\begin_inset Quotes eld
-\end_inset
+\end_inset
Overextended Manual
\begin_inset Quotes erd
-\end_inset
+\end_inset
for fun!
-\layout Standard
+\end_layout
+\begin_layout Standard
If you haven't read the
-\emph on
-Introduction
-\emph default
-yet, you are definitely in the wrong manual.
+\emph on
+Introduction
+\emph default
+ yet, you are definitely in the wrong manual.
The
-\emph on
+\emph on
Introduction
-\emph default
+\emph default
is the first place to go, since it will direct you to the correct manual,
and it also describes the notation and format of all of the manuals.
You should also be thoroughly familiar with the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
and all of the basic features of LyX.
-\layout Standard
+\end_layout
+\begin_layout Standard
In this document, many sections are independent articles contributed by
an individual and are noted as such.
This person is generally whoever wrote the layout file for the new document
class or LaTeX package, or implemented the feature.
If there is no mention of an author to a chapter [or chapter sections],
that means it was written by the LyX Documentation Team.
-\layout Standard
+\end_layout
+\begin_layout Standard
Since all the topics in this manual depend heavily on LyX's interaction
- with LaTeX, this first chapter covers
-\emph on
-
-\emph default
-the inner workings of LyX and how to direct LyX to generate exactly the
- LaTeX code you want.
+ 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.
-\layout Chapter
+\end_layout
+\begin_layout Chapter
LyX and LaTeX
-\layout Section
+\end_layout
+\begin_layout Section
How LyX Uses LaTeX
-\layout Standard
+\end_layout
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:lyxandlatex"
-\begin_inset LatexCommand \label{sec:lyxandlatex}
-
-\end_inset
+\end_inset
This chapter is for both TeX-nicians and the LaTeX-curious.
In it, we'll explain how LyX and LaTeX work together to produce printable
output.
This is the only place in any of the manuals where we assume you know something
about LaTeX.
-\layout Standard
+\end_layout
+\begin_layout Standard
At one time, we called LyX a
\begin_inset Quotes eld
-\end_inset
+\end_inset
WYSIWYM frontend to LaTeX,
\begin_inset Quotes erd
-\end_inset
+\end_inset
but that's no longer true.
There are frontends to LaTeX out there.
They are basically editors with the ability to run LaTeX and mark any errors
in the file you're editing.
Although LyX
-\emph on
+\emph on
is
-\emph default
+\emph default
an editor, and it
-\emph on
+\emph on
does
-\emph default
+\emph default
run LaTeX, and it also marks errors in the file, it also does much, much
more.
Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
LyX has also added a few extensions to LaTeX.
Try the following sometime: select
-\family sans
+\family sans
Export\SpecialChar \menuseparator
LaTeX
-\family default
+\family default
from the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile
-\family default
+\family default
menu, then look at the preamble of the resulting
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file.
You'll notice a variety of new macros defined specifically by LyX.
These macros are defined automatically, according to the features you use
in the document.
-\layout Standard
+\end_layout
+\begin_layout Standard
There are several commands that automatically invoke LaTeX.
They are:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew\SpecialChar \menuseparator
-View\SpecialChar ~
+View\InsetSpace ~
-\emph on
+\emph on
Format
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew\SpecialChar \menuseparator
-\bar under
+\bar under
U
-\bar default
+\bar default
pdate\SpecialChar \menuseparator
-\emph on
+\emph on
Format
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile
-\bar under
+\bar under
\SpecialChar \menuseparator
P
-\bar default
+\bar default
rint
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile
-\bar under
+\bar under
\SpecialChar \menuseparator
F
-\bar default
+\bar default
ax
-\layout Standard
+\end_layout
+\begin_layout Standard
They will only invoke LaTeX if the file has changed since the last time
LaTeX was run.
-\layout Standard
+\end_layout
+\begin_layout Standard
When you run LaTeX on the file you're editing, LyX performs these steps:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Convert the document to LaTeX and save to a file with the extension
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
in place of
-\family typewriter
+\family typewriter
.lyx
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Run LaTeX on the
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file (maybe several times).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
If there are any errors, insert error boxes in the document to mark where
they are.
These boxes are transient and are not saved along with the document.
-\layout Standard
+\end_layout
+\begin_layout Standard
If you've run LaTeX using
-\family sans
-View\SpecialChar ~
+\family sans
+View\InsetSpace ~
DVI
-\family default
+\family default
, LyX then executes
-\family typewriter
+\family typewriter
xdvi
-\family default
- on the Dvi file.
+\family default
+ on the DVI-file.
If you've used
-\family sans
-View\SpecialChar ~
+\family sans
+View\InsetSpace ~
PostScript
-\family default
+\family default
or
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
rint
-\family default
+\family default
, LyX performs two more steps:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Run
-\family typewriter
+\family typewriter
dvips
-\family default
- to convert the Dvi file to PostScript®:
-\begin_deeper
-\layout Itemize
+\family default
+ to convert the DVI file to PostScript:
+\end_layout
+\begin_deeper
+\begin_layout Itemize
For
-\family sans
-View\SpecialChar ~
+\family sans
+View\InsetSpace ~
PostScript
-\family default
+\family default
, the output file has the extension
-\family typewriter
+\family typewriter
.ps_tmp
-\layout Itemize
+\end_layout
+\begin_layout Itemize
For
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
rint
-\family default
-\SpecialChar ~
+\family default
+\InsetSpace ~
, the output file has the extension
-\family typewriter
+\family typewriter
.ps
-\family default
+\family default
, as expected.
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
Execute
-\family typewriter
+\family typewriter
ghostview
-\family default
- or send the PostScript® file to the printer.
-\layout Section
-
+\family default
+ or send the PostScript file to the printer.
+\end_layout
+\begin_layout Section
\begin_inset Quotes eld
-\end_inset
+\end_inset
Help! LyX generated an unreadable
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file!
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Die-hard LaTeX users will scream and howl this into the night, then declare
LyX useless, simply because they didn't RTFM.
-\layout Standard
+\end_layout
+\begin_layout Standard
We're going to set the record straight.
LyX produces two kinds of LaTeX files.
One is human readable.
Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
scan for errors.
The resulting
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file is not human readable.
Don't even try to read it.
If you want a
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file that you can send to a colleague, select
-\family sans
-\bar under
+\family sans
+\bar under
E
-\bar default
+\bar default
xport\SpecialChar \menuseparator
-\bar under
+\bar under
L
-\bar default
+\bar default
aTeX
-\family default
+\family default
from the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile
-\family default
+\family default
menu.
-\layout Section
+\end_layout
+\begin_layout Section
Translating LaTeX files into LyX
-\layout Standard
+\end_layout
+\begin_layout Standard
You can import a LaTeX file into LyX by using the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
I
-\bar default
+\bar default
mport\SpecialChar \menuseparator
-\bar under
+\bar under
L
-\bar default
+\bar default
aTeX
-\family default
+\family default
command in LyX.
- This will call a Perl script named
-\family typewriter
-reLyX
-\family default
+ This will call a program named
+\family typewriter
+tex2lyx
+\family default
---which will create a file
-\family typewriter
+\family typewriter
foo.lyx
-\family default
+\family default
from the file
-\family typewriter
+\family typewriter
foo.tex
-\family default
+\family default
---and then open that file.
- If the translation doesn't work, you can try calling
-\family typewriter
-reLyX
-\family default
- from the command line, possibly using fancier options.
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family typewriter
-reLyX
-\family default
+\family typewriter
+tex2lyx
+\family default
will translate most legal LaTeX, but not everything.
It will leave things it doesn't understand in TeX mode, so after translating
a file with
-\family typewriter
-reLyX
-\family default
+\family typewriter
+tex2lyx
+\family default
, you can look for red text and hand-edit it to look right.
-\layout Standard
+\end_layout
+\begin_layout Standard
+If you just want to put a piece of LaTeX code into a LyX file, see Section
+\begin_inset LatexCommand ref
+reference "sec:latexcodes"
-\family typewriter
-reLyX
-\family default
- has its own section in the
-\emph on
-Extended Features
-\emph default
- manual (as well as a Unix manpage equivalent), which you should read to
- find out about what LaTeX isn't supported, bugs (and how to get around
- them), and how to use the various options.
-\layout Standard
-
-If you can't get
-\family typewriter
-reLyX
-\family default
- to work, or you just want to put a piece of LaTeX code into a LyX file,
- see Section
-\begin_inset LatexCommand \ref{sec:latexcodes}
-
-\end_inset
+\end_inset
.
-\layout Section
+\end_layout
+\begin_layout Section
Inserting LaTeX Code into LyX Documents
-\begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
-
-\end_inset
+\begin_inset LatexCommand label
+name "sec:Inserting-LaTeX-Code"
+\end_inset
-\layout Standard
+\end_layout
-\begin_inset LatexCommand \label{sec:latexcodes}
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:latexcodes"
-\end_inset
+\end_inset
This is a rather important point: You can always insert LaTeX code into
any LyX document.
LaTeX construct.
If ever you need to insert LaTeX commands into your LyX document, you can
use the ERT box, which you can insert into your document with
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-\bar under
+\bar under
T
-\bar default
+\bar default
eX
-\family default
+\family default
.
The ERT box comes in three forms: collapsed, open, and inlined.
- The first two are used just like any other collapsable (foldable) box (such
+ The first two are used just like any other collapsible (foldable) box (such
as footnotes), and are useful for significant amounts of LaTeX commands.
An
\begin_inset Quotes eld
-\end_inset
+\end_inset
inlined
\begin_inset Quotes erd
-\end_inset
+\end_inset
ERT box displays its content as part of the button, and is useful for very
short sections of LaTeX commands.
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
% like this
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
You can switch between all three by right-clicking on the ERT.
Note that if you want more than one line of LaTeX commands, you cannot
use the inlined mode.
-\layout Standard
+\end_layout
+\begin_layout Standard
Here's an example of inserting LaTeX commands in a LyX document.
The code looks like this:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
begin{tabular}{ll}
-\newline
+\newline
-\backslash
+\backslash
begin{minipage}{5cm}
-\newline
+\newline
This is an example for a minipage environment.
You
-\newline
+\newline
can put nearly everything in it, even (non-floating)
-\newline
+\newline
figures and tables.
-\newline
+\newline
-\backslash
+\backslash
end{minipage}
-\newline
+\newline
&
-\newline
+\newline
-\backslash
+\backslash
begin{minipage}{5cm}
-\newline
+\newline
-\backslash
+\backslash
begin{verbatim}
-\newline
+\newline
-\backslash
+\backslash
begin{minipage}{5cm}
-\newline
+\newline
This ...
-\newline
+\newline
-\backslash
+\backslash
end{minipage}
-\newline
+\newline
-\backslash
+\backslash
end{verbatim}
-\newline
+\newline
-\backslash
+\backslash
end{minipage}
-\newline
+\newline
-\backslash
+\backslash
end{tabular}
-\layout LyX-Code
+\end_layout
-\layout Standard
+\begin_layout LyX-Code
+\end_layout
+
+\begin_layout Standard
The ERT box containing this text is directly after this paragraph.
Those of you reading the manual online will only see a bunch of funky text
in red.
Those reading a printed version of the manuals will see the actual results:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{tabular}{ll}
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
begin{minipage}{5cm}
-\newline
-This is an example for a minipage environment. You can put nearly everything in it, even (non-floating) figures and tables.
-\newline
+\end_layout
+
+\begin_layout Standard
+
+This is an example for a minipage environment.
+ You can put nearly everything in it, even (non-floating) figures and tables.
+
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
end{minipage}
-\newline
+\end_layout
+
+\begin_layout Standard
+
&
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
begin{minipage}{5cm}
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
begin{verbatim}
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
begin{minipage}{5cm}
-\newline
-This ...
-\newline
+\end_layout
+
+\begin_layout Standard
+
+This ...
+
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
end{minipage}
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
end{verbatim}
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
end{minipage}
-\newline
+\end_layout
+
+\begin_layout Standard
-\backslash
+
+\backslash
end{tabular}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
In addition to these two methods, you can also create a separate file containing
some complex LaTeX structure.
You can then use
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
Chil
-\bar under
+\bar under
d
-\bar default
-\SpecialChar ~
+\bar default
+\InsetSpace ~
Document
-\family default
+\family default
to include your file (you should select the type
-\family sans
+\family sans
Input
-\family default
+\family default
).
We recommend that you only do this if you have a
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file which you
-\emph on
+\emph on
know
-\emph default
+\emph default
works already.
Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
-\layout Standard
+\end_layout
+\begin_layout Standard
There are a few last notes to emphasize:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Inside of LyX, LaTeX code appears
-\emph on
+\emph on
in red
-\layout Itemize
+\end_layout
+\begin_layout Itemize
LyX
-\emph on
+\emph on
does not
-\emph default
+\emph default
check if your LaTeX code is correct.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Beware reinventing the wheel.
-\layout Standard
+\end_layout
+\begin_layout Standard
That last note refers to two things.
First, LyX does have quite a few features tucked into it, and more are
coming.
things, from labels to envelopes to fancy multipage tables.
Check out a CTAN site for details (see Section
\begin_inset Quotes eld
-\end_inset
+\end_inset
Requirements
\begin_inset Quotes erd
-\end_inset
+\end_inset
of the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
).
\begin_inset Foot
-collapsed false
-
-\layout Standard
+status open
+\begin_layout Standard
Note from
-\noun on
+\noun on
John Weiss
-\noun default
+\noun default
: I seem to do this an awful lot.
Sat down and merrily began coding something to print out labels, only to
learn that there were already 2 different LaTeX packages to do this.
Worse yet --- I had them already!
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
If you do need to do some wild and fancy things within your document, be
sure to check out a good LaTeX book for assistance.
There are a number of them listed in the bibliography of the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
There are a number of LaTeX commands which have to be placed before the
beginning of the actual text.
They go into the preamble, and this is explained in the next section.
-\layout Section
+\end_layout
+\begin_layout Section
LyX and the LaTeX Preamble
-\layout Subsection
+\end_layout
+\begin_layout Subsection
About the LaTeX Preamble
-\layout Standard
+\end_layout
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:preamble"
-\begin_inset LatexCommand \label{sec:preamble}
-
-\end_inset
+\end_inset
If you already know LaTeX, there is no need to explain here what the preamble
is good for.
In any case, you should read the points below, because they explain what
you can do and what you don't need to do in the LaTeX preamble of a LyX
document.
-\layout Standard
+\end_layout
+\begin_layout Standard
The LaTeX preamble comes at the very beginning of a document,
-\emph on
-before
-\emph default
-the text.
+\emph on
+before
+\emph default
+ the text.
It serves to:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
declare the document class.
LyX already does this for you.
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
If you're a seasoned LaTeX-nician, and you have some custom document class
you want to use, check out the
-\emph on
+\emph on
Customization Manual
-\emph default
+\emph default
for information on how to make LyX interface to it.
Be sure to submit your efforts to the LyX Team for inclusion in future
versions!
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
declare the usage of packages.
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
- For example, the
-\family typewriter
-
-\family default
-package
-\family typewriter
+ For example, the package
+\family typewriter
indentfirst
-\family default
+\family default
forces all paragraphs to be indented.
There are other packages for labels, envelopes, margins, etc.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
set counters, variables, lengths and widths.
There are several LaTeX counters and variables which
-\emph on
+\emph on
must
-\emph default
+\emph default
be set globally from within the preamble in order to have the desired effect.
[There are other variables which you can set and reset inside the document,
too.] Margins are a good example of something which must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
declare user defined commands [with
-\family typewriter
+\family typewriter
-\backslash
-newcommand
-\family default
-or
-\family typewriter
+\backslash
+newcommand
+\family default
+ or
+\family typewriter
-\backslash
+\backslash
renewcommand
-\family default
+\family default
], mostly abbreviations for LaTeX commands which appear very often inside
a document.
Although the preamble is a good place to declare such commands, they
-\emph on
+\emph on
can
-\emph default
+\emph default
be declared anywhere else [but
-\emph on
+\emph on
before
-\emph default
+\emph default
they are used for the first time, of course\SpecialChar \ldots{}
].
This can be useful if there is a lot of raw LaTeX code in your document,
which normally should not be the case.
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX adds its own set of definitions to the preamble of the
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file it produces.
This makes LaTeX files generated by LyX portable.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Changing the Preamble
-\layout Standard
+\end_layout
+\begin_layout Standard
The commands which LyX adds to the preamble of a LaTeX file are fixed; you
can't change them without patching LyX itself.
You can, however, add your own stuff to the preamble.
There are two ways to do this:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Select
-\family sans
-\bar under
+\family sans
+\bar under
L
-\bar default
-aTeX\SpecialChar ~
+\bar default
+aTeX\InsetSpace ~
-\bar under
+\bar under
P
-\bar default
+\bar default
reamble
-\family default
+\family default
from the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument
-\family default
+\family default
menu, or via the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog, depending on your frontend.
Note that the LyX keybindings will not work in this dialog, alas.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Use the preamble contents you've added as your default template (see
\begin_inset Quotes eld
-\end_inset
+\end_inset
Basic LyX Setup
\begin_inset Quotes erd
-\end_inset
+\end_inset
in the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
), so that it will be the default preamble for any file you create.
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX adds anything in the
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
reamble
-\family default
+\family default
dialog to its own built-in preamble.
Before adding your own declarations in the preamble, you should make sure
that LyX doesn't already support what you want to do (remember what we
said about reinventing the wheel?).
Also,
-\emph on
+\emph on
make sure your preamble code is correct
-\emph default
+\emph default
.
LyX doesn't check it.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Examples
-\layout Standard
+\end_layout
+\begin_layout Standard
Here are some examples of what you can add to a preamble, and what they
do:
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Example #1: Offsets
-\layout Standard
+\end_layout
+\begin_layout Standard
There are two variables under LaTeX that control page position:
-\family typewriter
+\family typewriter
-\backslash
+\backslash
hoffset
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
voffset
-\family default
+\family default
.
Their names should be self-explanatory.
These variables are useful if you think for a moment about computer labels.
Sometimes, the size of a print medium and the area of the medium that you
can actually print on aren't the same.
This is where
-\family typewriter
+\family typewriter
-\backslash
+\backslash
hoffset
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
voffset
-\family default
+\family default
come in.
-\layout Standard
+\end_layout
+\begin_layout Standard
The default values for
-\family typewriter
+\family typewriter
-\backslash
+\backslash
hoffset
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
voffset
-\family default
- are both 0 pt.,\SpecialChar ~
-i.\SpecialChar ~
-e.\SpecialChar ~
+\family default
+ are both 0 pt.,\InsetSpace ~
+i.\InsetSpace ~
+e.\InsetSpace ~
the page isn't shifted.
-\layout Standard
+\end_layout
+\begin_layout Standard
Unfortunately, some DVI drivers always seem to shift the page.
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
your sysadmin is a doofus,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
hoffset
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
voffset
-\family default
+\family default
can save the day.
Suppose you're left and top margins are always 0.5 inches too big.
You can add this to the preamble:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
setlength{
-\backslash
+\backslash
hoffset}{-0.5 in}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
setlength{
-\backslash
+\backslash
voffset}{-0.5 in}
-\layout Standard
+\end_layout
+\begin_layout Standard
\SpecialChar \ldots{}
and your margins should now be correct.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Example #2: Labels
-\layout Standard
+\end_layout
+\begin_layout Standard
Speaking of labels, suppose you wanted to print out a bunch of address labels.
There's a rather nice package, available at your nearest CTAN archive,
for printing sheets of labels, called
-\family typewriter
+\family typewriter
labels.sty
-\family default
+\family default
.
Now, your system may not have this package installed by default.
We leave that up to you to check.
that for you.
Since this is an example, however, we'll give you an example of how you
use this package.
-\layout Standard
+\end_layout
+\begin_layout Standard
First, make sure you're using the
-\family sans
-article
-\family default
-document class.
+\family sans
+article
+\family default
+ document class.
Next, you need to put the following in your preamble:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
usepackage{labels}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
LabelCols=3
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
LabelRows=7
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
LeftBorder=8mm
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
RightBorder=8mm
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
TopBorder=9mm
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
BottomBorder=2mm
-\layout Standard
+\end_layout
-This sets things up for Avery® label sheets, stock #5360.
+\begin_layout Standard
+This sets things up for Avery® label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
-\family typewriter
+\family typewriter
-\backslash
+\backslash
begin{labels}
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
end{labels}
-\family default
+\family default
around each label text.
This and other special features of
-\family typewriter
+\family typewriter
labels.sty
-\family default
+\family default
are explained in its documentation.
-\layout Standard
+\end_layout
+\begin_layout Standard
Someday, someone may write a LyX layout file to support this package directly.
Maybe that someone is you.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Example #3: Paragraph Indentation
-\layout Standard
+\end_layout
+\begin_layout Standard
Americans are trained to indent the first line of
-\emph on
+\emph on
every
-\emph default
+\emph default
paragraph.
As with all of their other weird quirks, most Americans will whine and
moan until they can have their way and indent the first line of all paragraphs.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Note from
-\noun on
+\noun on
John Weiss
-\noun default
+\noun default
: This was written by an American ---
-\emph on
+\emph on
me
-\emph default
+\emph default
! It's my perception of my fellow countrymen.
Tough if you don't like it.
Thpbpbpbpbpbpbpbp!
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Of course, this behavior isn't standard typography.
In books, you typically only indent the first line of a paragraph
-\emph on
+\emph on
if
-\emph default
+\emph default
it follows another one.
The idea behind indenting the first line of a paragraph is to distinguish
neighboring paragraphs from one another.
If there is no previous paragraph, for example, it follows a figure, or
is the first paragraph in a section, then there is no special indentation.
-\layout Standard
+\end_layout
+\begin_layout Standard
If you're a typical American, though, you don't care about such esoteric
things; you want your indentation! Add this to the preamble:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
usepackage{indentfirst}
-\layout Standard
+\end_layout
+\begin_layout Standard
If your TeX distribution isn't a braindead one, you'll have this package,
and all of your paragraphs will get the indentation you think they deserve.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Example #4: This Document
-\layout Standard
+\end_layout
+\begin_layout Standard
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
You'll probably need to make the
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
reamble\SpecialChar \ldots{}
-\family default
+\family default
dialog full-screen to see most of it.
Also, there are more examples and an assortment of LaTeX
\begin_inset Quotes eld
-\end_inset
+\end_inset
dirty tricks
\begin_inset Quotes erd
-\end_inset
+\end_inset
- given in Chapter\SpecialChar ~
+ given in Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{cha:secrets}
+\begin_inset LatexCommand ref
+reference "cha:secrets"
-\end_inset
+\end_inset
.
-\layout Section
+\end_layout
+\begin_layout Section
LyX and LaTeX Errors
-\layout Standard
+\end_layout
+\begin_layout Standard
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
It then uses the log-file from the LaTeX run to do a post-mortem.
As we stated earlier in the chapter, LyX generates two kinds of
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
files, one of which it uses to locate errors in the document.
If there was an error someplace, LyX will put a box with the word
\begin_inset Quotes eld
-\end_inset
+\end_inset
Error
\begin_inset Quotes erd
-\end_inset
+\end_inset
at the appropriate place in the document.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
LyX will occasionally misguess where the error was.
This will typically happen with tables, figures, math, and the preamble.
-\end_inset
+\end_layout
+
+\end_inset
It will also display a message alerting you to the fact that there were
errors.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can navigate through the errors by using
-\family sans
-\bar under
+\family sans
+\bar under
E
-\bar default
+\bar default
rror
-\family default
+\family default
in the
-\family sans
-\bar under
+\family sans
+\bar under
N
-\bar default
+\bar default
avigate
-\family default
+\family default
menu.
You can
\begin_inset Quotes eld
-\end_inset
+\end_inset
open
\begin_inset Quotes erd
-\end_inset
+\end_inset
the error-boxes and view the error message LaTeX produced by clicking on
it.
-\layout Standard
+\end_layout
-Some folks also like to look at the log file directly, accessible from
-\family sans
-
-\bar under
+\begin_layout Standard
+Some folks also like to look at the log file directly, accessible from
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
L
-\bar default
-aTeX\SpecialChar ~
-Log\SpecialChar ~
+\bar default
+aTeX\InsetSpace ~
+Log\InsetSpace ~
File
-\family default
+\family default
.
There are some fairly common error messages and warnings.
We'll cover those here.
You should look at a good LaTeX book for a complete listing.
-\layout Itemize
-
+\end_layout
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
LaTeX Warning:
-\family default
+\family default
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Anything beginning with these word is a warning message for the purpose
of
\begin_inset Quotes eld
-\end_inset
+\end_inset
debugging
\begin_inset Quotes erd
-\end_inset
+\end_inset
the LaTeX code itself.
You'll get messages like this if you added or changed cross-references
or bibliography entries, in which case, LaTeX is trying to tell you that
you need to make another run.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can by-and-large ignore these.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
LaTeX Font Warning:
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Another warning message, this time about fonts which LaTeX couldn't find.
The rest of the message will often say something about a replacement font
that LaTeX used.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can safely ignore these.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
Overfull
-\backslash
+\backslash
hbox
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
LaTeX absolutely
-\emph on
+\emph on
loves
-\emph default
+\emph default
to spew these out.
They are warning you about lines that were too long and run past the right
margin.
Or, only one or two characters extend past the margin.
LaTeX seems to generate at least one of these messages for just about any
document you write.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can ignore these stupid messages.
Your eyes will tell you if there's a problem with something that's too
wide; just look at the output.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
Underfull
-\backslash
+\backslash
hbox
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Not quite as common as its cousin.
LaTeX seems to like to print lines that are a bit too wide as opposed to
ones that are a bit too narrow.
We have no idea why.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can ignore these, too.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
Overfull
-\backslash
+\backslash
vbox
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
and
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
Underfull
-\backslash
+\backslash
vbox
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Warnings about troubles breaking the page.
Once again, just look at the output.
Your eyes will tell you where something has gone wrong.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
LaTeX Error: File
\begin_inset Quotes els
-\end_inset
+\end_inset
Xxxx
\begin_inset Quotes ers
-\end_inset
+\end_inset
not found
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
The file
\begin_inset Quotes eld
-\end_inset
+\end_inset
Xxxx
\begin_inset Quotes erd
-\end_inset
+\end_inset
isn't installed on this system.
This usually appears because some package your document needs isn't installed.
If you didn't touch the preamble or didn't use the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
usepackage{}
-\family default
+\family default
command, then one of the packages LyX tried to load is missing.
Use
-\family sans
-\bar under
+\family sans
+\bar under
H
-\bar default
+\bar default
elp\SpecialChar \menuseparator
L
-\bar under
+\bar under
a
-\bar default
+\bar default
TeX Configuration
-\family default
+\family default
, to get a list of packages that LyX knows about.
This file is updated whenever you reconfigure LyX (using
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools
-\bar under
+\bar under
\SpecialChar \menuseparator
R
-\bar default
+\bar default
econfigure
-\family default
+\family default
) and tells you which packages have been detected and what they do.
-\layout Standard
+\end_layout
+\begin_layout Standard
If you
-\emph on
+\emph on
did
-\emph default
+\emph default
use the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
usepackage{}
-\family default
+\family default
command, and the package in question isn't installed, you'll need to install
it yourself.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
LaTeX Error: Unknown option
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Error messages beginning with this are trying to tell you that you specified
a bad or undefined option to a package.
Check the package's documentation.
-\end_deeper
-\layout Itemize
-
+\end_layout
+\end_deeper
+\begin_layout Itemize
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
Undefined control sequence
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
If you've inserted LaTeX code into your document, but made a typo, you'll
get one of these.
You may have forgotten to load a package.
In any case, this error message usually means that you used an undefined
command.
-\end_deeper
-\layout Standard
+\end_layout
+\end_deeper
+\begin_layout Standard
There are other error and warning messages.
Some are self-explanatory.
These are usually LaTeX messages.
Others are downright cryptic.
These are actually TeX error messages, and we really have
-\emph on
+\emph on
no clue
-\emph default
+\emph default
what they mean or how to decipher them.
-\layout Standard
+\end_layout
+\begin_layout Standard
There's a general sequence you should follow if you get error messages:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Look at the LaTeX code you inserted for typos.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
If there are no typos, check and see that you used the command(s) correctly.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
If you get a bunch of error boxes piled up at the very top of the document,
it means that there are errors in the preamble.
Start debugging your preamble.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
If you didn't add anything to the preamble and didn't add any LaTeX code
to the document, the first suspect is your LaTeX distribution itself.
Check for missing packages and install them.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Okay, so there are no missing packages.
Did you use any of the fine-tuning options in LyX? Specifically, did you
-\emph on
+\emph on
misuse
-\emph default
+\emph default
any of them, like trying to manually insert lots of
-\family sans
-Protected\SpecialChar ~
+\family sans
+Protected\InsetSpace ~
Blank
-\family default
+\family default
s,
-\family sans
+\family sans
Linebreak
-\family default
+\family default
s, or
-\family sans
+\family sans
Pagebreak
-\family default
+\family default
s? Did you try to kludge something together with these instead of using
the appropriate paragraph environment?
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
All right, you didn't use any of the fine-tuning options, you played by
the rules.
Did you try to pull a fancy maneuver? Did you do something funky inside
a table or an equation, like inserting a graphic into a table cell?
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Do you have long sections of text where LaTeX cannot find a place to break
a line? By default, LaTeX is rather strict about how much extra inter-word
spacing it will add in order to break a line.
- Preferrably, you should rework the paragraph to avoid the problem.
+ Preferably, you should rework the paragraph to avoid the problem.
If this isn't an option, you can wrap your text in
-\family typewriter
+\family typewriter
-\backslash
+\backslash
sloppypar
-\family default
+\family default
to make LaTeX's line breaking more, well, sloppy.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Did you go overboard with the nesting? LyX (currently) doesn't check to
make sure you're in the limits for nesting environments.
If you nested a bunch of environments to the
\begin_inset Formula $17^{\mathrm{th}}$
-\end_inset
+\end_inset
level, that's the problem.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Okay, you didn't get any error messages, but your output looks whacked.
If you have a table or figure that's too wide or long for the page, you
need to:
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
rescale the figure so it fits.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
trim down the table so it fits.
-\layout Standard
+\end_layout
+\begin_layout Standard
If something else is wrong with the output, and you didn't try to pull anything
fancy or kludge the fine-tuning options, we're not sure what's wrong.
-\end_deeper
-\layout Standard
+\end_layout
+\end_deeper
+\begin_layout Standard
If all this doesn't help --- well, then
-\emph on
+\emph on
perhaps
-\emph default
+\emph default
you might have found a bug in LyX\SpecialChar \ldots{}
-\layout Chapter
+\end_layout
+\begin_layout Chapter
Supplemental Tools
-\layout Section
+\end_layout
+\begin_layout Section
Preparing a Bibliography with BibTeX
-\layout Standard
-\added_space_bottom bigskip
+\begin_inset LatexCommand label
+name "sec:Preparing-a-Bibliography"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
by
-\noun on
+\noun on
Mike Ressler
-\layout Standard
-\noindent
+\noun default
+ and
+\noun on
+Jürgen Spitzmüller
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
STOP! If you don't know what BibTeX is, or have a reasonably good idea of
how to use it (
-\emph on
-e.g.
-
-\emph default
- setting up your own bibliographic databases),
-\emph on
+\emph on
+e.\InsetSpace \thinspace{}
+g.
+\emph default
+\InsetSpace ~
+setting up your own bibliographic databases),
+\emph on
run
-\emph default
+\emph default
, do not walk, to your nearest copy of the 2nd edition of Lamport's
-\emph on
+\emph on
LaTeX: A Document Preparation System
-\emph default
+\emph default
, particularly Appendix B.
The rest of this discussion assumes you have created a correct bibliography
file, that you have all relevant environment variables set correctly (esp.
-\family typewriter
+\family typewriter
BIBINPUTS
-\family default
+\family default
,
-\family typewriter
+\family typewriter
BSTINPUTS
-\family default
+\family default
, and
-\family typewriter
+\family typewriter
TEXINPUTS
-\family default
+\family default
), and that if sufficiently desperate, you could create and
\begin_inset Quotes eld
-\end_inset
+\end_inset
TeX
\begin_inset Quotes erd
-\end_inset
+\end_inset
a LaTeX file with a BibTeX database.
-\layout Standard
+\end_layout
+\begin_layout Standard
For those who don't know what BibTeX is, it is a system for creating a large
database of your most used journal references.
For all future articles you write, you only need to include this standard
Even if you write only a few papers with handful of references each, it
is well worth your time to examine BibTeX and decide whether it will be
useful to you.
-\layout Standard
+\end_layout
+\begin_layout Standard
To use BibTeX with LyX, first read the
-\emph on
+\emph on
User Guide
-\emph default
+\emph default
where it describes how to insert citations.
The basic mechanism for inserting BibTeX references is the same.
Then, at the very end of your document, select
-\family sans
+\family sans
Insert\SpecialChar \menuseparator
List
-\family default
+\family default
/
-\family sans
+\family sans
TOC\SpecialChar \menuseparator
BibTeX Reference
-\family default
+\family default
.
In the resulting dialog, fill out the dialog boxes as follows:
-\layout Description
+\end_layout
+\begin_layout Description
Database: enter the name of your
-\family typewriter
+\family typewriter
.bib
-\family default
+\family default
file
-\emph on
+\emph on
without
-\emph default
+\emph default
the
-\family typewriter
+\family typewriter
.bib
-\family default
+\family default
extension.
For searching multiple
-\family typewriter
+\family typewriter
.bib
-\family default
+\family default
files, just enter them in the desired order, separated by commas.
-\layout Description
+\end_layout
+\begin_layout Description
Style: enter the name of your BibTeX style file *without* the
-\family typewriter
+\family typewriter
.bst
-\family default
+\family default
extension.
The default style is
-\family typewriter
+\family typewriter
plain
-\family default
+\family default
(which should be included in your LaTeX distribution, so you don't have
to worry about creating it).
-\layout Standard
+\end_layout
+\begin_layout Standard
For each citation, assuming that the source is in the
-\family typewriter
+\family typewriter
.bib
-\family default
+\family default
file, just call
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-\bar under
+\bar under
C
-\bar default
+\bar default
itation Reference
-\family default
+\family default
at the correct location in the text, and enter the appropriate reference
key.
Nothing else is required; when invoking
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew\SpecialChar \menuseparator
-\bar under
+\bar under
D
-\bar default
+\bar default
VI
-\family default
-, for example, you should see that BibTex and LaTeX are invoked as needed,
+\family default
+, for example, you should see that BibTeX and LaTeX are invoked as needed,
including multiple invocations of LaTeX.
-\layout Section
+\end_layout
-Making an Index
-\layout Standard
+\begin_layout Subsection
+Alternative Citation Styles
+\end_layout
-A good index is one of the hardest things to make in a lengthy document,
- but LyX helps make things a bit simpler by interfacing to the
-\family typewriter
-makeindex
-\family default
- program which is found in most recent LaTeX distributions.
- Inserting an index and marking words to include in it works much the same
- way as preparing a bibliography as mentioned in the last section.
-\layout Standard
+\begin_layout Standard
+Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
-First, go to the end of your file and select
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-List
-\family default
-\SpecialChar ~
-/\SpecialChar ~
+\begin_inset Quotes eld
+\end_inset
-\family sans
-T
-\bar under
-O
-\bar default
-C\SpecialChar \menuseparator
+[12]
+\begin_inset Quotes erd
+\end_inset
-\bar under
-I
-\bar default
-ndex
-\family default
-\SpecialChar ~
+) to refer to a cited work.
+ However, in many scientific disciplines, other citation styles are in use.
+ The most common one is the author-year style (e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
-\family sans
-List
-\family default
+\begin_inset Quotes eld
+\end_inset
+
+Knuth 1984a
+\begin_inset Quotes erd
+\end_inset
+
+).
+ LyX supports two packages that provide this style,
+\family typewriter
+natbib
+\family default
+ and
+\family typewriter
+jurabib
+\family default
.
- Then, for each word you would like to include in the index, go to the end
- of that word and click on
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+ Both packages have their own pros and cons, which cannot be listed in detail.
+ If you only want to have simple author-year (or author-numerical) style
+ or if you want to use one of the countless style files for natbib, than
+ the established
+\family typewriter
+natbib
+\family default
+ package is probably your choice.
+ If you need special features like short title references, ibidem etc., you
+ might consider the fairly new
+\family typewriter
+jurabib
+\family default
+ package.
+\end_layout
-\bar under
-I
-\bar default
-ndex
-\family default
-\SpecialChar ~
+\begin_layout Standard
+The handling of both packages in LyX is basically the same.
+ Go to
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-\family sans
-Entry
-\family default
+\bar under
+S
+\bar default
+ettings
+\family default
+ and select the
+\family sans
+Bibliography
+\family default
+ pane (with the xforms frontend: the
+\family sans
+Extras
+\family default
+ tab).
+ Then select
+\family sans
+Natbib
+\family default
+ or
+\family sans
+Jurabib
+\family default
.
- This will insert a tag showing the word as it will appear in the index.
- That's all there is to it; LyX will automatically call
-\family typewriter
-makeindex
-\family default
- for you and create the index itself.
- The text in the dialog available from right-clicking on the index button
- accepts LaTeX, so you'll need to be careful to avoid using any special
- characters.
- On the positive side, you can use the advanced options - have a look at
- the documentation which comes with your LaTeX distribution to find out
- how to do things like
+ With both packages, you will get some extra features in the citation dialog
+ and you can select the style of the reference (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-nested entries
+Knuth 1984
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, etc.
-\layout Standard
+,
+\begin_inset Quotes eld
+\end_inset
-Be careful not to put spaces between the word in the text and the index
- marker; apparently the wrong page number can be produced if this happens.
-\layout Section
+Knuth (1984)
+\begin_inset Quotes erd
+\end_inset
-Multipart Documents
-\layout Subsection
+,
+\begin_inset Quotes eld
+\end_inset
-General Operation
-\layout Standard
+Knuth, 1984
+\begin_inset Quotes erd
+\end_inset
-When you are working on a large file with many sections, it is often convenient
- to break up the document into several files, or perhaps you have something
- where a table may change from time to time, but the preceding text does
- not.
- In these cases, you should seriously consider using multipart documents.
- For example, scientific papers often have five major sections: the introduction
-, observations, results, discussion, and conclusion.
- Each of these could be its own separate LyX file, with one
+,
\begin_inset Quotes eld
-\end_inset
+\end_inset
-master
+1984
\begin_inset Quotes erd
-\end_inset
+\end_inset
- file which contains the title, authors, abstract, references, etc., plus
- the five included files.
- It is important to note that each of these files is a full LyX file which
- can be formatted and printed on its own, as well as included in a master
- file.
- Each of these files must have the same document class, however--- don't
- attempt to mix book classes with article classes.
- You may also include LaTeX files; however, these files must not have their
- own preamble
-\emph on
-(i.e.
+ etc.).
+ Note that both packages need specifically designed style files (they both
+ ship their own, while there are lots of additional style files and even
+ an interactive style file builder
+\begin_inset Foot
+status collapsed
-\emph default
- everything up to and including the
-\family typewriter
+\begin_layout Standard
+See
+\begin_inset LatexCommand url
+target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
-\backslash
-begin{document}
-\family default
- line as well as the
-\family typewriter
+\end_inset
-\backslash
-end{document}
-\family default
- line must be deleted) or else errors will be generated when you try to
- make a DVI file.
-\layout Standard
-LyX allows you to include files quite easily with
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-ChiI
-\bar under
-d
-\bar default
-\SpecialChar ~
-Document
-\family default
-.
- When you click on this selection a small box is inserted into the file
- at the current cursor location.
- Clicking on the box raises a dialog which allows you to select the file
- to be included, and the method of its inclusion.
-
-\layout Standard
+\end_layout
-The file selection box should by now be obvious.
- The three inclusion methods are
+\end_inset
+
+ for
+\family typewriter
+natbib
+\family default
+ available).
+\end_layout
+
+\begin_layout Subsection
+Sectionated Bibliographies
+\begin_inset LatexCommand label
+name "sub:Sectionated-Bibliographies"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+Sometimes you might need to divide your bibliography into several sections.
+ If you are, for instance, a historian, the possibility to separate sources
+ and scientific works is most likely a
\begin_inset Quotes eld
-\end_inset
+\end_inset
-include
+must have
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,
+.
+ Unfortunately, BibTeX itself does not allow you to do this.
+ The good news is, though: With the help of some LaTeX packages, BibTeX
+ can be extended to fit your historical needs.
+\end_layout
+
+\begin_layout Standard
+As of version 1.4, LyX provides native support for one of these packages,
+ Stefan Ulrich's
+\family typewriter
+bibtopic
+\family default
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+Available from
+\begin_inset LatexCommand url
+target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ The advantage of this package (compared to other packages like
+\family typewriter
+multibib
+\family default
+) is that you don't need to define new citation commands.
+ Instead, you need to prepare different bibliographic databases which include
+ the entries for the different sections of the bibliography.
+ For example: If you want to divide your bibliography into the sections
+
\begin_inset Quotes eld
-\end_inset
+\end_inset
-input
+Sources
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, and
+ and
\begin_inset Quotes eld
-\end_inset
+\end_inset
-verbatim
+Scientific works
\begin_inset Quotes erd
-\end_inset
+\end_inset
+
+, you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
+\family typewriter
+sources.bib
+\family default
+ and
+\family typewriter
+scientific.bib
+\family default
.
- The difference between
+
+\end_layout
+
+\begin_layout Standard
+In LyX, go to
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
+
+\bar under
+S
+\bar default
+ettings
+\family default
+ and select the
+\family sans
+Bibliography
+\family default
+ pane (with the xforms frontend: the
+\family sans
+Extras
+\family default
+ tab).
+ Check
+\family sans
+Sectionated\InsetSpace ~
+bibliography
+\family default
+.
+ Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sec:Preparing-a-Bibliography"
+
+\end_inset
+
+), one for each section of your bibliography.
+ Returning to our example: Insert a BibTeX reference for the database
+\family typewriter
+sources.bib
+\family default
+ and a second one for the database
+\family typewriter
+scientific.bib
+\family default
+.
+ You are free to use the same or different styles for each section.
+ Additionally, you can chose if the bibliography section should contain
+
\begin_inset Quotes eld
-\end_inset
+\end_inset
-include
+all cited references
\begin_inset Quotes erd
-\end_inset
+\end_inset
- and
+ of the specified database(s) (which is the default),
\begin_inset Quotes eld
-\end_inset
+\end_inset
-input
+all uncited references
\begin_inset Quotes erd
-\end_inset
+\end_inset
- is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
+ or even
\begin_inset Quotes eld
-\end_inset
+\end_inset
-included
+all references
\begin_inset Quotes erd
-\end_inset
+\end_inset
- are typeset beginning on a new page, while files which are
+.
+ This might be useful if you would like to separate your bibliography into
+ three sections:
\begin_inset Quotes eld
-\end_inset
+\end_inset
-inputted
+Cited sources
\begin_inset Quotes erd
-\end_inset
-
- are typeset starting on the current page.
- Perhaps the labeling in LyX will be changed someday to reflect this.
-\layout Standard
+\end_inset
-Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
- all the preamble information.
- Checking the
-\family sans
-Don't
-\family default
-\SpecialChar ~
+,
+\begin_inset Quotes eld
+\end_inset
-\family sans
-typeset
-\family default
- button prevents this conversion.
-\layout Standard
+Uncited sources
+\begin_inset Quotes erd
+\end_inset
-A
+, and
\begin_inset Quotes eld
-\end_inset
+\end_inset
-verbatim
+Scientific works
\begin_inset Quotes erd
-\end_inset
+\end_inset
- included file allows you to include a file typeset exactly as it appears
- in the file, i.e.\SpecialChar ~
-verbatim mode, with the characters set in a fixed-width
- typewriter font.
- Normally, spaces in this file are invisible, though two consecutive spaces
- are conserved, unlike LyX's normal treatment of spaces.
- However, setting the
-\family sans
-\bar under
-M
-\bar default
-ark\SpecialChar ~
-spaces\SpecialChar ~
-in\SpecialChar ~
-output
-\family default
- checkbox typesets a mark to unambiguously define the presence of a space.
-
-\emph on
-
-\layout Subsection
-
-Cross-References Between Files
-\layout Standard
+.
+ The titles for the sections can be added as ordinary sections or subsections.
+ Since
+\family typewriter
+bibtopic
+\family default
+ removes the bibliography title, you have manually re-add that, too (as
+ a chapter* or section*, for instance).
+\end_layout
+
+\begin_layout Subsection
+Multiple Bibliographies
+\end_layout
+
+\begin_layout Standard
+Multiple bibliographies, e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
+a bibliography for each section or chapter of
+ the document, are not supported by BibTeX itself.
+ But the
+\family typewriter
+bibtopic
+\family default
+ package, which is used for the creation of sectionated bibliographies in
+ LyX (cf.\InsetSpace ~
+section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sub:Sectionated-Bibliographies"
+
+\end_inset
+
+), provides an easy way to solve this task, if you are willing to use some
+ LaTeX-Code (ERT, cf.\InsetSpace ~
+section\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sec:Inserting-LaTeX-Code"
+
+\end_inset
-It is possible to set up cross-references between the different files.
- First, open all the files in question: let's call them A and B in a two
- file example, where B is included in A.
- Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
- the
-\begin_inset Quotes eld
-\end_inset
+).
+\begin_inset Foot
+status collapsed
-buffer
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+An alternative approach is to use the
+\family typewriter
+chapterbib
+\family default
+ or
+\family typewriter
+bibunits
+\family default
+ package, respectively.
+\end_layout
- to use.
-\layout Section
-
-Algorithms
-\layout Standard
-
-The package
-\family sans
-algorithm
-\family default
- is needed by LyX to be able to output algorithm floats.
- These are useful in placing short algorithms across page breaks and support
- an index of algorithms too.
-\layout Section
-
-Subfigures
-\layout Standard
-
-The package
-\family sans
- subfigure
-\family default
-is used by LyX when you select ``subfigure'' in the graphics dialog and
- enter the subfigure caption.
- Several figures marked in this way can be packed into a single float with
- individual sub-captions.
-\layout Section
+\end_inset
-Fancy Headers and Footers
-\layout Standard
-The default page layout is rather plain; for an article document class,
- all you get is a centered page number at the bottom of the page.
- This document is the book class, so it appears to be a bit fancier, but
- to really put on a show, you need to set the document page style to
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-fancy
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+First, go to
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-, as mentioned in the
-\family sans
-User\SpecialChar ~
-Guide
-\family default
+\bar under
+S
+\bar default
+ettings
+\family default
+ and select the
+\family sans
+Bibliography
+\family default
+ pane (with the xforms frontend: the
+\family sans
+Extras
+\family default
+ tab).
+ Check
+\family sans
+Sectionated\InsetSpace ~
+bibliography
+\family default
.
- This section describes the LaTeX codes you need to insert in your LaTeX
- preamble or the text in order to get the desired effects.
-\layout Standard
-
-The page header is divided into three fields, not surprisingly labeled
-\begin_inset Quotes eld
-\end_inset
-
-left
-\begin_inset Quotes erd
-\end_inset
+ In the document, you have to enclose the sections, which shall contain
+ their own bibliography (including the BibTeX reference itself), between
+
+\family typewriter
-,
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{btUnit}
+\family default
+ and
+\family typewriter
+
+\backslash
+end{btUnit}
+\family default
+ (those commands have to be inserted as ERT).
+ The bibliography will contain all references which have been cited in the
+ current btUnit.
+ N.\InsetSpace \thinspace{}
+B.: If you are using this approach, then
+\emph on
+every
+\emph default
+ citation reference has to be inside some btUnit.
+ Also, the btUnits cannot be nested.
+\end_layout
-center
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Section
+Making an Index
+\end_layout
-, and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+A good index is one of the hardest things to make in a lengthy document,
+ but LyX helps make things a bit simpler by interfacing to the
+\family typewriter
+makeindex
+\family default
+ program which is found in most recent LaTeX distributions.
+\begin_inset Foot
+status collapsed
-right
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+In the
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\family sans
+\size default
+\noun default
+Outputs\SpecialChar \menuseparator
+LaT\SpecialChar \textcompwordmark{}
+eX
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+ section of the preferences dialog, however, you can customize the index
+ command, if you prefer an alternative program like
+\family default
+\series default
+\shape default
+\emph default
+\bar default
+
+\family typewriter
+\size default
+\noun default
+xindy
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
.
- The footer is also divided into these three fields.
- The LaTeX commands to set these fields in the simplest manner are
-\family typewriter
-
-\backslash
-lhead
-\family default
-,
-\family typewriter
-
-\backslash
-chead
-\family default
-,
-\family typewriter
-
-\backslash
-rhead
-\family default
-,
-\family typewriter
-
-\backslash
-lfoot
-\family default
-, etc.
- Suppose you wish to put your name in the upper left hand corner of each
- page.
- Simply insert the following command in the preamble:
-\layout Standard
+\end_layout
+\end_inset
-\family typewriter
+ Inserting an index and marking words to include in it works much the same
+ way as preparing a bibliography as mentioned in the last section.
+\end_layout
-\backslash
-lhead{John Q.
- DocWriter}
-\layout Standard
+\begin_layout Standard
+First, go to the end of your file and select
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+List
+\family default
+\InsetSpace ~
+/\InsetSpace ~
-You will now see your name in the upper left.
- If a field has a default entry that you would like to get rid of (often
- the page number appears in the central footer, simply include a command
- with a blank argument, e.g.
-\layout Standard
+\family sans
+T
+\bar under
+O
+\bar default
+C\SpecialChar \menuseparator
+\bar under
+I
+\bar default
+ndex
+\family default
+\InsetSpace ~
-\family typewriter
+\family sans
+List
+\family default
+.
+ Then, for each word you would like to include in the index, go to the end
+ of that word and click on
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
-\backslash
-cfoot{}
-\layout Standard
+\bar under
+I
+\bar default
+ndex
+\family default
+\InsetSpace ~
-Let's get really fancy: lets put the section number with the word
+\family sans
+Entry
+\family default
+.
+ This will insert a tag showing the word as it will appear in the index.
+ That's all there is to it; LyX will automatically call
+\family typewriter
+makeindex
+\family default
+ for you and create the index itself.
+ The text in the dialog available from right-clicking on the index button
+ accepts LaTeX, so you'll need to be careful to avoid using any special
+ characters.
+ On the positive side, you can use the advanced options - have a look at
+ the documentation which comes with your LaTeX distribution to find out
+ how to do things like
\begin_inset Quotes eld
-\end_inset
+\end_inset
-Section
+nested entries
\begin_inset Quotes erd
-\end_inset
-
- (e.g.
- Section 3) in the upper left, the page number (e.g.
- Page 4) in the upper right, your name in the lower left, and the date in
- the lower right.
- The following commands should now appear in the preamble:
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-lhead{Section
-\backslash
-thesection}
-\layout Standard
-
+\end_inset
-\family typewriter
-
-\backslash
-chead{}
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-rhead{Page
-\backslash
-thepage}
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-lfoot{John Q.
- DocWriter}
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-cfoot{}
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-rfoot{
-\backslash
-today}
-\layout Standard
+, etc.
+\end_layout
-The codes
-\family typewriter
+\begin_layout Standard
+Be careful not to put spaces between the word in the text and the index
+ marker; apparently the wrong page number can be produced if this happens.
+\end_layout
-\backslash
-thesection
-\family default
- and
-\family typewriter
+\begin_layout Section
+Glossaries
+\end_layout
-\backslash
-thepage
-\family default
- access LaTeX's section and page counters, and so print out the current
- section and page numbers.
+\begin_layout Standard
+by
+\noun on
+Özgür Ug̃raş Baran
+\end_layout
+
+\begin_layout Standard
+Sometimes you need to compile a list of symbols that are mentioned in your
+ document with a brief explanation of them.
+ A LaTeX package named
+\family typewriter
+nomencl
+\family default
+ provides an easy way of compiling such lists.
-\family typewriter
+\family typewriter
+nomencl
+\family default
+ is included in most standard Linux distributions.
+ If your distribution doesn't contain it, you should download it from a
+ CTAN mirror and install the package in order to use this feature of LyX.
+\end_layout
+
+\begin_layout Standard
+A glossary entry is created if you place the cursor after a symbol entry
+ and then use the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Glossary\InsetSpace ~
+Entry
+\family default
+.
+ A gray box labeled
+\begin_inset Quotes eld
+\end_inset
-\backslash
-today
-\family default
- simply prints out today's date.
-\layout Standard
-The thicknesses of the horizontal rules drawn beneath the header and above
- the footer can also be modified.
- If you don't want one of the headers, set its thickness to 0.
- The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
- Use the commands, e.g.
-
-\family typewriter
+\family sans
+Not
+\family default
-\backslash
-renewcommand{
-\backslash
-headrulewidth}{0.4pt}
-\family default
- and
-\family typewriter
+\begin_inset Quotes erd
+\end_inset
-\backslash
-renewcommand{
-\backslash
-footrulewidth}{0.4pt}
-\family default
- to set the thicknesses.
-\layout Standard
+ is inserted and a window pops up asking for the glossary entry.
+ A glossary entry consists of two main entries.
+ The first is the symbol that you want to refer to.
+ You should enter a valid LaTeX code for the corresponding field in the
+ glossary dialog.
+ The second is the description of the symbol.
+ You should fill the corresponding field to complete the glossary entry.
+\end_layout
-You can switch the header/footer settings on and off for individual pages
- using commands like
-\family typewriter
+\begin_layout Subsection
+Sort Order of Glossary Entries
+\end_layout
-\backslash
-thispagestyle{empty}
-\family default
-,
-\family typewriter
+\begin_layout Standard
+Suppose you have two glossary entries for the symbols
+\begin_inset Formula $a$
+\end_inset
-\backslash
-thispagestyle{plain}
-\family default
-, and
-\family typewriter
+ and
+\begin_inset Formula $\sigma$
+\end_inset
-\backslash
-thispagestyle{fancy}
-\family default
.
- Simply insert them in the text on the page you want changed and mark them
- as TeX code.
- In fact, title pages are marked as plain by default, while following pages
- are marked fancy when using the global fancy setting.
-\layout Standard
-
-There are more complex commands which will let you insert things in the
- upper left on odd numbered pages, etc., but I will refer you to the
-\family typewriter
-fancyhdr
-\family default
- package documentation for more descriptions.
- For example, if you have a teTeX installation, look for
-\family typewriter
-/usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
-fancyhdr.dvi
-\family default
+ The
+\family typewriter
+nomencl
+\family default
+ package automatically sorts these two entries considering the symbol entry,
+ while printing the Glossary.
+ However, this can lead to an undesired sort order.
+ For the example given, the first entry appears as
+\family typewriter
+$a$
+\family default
+, while the second is
+\family typewriter
+$
+\backslash
+sigma$
+\family default
.
-\layout Standard
-
-As a final example, it is possible to include an Encapsulated PostScript®
- file in the header or footer.
- Suppose you want to put a company logo in the upper lefthand corner.
- You might try something like
-\layout Standard
+ Note that, in this case
+\begin_inset Formula $\sigma$
+\end_inset
+ is located in front of the
+\begin_inset Formula $a$
+\end_inset
-\family typewriter
+, since the character
+\begin_inset Quotes eld
+\end_inset
-\backslash
-lhead{
-\backslash
-resizebox{1in}{!}{
-\backslash
-includegraphics{logo.eps}}}
-\layout Standard
-\noindent
-(you may need to preface this with
-\family typewriter
-\backslash
-usepackage{graphics}
-\family default
- if you don't include EPS files elsewhere in your document).
-\layout Section
+\backslash
-Minipages
-\layout Standard
+\begin_inset Quotes erd
+\end_inset
-LaTeX provides a mechanism to produce essentially a page within a page,
- called minipages.
- Within a minipage, all the usual rules of indentation, line wrapping, etc.\SpecialChar ~
-apply.
- LyX also provides some of the minipage capability.
-\layout Standard
+ is considered in sorting.
+ In order to control the sort order, you can edit the
+\family sans
+Sort\InsetSpace ~
+as
+\family default
+ field of the glossary dialog.
+ For the given example, you can edit this field as
+\family typewriter
+a
+\family default
+ and
+\family typewriter
+sigma
+\family default
+ correspondingly.
+ Then, these entries will be effective in the sort ordering and
+\begin_inset Formula $a$
+\end_inset
+
+ will be located before
+\begin_inset Formula $\sigma$
+\end_inset
-Minipages in LyX have their own collapsable box; insert one via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Mini
-\bar under
-p
-\bar default
-age
-\family default
.
- Right-clicking on the box allows you to alter the minipage's width and
- alignment within the page.
- Warning: if the minipage is too long to fit on a page, it is truncated,
- not wrapped onto the next page.
-\layout Standard
-
-If you place two minipages side-by-side, you can use
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-pecial\SpecialChar ~
-Character
-\family default
- to insert a special instruction known in the LaTeX world as an
-\family typewriter
-hfill
-\family default
- to put a maximum amount of space between them; it forces one minipage to
- the left edge, the other to the right edge.
- The examples below show the difference.
-\layout Standard
+\end_layout
+\begin_layout Standard
+This feature provides exciting ways of ordering the entries.
+ For subgrouping and tips for using sort entries see the official nomencl
+ documentation.
+\end_layout
-\begin_inset Minipage
-position 0
-inner_position 0
-height "0pt"
-width "1.5in"
-collapsed true
+\begin_layout Subsection
+Referencing
+\end_layout
-\layout Standard
+\begin_layout Standard
+You can turn on referencing to the equations and pages in the glossary entries.
+ For this purpose, you should add referencing options commands at the end
+ of description field.
+ There are six referencing options in nomencl package:
+\end_layout
-This is a minipage which does not use hfill.
- This is the second sentence of a minipage which does not use hfill.
-\end_inset
+\begin_layout Paragraph*
+\backslash
+refeq:
+\end_layout
-\layout Standard
+\begin_layout Standard
+Adds reference to the equation by adding the phrase
+\begin_inset Quotes eld
+\end_inset
+, see equation (#)
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Minipage
-position 0
-inner_position 0
-height "0pt"
-width "1.5in"
-collapsed true
-\layout Standard
+\end_layout
-This is a second minipage which does not use hfill.
- This is the second sentence of a second minipage which does not use hfill.
-\end_inset
+\begin_layout Paragraph*
+\backslash
+refpage:
+\end_layout
-\layout Standard
-\added_space_top medskip \added_space_bottom medskip
-Here is some normal text to separate the two examples.
-\layout Standard
+\begin_layout Standard
+Adds reference to the page by adding the phrase
+\begin_inset Quotes eld
+\end_inset
+, page (#)
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Minipage
-position 0
-inner_position 0
-height "0pt"
-width "1.5in"
-collapsed true
-\layout Standard
+\end_layout
-This is a minipage which does use hfill.
- This is the second sentence of a minipage which does use hfill.
-\end_inset
+\begin_layout Paragraph*
+\backslash
+refeqpage:
+\end_layout
-\hfill
+\begin_layout Standard
+Is the short notation of
+\backslash
+refeq
+\backslash
+refpage.
+\end_layout
-\begin_inset Minipage
-position 0
-inner_position 0
-height "0pt"
-width "1.5in"
-collapsed true
+\begin_layout Paragraph*
-\layout Standard
+\backslash
+norefeq,
+\backslash
+norefpag,
+\backslash
+norefeqpage:
+\end_layout
-This is a second minipage which does use hfill.
- This is the second sentence of a second minipage which does use hfill.
-\end_inset
+\begin_layout Standard
+Turns off corresponding referencing options if they are turned on globally
+ (see reference documentation of nomencl).
+\end_layout
+\begin_layout Subsection
+Printing Glossary
+\end_layout
-\layout Section
+\begin_layout Standard
+You can insert the glossary with the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Lists\InsetSpace ~
+&TOC\SpecialChar \menuseparator
+Glossary
+\family default
+.
+ A light blue box labeled
+\begin_inset Quotes eld
+\end_inset
-Wrapping Text Around Figures
-\begin_inset LatexCommand \label{sec:floatflt}
-\end_inset
+\family sans
+Glossary
+\family default
+\begin_inset Quotes erd
+\end_inset
-\layout Standard
+ will show the place where the index is printed in the output.
+ The index list box is not clickable like other LyX-boxes.
+ In the printed output the title of the glossary appears as
+\series bold
+Nomenclature
+\series default
+\begin_inset Foot
+status collapsed
-\begin_inset Wrap figure
-placement r
-width "6cm"
-collapsed false
+\begin_layout Standard
+This is translated to the document language for a small number of languages,
+ amongst others French and German
+\end_layout
-\layout Standard
+\end_inset
+.
+ If you are not happy with the title, you can change it by re-defining the
+ command
+\family typewriter
+
+\backslash
+nomname
+\family default
+ in the preamble.
+ For example, in order to change the title
+\emph on
+List of Symbols
+\emph default
+ for the
+\emph on
+Glossary
+\emph default
+ add the following line to the preamble.
+\end_layout
-\begin_inset Graphics
- filename mobius.eps
- display color
- width 40col%
- rotateOrigin center
+\begin_layout LyX-Code
-\end_inset
+\backslash
+renewcommand{
+\backslash
+nomname}{List of Symbols}
+\end_layout
+\begin_layout Standard
+ If you're unhappy with the amount of space for symbols, you can alter it
+ by adding following line to the preamble.
+\end_layout
-\layout Caption
+\begin_layout LyX-Code
-This is a wrapped figure, and this is the brilliant caption that describes
- it
-\end_inset
+\backslash
+renewcommand{
+\backslash
+nomlabelwidth}{3.0cm}
+\end_layout
+\begin_layout Section
+Multipart Documents
+\end_layout
-\layout Standard
+\begin_layout Subsection
+General Operation
+\end_layout
-A very frequently asked question is whether text can be made to
+\begin_layout Standard
+When you are working on a large file with many sections, it is often convenient
+ to break up the document into several files, or perhaps you have something
+ where a table may change from time to time, but the preceding text does
+ not.
+ In these cases, you should seriously consider using multipart documents.
+ For example, scientific papers often have five major sections: the introduction
+, observations, results, discussion, and conclusion.
+ Each of these could be its own separate LyX file, with one
\begin_inset Quotes eld
-\end_inset
+\end_inset
-wrap
+master
\begin_inset Quotes erd
-\end_inset
+\end_inset
- around figures so that a figure occupies some fraction of the column width
- and text fills the rest.
- If you have the LaTeX package
-\family typewriter
-floatflt
-\family default
- installed (you can find out about it in the
-\emph on
-LaTeX Configuration
-\emph default
- manual) you can do this.
-\layout Standard
+ file which contains the title, authors, abstract, references, etc., plus
+ the five included files.
+ It is important to note that each of these files is a full LyX file which
+ can be formatted and printed on its own, as well as included in a master
+ file.
+ Each of these files must have the same document class, however--- don't
+ attempt to mix book classes with article classes.
+ You may also include LaTeX files; however, these files must not have their
+ own preamble
+\emph on
+(i.e.
-At the right is a figure of a mobius strip---you should have already seen
- this in the
-\emph on
-User's Guide
-\emph default
-.
- To wrap the text like this insert a wrap box via
-\family sans
-\bar under
+\emph default
+ everything up to and including the
+\family typewriter
+
+\backslash
+begin{document}
+\family default
+ line as well as the
+\family typewriter
+
+\backslash
+end{document}
+\family default
+ line must be deleted) or else errors will be generated when you try to
+ make a DVI file.
+\end_layout
+
+\begin_layout Standard
+LyX allows you to include files quite easily with
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-Flo
-\bar under
-a
-\bar default
-ts\SpecialChar \menuseparator
-Floatflt Figure
-\family default
+ChiI
+\bar under
+d
+\bar default
+\InsetSpace ~
+Document
+\family default
.
-\layout Standard
-
-Note: this package is very fragile! For example, having a figure too close
- to the bottom of the page will mess things up, as will having two figures
- close together.
- Use this package sparingly and do read the documentation that came with
- it (which will also tell you how to wrap text around tables).
-\layout Section
-
-Extra Table Options
-\layout Standard
+ When you click on this selection a small box is inserted into the file
+ at the current cursor location.
+ Clicking on the box raises a dialog which allows you to select the file
+ to be included, and the method of its inclusion.
+
+\end_layout
-While the standard table layout will suffice in 99% of all tables you generate,
- occasionally you will run into one which requires a bit of extra tweaking.
- The table dialog which appears on a right-click of a table allows these
- tweaks to be made.
- It will give you access to some extra column alignment parameters.
- A little bit of LaTeX background is useful here: when you set up a table
- in LaTeX, each column is given an alignment type.
- For example, you would give it
+\begin_layout Standard
+The file selection box should by now be obvious.
+ The three inclusion methods are
\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-l
-\family default
+\end_inset
+include
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
+input
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-c
-\family default
+, and
+\begin_inset Quotes eld
+\end_inset
+verbatim
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, or
+.
+ The difference between
\begin_inset Quotes eld
-\end_inset
+\end_inset
+include
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-r
-\family default
+ and
+\begin_inset Quotes eld
+\end_inset
+input
\begin_inset Quotes erd
-\end_inset
+\end_inset
- for left-aligned, centered, and right-aligned columns respectively (which
- appear as the left/center/right radio buttons in LyX).
- A fourth type is
+ is really only meaningful to LaTeXperts, but the practical difference is
+ that files which are
\begin_inset Quotes eld
-\end_inset
+\end_inset
+included
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-p
-\family default
+ are typeset beginning on a new page, while files which are
+\begin_inset Quotes eld
+\end_inset
+inputted
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, which will make a column of a specified width (the width box in LyX),
- and will wrap text within that box.
- A fifth type is
-\begin_inset Quotes eld
-\end_inset
+ are typeset starting on the current page.
+ Perhaps the labeling in LyX will be changed someday to reflect this.
+\end_layout
+
+\begin_layout Standard
+Generally, the master file is converted into a full LaTeX file before typesettin
+g, while the included files are converted to LaTeX files which do not have
+ all the preamble information.
+ Checking the
+\family sans
+Don't
+\family default
+\InsetSpace ~
+\family sans
+typeset
+\family default
+ button prevents this conversion.
+\end_layout
-\family typewriter
-|
-\family default
+\begin_layout Standard
+A
+\begin_inset Quotes eld
+\end_inset
+verbatim
\begin_inset Quotes erd
-\end_inset
+\end_inset
+
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.e.\InsetSpace ~
+verbatim mode, with the characters set in a fixed-width
+ typewriter font.
+ Normally, spaces in this file are invisible, though two consecutive spaces
+ are conserved, unlike LyX's normal treatment of spaces.
+ However, setting the
+\family sans
+\bar under
+M
+\bar default
+ark\InsetSpace ~
+spaces\InsetSpace ~
+in\InsetSpace ~
+output
+\family default
+ checkbox typesets a mark to unambiguously define the presence of a space.
+
+\end_layout
+
+\begin_layout Subsection
+Cross-References Between Files
+\end_layout
- (vertical bar) which rather than making a column will make a vertical rule
- at that point; this manifests itself in LyX as the
+\begin_layout Standard
+It is possible to set up cross-references between the different files.
+ First, open all the files in question: let's call them A and B in a two
+ file example, where B is included in A.
+ Let's say you insert a label in A, then want to reference it in B.
+ Open the cross-reference dialog in whilst in document B, and you can select
+ the
\begin_inset Quotes eld
-\end_inset
+\end_inset
-borders
+buffer
\begin_inset Quotes erd
-\end_inset
+\end_inset
- buttons.
- Finally, there is a type
-\begin_inset Quotes eld
-\end_inset
+ to use.
+\end_layout
+\begin_layout Section
+Fancy Headers and Footers
+\end_layout
-\family typewriter
-@
-\family default
+\begin_layout Standard
+The default page layout is rather plain; for an article document class,
+ all you get is a centered page number at the bottom of the page.
+ This document is the book class, so it appears to be a bit fancier, but
+ to really put on a show, you need to set the document page style to
+\begin_inset Quotes eld
+\end_inset
+fancy
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, which allows you to use whatever is enclosed in the accompanying braces
- as the column separator, including a null argument.
- The reasons for doing this may not be obvious, but they can be very powerful.
- They are best demonstrated by example.
-\layout Subsection
+, as mentioned in the
+\family sans
+User\InsetSpace ~
+Guide
+\family default
+.
+ This section describes the LaTeX codes you need to insert in your LaTeX
+ preamble or the text in order to get the desired effects.
+\end_layout
-Removing Extra Column Space
-\layout Standard
+\begin_layout Standard
+The page header is divided into three fields, not surprisingly labeled
+\begin_inset Quotes eld
+\end_inset
-Here is a standard table:
-\layout Standard
-\align center
+left
+\begin_inset Quotes erd
+\end_inset
-\begin_inset Tabular
-<lyxtabular version="3" rows="3" columns="2">
-<features>
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" leftline="true" width="0pt">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+,
+\begin_inset Quotes eld
+\end_inset
-\layout Standard
+center
+\begin_inset Quotes erd
+\end_inset
+, and
+\begin_inset Quotes eld
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Type
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+right
+\begin_inset Quotes erd
+\end_inset
-\layout Standard
+.
+ The footer is also divided into these three fields.
+ The LaTeX commands to set these fields in the simplest manner are
+\family typewriter
+\backslash
+lhead
+\family default
+,
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Example
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\backslash
+chead
+\family default
+,
+\family typewriter
-\layout Standard
+\backslash
+rhead
+\family default
+,
+\family typewriter
+\backslash
+lfoot
+\family default
+, etc.
+ Suppose you wish to put your name in the upper left hand corner of each
+ page.
+ Simply insert the following command in the preamble:
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
-\layout Standard
+\family typewriter
+\backslash
+lhead{John Q.
+ DocWriter}
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+You will now see your name in the upper left.
+ If a field has a default entry that you would like to get rid of (often
+ the page number appears in the central footer, simply include a command
+ with a blank argument, e.\InsetSpace \thinspace{}
+g.
+\end_layout
-\layout Standard
+\begin_layout Standard
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\backslash
+cfoot{}
+\end_layout
-\layout Standard
+\begin_layout Standard
+Let's get really fancy: lets put the section number with the word
+\begin_inset Quotes eld
+\end_inset
+Section
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+ (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+Page 4) in the upper
+ right, your name in the lower left, and the date in the lower right.
+ The following commands should now appear in the preamble:
+\end_layout
-\end_inset
+\begin_layout Standard
+\family typewriter
-\layout Standard
+\backslash
+lhead{Section
+\backslash
+thesection}
+\end_layout
-Notice that the horizontal rule extends a bit past the text on both sides.
- If you wanted the line to end even with the text, we can put a null separator
- on the ends to get rid of the bit of extra space LaTeX adds by default.
- Here is the example:
-\layout Standard
-\align center
+\begin_layout Standard
-\begin_inset Tabular
-<lyxtabular version="3" rows="3" columns="2">
-<features>
-<column alignment="left" valignment="top" width="0pt" special="@{} l">
-<column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\family typewriter
-\layout Standard
+\backslash
+chead{}
+\end_layout
+\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Type
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\family typewriter
-\layout Standard
+\backslash
+rhead{Page
+\backslash
+thepage}
+\end_layout
+\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Example
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\family typewriter
-\layout Standard
+\backslash
+lfoot{John Q.
+ DocWriter}
+\end_layout
+\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\family typewriter
-\layout Standard
+\backslash
+cfoot{}
+\end_layout
+\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\family typewriter
-\layout Standard
+\backslash
+rfoot{
+\backslash
+today}
+\end_layout
+\begin_layout Standard
+The codes
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\backslash
+thesection
+\family default
+ and
+\family typewriter
-\layout Standard
+\backslash
+thepage
+\family default
+ access LaTeX's section and page counters, and so print out the current
+ section and page numbers.
+
+\family typewriter
+\backslash
+today
+\family default
+ simply prints out today's date.
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+\begin_layout Standard
+The thicknesses of the horizontal rules drawn beneath the header and above
+ the footer can also be modified.
+ If you don't want one of the headers, set its thickness to 0.
+ The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
+ Use the commands, e.\InsetSpace \thinspace{}
+g.
+
+\family typewriter
-\end_inset
+\backslash
+renewcommand{
+\backslash
+headrulewidth}{0.4pt}
+\family default
+ and
+\family typewriter
+\backslash
+renewcommand{
+\backslash
+footrulewidth}{0.4pt}
+\family default
+ to set the thicknesses.
+\end_layout
-\layout Standard
+\begin_layout Standard
+You can switch the header/footer settings on and off for individual pages
+ using commands like
+\family typewriter
-In this case, the column specifier for the left column was set to
-\begin_inset Quotes eld
-\end_inset
+\backslash
+thispagestyle{empty}
+\family default
+,
+\family typewriter
+\backslash
+thispagestyle{plain}
+\family default
+, and
+\family typewriter
-\family typewriter
-@{} l
-\family default
+\backslash
+thispagestyle{fancy}
+\family default
+.
+ Simply insert them in the text on the page you want changed and mark them
+ as TeX code.
+ In fact, title pages are marked as plain by default, while following pages
+ are marked fancy when using the global fancy setting.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+There are more complex commands which will let you insert things in the
+ upper left on odd numbered pages, etc., but I will refer you to the
+\family typewriter
+fancyhdr
+\family default
+ package documentation for more descriptions.
+ For example, if you have a teTeX installation, look for
+\family typewriter
+/usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
+fancyhdr.dvi
+\family default
+.
+\end_layout
-, while the right column was set to
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+As a final example, it is possible to include an Encapsulated PostScript
+ file in the header or footer.
+ Suppose you want to put a company logo in the upper lefthand corner.
+ You might try something like
+\end_layout
+\begin_layout Standard
-\family typewriter
-l @{}
-\family default
+\family typewriter
-\begin_inset Quotes erd
-\end_inset
+\backslash
+lhead{
+\backslash
+resizebox{1in}{!}{
+\backslash
+includegraphics{logo.eps}}}
+\end_layout
-, in order to put the null characters on the edges.
-
-\layout Subsection
+\begin_layout Standard
+\noindent
+(you may need to preface this with
+\family typewriter
-Changing the Column Separator Character
-\layout Standard
+\backslash
+usepackage{graphics}
+\family default
+ if you don't include EPS files elsewhere in your document).
+\end_layout
-Now suppose you really wanted, for reasons that are completely opaque, to
- use
-\begin_inset Formula $\sqrt{\pi}$
-\end_inset
+\begin_layout Section
+Itemize Bullet Selection
+\begin_inset LatexCommand label
+name "sec:bullet"
- with some space around it for the column separator.
- Simply turn off the vertical border, then set the right column specifier
- to
-\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
-@{~$
-\backslash
-sqrt{
-\backslash
-pi}$~} l
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- You could now make a table like this:
-\layout Standard
-\align center
-
-\begin_inset Tabular
-<lyxtabular version="3" rows="3" columns="2">
-<features>
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Type
-\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Example
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_inset
-</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\layout Subsection
-
-Making a Decimal Point Aligned Column
-\layout Standard
-
-Okay, that last example was very silly, but here is one that is not.
- Suppose you want to make a table that has a column which is aligned on
- a decimal point.
- A standard LaTeX trick to do this is to set the whole number part in a
- right-aligned column, use a decimal point for the column separator, then
- set the fractional part as a left-aligned column.
- A variation on this is to include the decimal point explicitly with the
- whole part, then use just a null separator in between.
- The latter variation is demonstrated here:
-\layout Standard
-\align center
-
-\begin_inset Tabular
-<lyxtabular version="3" rows="5" columns="3">
-<features>
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="right" valignment="top" leftline="true" width="0pt">
-<column alignment="center" valignment="top" width="0pt" special="@{} l">
-<row bottomline="true">
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Expression
-\end_inset
-</cell>
-<cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Value
-\end_inset
-</cell>
-<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-
-\begin_inset Formula $\pi$
-\end_inset
-
-
-\end_inset
-</cell>
-<cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-3.
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-1416
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-
-\begin_inset Formula $\pi^{\pi}$
-\end_inset
-
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-36.
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-462
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-
-\begin_inset Formula $(\pi^{\pi})^{\pi}$
-\end_inset
-
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-80663.
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-
-\begin_inset Formula $\pi^{\pi^{\pi}}$
-\end_inset
-
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-1.
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-3402
-\begin_inset Formula $\times10^{18}$
-\end_inset
-
-
-\end_inset
-</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\layout Standard
-
-Though it appears a bit funny in LyX, on paper it will produce what appears
- to be a 2-column table in which the right column is aligned on the decimal
- point and the header appears to be centered over it.
-\layout Standard
-
-Perhaps it is best if I described just what I did: first, create a 3
-\begin_inset Formula $\times$
-\end_inset
-
-3 table and remove all the borders.
- Then re-add a bottom border to the top row, and a right border to the first
- column.
- Type in the values for the first column and set its alignment to
-\family sans
-center
-\family default
-.
- Type in the
-\family typewriter
-3.
-\family default
-,
-\family typewriter
-36.
-\family default
-,
-\family typewriter
-80663.
-\family default
-, and
-\family typewriter
-1.
-
-\family default
- and set that column's alignment to
-\family sans
-right
-\family default
-.
- Type in the
-\family typewriter
-1416
-\family default
-,
-\family typewriter
-462
-\family default
-, and
-\family typewriter
-3402
-\begin_inset Formula $\times10^{18}$
-\end_inset
-
-
-\family default
- and set the extra column alignment to
-\family typewriter
-@{} l
-\family default
-.
- Finally type in the word
-\family typewriter
-Value
-\family default
- in the middle column, highlight it and the blank entry to its right, and
- check the
-\family sans
-Special Cell
-\family default
- entry
-\family sans
-multicolumn
-\family default
-.
- Easy, right?
-\layout Subsection
-
-A Better Decimal-Alignment Solution
-\layout Standard
-
-An alternative way to have decimal alignment in tables is through the
-\family typewriter
-dcolumn
-\family default
- package.
- Add the following to the LateX preamble:
-\layout LyX-Code
-
-
-\backslash
-usepackage{dcolumn}
-\layout LyX-Code
-
-
-\backslash
-newcolumntype{d}[1]{D{.}{.}{#1}}
-\layout Standard
-
-To have a column decimally aligned, enter in the
-\family sans
-Special Column Alignment
-\family default
- box of the
-\family sans
-Table
-\family default
- dialog the following:
-\layout LyX-Code
-
-d{number of decimals of the data}
-\layout Standard
-
-To create extra column space just increase the number of decimals in
-\family typewriter
-d{}
-\family default
-.
- Setting the multicolumn attribute for a single cell makes it insensitive
- to the decimal alignment which comes in handy as well.
- A drawback of this method is that math mode is not allowed in a column
- with decimal alignment except if the multicolumn attribute is set.
-\layout Standard
-
-This method offers the same flexibility as the
-\family typewriter
-dcolumn
-\family default
- package.
- One could, for example, change the alignment separator, and have different
- alignment separators for different columns by defining multiple column
- types in the preamble.
- The syntax is as follows:
-\layout LyX-Code
-
-D{inputsep}{outputsep}{decimal places}
-\layout Standard
-
-The interested reader is directed towards the
-\family typewriter
-dcolumn
-\family default
- package documentation for more details.
-\layout Section
-
-Itemize Bullet Selection
-\begin_inset LatexCommand \label{sec:bullet}
-
-\end_inset
-
-
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Allan Rae
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX provides 216 bullet shapes that can be accessed from a simple dialog.
Using this dialog you can easily specify what bullet shape to use at each
level of an itemized list.
These settings are document-wide so you won't be able to specify different
sets of bullets for different paragraphs
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Well, actually you can but you'll have to do it by hand.
-\end_inset
+\end_layout
+
+\end_inset
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
How it looks
-\layout Standard
+\end_layout
+\begin_layout Standard
Open the dialog by selecting the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
menu item and then select the
-\family sans
-\bar under
+\family sans
+\bar under
B
-\bar default
+\bar default
ullets
-\family default
+\family default
tab.
-\layout Standard
+\end_layout
+\begin_layout Standard
The dialog provides you with a table of bullet shapes.
A column of buttons on the left of the table provides access to the six
different panels of bullet shapes.
LaTeX equivalent and this can be edited if desired.
If you do modify the text you will also need to specify any needed packages
in the LaTeX preamble.
-\layout Standard
+\end_layout
+\begin_layout Standard
The six panels are divided up by the packages they require.
The following table shows the mappings from button name to LaTeX packages.
-\layout Standard
-\align center
+\end_layout
-\begin_inset Tabular
+\begin_layout Standard
+\align center
+\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
<features>
<column alignment="center" valignment="top" leftline="true" width="0pt">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Button
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Packages Required
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Standard
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
base LaTeX
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Maths
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
amssymb.sty
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Ding1
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
pifont.sty
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Ding2
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
pifont.sty
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
<row topline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Ding3
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
pifont.sty
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
<row topline="true" bottomline="true">
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family sans
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
Ding4
-\end_inset
+\end_layout
+
+\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\layout Standard
+\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
+\family typewriter
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
\color none
pifont.sty
-\end_inset
+\end_layout
+
+\end_inset
</cell>
</row>
</lyxtabular>
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX doesn't stop you using bullets from packages you don't have.
If you get errors from LaTeX when you try to view or print the file then
its likely you are missing a package.
LyX doesn't restrict your use since you may be editing locally and exporting
elsewhere.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
How to use it
-\layout Standard
+\end_layout
+\begin_layout Standard
Select which bullet depth you want to change then select the bullet shape
and size.
-
-\family sans
-
-\family default
-Any changes will not be visible in LyX, but are visible when viewing the
+ Any changes will not be visible in LyX, but are visible when viewing the
document using xdvi or ghostview.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can reset a bullet shape to the default simply by clicking your right
mouse button on the appropriate bullet depth button.
-\layout Standard
+\end_layout
+\begin_layout Standard
If you
-\emph on
+\emph on
really
-\emph default
+\emph default
want to have multiple sets of paragraphs with different sets of bullets
in each then you're going to have to get your hands dirty.
The itemize bullet selection dialog can help though because it provides
you with the LaTeX code for a wide range of bullet shapes.
To make your own custom paragraphs you have the following options:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
let
-\backslash
+\backslash
savelabelitemi=
-\backslash
+\backslash
labelitemi
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
renewcommand
-\backslash
+\backslash
labelitemi[0]{
-\backslash
+\backslash
small
-\backslash
+\backslash
(
-\backslash
+\backslash
sharp
-\backslash
+\backslash
)}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Use the LaTeX command
-\family typewriter
+\family typewriter
-\backslash
+\backslash
renewcommand{}{}
-\family default
+\family default
to specify a new bullet shape for a given depth.
You'll also need to save the current bullet shape so you can restore it
again afterwards.
In this itemized list the following LaTeX code was used to change the bullet
used for the first depth.
-\newline
+\newline
-\family typewriter
+\family typewriter
-\backslash
+\backslash
let
-\backslash
+\backslash
savelabelitemi=
-\backslash
+\backslash
labelitemi
-\family default
+\family default
-\family typewriter
+\family typewriter
-\newline
+\newline
-\backslash
+\backslash
renewcommand
-\backslash
+\backslash
labelitemi[0]{
-\backslash
+\backslash
small
-\backslash
+\backslash
(
-\backslash
+\backslash
sharp
-\backslash
+\backslash
)}
-\newline
+\newline
-\family default
+\family default
Note that the itemize depth is specified in Roman numerals as part of the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
labelitem
-\family default
+\family default
command.
-\layout Itemize
-
+\end_layout
+\begin_layout Itemize
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
[
-\backslash
+\backslash
(
-\backslash
+\backslash
star
-\backslash
+\backslash
)]
-\end_inset
+\end_layout
+
+\end_inset
Specify each individual entry by starting each item with the bullet shape
enclosed in square brackets and set as TeX.
For example, this item was started with
-\family typewriter
+\family typewriter
[
-\backslash
+\backslash
(
-\backslash
+\backslash
star
-\backslash
+\backslash
)]
-\family default
+\family default
.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
renewcommand
-\backslash
+\backslash
labelitemi[0]{
-\backslash
+\backslash
savelabelitemi}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
You'll also need to revert the labelitem back to its previous setting for
the global bullet shape settings to remain in effect.
The way used here was:
-\newline
+\newline
-\family typewriter
+\family typewriter
-\backslash
+\backslash
renewcommand
-\backslash
+\backslash
labelitemi[0]{
-\backslash
+\backslash
savelabelitemi}
-\layout Chapter
+\end_layout
+\begin_layout Chapter
Special Document Classes
-\layout Section
+\end_layout
+\begin_layout Section
AMS LaTeX
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
David Johnson
-\layout Standard
-\added_space_top bigskip \noindent
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
papers to be submitted to American Mathematical Society publications.
The layouts are not tailored to a specific journal, but easily can be.
each journal (usually it will entail only changing a single line in the
TeX output).
That documentation is available on the Web at
-\begin_inset LatexCommand \url{http://www.ams.org}
+\begin_inset LatexCommand url
+target "http://www.ams.org"
-\end_inset
+\end_inset
or by ftp at
-\begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
+\begin_inset LatexCommand url
+target "ftp://ftp.ams.org/pub/tex/amslatex/"
-\end_inset
+\end_inset
.These layouts are appropriate, and useful, for any mathematical writing.
There are currently 4 distinct AMS LaTeX layouts:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
amsart: The standard AMS-article format.
All results and similar statements are numbered as
\begin_inset Formula $(n.m)$
-\end_inset
+\end_inset
, where the first number refers to the section, and the second refers to
the total number of results (Theorems, Corollaries, Propositions, Definitions
There are also many (but not all) environments available unnumbered, which
is occasionally needed.
Unnumbered environments indicated by an asterisk at the end.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
amsart-seq: Here, numbering for each type of statement is in its own sequence,
with no reference to the section number.
There are also many (but not all) environments available unnumbered, which
is occasionally needed.
Unnumbered environments indicated by an asterisk at the end.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
amsart-plain: This one is even more terse, since all the environments are
unnumbered.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
amsbook: the standard AMS book (really, monograph) format.
Numbering is similar to the amsart layout, except that all numbering is
by
\begin_inset Formula $(n.m.p)$
-\end_inset
+\end_inset
, where the first number refers to the chapter, the second to the section,
and the third is the number of the results (Theorems, Corollaries, Propositions
There are also many (but not all) environments available unnumbered, which
is occasionally needed.
Unnumbered environments indicated by an asterisk at the end.
-\layout Standard
+\end_layout
+\begin_layout Standard
Any AMS LyX file can be converted to either of the numbering schemes by
simply changing the document class in the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
What these layouts provide
-\layout Standard
+\end_layout
+\begin_layout Standard
There is a long list of included environments provided by these layouts.
Most mathematical papers or books will set as special statements most of
these environments, in AMS-LaTeX there is an opportunity to define an unlimited
However, the AMS recommends the environments that are available in LyX.
The list of environments (not counting the standard environments such as
-\family sans
+\family sans
sections, bibliography, title, author, date
-\family default
+\family default
), is:
-\layout Description
+\end_layout
+\begin_layout Description
Theorem This is typically used for the statements of major results.
The word
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
Theorem
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
appears in bold type, along with an automatically-determined number (an
unnumbered version,
-\family sans
+\family sans
Theorem*
-\family default
+\family default
, is also available).
The text is italicized.
-\layout Description
+\end_layout
+\begin_layout Description
Corollary This is used for statements which follow fairly directly from
previous statements.
Again, these can be major results.
Unnumbered version
-\family sans
+\family sans
Corollary*
-\family default
+\family default
is available.
-\layout Description
+\end_layout
+\begin_layout Description
Lemma These are smaller results needed to prove other statements.
-\layout Description
+\end_layout
+\begin_layout Description
Proposition These are less major results which (hopefully) add to the general
theory being discussed.
-\layout Description
+\end_layout
+\begin_layout Description
Conjecture These are statements provided without justification, which the
author does not know how to prove, but which seem to be true (to the author,
at least).
-\layout Description
+\end_layout
+\begin_layout Description
Criterion A required condition.
-\layout Description
+\end_layout
+\begin_layout Description
Algorithm A general procedure to be used.
-\layout Description
+\end_layout
+\begin_layout Description
Axiom This is a property or statement taken as true within the system being
discussed.
-\layout Description
+\end_layout
+\begin_layout Description
Definition Guess what this is for.
The font, both on-screen and in the output, is different for this environment
than for the previous ones.
The heading (
\begin_inset Quotes eld
-\end_inset
+\end_inset
definition
\begin_inset Quotes erd
-\end_inset
+\end_inset
) is still set in boldface, along with the number, if any, but the rest
is set upright.
-\layout Description
+\end_layout
+\begin_layout Description
Example Typeset similarly to Definition.
-\layout Description
+\end_layout
+\begin_layout Description
Condition
-\layout Description
+\end_layout
+\begin_layout Description
Problem
-\layout Description
+\end_layout
+\begin_layout Description
Exercise
-\layout Description
+\end_layout
+\begin_layout Description
Remark This environment is also a new type of theorem.
This is set with the word Remark in italics, and the rest upright.
-\layout Description
+\end_layout
+\begin_layout Description
Note Set similarly to the Remark environment.
-\layout Description
+\end_layout
+\begin_layout Description
Notation
-\layout Description
+\end_layout
+\begin_layout Description
Claim
-\layout Description
+\end_layout
+\begin_layout Description
Summary
-\layout Description
+\end_layout
+\begin_layout Description
Acknowledgement
-\layout Description
+\end_layout
+\begin_layout Description
Case Generally, these are used to break up long arguments, using specific
instances of some condition.
The numbering scheme for cases is on its own, not together with other numbered
statements.
-\layout Description
+\end_layout
+\begin_layout Description
Conclusion
-\layout Description
+\end_layout
+\begin_layout Description
Fact
-\layout Description
+\end_layout
+\begin_layout Description
Proof The word
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\shape italic
+\shape italic
Proof
-\shape default
+\shape default
\begin_inset Quotes erd
-\end_inset
+\end_inset
is set in italics, but the rest is set upright.
At the end of this environment (other environments can be nested within
this one, of course) a QED symbol (usually a square, but it can vary with
different styles) is placed.
-\layout Description
+\end_layout
+\begin_layout Description
Address This should be the author's permanent address.
-\layout Description
+\end_layout
-Current\SpecialChar ~
+\begin_layout Description
+Current\InsetSpace ~
Address This should be the author's temporary address at the time
of submission, if different from the Address.
-\layout Description
+\end_layout
+\begin_layout Description
Email Author's e-mail address
-\layout Description
+\end_layout
+\begin_layout Description
URL Author's Web address, if desired.
-\layout Description
+\end_layout
+\begin_layout Description
Keywords Key words or phrases used to identify specific topics discussed
in the paper.
-\layout Description
+\end_layout
+\begin_layout Description
Subjectclass These refer to the AMS Subject Classifications, published and
described in
-\emph on
+\emph on
Mathematical Reviews
-\emph default
+\emph default
.
These are also available online at the AMS cites listed above.
-\layout Description
+\end_layout
+\begin_layout Description
Thanks
-\layout Description
+\end_layout
+\begin_layout Description
Dedicatory
-\layout Description
+\end_layout
+\begin_layout Description
Translator
-\layout Standard
+\end_layout
+\begin_layout Standard
In addition, these environments automatically provide the AMS LaTeX and
AMS fonts packages.
They need to be available on your system in order to use these environments.
-\layout Section
+\end_layout
+\begin_layout Section
Dinbrief
-\layout Standard
+\end_layout
+\begin_layout Standard
The document class
-\family sans
+\family sans
dinbrief
-\family default
+\family default
can be used to type letters according to German conventions.
A template file is included in
-\family typewriter
+\family typewriter
.../lyx/share/templates
-\family default
+\family default
for you to use as a starting point.
-\layout Section
+\end_layout
+\begin_layout Section
Paper
-\layout Standard
+\end_layout
+\begin_layout Standard
The document class
-\family sans
+\family sans
paper
-\family default
+\family default
provides an alternative to the standard
-\family sans
+\family sans
article
-\family default
+\family default
class.
It provides similar functionality, but you might prefer this layout with
sans serif sections, headings, and more.
-\layout Section
+\end_layout
+\begin_layout Section
A&A Paper
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
-Peter Sütterlin
-\layout Subsection
+\noun on
+Peter Sütterlin
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
This section describes how LyX can be used to write articles for submission
to the scientific journal
-\emph on
+\emph on
Astronomy and Astrophysics
-\emph default
+\emph default
(
-\begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
+\begin_inset LatexCommand url
+name "www.edpsciences.fr/aa/"
+target "http://www.edpsciences.fr/aa/"
-\end_inset
+\end_inset
-)
-\emph on
-
-\emph default
-using
-\emph on
-
-\emph default
-Version 5.01 of the document class
-\family typewriter
+) using Version 5.01 of the document class
+\family typewriter
aa.cls
-\family default
+\family default
.
This package can be downloaded from the ftp site
-\layout Standard
-\added_space_top medskip \added_space_bottom medskip \align center
+\end_layout
-\begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\end_inset
+\end_layout
-\layout Standard
+\begin_layout Standard
+\align center
+\begin_inset LatexCommand url
+target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
-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.
-
-\layout Standard
+\end_inset
-Please note that the publisher of the journal was changed from Springer
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\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.
+
+\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
+\family sans
article (A&A V4)
-\family default
+\family default
.
Please refer to the comments in
-\family typewriter
+\family typewriter
LyXDir/layouts/aapaper.layout
-\family default
+\family default
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Getting started
-\layout Standard
+\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:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Select
-\family sans
+\family sans
article (A&A)
-\family default
+\family default
in the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog (OK, that one was obvious).
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Don't change the option
-\family sans
-Page\SpecialChar ~
+\family sans
+Page\InsetSpace ~
style
-\family default
+\family default
: Leave it set to
-\family sans
+\family sans
default
-\family default
+\family default
.
The whole layout is done by the macros, you shouldn't change anything.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
The header block
-\layout Standard
+\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
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\family default
+\family default
: [required]
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Subtitle
-\family default
+\family default
: [optional]
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Author
-\family default
+\family default
: [required]
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Address
-\family default
+\family default
: [required]
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Offprints
-\family default
+\family default
: [optional] if more than one author: whom to contact for offprint requests.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Mail
-\family default
+\family default
: [optional] mail address for contacts.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Date
-\family default
+\family default
: [required].
Suggested format is
-\family typewriter
+\family typewriter
Received: <date>; Accepted <date>
-\layout Standard
+\end_layout
+\begin_layout Standard
There is no need to issue the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
maketitle
-\family default
+\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.
-\layout Standard
+\end_layout
-If you want to place footnotes in the header block, e.g.
+\begin_layout Standard
+If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
+g.
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
to state your present address, just use the standard footnote via
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-\bar under
+\bar under
F
-\bar default
+\bar default
ootnote.
-
-\family default
-LyX will automagically use the term
-\family typewriter
-\backslash
+\family default
+ LyX will automagically use the term
+\family typewriter
+
+\backslash
thanks{}
-\family default
+\family default
in that case.
-\layout Standard
+\end_layout
+\begin_layout Standard
In addition to these topics, the macros use three additional LaTeX commands
that have no counterpart in LyX:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
and
-\family default
+\family default
to separate different names for more than one author and institute, respectivel
y.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
inst{<nr>}
-\family default
+\family default
to mark corresponding author/institute pairs.
The institutes are numbered sequentially as they appear in the
-\family sans
+\family sans
Address
-\family default
+\family default
field, so you have to put a marker to each author.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
email{address}
-\family default
+\family default
to supply an email address for fast contact.
-\layout Standard
+\end_layout
-In all cases, the appropriate command has to be entered in LyX an marked
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
as LaTeX code.
See the examples.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
The abstract
-\layout Standard
+\end_layout
+\begin_layout Standard
The abstract should immediately follow the header block.
With version 5 the abstract environment was changed to a command, and there
is now a resctriction to only one paragraph.
In addition, it should contain an entry with the keywords.
This is not yet implemented for LyX, therefore you have to enter the LaTeX
command
-\family typewriter
+\family typewriter
-\backslash
+\backslash
keywords{}
-\family default
+\family default
by hand and mark it as LaTeX code.
Refer to the example paper.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Supported environments
-\layout Standard
+\end_layout
+\begin_layout Standard
The A&A paper layout supports the following environments for structuring
your text:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Section
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Subsection
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Subsubsection
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Itemize
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Enumerate
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Description
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Caption
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Abstract
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Acknowledgment
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Bibliography
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
LaTeX
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Commands not supported by LyX
-\layout Standard
+\end_layout
+\begin_layout Standard
Some commands are not yet supported by the
-\family sans
+\family sans
paper (A&A)
-\family default
+\family default
layout for LyX.
Some have already been mentioned.
For the sake of completeness, they are listed all together here:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
and
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
email
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
appendix
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
authorrunning
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
inst{}
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
keywords{}
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
object{}
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
titlerunning{}
-\layout Standard
+\end_layout
+\begin_layout Standard
If you want to use any of these commands, you have to enter them yourself.
-\series bold
+\series bold
Do not forget to mark them as LaTeX code!
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Figure and Table Floats
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX provides support for the necessary float environments
-\family sans
-figure, figure*, table
-\family default
-and
-\family sans
+\family sans
+figure, figure*, table
+\family default
+ and
+\family sans
table*
-\family default
+\family default
, therefore we won't tell much about it here.
Refer to the
-\emph on
-User's\SpecialChar ~
+\emph on
+User's\InsetSpace ~
Guide
-\emph default
+\emph default
.
Just remember that tables should be left-aligned.
For that, select the table and change the alignment in
-\family sans
-\bar under
+\family sans
+\bar under
E
-\bar default
+\bar default
dit\SpecialChar \menuseparator
-\bar under
+\bar under
P
-\bar default
-aragraph\SpecialChar ~
+\bar default
+aragraph\InsetSpace ~
Settings.
-\layout Standard
+\end_layout
-There is
-\family sans
-
-\family default
-only one special thing: the figures with caption besides the figure.
+\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:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Create a wide figure float:
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
Flo
-\bar under
+\bar under
a
-\bar default
+\bar default
t\SpecialChar \menuseparator
Figure
-\family default
-, then right click in the figure and select
-\family sans
-
-\bar under
+\family default
+, then right click in the figure and select
+\family sans
+\bar under
S
-\bar default
-pan\SpecialChar ~
+\bar default
+pan\InsetSpace ~
columns
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Enter your caption text.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Press
-\family sans
+\family sans
Return
-\family default
+\family default
to move the cursor above the caption.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Insert your figure
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
-pecial\SpecialChar ~
+\bar default
+pecial\InsetSpace ~
Character
-\bar under
+\bar under
\SpecialChar \menuseparator
H
-\bar default
-orizontal\SpecialChar ~
+\bar default
+orizontal\InsetSpace ~
Fill
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Switch to LaTeX mode:
-\family sans
-M-c\SpecialChar ~
+\family sans
+M-c\InsetSpace ~
t
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Enter
-\family typewriter
+\family typewriter
-\backslash
+\backslash
parbox[b]{55mm}{
-\family default
+\family default
.
-\series bold
+\series bold
Do not close the brace!
-\layout Enumerate
+\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\SpecialChar ~
-t
-\family typewriter
+\family sans
+M-c\InsetSpace ~
+t
+\family default
+
+\family typewriter
}
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
Also, refer to the figures in the example paper.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Referee layout
-\layout Standard
+\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
+\family typewriter
referee
-\family default
+\family default
to the documentclass.
This must be done using the extra class options field in the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog.
Just enter the string
-\family typewriter
+\family typewriter
referee
-\family default
+\family default
there.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
The example paper
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family sans
+\family sans
Examples
-\family default
+\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.
-\layout Section
+\end_layout
+\begin_layout Section
AASTeX
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Mike Ressler
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\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 requires version 5.0 (or higher) of these macros.
+ 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 AAS's ftp site
-\layout Standard
-\added_space_top medskip \added_space_bottom medskip \align center
+ The AASTeX package may be downloaded from the AASTeX Web site
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
-\begin_inset LatexCommand \url{ftp://ftp.aas.org/pubs}
+\begin_layout Standard
+\align center
+\begin_inset LatexCommand url
+target "http://www.journals.uchicago.edu/AAS/AASTeX"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
A complete user guide is contained in that package and you should familiarize
yourself with it thoroughly before embarking on writing a paper in LyX.
LyX will not reduce the need to figure out all the AASTeX commands, it
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.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Starting a New Paper
-\layout Standard
+\end_layout
+\begin_layout Standard
I strongly suggest that you start with the AASTeX template file.
Click on
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-New from
-\bar under
+New from
+\family default
+
+\family sans
+\bar under
T
-\bar default
+\bar default
emplate
-\family default
+\family default
, enter the new file name, then choose the
-\family typewriter
+\family typewriter
aastex.lyx
-\family default
+\family default
template.
This will show the most common fields found in a manuscript.
Simply overwrite the existing text (including the brackets,
-\family typewriter
+\family typewriter
<>
-\family default
+\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
+\family typewriter
-\backslash
+\backslash
altaffilmark
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
altaffiltext
-\family default
+\family default
, which should stick out like a sore thumb if you actually just opened the
template file.
For commands such as these, the LaTeX code must be entered directly and
marked as such.
Such commands are referred to as ERT, or Evil Red Text.
I tried to minimize the amount of ERT needed in an AASTeX document, but
- there is still more required than any of us would like.
-\layout Subsection
+ there is still a bit more required than any of us would like.
+\end_layout
+\begin_layout Subsection
Finishing Your Paper
-\layout Standard
+\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
+\end_inset
postprocessing
\begin_inset Quotes erd
-\end_inset
+\end_inset
actions which need to be done before you submit it to the journals.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Export your paper as a LaTeX file (
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
E
-\bar default
+\bar default
xport\SpecialChar \menuseparator
-\bar under
+\bar under
L
-\bar default
-ateX
-\family default
+\bar default
+aTeX
+\family default
).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Edit the resulting
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file with your favorite text editor
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
remove the comment lines before the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
documentclass
-\family default
+\family default
command
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
remove the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
usepackage...{fontenc}
-\family default
+\family default
line if it appears (usually just after
-\family typewriter
+\family typewriter
-\backslash
+\backslash
documentclass
-\family default
+\family default
}; also remove the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
secnumdepth
-\family default
+\family default
line if it appears.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
remove everything between (and including) the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
makeatletter
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
makeatother
-\family default
+\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
+\end_inset
User specified LaTeX commands
\begin_inset Quotes erd
-\end_inset
+\end_inset
comment in the
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file).
-\layout Enumerate
-
-search for any
-\family typewriter
-
-\backslash
-figcaption
-\family default
- commands and replace
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-FileName
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- with the correct, real file name.
-\layout Enumerate
-
-alter any
-\family typewriter
-
-\backslash
-cite
-\family default
- commands, if necessary (see section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{cite}
-
-\end_inset
-
- below).
-\end_deeper
-\layout Enumerate
+\end_layout
+\end_deeper
+\begin_layout Enumerate
Run the resulting file through LaTeX to make sure it still processes correctly.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Reread the journal requirements to make sure your filenames and formats
are correct.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Submit it.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Comments On Specific Commands
-\layout Standard
+\end_layout
+\begin_layout Standard
I will not describe the detailed usage of the individual AASTeX commands:
the AASTeX User Guide (
-\family typewriter
+\family typewriter
aasguide.tex
-\family default
+\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{}
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Things that work as expected
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{sloppypar}
-\end_inset
+\end_layout
+
+\end_inset
-\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
+\family typewriter
-\backslash
+\backslash
documentclass
-\family default
+\family default
(2.1.1),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
begin{document}
-\family default
+\family default
(2.2),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
title
-\family default
+\family default
(2.3),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
author
-\family default
+\family default
(2.3),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
affil
-\family default
+\family default
(2.3),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
abstract
-\family default
+\family default
(2.4),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
keywords
-\family default
+\family default
(2.5),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
section
-\family default
+\family default
(2.7),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
subsection
-\family default
+\family default
(2.7),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
subsubsection
-\family default
+\family default
(2.7),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
paragraph
-\family default
+\family default
(2.7),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
+facility
+\family default
+ (2.10),
+\family typewriter
+
+\backslash
begin{displaymath}
-\family default
- (2.11),
-\family typewriter
+\family default
+ (2.12),
+\family typewriter
-\backslash
+\backslash
begin{equation}
-\family default
- (2.11),
-\family typewriter
+\family default
+ (2.12),
+\family typewriter
-\backslash
+\backslash
begin{eqnarray}
-\family default
- (2.11),
-\family typewriter
+\family default
+ (2.12),
+\family typewriter
-\backslash
+\backslash
begin{mathletters}
-\family default
- (2.11),
-\family typewriter
+\family default
+ (2.12),
+\family typewriter
-\backslash
+\backslash
begin{thebibliography}
-\family default
- (2.12.1),
-\family typewriter
+\family default
+ (2.13.1),
+\family typewriter
-\backslash
+\backslash
bibitem
-\family default
- (2.12.2),
-\family typewriter
+\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
-\backslash
+\backslash
begin{table}
-\family default
- (2.14.4),
-\family typewriter
+\family default
+ (2.15.4),
+\family typewriter
-\backslash
+\backslash
begin{tabular}
-\family default
- (2.14.4),
-\family typewriter
+\family default
+ (2.15.4),
+\family typewriter
-\backslash
+\backslash
caption
-\family default
- (2.14.4),
-\family typewriter
+\family default
+ (2.15.4),
+\family typewriter
-\backslash
+\backslash
label
-\family default
- (2.14.4, amongst other places),
-\family typewriter
+\family default
+ (2.15.4, amongst other places),
+\family typewriter
-\backslash
+\backslash
tablerefs
-\family default
- (2.14.5),
-\family typewriter
+\family default
+ (2.15.5),
+\family typewriter
-\backslash
+\backslash
tablecomments
-\family default
- (2.14.5),
-\family typewriter
+\family default
+ (2.15.5),
+\family typewriter
-\backslash
+\backslash
url
-\family default
- (2.15.4),
-\family typewriter
+\family default
+ (2.17.4),
+\family typewriter
-\backslash
+\backslash
end{document}
-\family default
- (2.16).
-\layout Standard
+\family default
+ (2.18).
+\end_layout
+\begin_layout Standard
The following style options also work correctly:
-\family typewriter
+\family typewriter
+longabstract
+\family default
+ (2.4),
+\family typewriter
preprint
-\family default
-,
-\family typewriter
+\family default
+ (3.2.1),
+\family typewriter
preprint2
-\family default
-,
-\family typewriter
+\family default
+ (3.2.2),
+\family typewriter
eqsecnum
-\family default
-,
-\family typewriter
+\family default
+ (3.3),
+\family typewriter
flushrt
-\family default
- (3, 3.1, 3.2).
- Simply put them in
-\family sans
-Extra Options
-\family default
+\family default
+ (3.4).
+ Simply put them in the
+\family sans
+Options
+\family default
box in
-\family sans
+\family sans
Layout\SpecialChar \menuseparator
Document
-\family default
+\family default
.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{sloppypar}
-\end_inset
+\end_layout
+\end_inset
-\layout Subsubsection
+\end_layout
+
+\begin_layout Subsubsection
Things that work, but require more comment
-\layout Standard
+\end_layout
+\begin_layout Standard
The following items work, but require a little more discussion:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
These items are reserved for use by the journal editors, but you can put
them into the LaTeX preamble if you feel compelled to do so:
-\family typewriter
+\family typewriter
-\backslash
+\backslash
received
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
revised
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
accepted
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
ccc
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
cpright
-\family default
+\family default
(all from 2.1.3)
-\layout Itemize
+\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
+\family typewriter
-\backslash
+\backslash
slugcomment
-\family default
+\family default
(2.1.4),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
shorttitle
-\family default
+\family default
(2.1.5),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
shortauthors
-\family default
+\family default
(2.1.5)
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
email
-\family default
+\family default
(2.3) -- can only be used
\begin_inset Quotes eld
-\end_inset
+\end_inset
standalone
\begin_inset Quotes erd
-\end_inset
+\end_inset
, not in the middle of a paragraph.
Use ERT if you need to embed it.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
and
-\family default
+\family default
(2.3) -- will have extra {} after it.
This should not cause an error.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
notetoeditor
-\family default
+\family default
(2.6) -- can only be used
\begin_inset Quotes eld
-\end_inset
+\end_inset
standalone
\begin_inset Quotes erd
-\end_inset
+\end_inset
, not in the middle of a paragraph.
Use ERT if you need to embed it.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
placetable
-\family default
+\family default
(2.8) -- can't insert a cross-reference tag, you must type the tag name
by hand
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
placefigure
-\family default
+\family default
(2.8) -- same as for
-\family typewriter
+\family typewriter
-\backslash
+\backslash
placetable
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
acknowledgements
-\family default
+\family default
(2.9) -- will have extra {} after it.
This should not cause an error.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
appendix
-\family default
- (2.10) -- will have extra {} after it.
+\family default
+ (2.11) -- will have extra {} after it.
This should not cause an error.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
-\backslash
+\backslash
figcaption
-\family default
- (2.13.2) -- you will have to edit the optional argument by hand in the final
- LaTeX file.
-\layout Subsubsection
+\family default
+ (2.14.2) -- you can insert an optional filename argument by placing the cursor
+ at the beginning of the text and selecting
+\family sans
+Insert\SpecialChar \menuseparator
+Short Title
+\family default
+.
+
+\begin_inset Quotes eld
+\end_inset
-Things not implemented, use ERT
-\layout Standard
+Short Title
+\begin_inset Quotes erd
+\end_inset
+
+ 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
+
+\family typewriter
+
+\backslash
+objectname
+\family default
+ (2.17.1) -- same as
+\family typewriter
+
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
+\end_layout
+\begin_layout Itemize
+\family typewriter
+
+\backslash
+dataset
+\family default
+ (2.17.1) -- same as
+\family typewriter
+
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
+\end_layout
+
+\begin_layout Subsubsection
+Things not implemented, use ERT
+\end_layout
+
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{sloppypar}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family typewriter
+\family typewriter
-\backslash
+\backslash
altaffilmark
-\family default
+\family default
(2.3),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
altaffiltext
-\family default
+\family default
(2.3),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
eqnum
-\family default
- (2.11),
-\family typewriter
-
-\backslash
-setcounter{equation}
-\family default
- (2.11),
-\family typewriter
-
-\backslash
-citet
-\family default
+\family default
(2.12),
-\family typewriter
+\family typewriter
-\backslash
-citep
-\family default
- (2.12), Journal name abbreviations (2.12.4),
-\family typewriter
+\backslash
+setcounter{equation}
+\family default
+ (2.12), Journal name abbreviations (2.13.4),
+\family typewriter
-\backslash
+\backslash
figurenum
-\family default
- (2.13.1),
-\family typewriter
+\family default
+ (2.14.1),
+\family typewriter
-\backslash
+\backslash
epsscale
-\family default
- (2.13.1),
-\family typewriter
+\family default
+ (2.14.1),
+\family typewriter
-\backslash
+\backslash
plotone
-\family default
- (2.13.1),
-\family typewriter
+\family default
+ (2.14.1),
+\family typewriter
-\backslash
+\backslash
plottwo
-\family default
- (2.13.1),
-\family typewriter
+\family default
+ (2.14.1),
+\family typewriter
-\backslash
+\backslash
tablenum
-\family default
- (2.14.4),
-\family typewriter
+\family default
+ (2.15.4),
+\family typewriter
-\backslash
+\backslash
tableline
-\family default
- (2.14.4, insert it as the first element in the lefthand cell after where
+\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
+\family typewriter
-\backslash
+\backslash
tablenotemark
-\family default
- (2.14.5),
-\family typewriter
+\family default
+ (2.15.5),
+\family typewriter
-\backslash
+\backslash
tablenotetext
-\family default
- (2.14.5), most everything in Misc (2.15, except
-\family typewriter
+\family default
+ (2.15.5), much of Misc (2.17, except
+\family typewriter
+
+\backslash
+objectname
+\family default
+,
+\family typewriter
+
+\backslash
+dataset
+\family default
+,
+\family typewriter
-\backslash
+\backslash
url
-\family default
- and
-\family typewriter
+\family default
+, and
+\family typewriter
-\backslash
+\backslash
email
-\family default
+\family default
; see above),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
singlespace
-\family default
+\family default
(3.1),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
doublespace
-\family default
+\family default
(3.1),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onecolumn
-\family default
+\family default
(3.2),
-\family typewriter
+\family typewriter
-\backslash
+\backslash
twocolumn
-\family default
+\family default
(3.2)
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
end{sloppypar}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Things that cannot be implemented
-\layout Standard
+\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.12.3), and the deluxetable environment
- (2.14).
+ 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
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
Chil
-\bar under
+\bar under
d
-\bar default
-\SpecialChar ~
+\bar default
+\InsetSpace ~
Document
-\family default
+\family default
to include it in your LyX document.
See the
-\family typewriter
+\family typewriter
aas_sample.lyx
-\family default
+\family default
file to see an example of this.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
FAQs, Tips, Tricks, and Other Ruminations
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Getting LyX and AASTeX to cooperate
-\layout Standard
+\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:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Make certain that LaTeX can find AASTeX.
Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
-\family typewriter
+\family typewriter
sample.tex
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Make certain that
-\family typewriter
+\family typewriter
aastex.layout
-\family default
+\family default
appears in
-\family typewriter
+\family typewriter
/usr/.../share/lyx/layouts
-\family default
+\family default
or
-\family typewriter
+\family typewriter
~/.lyx/layouts
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Rerun
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools\SpecialChar \menuseparator
-\bar under
+\bar under
R
-\bar default
+\bar default
econfigure
-\family default
+\family default
in LyX, then restart LyX.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Open a regular new file, not from a template.
Does AASTeX appear in the class list in
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
?
-\layout Standard
+\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
+\end_inset
You should not mix title layouts with normal ones
\begin_inset Quotes erd
-\end_inset
+\end_inset
, things haven't been installed correctly.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
LaTeX error processing a table
-\layout Standard
+\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
-\bar under
+\family sans
+\bar under
E
-\bar default
+\bar default
dit\SpecialChar \menuseparator
-\bar under
+\bar under
P
-\bar default
-aragraph\SpecialChar ~
+\bar default
+aragraph\InsetSpace ~
Settings
-\family default
+\family default
, then set the
-\family sans
+\family sans
Alignment
-\family default
+\family default
to
-\family sans
-\bar under
+\family sans
+\bar under
B
-\bar default
+\bar default
lock
-\family default
+\family default
.
This took care of it for me.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
References
-\begin_inset LatexCommand \label{cite}
+\begin_inset LatexCommand label
+name "cite"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
-A few things: 1) I have noticed some funny spacing in the reference entries
- in the text.
+\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
+\emph on
no
-\emph default
+\emph default
space between the last author and the parenthesis setting off the year;
-\emph on
-e.g.
-
-\emph default
-type
-\family typewriter
- Ressler(1992)
-\family default
+\emph on
+e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+
+\emph default
+type
+\family typewriter
+Ressler(1992)
+\family default
, not
-\family typewriter
+\family typewriter
Ressler (1992)
-\family default
-.
- 2) I am really unhappy that I can't make
-\family typewriter
-
-\backslash
-citet
-\family default
- and
-\family typewriter
-
-\backslash
-citep
-\family default
- more automatic, but that would require changes to the LyX source code.
- For now you can do one of two things: a) enter all your citations using
- the built-in
-\family sans
-Insert\SpecialChar \menuseparator
-Citation Reference
-\family default
- mechanism; at least you can take advantage of the automatic insertions.
- Then edit the exported LaTeX file by hand changing the
-\family typewriter
-
-\backslash
-cite
-\family default
- entries to the appropriate
-\family typewriter
-
-\backslash
-citet
-\family default
- or
-\family typewriter
-
-\backslash
-citep
-\family default
- commands before you submit it (
-\family typewriter
-
-\backslash
-cite
-\family default
- is currently equivalent to
-\family typewriter
-
-\backslash
-citet
-\family default
-, so you wouldn't necessarily have to change those).
- Or b) you can simply enter all your citations as ERT using the same key
- for the argument that you used in the bibliography dialog,
-\emph on
-e.g.
-
-\emph default
-
-\family typewriter
-
-\backslash
-citet{key}
-\family default
+\family default
.
- Neither choice is pleasant, but until LyX's citation mechanism understands
-
-\family typewriter
-natbib
-\family default
-, we'll have to put up with it.
- 3) Entering the references at all is not obvious.
+ 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
+\family sans
References
-\family default
+\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.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Including EPS files
-\layout Standard
+\end_layout
-With all due respect to Chris Biemesderfer and the others who have helped
- to write the AASTeX package, the figure handling mechanism smells really
- foul.
- You can insert the
-\family typewriter
+\begin_layout Standard
+Even though AASTeX provides its own figure commands (
+\family typewriter
-\backslash
+\backslash
plotone
-\family default
-, etc.
-\begin_inset ERT
-status Inlined
-
-\layout Standard
+\family default
+, for example), I much prefer LaTeX's standard figure commands (with the
+ default graphicx).
+ You can insert the
+\family typewriter
-\backslash
-
-\end_inset
+\backslash
+plotone
+\family default
+, etc.\InsetSpace ~
+commands as ERT into a Figure Float box if you desire, but I never
+ have much luck getting the layout right.
+ With the standard graphics, LyX will insert a
+\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
-commands as ERT into a Figure Float box, but I never have much luck getting
- the layout right.
- My advice would be to avoid all EPS inclusions in the manuscript you submit
- to the journal, but then use the standard LyX EPS file inclusion mechanism
- when you want to make your nicer looking preprints.
- LyX will insert a
-\family typewriter
+stack everything at the end
+\begin_inset Quotes erd
+\end_inset
-\backslash
-usepackage{graphics}
-\family default
- command into the LaTeX preamble and handle the figures in the standard
- LaTeX2e way.
- Anyone who attempts to print your AASTeX 5.0 manuscript must have a LaTeX2e
- installation anyway, so why not take advantage of the infinitely better
- graphics handling mechanism? If they complain about LaTeX2e or the graphics
- package, point out that it appears in the second edition of Lamport (1994),
- so it was time to upgrade many years ago.
-\layout Subsubsection
+ technique.
+\end_layout
+\begin_layout Subsubsection
Things I could have done, but didn't
-\layout Standard
+\end_layout
+\begin_layout Standard
There are a few
\begin_inset Quotes eld
-\end_inset
+\end_inset
pretty
\begin_inset Quotes erd
-\end_inset
+\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,
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.
- If you feel strongly that I should make such layouts, I will adhere to
- the spirit of the rules laid out by the Mudgeeraba Creek Emu-Riding and
- Boomerang-Throwing Association:
-\layout Quotation
-
-
-\begin_inset Quotes eld
-\end_inset
-
-Decisions of the judges will be final unless shouted down by a really overwhelmi
-ng majority of the crowd present.
- Abusive and obscene language may not be used by contestants when addressing
- members of the judging panel, or, conversely, by members of the judging
- panel when addressing contestants (unless struck by a boomerang).
-\begin_inset Quotes erd
-\end_inset
-
-
-\layout Subsection
-
-Final Caveat
-\layout Standard
-
-To mangle the infamous quote by Donald Knuth about a computer algorithm,
-\begin_inset Quotes eld
-\end_inset
-
-I have only proved this to be correct, I have not actually tried it.
-\begin_inset Quotes erd
-\end_inset
-
- I believe following the above procedures will produce an acceptable AASTeX
- document, but as of this update (Jan 25, 2000), I have not yet submitted
- a paper using it.
- Hopefully in the next few months \SpecialChar \ldots{}
-
-\layout Section
-
-ijmpd
-\layout Standard
+\end_layout
+\begin_layout Subsection
+Final Caveat
+\end_layout
+
+\begin_layout Standard
+Your mileage may vary.
+ I've now had papers published by both ApJ and AJ that have had 98% of the
+ effort done in LyX; the last 2% was the LaTeX post-processing and a few
+ cleanups.
+ I have had no trouble with the submission process, and I'm sure the journals
+ were never aware that there might be a difference.
+ So, go forth and publish!
+\end_layout
+
+\begin_layout Section
+qijmpc and ijmpd
+\end_layout
+
+\begin_layout Standard
by
-\noun on
+\noun on
Panayotis Papasotiriou
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Overview
-\layout Standard
+\end_layout
-The ijmpd package is a set of macros that facilitates electronic manuscript
+\begin_layout Standard
+The ijmpc package is a set of macros that facilitates electronic manuscript
submission to the
-\emph on
+\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
- published by World Scientific.
- The name of the document class is
-\family typewriter
-ws-ijmpd.cls
-\family default
+\emph default
.
- This file, together with instructions for the authors, can be downloaded
- from the site
-\begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
+ Both journals are published by World Scientific.
+ The corresponding document classes are named
+\family typewriter
+ws-ijmpc.cls
+\family default
+ and
+\family typewriter
+ws-ijmpd.cls
+\family default
+, respectively.
+ These files, together with instructions for the authors, can be downloaded
+ from the sites
+\begin_inset LatexCommand url
+target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
+
+\end_inset
+
+ and
+\begin_inset LatexCommand url
+target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
-\end_inset
+\end_inset
.
- The ijmpd package is a modified version of the standard
+ Both packages are modified versions of the standard
\begin_inset Quotes eld
-\end_inset
+\end_inset
article
\begin_inset Quotes erd
-\end_inset
+\end_inset
- package.
- Most of its features are supported by LyX.
- I have recently used LyX successfully to write an article submitted to
- the
-\emph on
-International Journal of Modern Physics D
-\emph default
-.
-\layout Subsection
+ package, and they are almost (but not exactly) identical.
+ Most of their features are supported by LyX.
+ I have used LyX successfully to write articles submitted to both journals
+ without any problem.
+\end_layout
+\begin_layout Subsection
Writing a paper
-\layout Standard
+\end_layout
+\begin_layout Standard
As usual, the easiest way to write a paper is to start with a template.
Click on
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-New from
-\bar under
+New from
+\family default
+
+\family sans
+\bar under
T
-\bar default
+\bar default
emplate
-\family default
+\family default
, then choose the
-\family typewriter
+\family typewriter
+ijmpc.lyx
+\family default
+ or
+\family typewriter
ijmpd.lyx
-\family default
+\family default
template.
This will give an (almost) empty document that includes the most common
fields found in a manuscript.
Simply overwrite the existing text (including the brackets,
-\family typewriter
+\family typewriter
<>
-\family default
-) with the correct information.
+\family default
+) with your text.
You should keep in mind the following remarks.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
LyX won't let you change the font size and the page style of the document,
- because the ijmpd package does not allow such modifications.
-\layout Enumerate
+ because such modifications are not allowed by both packages.
+\end_layout
-The ijmpd package requires that the language of the document should not
- be changed.
+\begin_layout Enumerate
+The language of the document should not be changed.
Before previewing your paper, be sure that the babel package is not used.
To do this, click on
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools\SpecialChar \menuseparator
-\bar under
+\bar under
P
-\bar default
+\bar default
references
-\family default
-, deselect the
-\family sans
-\bar under
+\family default
+, select the
+\family sans
+Lang Opts
+\family default
+ tab, deselect the
+\family sans
+\bar under
U
-\bar default
+\bar default
se babel
-\family default
+\family default
checkbox in the language settings, and click on
-\family sans
-\bar under
+\family sans
+\bar under
A
-\bar default
+\bar default
pply
-\family default
+\family default
(or
-\family sans
+\family sans
Save
-\family default
+\family default
, if you wish to make this change permanent).
-\layout Enumerate
+\end_layout
-Two new environments, named
+\begin_layout Enumerate
+The
\begin_inset Quotes eld
-\end_inset
+\end_inset
-Theorem
+Keywords
\begin_inset Quotes erd
-\end_inset
+\end_inset
- and
+ 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
+\end_inset
-Proof
+Classification Codes
\begin_inset Quotes erd
-\end_inset
+\end_inset
- are available (their use is obvious).
-\layout Enumerate
+, 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
-Appendices may be added to the paper.
- LyX offers a special environment, called
+\begin_layout Enumerate
+Several new environments are available:
\begin_inset Quotes eld
-\end_inset
+\end_inset
-Appendix
+Definition
\begin_inset Quotes erd
-\end_inset
+\end_inset
- which marks the beginning of the appendix.
- An appendix can contain normal sections, subsections, or subsubsections.
-\layout Enumerate
+,
+\begin_inset Quotes eld
+\end_inset
-The ijmpd package implements table captions quite differently than LyX does.
- As a result, a table created by LyX is printed correctly, but its caption
- is ignored.
- 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
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-\SpecialChar ~
-Document
-\family default
-).
- Details on how to create an ijmpd table float can be found in the file
-
-\family typewriter
-ws-ijmpd.tex
-\family default
-, which is included in the ijmpd package.
-\layout Subsection
+Step
+\begin_inset Quotes erd
+\end_inset
-Preparing a paper for submission
-\layout Standard
+,
+\begin_inset Quotes eld
+\end_inset
-Before you submit your paper you must export the LyX document as a LaTeX
- file (
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+Example
+\begin_inset Quotes erd
+\end_inset
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+,
+\begin_inset Quotes eld
+\end_inset
-\bar under
-L
-\bar default
-ateX
-\family default
-), then make the following changes to the resulting
-\family typewriter
-.tex
-\family default
- file.
-\layout Enumerate
+Remark
+\begin_inset Quotes erd
+\end_inset
-Remove the comment lines before the
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-documentclass
-\family default
- command.
-\layout Enumerate
+Notation
+\begin_inset Quotes erd
+\end_inset
-Remove everything between (and including) the
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
+Theorem
+\begin_inset Quotes erd
+\end_inset
-\backslash
-makeatother
-\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
-\layout Standard
+,
+\begin_inset Quotes eld
+\end_inset
-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.
-\layout Subsection
+Proof
+\begin_inset Quotes erd
+\end_inset
-Use of ERT
-\layout Standard
+,
+\begin_inset Quotes eld
+\end_inset
-The use of ERT is optional, and is reduced to three commands, which affect
- the look of the page.
- If you started writing your paper by using the
-\family typewriter
-ijmpd.lyx
-\family default
- template, the ERT needed is already in its place; you usually don't need
- to delete it.
- You may only change the first ERT to specify the information printed to
- the top of odd and even pages (authors' names and short paper's title,
- respectively).
- This ERT must have the form
-\family typewriter
+Corollary
+\begin_inset Quotes erd
+\end_inset
-\backslash
-markboth{Authors' Names}{Short Paper's Title}
-\family default
-.
-\layout Section
+,
+\begin_inset Quotes eld
+\end_inset
-Kluwer
-\layout Standard
+Lemma
+\begin_inset Quotes erd
+\end_inset
-by
-\noun on
-Panayotis Papasotiriou
-\layout Subsection
+,
+\begin_inset Quotes eld
+\end_inset
-Overview
-\layout Standard
+Proposition
+\begin_inset Quotes erd
+\end_inset
-The Kluwer package is a set of macros produced by Kluwer Academic Publishers
- that facilitates electronic manuscript submission to the journals they
- publish.
- Most known of them (at least in my domain of interest) are
-\emph on
+,
+\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.\InsetSpace \thinspace{}
+g.,
+\begin_inset Quotes eld
+\end_inset
+
+See Ref.\InsetSpace ~
+
+\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 ERT to overpass this problem, so that captions
+ are printed as expected.
+ To do so, create a float table as usual, remove the caption, and replace
+ it with the ERT
+\family typewriter
+
+\backslash
+tbl{
+\emph on
+your table caption
+\emph default
+}{
+\family default
+ (sic); you must also the ERT
+\family typewriter
+}
+\family default
+ immediately after the tabular material.
+ Study the example table included in the template files to see how this
+ trick is implemented.
+ Alternatively, If you need table captions, you should implement the whole
+ table float in a
+\family typewriter
+.tex
+\family default
+ file, then include this file to the LyX document (
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+Fil
+\bar under
+e
+\bar default
+\SpecialChar \menuseparator
+Chil
+\bar under
+d
+\bar default
+\InsetSpace ~
+Document
+\family default
+).
+ Details on how to create a table float can be found in the files
+\family typewriter
+ws-ijmpc.tex
+\family default
+ and
+\family typewriter
+ws-ijmpd.tex
+\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
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
+
+\bar under
+L
+\bar default
+a
+\family default
+T
+\family sans
+eX
+\family default
+)
+\begin_inset Foot
+status open
+
+\begin_layout Standard
+Actually you have the choice between LaTeX (plain) and pdflatex.
+ If you intend to use pdflatex to prepare the paper, you should use the
+ pdflatex option so that included graphics are converted to PDF format,
+ ready for use by pdflatex.
+\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 ERT
+\end_layout
+
+\begin_layout Standard
+The use of ERT is reduced to two commands, which must be placed at the top
+ of the document.
+ If you started writing your paper by using the
+\family typewriter
+ijmpc.lyx
+\family default
+ or the
+\family typewriter
+ijmpd.lyx
+\family default
+ template, the ERT needed is already in its place; you usually don't need
+ to delete it.
+ You may only modify the first ERT to specify the information printed to
+ the top of odd and even pages (authors' names and short paper's title,
+ respectively).
+ This ERT must have the form
+\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
+ can be downloaded together with the iopart package from the site
+\begin_inset LatexCommand url
+target "ftp://ftp.iop.org/pub/journals/latex2e"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsection
+Writing a paper
+\end_layout
+
+\begin_layout Standard
+The easiest way to write a paper is to start with the file
+\emph on
+IOP-article.lyx
+\emph default
+ that is available in LyX's examples files folder.
+ Open this file, save it under a new name, and start writing.
+ The example file explains how to use the special text environments.
+ Here are the most important advices:
+\end_layout
+
+\begin_layout Itemize
+To be able to compile your document to a PDF, PS, or DVI, assure that the
+ two options
+\family sans
+Use AMS math package
+\family default
+ in the document settings under
+\family sans
+Math Options
+\family default
+ are not used!
+\end_layout
+
+\begin_layout Itemize
+
+\size normal
+The title environment defines the kind of your paper.
+ So use one of the following environments for the title:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
+\family sans
+\size normal
+Title
+\family default
+ for a Paper
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Review
+\family default
+ for a Review
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Topical
+\family default
+ for a Topical review
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Comment
+\family default
+ for a Comment
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Note
+\family default
+ for a Note
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Paper
+\family default
+ for a Paper (same as Title)
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Prelim
+\family default
+ for a Preliminary communication
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Rapid
+\family default
+ for a Rapid communication
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+\size normal
+Letter
+\family default
+ for a Letter to the editor
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+
+\size normal
+All title environments except of
+\family sans
+Letter
+\family default
+ can have an optional short title.
+\end_layout
+
+\begin_layout Itemize
+There is a general title environment
+\family sans
+Article
+\family default
+ which is not directly supported by the LyX.
+ This can be used as ERT when your document doesn't fit into one of the
+ other title types.
+\end_layout
+
+\begin_layout Standard
+For more informations like hints for special table and formula formatting,
+ look at the IOP author guidelines.
+\end_layout
+
+\begin_layout Section
+Kluwer
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
+
+\begin_layout Subsection
+Overview
+\end_layout
+
+\begin_layout Standard
+The Kluwer package is a set of macros produced by Kluwer Academic Publishers
+ that facilitates electronic manuscript submission to the journals they
+ publish.
+ Most known of them (at least in my domain of interest) are
+\emph on
Astrophysics and Space Science
-\emph default
+\emph default
and
-\emph on
+\emph on
Solar Physics
-\emph default
+\emph default
, but there are many others (see a complete list at
-\begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
+\begin_inset LatexCommand url
+target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
-\end_inset
+\end_inset
).
The Kluwer package may be downloaded from the site
-\begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
+\begin_inset LatexCommand url
+target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
-\end_inset
+\end_inset
.
A complete user guide is contained in that package (but it can also be
downloaded separately).
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX supports many features of the package but not everything.
However, the ERT needed is reduced to some
\begin_inset Quotes eld
-\end_inset
+\end_inset
peculiar
\begin_inset Quotes erd
-\end_inset
+\end_inset
- commands of the package (see\SpecialChar ~
+ commands of the package (see\InsetSpace ~
-\begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
+\begin_inset LatexCommand ref
+reference "subsec:kluwer_peculiarities"
-\end_inset
+\end_inset
).
I have recently used LyX to write an article submitted to the
-\emph on
+\emph on
Astrophysics and Space Science
-\emph default
+\emph default
without any problem.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Writing a paper
-\layout Standard
+\end_layout
+\begin_layout Standard
The easiest way to write a paper is to start with the Kluwer template file.
Click on
-\family sans
+\family sans
File\SpecialChar \menuseparator
-New from
-\bar under
+New from
+\family default
+
+\family sans
+\bar under
T
-\bar default
+\bar default
emplate
-\family default
+\family default
, then choose the
-\family typewriter
+\family typewriter
kluwer.lyx
-\family default
+\family default
template.
This will give an (almost) empty document that includes the most common
fields found in a manuscript and a short description of their use.
As in most templates, simply overwrite the existing text (including the
brackets,
-\family typewriter
+\family typewriter
<>
-\family default
+\family default
) with the correct information.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Preparing a paper for submission
-\layout Standard
+\end_layout
+\begin_layout Standard
As in the AASTeX package, before you submit your paper to a journal you
must
\begin_inset Quotes eld
-\end_inset
+\end_inset
postprocess
\begin_inset Quotes erd
-\end_inset
+\end_inset
it as follows.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Export your paper as a LaTeX file.
To do this, click on
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
E
-\bar default
+\bar default
xport\SpecialChar \menuseparator
-\bar under
+\bar under
L
-\bar default
-ateX
-\family default
+\bar default
+aTeX
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Edit the resulting
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file with a text editor and make the following changes
-\begin_deeper
-\layout Enumerate
+\end_layout
+\begin_deeper
+\begin_layout Enumerate
remove the comment lines before the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
documentclass
-\family default
+\family default
command,
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
remove everything between (and including) the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
makeatletter
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
makeatother
-\family default
+\family default
commands, except for any commands you specifically put into the LaTeX preamble.
-\layout Standard
+\end_layout
+\begin_layout Standard
Save the resulting
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file.
-\end_deeper
-\layout Enumerate
+\end_layout
+\end_deeper
+\begin_layout Enumerate
Run the
-\family typewriter
+\family typewriter
.tex
-\family default
+\family default
file through LaTeX as many times as necessary (usually up to three).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
View the resulting
-\family typewriter
+\family typewriter
.dvi
-\family default
- document using, e.g.,
-\family sans
+\family default
+ document using, e.\InsetSpace \thinspace{}
+g.,
+\family sans
xdvi
-\family default
-, and check if everything is ok (it should, if you didn't make any mistake).
-\layout Subsection
-
+\family default
+, and check if everything is OK (it should, if you didn't make any mistake).
+\end_layout
+\begin_layout Subsection
\begin_inset Quotes eld
-\end_inset
+\end_inset
Peculiarities
\begin_inset Quotes erd
-\end_inset
+\end_inset
of the Kluwer package
-\begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
+\begin_inset LatexCommand label
+name "subsec:kluwer_peculiarities"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
The Kluwer package has the following
\begin_inset Quotes eld
-\end_inset
+\end_inset
peculiarities
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
It is possible to write multiple articles in the same LaTeX file
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
I can't imagine any good reason to do this.
-\end_inset
+\end_layout
+
+\end_inset
.
Each article must be included in the environment
\begin_inset Quotes eld
-\end_inset
+\end_inset
article
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
Unfortunately, this environment cannot be omitted, even if you write just
one article.
Therefore, each article starts with the command
-\family typewriter
+\family typewriter
-\backslash
+\backslash
begin{article}
-\family default
+\family default
and, obviously, ends with the command
-\family typewriter
+\family typewriter
-\backslash
+\backslash
end{article}
-\family default
+\family default
.
Although this can be implemented in LyX, I didn't included it, since it
looks ugly and can confuse the novice user.
Therefore, you need to enter them directly and mark them as LaTeX code
(the well-known
\begin_inset Quotes eld
-\end_inset
+\end_inset
ERT
\begin_inset Quotes erd
-\end_inset
+\end_inset
).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Information given at the beginning of the article (i.e., title, subtitle,
author, institution, running title, running author, abstract and keywords)
must be included in an environment called
\begin_inset Quotes eld
-\end_inset
+\end_inset
opening
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
- This is not implemented in LyX, so you must enter title, subtitle etc.
- between two ERT lines (
-\family typewriter
+ This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
+between
+ two ERT lines (
+\family typewriter
-\backslash
+\backslash
begin{opening}
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
end{opening}
-\family default
+\family default
).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
According to the user manual, the label of each bibliography item must be
written as
-\family typewriter
+\family typewriter
-\backslash
+\backslash
protect
-\backslash
+\backslash
citeauthoryear{
-\family default
-\emph on
+\family default
+\emph on
author(s)
-\family typewriter
-\emph default
+\family typewriter
+\emph default
}{
-\family default
-\emph on
+\family default
+\emph on
year
-\family typewriter
-\emph default
+\family typewriter
+\emph default
}
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family typewriter
+\family typewriter
kluwer.lyx
-\family default
+\family default
template takes care of all these
\begin_inset Quotes eld
-\end_inset
+\end_inset
peculiarities
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
If you start a new paper using this template you don't need to do anything
special.
Just
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
don't delete the ERT included in the template, and
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
copy the example bibliography item included in the template and modify it
as necessary to enter new bibliography items.
-\layout Section
+\end_layout
+\begin_layout Section
Koma-Script
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Bernd Rellermeyer
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Overview
-\layout Standard
+\end_layout
-The LyX document classes
-\emph on
- article (koma-script)
-\emph default
+\begin_layout Standard
+The LyX document classes
+\emph on
+article (koma-script)
+\emph default
,
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
,
-\emph on
+\emph on
book
-\emph default
+\emph default
-\emph on
+\emph on
(koma-script)
-\emph default
+\emph default
, and
-\emph on
+\emph on
letter
-\emph default
+\emph default
-\emph on
+\emph on
(koma-script)
-\emph default
+\emph default
correspond to the LaTeX document classes
-\family typewriter
+\family typewriter
scrartcl.cls
-\family default
+\family default
,
-\family typewriter
+\family typewriter
scrreprt.cls
-\family default
+\family default
,
-\family typewriter
+\family typewriter
scrbook.cls
-\family default
+\family default
, and
-\family typewriter
+\family typewriter
scrlettr.cls
-\family default
-, resp.
- of the Koma-Script family.
+\family default
+, resp.\InsetSpace ~
+of the Koma-Script family.
They are replacements for the standard document classes
-\family typewriter
+\family typewriter
article.cls
-\family default
+\family default
,
-\family typewriter
+\family typewriter
report.cls
-\family default
+\family default
,
-\family typewriter
+\family typewriter
book.cls
-\family default
+\family default
and
-\family typewriter
+\family typewriter
letter.cls
-\family default
+\family default
, resp., and fit better to European typography conventions in a number of
points.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Standard character size is 11pt in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
,
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
, and
-\emph on
+\emph on
book (koma-script)
-\emph default
+\emph default
, and 12pt in
-\emph on
+\emph on
letter (koma-script)
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Headings, labels of the description environment, and a number of elements
of the
-\emph on
-letter (koma-script)
-\emph default
-document class are set in a bold sans serif font.
+\emph on
+letter (koma-script)
+\emph default
+ document class are set in a bold sans serif font.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
There is a big difference between the bold sans serif old cm fonts and new
ec fonts, especially in the appearance of headings.
In comparison, the ec bold sans serif fonts look a bit thin.
Here the LaTeX package
-\family typewriter
-cmsd.sty by
-\family default
-\shape smallcaps
+\family typewriter
+cmsd.sty by
+\family default
+
+\shape smallcaps
Walter Schmidt
-\shape default
+\shape default
helps to produce the
\begin_inset Quotes eld
-\end_inset
+\end_inset
usual
\begin_inset Quotes erd
-\end_inset
+\end_inset
appearance when using the ec fonts.
-\end_inset
+\end_layout
+
+\end_inset
The numbering of chapter headings is made in the same way as the numbering
of section headings, that is without the extra line
\begin_inset Quotes eld
-\end_inset
+\end_inset
Chapter\SpecialChar \ldots{}
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
In addition, the appearance of the headings can be modified by using a
number of options (in LyX to be entered in the field
-\family sans
+\family sans
E
-\bar under
+\bar under
x
-\bar default
-tra\SpecialChar ~
+\bar default
+tra\InsetSpace ~
Options
-\family default
+\family default
of the dialog
-\family sans
-\bar under
+\family sans
+\bar under
L
-\bar default
+\bar default
ayout\SpecialChar \menuseparator
-\bar under
+\bar under
D
-\bar default
+\bar default
ocument
-\family default
+\family default
).
A detailed German description of these options can be found in the Koma-Script
documentation
-\emph on
+\emph on
scrguide
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The main means in the Koma-Script document classes to design the type area
are the options
-\family sans
+\family sans
BCOR
-\family default
+\family default
and
-\family sans
+\family sans
DIV
-\family default
+\family default
(in LyX to be entered in the extra class options field in the dialog
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
).
They make a clearer modification of page margins possible as do the options
of the dialog
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
.
A detailed German description of these and other type area options can
be found in the Koma-Script documentation
-\emph on
+\emph on
scrguide
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The LaTeX document classes of the Koma-Script family define a number of
additional commands.
Those part of it which makes sense in LyX is implemented in corresponding
paragraph types.
-\layout Standard
+\end_layout
+\begin_layout Standard
A detailed German description of the LaTeX document classes of the Koma-Script
family can be found in the Koma-Script documentation
-\emph on
+\emph on
scrguide
-\emph default
+\emph default
.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
There is an English translation
-\emph on
+\emph on
screnggu
-\emph default
+\emph default
, but it is not a complete one.
-\end_inset
+\end_layout
+
+\end_inset
The following sections describe only those aspects, which are relevant
in LyX.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
article (koma-script), report (koma-script), and book (koma-script)
-\layout Standard
+\end_layout
+\begin_layout Standard
The document classes
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
,
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
, and
-\emph on
+\emph on
book
-\emph default
+\emph default
-\emph on
+\emph on
(koma-script)
-\emph default
+\emph default
are implemented in the layout files
-\family typewriter
+\family typewriter
scrartcl.layout
-\family default
+\family default
,
-\family typewriter
+\family typewriter
scrreprt.layout
-\family default
+\family default
, and
-\family typewriter
+\family typewriter
scrbook.layout
-\family default
+\family default
, resp.
They contain all the paragraph types of the corresponding standard document
classes
-\emph on
+\emph on
article
-\emph default
+\emph default
,
-\emph on
+\emph on
report
-\emph default
+\emph default
, and
-\emph on
+\emph on
book
-\emph default
+\emph default
, resp., partly modified, with the exception of the LyX specific
-\family sans
+\family sans
List
-\family default
+\family default
-type, which is replaced by the new
-\family sans
+\family sans
Labeling
-\family default
+\family default
-type having the same functionality.
Beside the
-\family sans
+\family sans
Labeling
-\family default
+\family default
-Type there is a number of new paragraph types added.
They are
-\emph on
+\emph on
not
-\emph default
+\emph default
part of
-\emph on
+\emph on
letter (koma-script)
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Addpart, Addchap
-\family default
+\family default
,
-\family sans
+\family sans
Addsec
-\family default
+\family default
: are equivalents to
-\family sans
+\family sans
Part*, Chapter*
-\family default
+\family default
and
-\family sans
+\family sans
Section*
-\family default
+\family default
, resp., additionally inserting an entry in the table of contents.
-\family sans
-Addpart
-\family default
-and
-\family sans
- Addchap
-\family default
+\family sans
+Addpart
+\family default
+ and
+\family sans
+Addchap
+\family default
are not contained in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Addchap*
-\family default
+\family default
,
-\family sans
+\family sans
Addsec*
-\family default
+\family default
: behave exactly as
-\family sans
+\family sans
Addchap
-\family default
+\family default
and
-\family sans
+\family sans
Addsec
-\family default
+\family default
, resp., additionally clearing running heads.
-
-\family sans
- Addchap*
-\family default
+
+\family sans
+Addchap*
+\family default
is not contained in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
There is also an
-\family typewriter
+\family typewriter
-\backslash
+\backslash
addpart*
-\family default
+\family default
command in
-\emph on
+\emph on
book (koma-script)
-\emph default
+\emph default
and in
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
, but since this is identical to
-\family sans
+\family sans
Part*
-\family default
+\family default
, is has not been implemented in LyX.
-\end_inset
+\end_layout
+\end_inset
-\layout Itemize
+\end_layout
-\family sans
+\begin_layout Itemize
+
+\family sans
Minisec
-\family default
+\family default
: generates a heading directly above the following paragraph in the standard
character size without affecting the structure of the document.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Captionabove
-\family default
+\family default
and
-\family sans
-Captionbelow
-\family default
-are special captions which respect the different space settings needed for
- captions placed above or below an element (if you follow strict typographic
+\family sans
+Captionbelow
+\family default
+ are special captions which respect the different space settings needed
+ for captions placed above or below an element (if you follow strict typographic
rules, you might want to place table captions always above the table).
You can also use the class option
-\family typewriter
+\family typewriter
tablecaptionsabove
-\family default
+\family default
, which will switch
-\family sans
+\family sans
caption
-\family default
+\family default
to
-\family sans
+\family sans
captionabove
-\family default
+\family default
for tables and
-\family sans
+\family sans
captionbelow
-\family default
+\family default
for figures.
You need at least Koma-Script version 2.8q to use this.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Dictum
-\family default
+\family default
: can be used to set a bonmot, e.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
,
-\end_inset
+\end_layout
+
+\end_inset
g.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
at the beginning of a chapter.
If you use the optional argument (
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-Short\SpecialChar ~
+Short\InsetSpace ~
Title
-\family default
+\family default
), you can insert the dictum's author there.
Dictum and author are separated by a line.
You need at least Koma-Script version 2.8q to use this.
-\family sans
+\family sans
Dictum
-\family default
+\family default
is not contained in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
The following types, together with the standard types
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
, and
-\family sans
+\family sans
Date
-\family default
+\family default
, form the title area of the document.
They must be entered ahead of the first
\begin_inset Quotes eld
-\end_inset
+\end_inset
ordinary
\begin_inset Quotes erd
-\end_inset
+\end_inset
paragraph.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
The corresponding LaTeX commands must appear before the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
maketitle
-\family default
+\family default
command.
-\end_inset
+\end_layout
+
+\end_inset
When such a type is used more than once, the latter usage overwrites the
former one, that means, for every type only the latest usage is valid.
The order of the different types however has, like
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
, and
-\family sans
+\family sans
Date
-\family default
+\family default
, no effect on the appearance of the produced document.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Subject
-\family default
+\family default
: produces a centered paragraph above the ordinary title (
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
,
-\family sans
+\family sans
Date
-\family default
+\family default
) for the subject of the document.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Publishers
-\family default
+\family default
: produces a centered paragraph below the ordinary title (
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
,
-\family sans
+\family sans
Date
-\family default
+\family default
) for the publishers' name.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Dedication
-\family default
+\family default
: in
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
and
-\emph on
+\emph on
book (koma-script)
-\emph default
+\emph default
produces a centered paragraph on its own page behind the title page, or
in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
produces a centered paragraph below the ordinary title (
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
,
-\family sans
+\family sans
Date
-\family default
+\family default
,
-\family sans
+\family sans
Publishers
-\family default
+\family default
) for a dedication.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Titlehead
-\family default
+\family default
: produces a left aligned paragraph above the ordinary title (
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
,
-\family sans
+\family sans
Date
-\family default
+\family default
,
-\family sans
+\family sans
Subject
-\family default
+\family default
) for a document`s head.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Uppertitleback
-\family default
+\family default
: produces in a double-sided print in
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
and
-\emph on
+\emph on
book (koma-script)
-\emph default
+\emph default
a left-aligned paragraph at the top of the title page`s back or has no
effect in a single-sided print or in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Lowertitleback
-\family default
+\family default
: produces in a double-sided print in
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
and
-\emph on
+\emph on
book (koma-script)
-\emph default
+\emph default
a left-aligned paragraph at the bottom of the title page`s back or has
no effect in a single-sided print or in
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Extratitle
-\family default
+\family default
: produces a special
\begin_inset Quotes eld
-\end_inset
+\end_inset
dirty
\begin_inset Quotes erd
-\end_inset
+\end_inset
page ahead of the actual document containing a paragraph without special
formatting.
-\layout Standard
+\end_layout
+\begin_layout Standard
The layout files for the document classes
-\emph on
+\emph on
article (koma-script)
-\emph default
+\emph default
,
-\emph on
+\emph on
report (koma-script)
-\emph default
+\emph default
, and
-\emph on
+\emph on
book (koma-script)
-\emph default
+\emph default
do include the file
-\family typewriter
+\family typewriter
scrmacros.inc
-\family default
+\family default
.
This is thought of as a place to define your own types.
Copy s
-\family typewriter
+\family typewriter
crmacros.inc
-\family default
+\family default
in your personal layout directory and edit the file!
-\layout Subsection
+\end_layout
+\begin_layout Subsection
letter (koma-script)
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{sloppypar}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
-\noindent
+\end_layout
+
+\begin_layout Standard
+\noindent
The document class
-\emph on
+\emph on
letter (koma-script)
-\emph default
+\emph default
is implemented in the layout file
-\family typewriter
+\family typewriter
scrlettr.layout
-\family default
+\family default
.
It contains all the paragraph types of the corresponding standard document
class
-\emph on
+\emph on
letter
-\emph default
+\emph default
, partly modified, with the exception of the LyX specific types
-\family sans
+\family sans
LyX-Code
-\family default
+\family default
and
-\family sans
+\family sans
Comment
-\family default
+\family default
and the
-\family sans
+\family sans
List
-\family default
+\family default
type, which is replaced by the new
-\family sans
+\family sans
Labeling
-\family default
+\family default
type.
In addition, it contains, in contrast to the standard document class, the
standard types
-\family sans
+\family sans
LaTeX
-\family default
+\family default
,
-\family sans
+\family sans
Quotation
-\family default
+\family default
,
-\family sans
+\family sans
Quote
-\family default
+\family default
, and
-\family sans
+\family sans
Verse
-\family default
+\family default
.
Furthermore, there are a number of new letter specific types.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
end{sloppypar}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
The appearance of the letter produced by this document class can be controlled
by a number of LaTeX commands, which you can put in the LaTeX preamble.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
For example, the standard appearance of the letter`s heading, consisting
of name and address, is quite self-willed.
An
\begin_inset Quotes eld
-\end_inset
+\end_inset
ordinary
\begin_inset Quotes erd
-\end_inset
+\end_inset
heading is produced by the following LaTeX commands in the preamble:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
firsthead{
-\backslash
+\backslash
parbox[b]{
-\backslash
+\backslash
textwidth}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
{
-\backslash
+\backslash
ignorespaces
-\backslash
+\backslash
fromname
-\backslash
+\backslash
-\backslash
+\backslash
-\backslash
+\backslash
ignorespaces
-\backslash
+\backslash
fromaddress}}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
nexthead{
-\backslash
+\backslash
parbox[b]{
-\backslash
+\backslash
textwidth}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
{
-\backslash
+\backslash
ignorespaces
-\backslash
+\backslash
fromname
-\backslash
+\backslash
hfill
-\backslash
+\backslash
ignorespaces
-\backslash
+\backslash
pagename
-\backslash
+\backslash
-\backslash
+\backslash
thepage}}
-\end_inset
+\end_layout
+
+\end_inset
A detailed German description of such LaTeX commands can be found in the
Koma-Script documentation
-\emph on
+\emph on
scrguide
-\emph default
+\emph default
.
With it, the letter's author can produce his personal letter layout.
-\layout Standard
+\end_layout
+\begin_layout Standard
The types
-\family sans
-Letter
-\family default
-and
-\family sans
+\family sans
+Letter
+\family default
+ and
+\family sans
Opening
-\family default
+\family default
define the beginning of the letter and must be used in every letter.
To emphasize them in the LyX document class, they are marked with the letter
-\shape italic
+\shape italic
L
-\shape default
+\shape default
or
-\shape italic
+\shape italic
O
-\shape default
-, resp.
- in the left margin.
+\shape default
+, resp.\InsetSpace ~
+in the left margin.
It is possible to write any number of letters in one file.
An
-\family sans
+\family sans
Opening
-\family default
+\family default
type produces a new letter using the same addressee and a
-\family sans
+\family sans
Letter
-\family default
+\family default
type produces a new addressee.
The types
-\family sans
+\family sans
Closing
-\family default
+\family default
,
-\family sans
+\family sans
PS
-\family default
+\family default
,
-\family sans
+\family sans
CC
-\family default
+\family default
, and
-\family sans
+\family sans
Encl
-\family default
+\family default
are ordinary paragraph types and can also be used several times in one
and the same letter.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Letter
-\family default
+\family default
: produces a paragraph for the addressee and implicitly defines the beginning
of the letter.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Opening
-\family default
+\family default
: produces a paragraph for the form of address and implicitly produces a
new letter.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Closing
-\family default
+\family default
: produces a paragraph for a close.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
PS
-\family default
+\family default
: produces a paragraph for a postscript.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
CC
-\family default
+\family default
: produces a paragraph for a distribution list.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Encl
-\family default
+\family default
: produces a paragraph for enclosures.
-\layout Standard
+\end_layout
+\begin_layout Standard
The types
-\family sans
+\family sans
Name
-\family default
+\family default
,
-\family sans
+\family sans
Signature
-\family default
+\family default
,
-\family sans
+\family sans
Address
-\family default
-,
-\family sans
- Telephone
-\family default
+\family default
+,
+\family sans
+Telephone
+\family default
,
-\family sans
+\family sans
Place
-\family default
+\family default
,
-\family sans
+\family sans
Backaddress
-\family default
+\family default
,
-\family sans
+\family sans
Specialmail
-\family default
+\family default
,
-\family sans
+\family sans
Location
-\family default
+\family default
,
-\family sans
+\family sans
Title
-\family default
+\family default
, and
-\family sans
+\family sans
Subject
-\family default
+\family default
are input types provided with a label to enter information, which will
be processed by the document class.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status open
+\begin_layout Standard
It could be seen as a matter of inconsequence, that the types
-\family sans
+\family sans
Letter
-\family default
+\family default
and
-\family sans
+\family sans
Opening
-\family default
+\family default
described above are not such input types as well.
Because of the special meaning of those types, however, I have implemented
them as ordinary paragraph types with a one letter mark in the left margin.
Moreover, it would affect my feeling of symmetry, if the
-\family sans
+\family sans
Opening
-\family default
+\family default
type and the
-\family sans
+\family sans
Closing
-\family default
+\family default
type had such a serious different appearance.
-\end_inset
+\end_layout
+
+\end_inset
The types must be used ahead of the corresponding
-\family sans
+\family sans
Opening
-\family default
+\family default
type.
-\layout Standard
+\end_layout
+\begin_layout Standard
An implementation of these types in a WYSIWYG fashion does not seem to make
sense, because the real appearance of the produced letter does not only
depend on the usage of the particular type, but also on other factors.
For example, a signature entered in the
-\family sans
+\family sans
Signature
-\family default
+\family default
type will in the standard behavior appear in the produced letter only,
when in the same letter also a
-\family sans
+\family sans
Closing
-\family default
+\family default
type is used.
The entered value of the
-\family sans
+\family sans
Telephone
-\family default
+\family default
type will in the standard behavior not appear in the produced letter at
all.
The possibility to design the letter`s heading freely is already indicated
in a footnote above.
-\layout Standard
+\end_layout
+\begin_layout Standard
The input types can also be used as empty paragraphs.
- This makes sense e.\SpecialChar ~
-g.
- for the
-\family sans
+ This makes sense e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+for the
+\family sans
Signature
-\family default
+\family default
type.
If the
-\family sans
+\family sans
Signature
-\family default
+\family default
type is not used at all, in the standard behavior the value of the
-\family sans
+\family sans
Name
-\family default
+\family default
type is used as signature, whereas if an empty
-\family sans
+\family sans
Signature
-\family default
+\family default
type is used, no signature value is defined.
-\layout Standard
+\end_layout
+\begin_layout Standard
By using the input types it is possible to write a letter template, containing
filled input types with your personal dates (name, address, etc.) and empty
input types for other dates you want to enter.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Name
-\family default
+\family default
: sender's name, in the standard behavior appears as a centered paragraph
in small caps in the letter`s heading.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Signature
-\family default
+\family default
: sender's signature, in the standard behavior appears below the
-\family sans
+\family sans
Closing
-\family default
+\family default
type.
If no
-\family sans
+\family sans
Signature
-\family default
+\family default
type is used, the value of the
-\family sans
+\family sans
Name
-\family default
+\family default
type appears instead.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Address
-\family default
+\family default
: sender's address, in the standard behavior appears in a centered paragraph
in the letter`s heading below the sender's name.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Telephone
-\family default
+\family default
: sender's telephone number, in the standard behavior only sets the LaTeX
variable
-\family typewriter
+\family typewriter
-\backslash
+\backslash
telephonenum
-\family default
+\family default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Place
-\family default
+\family default
: place of the letter`s making.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Date
-\family default
+\family default
: date of the letter`s making.
-\family sans
+\family sans
Place
-\family default
+\family default
and
-\family sans
+\family sans
Date
-\family default
+\family default
, in the standard behavior, produce the place and the date in a right-aligned
line below the addressee's field.
If an empty
-\family sans
+\family sans
Date
-\family default
+\family default
type is used, neither place nor date appear, independent of the value of
the
-\family sans
+\family sans
Place
-\family default
+\family default
type.
If no
-\family sans
+\family sans
Date
-\family default
+\family default
type is used, the date of the letter `s production is used.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Backaddress
-\family default
+\family default
: sender`s back address, in the standard behavior appears above the addressee's
field in a small sans serif font.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Specialmail
-\family default
+\family default
: special mail information, in the standard behavior appears underlined
above the addressee's field below the back address.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Location
-\family default
+\family default
: additional information, in the standard behavior appears on right side
below the addressee`s field.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\family default
+\family default
: the letter's title, in the standard behavior appears in a big, bold, sans
serif font above the subject.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Subject
-\family default
+\family default
: the letter's subject, in the standard behavior appears in a bold font
above the
-\family sans
+\family sans
Opening
-\family default
+\family default
paragraph.
-\layout Standard
+\end_layout
+\begin_layout Standard
The types
-\family sans
+\family sans
Yourref
-\family default
+\family default
,
-\family sans
+\family sans
Yourmail
-\family default
+\family default
,
-\family sans
+\family sans
Myref
-\family default
+\family default
,
-\family sans
+\family sans
Customer
-\family default
+\family default
, and
-\family sans
+\family sans
Invoice
-\family default
+\family default
produce a business letter like line above the
-\family sans
+\family sans
Title
-\family default
+\family default
line containing the fields
\begin_inset Quotes eld
-\end_inset
+\end_inset
Your ref.
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
Your letter of
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
Our ref.
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
Customer no.
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
Invoice no.
\begin_inset Quotes erd
-\end_inset
+\end_inset
, and
\begin_inset Quotes eld
-\end_inset
+\end_inset
Date
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
For the date field, the value of the
-\family sans
+\family sans
Date
-\family default
+\family default
type is used.
If one of these
\begin_inset Quotes eld
-\end_inset
+\end_inset
business letter types
\begin_inset Quotes erd
-\end_inset
+\end_inset
is used, the value of the
-\family sans
+\family sans
Place
-\family default
+\family default
type however does not appear, but only the LaTeX variable
-\family typewriter
+\family typewriter
-\backslash
+\backslash
fromplace
-\family default
+\family default
is set.
The ordinary output of place and date in a right-aligned line below the
addressee`s field is suppressed.
The types are implemented as input types provided with a label and must
be used ahead of the corresponding
-\family sans
+\family sans
Opening
-\family default
+\family default
type.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Yourref
-\family default
+\family default
: Your ref.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Yourmail
-\family default
+\family default
: Your letter of.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Myref
-\family default
+\family default
: Our ref.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Customer
-\family default
+\family default
: Customer no.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Invoice
-\family default
+\family default
: Invoice no.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
The new letter class: letter (koma-script v.2)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
-Jürgen Spitzmüller
-\layout Standard
-\added_space_top medskip \noindent
+\noun on
+Jürgen Spitzmüller
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
Koma-Script version 2.8 has introduced a new letter class
-\family typewriter
+\family typewriter
scrlttr2
-\family default
- which superceeds the now unsupported
-\family typewriter
+\family default
+ which supersedes the now unsupported
+\family typewriter
scrlettr
-\family default
+\family default
.
It has --- on the LaTeX side --- a completely new interface and is not
compatible with the old class.
Therefore, LyX supports both, though it is recommended to use the new class.
-\layout Standard
+\end_layout
+\begin_layout Standard
This class covers the same functionality as
-\emph on
+\emph on
letter (koma-script),
-\emph default
+\emph default
and a few more.
The basic items are
-\family sans
+\family sans
Address
-\family default
+\family default
(receiver's address, same as
-\family sans
+\family sans
Letter
-\family default
+\family default
in the old layout),
-\family sans
+\family sans
Opening
-\family default
+\family default
, and
-\family sans
+\family sans
Closing
-\family default
+\family default
.
-\family sans
+\family sans
NextAddress
-\family default
+\family default
will start a new letter (i.
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
,
-\end_inset
+\end_layout
+
+\end_inset
e.
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
you can write several letters per document).
New elements are sender's
-\family sans
+\family sans
E-Mail
-\family default
+\family default
,
-\family sans
+\family sans
URL
-\family default
+\family default
,
-\family sans
+\family sans
Fax
-\family default
+\family default
,
-\family sans
+\family sans
Bank
-\family default
+\family default
and the possibility to use a
-\family sans
+\family sans
Logo
-\family default
+\family default
(via
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
nsert\SpecialChar \menuseparator
-\bar under
+\bar under
G
-\bar default
+\bar default
raphics
-\family default
+\family default
) in the header.
-\layout Standard
+\end_layout
+\begin_layout Standard
The biggest improvement is, though, that the letter's layout is configurable
at almost any needs.
This can be done via the preamble or with a special style file (Letter
Class Option, extension
-\family typewriter
+\family typewriter
*.lco
-\family default
+\family default
), that will be read in as a class option.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
The KOMA package comes with some default
-\family typewriter
+\family typewriter
*.lco
-\family default
+\family default
files.
There is, for instance, a
-\family typewriter
+\family typewriter
DIN.lco
-\family default
+\family default
file that follows german typesetting rules, or a
-\family typewriter
+\family typewriter
KOMAold.lco
-\family default
+\family default
that provides the default layout of the old
-\family typewriter
+\family typewriter
scrlettr
-\family default
+\family default
class.
The latter can be loaded with the class option
-\family typewriter
+\family typewriter
KOMAold
-\family default
+\family default
, inserted via the
-\family sans
-\bar under
+\family sans
+\bar under
L
-\bar default
+\bar default
ayout\SpecialChar \menuseparator
-\bar under
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-Extra Options
-\family default
-field.
-\end_inset
+Extra Options
+\family default
+ field.
+\end_layout
+
+\end_inset
Have a look at the
-\emph on
+\emph on
koma-letter2
-\emph default
+\emph default
template that is included in LyX for examples.
A detailed description is to be found in the Koma-Script documentation
(
-\emph on
+\emph on
scrguide
-\emph default
+\emph default
).
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Problems
-\layout Standard
+\end_layout
+\begin_layout Standard
Visualizing the Koma-Script document classes in LyX, the LyX internals cause
some problems.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The chapter number of a
-\family sans
+\family sans
Chapter
-\family default
+\family default
type appears on a line of its own above the chapter heading instead of
appearing in the same line ahead of it.
The cause for that is the LyX internal behavior for the labeltype
-\family sans
+\family sans
Counter_Chapter
-\family default
+\family default
in the layout file.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The headings of the types
-\family sans
+\family sans
Addchap
-\family default
+\family default
and
-\family sans
+\family sans
Addsec
-\family default
+\family default
are only put in the
\begin_inset Quotes eld
-\end_inset
+\end_inset
true
\begin_inset Quotes erd
-\end_inset
+\end_inset
LaTeX table of contents, but not in the LyX table of contents (
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
T
-\bar default
-able\SpecialChar ~
-of\SpecialChar ~
+\bar default
+able\InsetSpace ~
+of\InsetSpace ~
Contents
-\family default
+\family default
).
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The paragraphs in a
-\emph on
+\emph on
letter
-\emph default
+\emph default
document class appear in a skip separation mode, not indented.
This is the standard behavior, no special LaTeX commands are needed for
that.
But in the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog the corresponding radio button indicates
-\family sans
-\bar under
+\family sans
+\bar under
I
-\bar default
+\bar default
ndent
-\family default
+\family default
.
A
-\family sans
+\family sans
S
-\bar under
+\bar under
k
-\bar default
+\bar default
ip
-\family default
+\family default
value always has the effect that extra LaTeX commands are inserted in the
document to produce the gap, which is not what is wanted in this case.
-\layout Section
+\end_layout
+\begin_layout Section
Springer Journals (
-\family sans
+\family sans
svjour
-\family default
+\family default
)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Martin Vermeer
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Description
-\layout Standard
+\end_layout
+\begin_layout Standard
These are the layout files for some of the journal formats used by Springer
Verlag and listed on
-\begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
+\begin_inset LatexCommand url
+target "http://www.springer.de/author/tex/help-journals.html"
-\end_inset
+\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
+\family typewriter
svjour.inc
-\family default
-, which journal-specific layout files (such as, e.g.,
-\family typewriter
+\family default
+, which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
+g.,
+\family typewriter
svjog.layout
-\family default
+\family default
for Journal of Geodesy) can include.
-\layout Standard
+\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
+\family typewriter
sv
-\family default
+\family default
<myjournal>
-\family typewriter
+\family typewriter
.layout
-\family default
+\family default
file following the outline given in
-\family typewriter
+\family typewriter
svjog.layout
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
It is reasonably well tested only for the Journal of Geodesy.
-\family typewriter
+\family typewriter
svjour
-\family default
+\family default
and
-\family typewriter
+\family typewriter
svjog
-\family default
+\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
+\family typewriter
texhash
-\family default
+\family default
, as root if necessary --- doesn't LyX take care of this?), reconfigure
LyX and it should work.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
New styles
-\layout Standard
+\end_layout
+\begin_layout Standard
A large number of theorem-like styles ---
-\family sans
+\family sans
Claim, Conjecture,
-\family default
+\family default
-\family sans
+\family sans
\SpecialChar \ldots{}
Theorem
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family sans
+\family sans
Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
-\family default
+\family default
.
See the Springer class file documentation for details.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Supported journals
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\emph on
+\emph on
Journal of Geodesy
-\emph default
+\emph default
:
-\family typewriter
-svjog.layout
-\family default
---- Martin Vermeer
-\layout Itemize
+\family typewriter
+svjog.layout
+\family default
+ --- Martin Vermeer
+\end_layout
+\begin_layout Itemize
-\emph on
+\emph on
Probability Theory and Related Fields
-\emph default
+\emph default
:
-\family typewriter
+\family typewriter
svprobth.layout
-\family default
+\family default
--- Jean-Marc Lasgouttes
-\layout Standard
+\end_layout
+\begin_layout Standard
Add your own, it isn't so hard!
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Credits
-\layout Standard
+\end_layout
+\begin_layout Standard
These files are partly based on the older
-\family typewriter
+\family typewriter
ejour2.layout
-\family default
+\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
+\family typewriter
ejour2
-\family default
+\family default
layout, are now defunct.
Jean-Marc Lasgouttes helped out big in making me find my way around the
LyX layout file mechanism.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Bugs
-\layout Standard
+\end_layout
+\begin_layout Standard
Probably.
But probably less than in the old hacked-LaTeX
-\family typewriter
+\family typewriter
ejour2
-\family default
+\family default
.
-\layout Standard
+\end_layout
-Limitations e.g.: does not display the number for theorem-like layouts, just
+\begin_layout Standard
+Limitations e.\InsetSpace \thinspace{}
+g.: does not display the number for theorem-like layouts, just
#.
-\layout Section
+\end_layout
+\begin_layout Section
AGU journals (
-\family sans
+\family sans
aguplus
-\family default
+\family default
)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\shape smallcaps
+\shape smallcaps
Martin Vermeer
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Description
-\layout Standard
+\end_layout
+\begin_layout Standard
These are the layout files for some of the journals of the American Geophysical
Society.
It is assumed that you have both the AGU's own class files and AGUplus
installed (everything to be found at
-\begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
+\begin_inset LatexCommand url
+target "ftp://ftp.agu.org/journals/latex/journals"
-\end_inset
+\end_inset
).
-\layout Subsection
+\end_layout
+\begin_layout Subsection
New styles
-\layout Standard
+\end_layout
+\begin_layout Standard
Redefined are
-\family sans
+\family sans
Paragraph
-\family default
+\family default
,
-\family sans
+\family sans
Paragraph*
-\family default
+\family default
.
They are still called this in the LyX GUI, though their LaTeX equivalents
in the AGU classes are
-\family sans
+\family sans
Subsubsubsection
-\family default
+\family default
and
-\family sans
+\family sans
Subsubsubsection*
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
Newly defined styles are
-\family sans
+\family sans
Left_Header
-\family default
+\family default
,
-\family sans
+\family sans
Right_Header
-\family default
+\family default
,
-\family sans
+\family sans
Received
-\family default
+\family default
,
-\family sans
+\family sans
Revised
-\family default
+\family default
,
-\family sans
+\family sans
Accepted
-\family default
+\family default
,
-\family sans
+\family sans
CCC
-\family default
+\family default
,
-\family sans
+\family sans
PaperId
-\family default
+\family default
,
-\family sans
+\family sans
AuthorAddr
-\family default
+\family default
,
-\family sans
+\family sans
SlugComment
-\family default
+\family default
.
These are mostly manuscript attributes and defined in the AGU class documentati
on.
-\layout Standard
+\end_layout
+\begin_layout Standard
I suspect this is still badly incomplete.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
New floats
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family sans
+\family sans
Planotable
-\family default
+\family default
and
-\family sans
+\family sans
Plate
-\family default
+\family default
.
We also have a new
-\family sans
+\family sans
Table_Caption
-\family default
+\family default
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Supported journals
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\emph on
+\emph on
Journal of Geophysical Research
-\emph default
+\emph default
:
-\family typewriter
-jgrga.layout
-\family default
---- Martin Vermeer
-\layout Standard
+\family typewriter
+jgrga.layout
+\family default
+ --- Martin Vermeer
+\end_layout
+\begin_layout Standard
Add your own, it isn't so hard! Look at the
-\family typewriter
+\family typewriter
jgrga.layout
-\family default
+\family default
example and
-\family typewriter
+\family typewriter
aguplus.inc
-\family default
+\family default
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Bugs and things to remember
-\layout Standard
+\end_layout
+\begin_layout Standard
In order to use the new layouts, you must remember to do the following for
a new document:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\emph on
+\emph on
Turn off babel
-\emph default
+\emph default
.
This can be done in the
-\family sans
+\family sans
layout\SpecialChar \menuseparator
document
-\family default
+\family default
or
-\family sans
+\family sans
document\SpecialChar \menuseparator
settings
-\family default
+\family default
menu item.
(AGU articles are always in English, right? So
-\emph on
+\emph on
don't
-\emph default
+\emph default
choose a language.)
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Enter
-\family typewriter
+\family typewriter
jgrga
-\family default
+\family default
into the document's
-\family sans
+\family sans
Extra Options
-\family default
+\family default
field.
(Yes, this is a bug.)
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Make sure you use the
-\family typewriter
+\family typewriter
agu.bst
-\family default
+\family default
bibliography style, by entering
-\family sans
+\family sans
agu
-\family default
+\family default
into the second field of the BibTeX inset.
None of the standard styles will do.
-\layout Section
+\end_layout
+\begin_layout Section
EGS journals (
-\family sans
+\family sans
egs
-\family default
+\family default
)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\shape smallcaps
+\shape smallcaps
Martin Vermeer
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Description
-\layout Standard
+\end_layout
+\begin_layout Standard
This is the layout file for the European Geophysical Society journals.
The needed
-\family typewriter
+\family typewriter
egs.cls
-\family default
+\family default
can be downloaded from the web site of the EGS under
-\begin_inset LatexCommand \url{www.copernicus.org}
+\begin_inset LatexCommand url
+target "www.copernicus.org"
-\end_inset
+\end_inset
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
New styles
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family sans
+\family sans
Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
Accepted
-\family default
+\family default
,
-\family sans
+\family sans
Offsets
-\family default
+\family default
.
The current layout file is unfortunately very unmodular and would benefit
from using the various
-\family typewriter
+\family typewriter
std*.inc
-\family default
+\family default
file inclusions.
-\layout Section
+\end_layout
+\begin_layout Section
Slides [aka
-\noun on
+\noun on
Sli
-\noun default
+\noun default
TeX]
-\begin_inset LatexCommand \label{sec:slitex}
+\begin_inset LatexCommand label
+name "sec:slitex"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
John Weiss
-\noun default
+\noun default
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\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
+\family sans
Foil
-\family default
+\family default
TeX slides class.
This section documents the former.
-\layout Standard
+\end_layout
+\begin_layout Standard
I'm going to say this again, nice and clear, so that there's no misunderstanding
:
-\layout Standard
-\added_space_top bigskip \added_space_bottom bigskip \align center
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-\size large
+\end_layout
+
+\begin_layout Standard
+\align center
+
+\size large
This section documents the class
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (default)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\emph on
+\emph on
only.
-\layout Standard
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+\end_layout
+
+\begin_layout Standard
If you're looking for the documentation for
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (FoilTeX)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, check out section\SpecialChar ~
+, check out section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:foiltex}
+\begin_inset LatexCommand ref
+reference "sec:foiltex"
-\end_inset
+\end_inset
.
The
-\family sans
-foils
-\family default
-class [
+\family sans
+foils
+\family default
+ class [
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (FoilTeX)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
] is actually somewhat better than the default
-\family sans
+\family sans
slides
-\family default
+\family default
class,
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
\SpecialChar \ldots{}
or so I've been told repeatedly by its advocates.
Having never used it, I have no idea if this claim is true or not.
-\end_inset
+\end_layout
+
+\end_inset
which this section documents.
-\layout Standard
+\end_layout
+\begin_layout Standard
This class is the LaTeX2e improvement of the old
-\noun on
+\noun on
Sli
-\noun default
+\noun default
TeX package.
Every LaTeX2e distribution includes this class [which I'll just refer to
as
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
from now on], so you're bound to have it.
As I noted earlier, there are other classes, such as
-\family sans
+\family sans
foils
-\family default
+\family default
, which also produce slides for overhead projectors and do a better job
at it.
However, there are some things which
-\family sans
+\family sans
slides
-\family default
+\family default
can do which the others can't, such as generate overlays.
Read on to learn more!
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Getting Started
-\begin_inset LatexCommand \label{sec:slidesetup}
+\begin_inset LatexCommand label
+name "sec:slidesetup"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Obviously, to use this document class, you need to select
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (default)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
from the class list in the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog.
There are some other special things you should know about this class:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Don't bother changing the options
-\family sans
+\family sans
Sides and Columns
-\family default
+\family default
.
They're not supported by the
-\family sans
+\family sans
slides
-\family default
+\family default
class, anyways.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The option
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
-age\SpecialChar ~
+\bar default
+age\InsetSpace ~
style
-\family default
+\family default
behaves a bit differently for this class.
The possible choices and what they do are as follows:
-\begin_deeper
-\layout Description
+\end_layout
+\begin_deeper
+\begin_layout Description
-\family sans
+\family sans
plain
-\family default
+\family default
The final output contains page numbers in the lower right corner.
-\layout Description
+\end_layout
+\begin_layout Description
-\family sans
+\family sans
headings
-\family default
+\family default
Like
-\family sans
+\family sans
plain
-\family default
+\family default
, but also prints out any time markers you've put in.
This is the default.
-\layout Description
+\end_layout
+\begin_layout Description
-\family sans
+\family sans
empty
-\family default
+\family default
The final output contains no page numbers, time markers, or alignment markers.
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
The
-\family sans
+\family sans
slides
-\family default
+\family default
class has an extra option:
-\family typewriter
+\family typewriter
clock
-\family default
+\family default
.
To use it, put
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
clock
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
in the extra class options.
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Using this options allows you to add time markers to
-\family sans
+\family sans
Note
-\family default
+\family default
s.
- See section\SpecialChar ~
+ See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideNote}
+\begin_inset LatexCommand ref
+reference "sec:slideNote"
-\end_inset
+\end_inset
for more details.
-\end_deeper
-\layout Standard
+\end_layout
+\end_deeper
+\begin_layout Standard
You can also use the template file
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
slides.lyx
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
to automatically set up a document to use the
-\family sans
-slides
-\family default
-class [using
-\family sans
-\bar under
+\family sans
+slides
+\family default
+ class [using
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-New\SpecialChar ~
-from\SpecialChar ~
+New\InsetSpace ~
+from\InsetSpace ~
-\bar under
+\bar under
T
-\bar default
+\bar default
emplate
-\family default
+\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.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Paragraph Environments
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Supported Environments
-\layout Standard
+\end_layout
+\begin_layout Standard
The first thing you'll notice when you start up a new
-\family sans
-slides
-\family default
-document is the font size and type: it's the equivalent of the size
+\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
+\end_inset
-\family sans
+\family sans
Largest
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
in the
-\family sans
-Sans\SpecialChar ~
+\family sans
+Sans\InsetSpace ~
Serif
-\family default
+\family default
font.
This is also what's used in the output.
Think of this as a
\begin_inset Quotes eld
-\end_inset
+\end_inset
visual cue
\begin_inset Quotes erd
-\end_inset
+\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.
-\layout Standard
+\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
+\family sans
slides
-\family default
+\family default
class itself only supports certain paragraph environments:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Itemize
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Enumerate
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Description
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
List
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Quotation
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Quote
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Verse
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Caption
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
LyX-Code
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Comment
-\layout Standard
+\end_layout
+\begin_layout Standard
All of the other standard environments, including the section-heading environmen
ts, aren't used in the
-\family sans
+\family sans
slides
-\family default
+\family default
class.
-\layout Standard
+\end_layout
+\begin_layout Standard
On the other hand, you'll notice the following new environments:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Slide
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Overlay
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Note
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
InvisibleText
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
VisibleText
-\layout Standard
+\end_layout
+\begin_layout Standard
These five are kind of quirky, due to a
\begin_inset Quotes eld
-\end_inset
+\end_inset
feature
\begin_inset Quotes erd
-\end_inset
+\end_inset
in LyX.
You see, LyX doesn't permit you to nest any other paragraph environment
a slide with anything except plain text.
To deal with this, I've performed a little
\begin_inset Quotes eld
-\end_inset
+\end_inset
LaTeX magic.
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Quirks of the New Environments
-\begin_inset LatexCommand \label{sec:slideQuirk}
+\begin_inset LatexCommand label
+name "sec:slideQuirk"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
All five of the new paragraph environments are somewhat quirky due to inherent
limitiations in the current version of LyX.
As I just mentioned, LyX forbids environments that begin with another environme
nt.
To get around this, the
-\family sans
+\family sans
Slide
-\family default
+\family default
environment isn't a paragraph environment as described in the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
You should consider
-\family sans
+\family sans
Slide
-\family default
+\family default
,
-\family sans
+\family sans
Overlay
-\family default
+\family default
, and
-\family sans
+\family sans
Note
-\family default
+\family default
to be
\begin_inset Quotes eld
-\end_inset
+\end_inset
pseudo-environments.
\begin_inset Quotes erd
-\end_inset
+\end_inset
They look like a section heading or a
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
Caption
-\family default
+\family default
,
\begin_inset Quotes erd
-\end_inset
+\end_inset
but really begin a [and, if necessary, end the previous] paragraph environment.
Likewise, treat
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\family default
as
\begin_inset Quotes eld
-\end_inset
+\end_inset
pseudo-commands.
\begin_inset Quotes erd
-\end_inset
+\end_inset
These two perform some action.
-\layout Standard
+\end_layout
+\begin_layout Standard
A common feature of all five environments,
-\family sans
+\family sans
Slide
-\family default
+\family default
,
-\family sans
+\family sans
Overlay
-\family default
+\family default
,
-\family sans
+\family sans
Note
-\family default
+\family default
,
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\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
+\family sans
Slide
-\family default
+\family default
,
-\family sans
+\family sans
Overlay
-\family default
+\family default
,
-\family sans
+\family sans
Note
-\family default
+\family default
,
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\family default
.
LyX completely ignores it.
In fact, you can leave these five environments completely empty.
-\layout Standard
+\end_layout
+\begin_layout Standard
While you don't
-\emph on
+\emph on
have
-\emph default
+\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
+\family sans
Slide
-\family default
+\family default
, for example.
In that case, enter in your descriptive comment and hit
-\family sans
+\family sans
Return
-\family default
+\family default
as you normally would.
-\layout Standard
+\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:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Start entering the text that will
-\emph on
+\emph on
follow
-\emph default
+\emph default
the new
-\family sans
+\family sans
Slide
-\family default
+\family default
,
-\family sans
+\family sans
Overlay
-\family default
+\family default
,
-\family sans
+\family sans
Note
-\family default
+\family default
,
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
or
-\family sans
+\family sans
VisibleText
-\family default
+\family default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Now move to the beginning of that paragraph.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Next, hit
-\family sans
+\family sans
Return
-\family default
+\family default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Finally, change this new, empty paragraph to a
-\family sans
+\family sans
Slide
-\family default
+\family default
,
-\family sans
+\family sans
Overlay
-\family default
+\family default
,
-\family sans
+\family sans
Note
-\family default
+\family default
,
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
or
-\family sans
+\family sans
VisibleText
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Making a Presentation with
-\family sans
+\family sans
Slide
-\family default
-,
-\family sans
- Overlay
-\family default
+\family default
+,
+\family sans
+Overlay
+\family default
and
-\family sans
+\family sans
Note
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Using the
-\family sans
+\family sans
Slide
-\family default
+\family default
Environment
-\layout Standard
+\end_layout
+\begin_layout Standard
If you're expecting this section to teach you how to actually make a presentatio
n, you'll be sorely disappointed.
Naturally, I'll describe all of the ways the
-\family sans
+\family sans
slides
-\family default
+\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
+\emph on
is
-\emph default
+\emph default
the LyX philosophy.]
-\layout Standard
+\end_layout
+\begin_layout Standard
Choosing the
-\family sans
+\family sans
Slide
-\family default
- environment [in the manner described in section\SpecialChar ~
+\family default
+ environment [in the manner described in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideQuirk}
+\begin_inset LatexCommand ref
+reference "sec:slideQuirk"
-\end_inset
+\end_inset
] tells LyX to begin a new slide [duh].
The label for this environment/
\begin_inset Quotes erd
-\end_inset
+\end_inset
pseudo-command
\begin_inset Quotes erd
-\end_inset
+\end_inset
is an
\begin_inset Quotes eld
-\end_inset
+\end_inset
ASCII line,
\begin_inset Quotes erd
-\end_inset
+\end_inset
in cool blue, followed by the label,
\begin_inset Quotes eld
-\end_inset
+\end_inset
NewSlide:
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
Any text or paragraph environments that follow this one go on the new slide.
It's that simple.
-\layout Standard
+\end_layout
+\begin_layout Standard
Slides are probably the only time you'll need to forcibly end pages in LyX
(this can be specified in the
-\family sans
+\family sans
Paragraph Layout
-\family default
+\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
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
+\family sans
Overlay
-\family default
+\family default
you've made to accompany the oversized
-\family sans
+\family sans
Slide
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family sans
+\family sans
Overlay
-\family default
+\family default
and
-\family sans
+\family sans
Note
-\family default
+\family default
environments work the same way as the
-\family sans
-Slide
-\family default
-environment.
+\family sans
+Slide
+\family default
+ environment.
They both create an
\begin_inset Quotes eld
-\end_inset
+\end_inset
ASCII line
\begin_inset Quotes erd
-\end_inset
+\end_inset
followed by a label [
\begin_inset Quotes eld
-\end_inset
+\end_inset
NewOverlay:
\begin_inset Quotes erd
-\end_inset
+\end_inset
and
\begin_inset Quotes eld
-\end_inset
+\end_inset
NewNote:
\begin_inset Quotes erd
-\end_inset
+\end_inset
, respectively].
The color is a stunning magenta instead of blue, and the
\begin_inset Quotes eld
-\end_inset
+\end_inset
ASCII line
\begin_inset Quotes erd
-\end_inset
+\end_inset
will look different, in style and in length.
The label fonts of all three also differ from one another.
-\layout Standard
+\end_layout
+\begin_layout Standard
As with a
-\family sans
+\family sans
Slide
-\family default
+\family default
, if the contents of a
-\family sans
+\family sans
Note
-\family default
+\family default
or
-\family sans
+\family sans
Overlay
-\family default
+\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
+\family sans
Note
-\family default
+\family default
s and
-\family sans
+\family sans
Overlay
-\family default
+\family default
s.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Using
-\family sans
+\family sans
Overlay
-\family default
+\family default
with
-\family sans
+\family sans
Slide
-\layout Standard
+\end_layout
+\begin_layout Standard
The idea behind an
-\family sans
+\family sans
Overlay
-\family default
+\family default
is a slide that sits atop another slide.
Perhaps you wish to discuss a figure on the main
-\family sans
+\family sans
Slide
-\family default
+\family default
before displaying the text associated with it.
One way to accomplish this is tape a flap of dark paper over the part of
the
-\family sans
+\family sans
Slide
-\family default
+\family default
you want to display later.
This method fails, however, if you wish to overlap one graph with another,
for example.
You would then have to fumble while speaking to align the two separate,
overlapping
-\family sans
+\family sans
Slide
-\family default
+\family default
s to align the two graphs.
The use of an
-\family sans
+\family sans
Overlay
-\family default
+\family default
environment in both cases makes life much easier.
-\layout Standard
+\end_layout
+\begin_layout Standard
Each
-\family sans
+\family sans
Overlay
-\family default
+\family default
receives the page number of its
\begin_inset Quotes eld
-\end_inset
+\end_inset
parent
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\family sans
+\family sans
Slide
-\family default
+\family default
, appended by
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-a
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Presumably, mutliple
-\family sans
+\family sans
Overlay
-\family default
+\family default
s would have
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-a
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-b
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-c
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, etc.\SpecialChar ~
+, etc.\InsetSpace ~
appended to the page number of the parent
-\family sans
+\family sans
Slide
-\family default
+\family default
.
-\end_inset
+\end_layout
+
+\end_inset
Clearly, you want the contents of both the
-\family sans
+\family sans
Slide
-\family default
+\family default
and the
-\family sans
+\family sans
Overlay
-\family default
+\family default
to each fit on a single physical slide! You should probably consider an
-\family sans
+\family sans
Overlay
-\family default
+\family default
as
\begin_inset Quotes eld
-\end_inset
+\end_inset
part of
\begin_inset Quotes erd
-\end_inset
+\end_inset
a
-\family sans
+\family sans
Slide
-\family default
+\family default
.
Indeed, the LyX
-\family sans
+\family sans
slides
-\family default
+\family default
class provides a visual cue for this: the label at the start of an
-\family sans
+\family sans
Overlay
-\family default
+\family default
is shorter than that at the start of a
-\family sans
+\family sans
Slide
-\family default
+\family default
.
Lastly, when you generate printable output, you'll find alignment markers
in all four corners of both the
-\family sans
+\family sans
Overlay
-\family default
+\family default
page and its parent
-\family sans
+\family sans
Slide
-\family default
+\family default
.
These will assist you in lining up the two physical slides.
-\layout Standard
+\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
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
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
As their names imply,
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\family default
are two command-like paragraph environments that make all subsequent text
invisible and visible, respectively.
- Note from section\SpecialChar ~
+ Note from section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideQuirk}
+\begin_inset LatexCommand ref
+reference "sec:slideQuirk"
-\end_inset
+\end_inset
that you don't place anything
-\emph on
+\emph on
into
-\emph default
+\emph default
these two environments, however.
When you create an
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
, it inserts a centered, sky-blue label into the page reading
\begin_inset Quotes eld
-\end_inset
+\end_inset
<Invisible Text Follows>
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
For paragraphs following this label, the parts of the
-\family sans
+\family sans
Slide
-\family default
+\family default
[or
-\family sans
+\family sans
Overlay
-\family default
+\family default
; it doesn't matter which] where they would be contain instead blank space.
-\layout Standard
+\end_layout
+\begin_layout Standard
For
-\family sans
+\family sans
VisibleText
-\family default
+\family default
, the corresponding centered label is
\begin_inset Quotes eld
-\end_inset
+\end_inset
<Visible Text Follows>
\begin_inset Quotes erd
-\end_inset
+\end_inset
in blazing green.
Paragraphs following this label behave normally.
Note that the beginning of a new
-\family sans
+\family sans
Slide
-\family default
+\family default
,
-\family sans
+\family sans
Overlay
-\family default
+\family default
, or
-\family sans
+\family sans
Note
-\family default
+\family default
automatically shuts off an
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
.
It's therefore not necessary to use
-\family sans
+\family sans
VisibleText
-\family default
+\family default
at the end of a
-\family sans
+\family sans
Slide
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
By now, it should be obvious how to create overlay transparencies using
the proper combination of
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\family default
on a
-\family sans
+\family sans
Slide
-\family default
+\family default
and
-\family sans
+\family sans
Overlay
-\family default
+\family default
:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Create a
-\family sans
+\family sans
Slide
-\family default
+\family default
, including everything that will appear on it, whether on the main slide
or on the
-\family sans
+\family sans
Overlay
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Before each figure or paragraph that will appear only on the
-\family sans
+\family sans
Overlay
-\family default
+\family default
, insert an
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
environment.
If necessary, insert a
-\family sans
+\family sans
VisibleText
-\family default
+\family default
environment after the
-\family sans
+\family sans
Overlay
-\family default
+\family default
-only text.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Start an
-\family sans
+\family sans
Overlay
-\family default
+\family default
immediately following the
-\family sans
+\family sans
Slide
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Copy the contents of this
-\family sans
+\family sans
Slide
-\family default
+\family default
into the
-\family sans
+\family sans
Overlay
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
Within the
-\family sans
+\family sans
Overlay
-\family default
+\family default
, change all of the
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
lines to
-\family sans
+\family sans
VisibleText
-\family default
+\family default
and vice-versa.
-\layout Standard
+\end_layout
+\begin_layout Standard
That's it.
You've just made an
-\family sans
+\family sans
Overlay
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
There's one problem with the way I've designed the LyX
-\family sans
+\family sans
slides
-\family default
+\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
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
The commands of interest are:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
{
-\backslash
+\backslash
invisible \SpecialChar \ldots{}
}
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family typewriter
+\family typewriter
{
-\backslash
+\backslash
visible \SpecialChar \ldots{}
}
-\layout Standard
+\end_layout
+\begin_layout Standard
\SpecialChar \ldots{}
and need to be marked as TeX.
The text whose
\begin_inset Quotes eld
-\end_inset
+\end_inset
visibility
\begin_inset Quotes erd
-\end_inset
+\end_inset
you wish to change goes in between the brackets [and after the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
invisible
-\family default
+\family default
or
-\family typewriter
+\family typewriter
-\backslash
+\backslash
visible
-\family default
+\family default
command].
- If you don't know how to mark text as TeX, see the apprpriate section of
- the
-\emph on
+ If you don't know how to mark text as TeX, see the appropriate section
+ of the
+\emph on
User's Guide
-\emph default
+\emph default
.
-\end_inset
+\end_layout
+\end_inset
-\layout Subsubsection
+\end_layout
+
+\begin_layout Subsubsection
Using
-\family sans
+\family sans
Note
-\family default
+\family default
with
-\family sans
+\family sans
Slide
-\family default
+\family default
-\begin_inset LatexCommand \label{sec:slideNote}
+\begin_inset LatexCommand label
+name "sec:slideNote"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Like an
-\family sans
+\family sans
Overlay
-\family default
+\family default
, a
-\family sans
+\family sans
Note
-\family default
+\family default
is associated with a
\begin_inset Quotes eld
-\end_inset
+\end_inset
parent
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\family sans
+\family sans
Slide
-\family default
+\family default
.
Here, too, the LyX
-\family sans
+\family sans
slides
-\family default
+\family default
class provides visual cues.
The label for a
-\family sans
+\family sans
Note
-\family default
+\family default
is shorter than that of a
-\family sans
+\family sans
Slide
-\family default
+\family default
[yet longer than that of an
-\family sans
+\family sans
Overlay
-\family default
+\family default
] and, like the label of an
-\family sans
+\family sans
Overlay
-\family default
+\family default
is shockingly magenta.
Additionally, the printed
-\family sans
+\family sans
Note
-\family default
+\family default
has the page number of its
\begin_inset Quotes eld
-\end_inset
+\end_inset
parent
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\family sans
+\family sans
Slide
-\family default
+\family default
, appended by
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-
-\family default
+\family default
1
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-
-\family default
+\family default
2
\begin_inset Quotes erd
-\end_inset
+\end_inset
,
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-
-\family default
+\family default
3
\begin_inset Quotes erd
-\end_inset
+\end_inset
, etc.
You can have multiple
-\family sans
+\family sans
Note
-\family default
+\family default
s associated with a single
-\family sans
+\family sans
Slide
-\family default
+\family default
, and, as with
-\family sans
+\family sans
Slide
-\family default
+\family default
and
-\family sans
+\family sans
Overlay
-\family default
+\family default
, you'll probably want to break up long
-\family sans
+\family sans
Note
-\family default
+\family default
s so that they fit on a single sheet of paper.
-\layout Standard
+\end_layout
+\begin_layout Standard
The purpose of a
-\family sans
+\family sans
Note
-\family default
+\family default
is obvious: it contains anything additional you might want to say about
a
-\family sans
+\family sans
Slide
-\family default
+\family default
.
It could also be used as a sheet of reminders for a particular
-\family sans
+\family sans
Slide
-\family default
+\family default
.
In the case of the latter, you might want to make use of time markers.
Currently, the LyX
-\family sans
+\family sans
slides
-\family default
+\family default
class has no
\begin_inset Quotes eld
-\end_inset
+\end_inset
native
\begin_inset Quotes erd
-\end_inset
+\end_inset
support for time markers, a
-\noun on
+\noun on
Sli
-\noun default
+\noun default
TeX feature.
So, you'll have to resort to using the LaTeX codes.
-\layout Standard
+\end_layout
+\begin_layout Standard
To use time markers, you'll need to specify the extra class option
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
clock
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
- [see section\SpecialChar ~
+ [see section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slidesetup}
+\begin_inset LatexCommand ref
+reference "sec:slidesetup"
-\end_inset
+\end_inset
].
This option turns on timing marks, which will appear in the lower-left-hand
corner of every
-\family sans
+\family sans
Note
-\family default
+\family default
you generate.
To set what appears in the time marker, you use the LaTeX commands
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
settime{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
and
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
addtime{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
The arguments of both commands are time measured in seconds.
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
settime{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
sets the time marker to a given time.
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
addtime{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
increments the time marker by the specified amount.
Using time markers and
-\family sans
+\family sans
Note
-\family default
+\family default
s in this fashion, you can remind yourself how much time to spend on a particula
r
-\family sans
+\family sans
Slide
-\family default
+\family default
.
-\layout Standard
+\end_layout
+\begin_layout Standard
There's one last feature to describe.
Clearly, you'd like to print out all of your
-\family sans
+\family sans
Slide
-\family default
+\family default
s and
-\family sans
+\family sans
Overlay
-\family default
+\family default
s on transparencies while printing all of your
-\family sans
+\family sans
Note
-\family default
+\family default
s on plain paper.
However, a
-\family sans
+\family sans
Note
-\family default
+\family default
-\emph on
+\emph on
must
-\emph default
+\emph default
follow the
-\family sans
+\family sans
Slide
-\family default
+\family default
with which it is associated.
What's a person to do?
-\layout Standard
+\end_layout
+\begin_layout Standard
Luckily, there are two LaTeX commands that allow you to select what to print
out.
Both must be placed into the preamble of your document.
The command
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onlyslides{
-\backslash
+\backslash
slides}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
will cause the output to contain only the
-\family sans
+\family sans
Slide
-\family default
+\family default
s and
-\family sans
+\family sans
Overlay
-\family default
+\family default
s.
Correspondingly, the command
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onlynotes{
-\backslash
+\backslash
notes}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
prevents the output of anything but
-\family sans
+\family sans
Note
-\family default
+\family default
s.
I'd advise placing both commands in the preamble and initially comment
both out.
what you want to print.
I like to uncomment
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onlyslides{
-\backslash
+\backslash
slides}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
, print to a file with
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-slides
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
in its name, comment it back out, then uncomment
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onlynotes{
-\backslash
+\backslash
notes}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
and print to a
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
*-notes.ps
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
file.
I can then send either file to a printer, loading transparencies or plain
paper as appropriate.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can also provide other arguments to the
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onlyslides{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
and
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
onlynotes{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
commands.
See a good LaTeX book for details.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
The
-\family sans
+\family sans
slides
-\family default
+\family default
Class Template File
-\layout Standard
+\end_layout
+\begin_layout Standard
I have also provided a template file,
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
slides.lyx
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
, with the
-\family sans
+\family sans
slides
-\family default
+\family default
class.
To use it, begin your new presentation with
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-New\SpecialChar ~
-from\SpecialChar ~
+New\InsetSpace ~
+from\InsetSpace ~
-\bar under
+\bar under
T
-\bar default
+\bar default
emplate
-\family default
+\family default
.
Your new LyX presentation file will contain an example
-\family sans
+\family sans
Slide
-\family default
+\family default
--
-\family sans
+\family sans
Overlay
-\family default
- --
-\family sans
- Note
-\family default
+\family default
+ --
+\family sans
+Note
+\family default
triplet.
The
-\family sans
+\family sans
Slide
-\family default
+\family default
and
-\family sans
+\family sans
Overlay
-\family default
+\family default
additionally contain an example of the use of
-\family sans
+\family sans
InvisibleText
-\family default
+\family default
and
-\family sans
+\family sans
VisibleText
-\family default
+\family default
.
Lastly, the preamble will contain:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
% Uncomment to print out only slides and overlays
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
%
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
%
-\backslash
+\backslash
onlyslides{
-\backslash
+\backslash
slides}
-\newline
+\newline
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
% Uncomment to print out only notes
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
%
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
%
-\backslash
+\backslash
onlynotes{
-\backslash
+\backslash
notes}
-\layout Standard
+\end_layout
+\begin_layout Standard
One final thing: I created this class to support the LaTeX2e
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\noun on
+\noun on
Sli
-\noun default
+\noun default
TeX emulation
\begin_inset Quotes erd
-\end_inset
+\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
It's here if you want it or need it.
There exist other LaTeX2e classes for creating presentations, such as the
-\family sans
+\family sans
Foils
-\family default
- class [see section\SpecialChar ~
+\family default
+ class [see section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:foiltex}
+\begin_inset LatexCommand ref
+reference "sec:foiltex"
-\end_inset
+\end_inset
] or the
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
seminar
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
package [present on some TeX distributions].
The latter is not yet supported under LyX.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Perhaps you can take on the task\SpecialChar \ldots{}
-\end_inset
+\end_layout
+
+\end_inset
I know nothing about these other classes.
Try them out to see what sort of alternative they provide.
-\layout Section
+\end_layout
+\begin_layout Section
Foils [aka
-\family sans
+\family sans
Foil
-\family default
-\noun on
+\family default
+\noun on
TeX
-\noun default
+\noun default
]
-\begin_inset LatexCommand \label{sec:foiltex}
+\begin_inset LatexCommand label
+name "sec:foiltex"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Allan Rae
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\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
+\family sans
Foil
-\family default
+\family default
TeX slides class.
This section documents the latter.
-\layout Standard
+\end_layout
+\begin_layout Standard
I'm going to say this again, nice and clear, so that there's no misunderstanding
:
-\layout Standard
-\added_space_top bigskip \added_space_bottom bigskip \align center
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
-\size large
+\begin_layout Standard
+\align center
+
+\size large
This section documents the class
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (FoilTeX)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\emph on
+\emph on
only.
-\layout Standard
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+\begin_layout Standard
If you're looking for the documentation for
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (default)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-, check out section\SpecialChar ~
+, check out section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slitex}
+\begin_inset LatexCommand ref
+reference "sec:slitex"
-\end_inset
+\end_inset
.
If your machine doesn't have the
-\family sans
-foils
-\family default
-class [
+\family sans
+foils
+\family default
+ class [
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (FoilTeX)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
] installed, you'll probably have to use the default
-\family sans
+\family sans
slides
-\family default
+\family default
class, which isn't quite as good as
-\family sans
+\family sans
foils.
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family sans
+\family sans
foils
-\family default
+\family default
class is designed for use with version 2.1 of the
-\family sans
+\family sans
foils.cls
-\family default
+\family default
LaTeX class file which is now an integral part of LaTeX2e.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Getting Started
-\layout Standard
+\end_layout
+\begin_layout Standard
Obviously, to use this document class, you need to select
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family sans
+\family sans
slides (FoilTeX)
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
from the
-\family sans
-\bar under
+\family sans
+\bar under
C
-\bar default
+\bar default
lass
-\family default
+\family default
entry in the
-\family sans
-Document\SpecialChar ~
+\family sans
+Document\InsetSpace ~
Layout
-\family default
+\family default
dialog.
There are some settings in the
-\family sans
-Document\SpecialChar ~
+\family sans
+Document\InsetSpace ~
Layout
-\family default
+\family default
dialog that you should know about that are specific to this class:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Don't change the options
-\family sans
+\family sans
Sides
-\family default
+\family default
and
-\family sans
+\family sans
Columns
-\family default
+\family default
on the
-\family sans
-Document\SpecialChar ~
+\family sans
+Document\InsetSpace ~
Layout
-\family default
+\family default
dialog.
They're ignored by the
-\family sans
+\family sans
foils
-\family default
+\family default
class.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The default font size is 20pt with the other options being 17pt, 25pt and
30pt.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The default font is
-\family sans
+\family sans
sans
-\family default
+\family default
-\family sans
+\family sans
serif
-\family default
+\family default
but all math equations are still typeset in the usual roman font.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX supports A4 and Letter paper sizes as well as a special size for working
with 35mm slides.
It doesn't support A5, B5, legal or executive paper sizes.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Don't bother changing the
-\family sans
+\family sans
Float Placement
-\family default
+\family default
settings because they are ignored anyway.
All floats appear where they are defined in the text.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
The
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
agestyle
-\family default
+\family default
setting behaves a bit differently for this class.
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX provides extensive footer and header capabilities including a user-defined
logo.
- See section\SpecialChar ~
+ See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:foilfoot}
+\begin_inset LatexCommand ref
+reference "sec:foilfoot"
-\end_inset
+\end_inset
for more details.
The title page is treated differently to all other pages in the document
and is
-\emph on
+\emph on
always
-\emph default
+\emph default
unnumbered and
-\emph on
+\emph on
always
-\emph default
+\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:
-\begin_deeper
-\layout List
-\labelwidthstring MMMMMMM
+\end_layout
+\begin_deeper
+\begin_layout List
+\labelwidthstring MMMMMMM
-\family sans
-\series bold
+\family sans
+\series bold
empty
-\family default
-\series default
+\family default
+\series default
The final output contains no page numbers, or other headers or footers
(except footnotes of course).
-\layout List
-\labelwidthstring MMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMM
-\family sans
-\series bold
+\family sans
+\series bold
plain
-\family default
-\series default
+\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).
-\layout List
-\labelwidthstring MMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMM
-\series bold
+\series bold
foilheadings
-\series default
+\series default
Page numbers in lower right corner.
Additional headers and footers are also shown.
This is also the default.
-\layout List
-\labelwidthstring MMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMM
-\series bold
+\series bold
fancy
-\series default
+\series default
Gives you access to the
-\family sans
+\family sans
fancyheadings
-\family default
+\family default
package although its use with
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX is discouraged by the writer of the
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX package because of some potential page layout clashes.
-\end_deeper
-\layout Subsubsection
+\end_layout
+\end_deeper
+\begin_layout Subsubsection
Extra Options
-\layout Standard
+\end_layout
+\begin_layout Standard
The following options may be used in the extra class options in the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog.
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
35mmSlide
-\series default
+\series default
This sets up the page layout for 7.33in by 11in paper, which is about the
same aspect ratio as a 35mm slide, making it a bit easier to work with
this medium.
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
headrule
-\series default
+\series default
Places a rule across the page below the header on every page except the
title page.
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
footrule
-\series default
+\series default
Places a rule across the page above the footer on every page except the
title page.
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
dvips
-\series default
+\series default
This is automatically set each time you create a new
-\family sans
+\family sans
foils
-\family default
+\family default
document.
This option tells
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX to use the dvips driver to rotate those pages that are set as landscape
foils.
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
landscape
-\series default
+\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
+\family sans
Foilhead
-\family default
+\family default
and
-\family sans
+\family sans
Rotatefoilhead
-\family default
+\family default
environments (don't worry these are described in the next section).
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
leqno
-\series default
+\series default
Equation numbers on the left.
-\layout List
-\labelwidthstring MMMMMMx
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMx
-\series bold
+\series bold
fleqn
-\series default
+\series default
Flush-left equations.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Supported Environments
-\layout Standard
+\end_layout
+\begin_layout Standard
Most of the environments commonly supported in other classes are also supported
by the
-\family sans
+\family sans
foils
-\family default
+\family default
class.
There are several additional environments provided by
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX as well as a couple added by LyX.
The following environments are shared with other classes:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{multicols}{2}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Itemize
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Enumerate
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Description
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
List
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
LyX-Code
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Verse
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Quote
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Quotation
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Author
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Date
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Abstract
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Bibliography
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Address
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
RightAddress
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Caption
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Comment
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{multicols}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\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
+\family sans
Foil
-\family default
+\family default
TeX provides specific commands for starting new foils and these are:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Foilhead
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Rotatefoilhead
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX also provides slightly modified versions of these two environments called:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
ShortFoilhead
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
ShortRotatefoilhead
-\layout Standard
+\end_layout
+\begin_layout Standard
and the differences will be explained in the next section.
-\layout Standard
+\end_layout
+\begin_layout Standard
Since foils are often used in presenting ideas or new theorems and such
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX also provides a comprehensive box of goodies for presenting them:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{multicols}{2}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Theorem
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Lemma
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Corollary
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Proposition
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Definition
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Proof
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Theorem*
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Lemma*
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Corollary*
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Proposition*
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Definition*
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{multicols}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\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:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
TickList
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
CrossList
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX provides some powerful header and footer capabilities that are best
set in the preamble although they may be set at any point in a document.
If you want to change these settings in your document the best place to
do so is at the very top of a foil,
-\emph on
+\emph on
i.e.
-\emph default
+\emph default
straight after the foilhead.
-\layout Standard
+\end_layout
+\begin_layout Standard
For this purpose, the following command styles are provided [
-\shape smallcaps
+\shape smallcaps
Martin Vermeer
-\shape default
+\shape default
]:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{multicols}{2}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-My\SpecialChar ~
+\family sans
+My\InsetSpace ~
Logo
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Restriction
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-Right\SpecialChar ~
+\family sans
+Right\InsetSpace ~
Footer
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-Right\SpecialChar ~
+\family sans
+Right\InsetSpace ~
Header
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-Left\SpecialChar ~
+\family sans
+Left\InsetSpace ~
Header
-\begin_deeper
-\layout Standard
+\end_layout
-\SpecialChar ~
-
-\end_deeper
-\layout Standard
+\begin_deeper
+\begin_layout Standard
+\InsetSpace ~
+\end_layout
+\end_deeper
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{multicols}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
+
+\begin_layout Standard
There are also a few commands provided by
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX that aren't directly supported by LyX but I'll tell you what they do
- and how to use them in section\SpecialChar ~
+ and how to use them in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:unsuppfoils}
+\begin_inset LatexCommand ref
+reference "sec:unsuppfoils"
-\end_inset
+\end_inset
.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Building a Set of Foils
-\layout Standard
+\end_layout
+\begin_layout Standard
This section will give a simple introduction to using the different environments
to build a set of foils.
If you want to see an example set of foils take a look at the
-\family typewriter
+\family typewriter
Foils.lyx
-\family default
+\family default
file accessible from the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
O
-\bar default
+\bar default
pen\SpecialChar \ldots{}
-\family default
+\family default
dialog under the
-\family sans
+\family sans
Examples
-\family default
+\family default
button.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Give It a Title Page
-\layout Standard
+\end_layout
+\begin_layout Standard
Unlike other classes that provide
-\family sans
+\family sans
Title
-\family default
+\family default
,
-\family sans
+\family sans
Author
-\family default
+\family default
,
-\family sans
+\family sans
Date
-\family default
+\family default
and
-\family sans
+\family sans
Abstract
-\family default
+\family default
environments,
-\family sans
+\family sans
foils
-\family default
+\family default
creates the title on a page of its own.
If you leave out the
-\family sans
+\family sans
Date
-\family default
+\family default
environment LaTeX will substitute the current date (every time you regenerate
the output).
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Start a New Foil
-\layout Standard
+\end_layout
+\begin_layout Standard
As I mentioned earlier, there are four ways of starting a new foil.
For portrait foils you should use
-\family sans
+\family sans
Foilhead
-\family default
+\family default
or
-\family sans
+\family sans
ShortFoilhead.
-\family default
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
Landscape foils are generated using the
-\family sans
+\family sans
Rotatefoilhead
-\family default
+\family default
and
-\family sans
+\family sans
ShortRotatefoilhead
-\family default
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
One problem with the support for landscape foils is the requirement that
you have to use the
-\family typewriter
+\family typewriter
dvips
-\family default
- driver to generate the PostScript® output otherwise the foils won't be
- rotated.
+\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
+\family typewriter
dvips
-\family default
+\family default
driver provided you can feed your foils sideways through your printer ;-)
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Theorems, Lemmas, Proofs and more
-\layout Standard
+\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.
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
+\family sans
LaTeX
-\family default
+\family default
environment between the two with just a
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
in it.
This will force LyX to produce two separate environments and hence the
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.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Lists
-\layout Standard
+\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
+\emph on
User's Guide.
-\emph default
+\emph default
If you intend to use itemized lists you might also want to read about the
-\family sans
-Itemize\SpecialChar ~
-Bullet\SpecialChar ~
+\family sans
+Itemize\InsetSpace ~
+Bullet\InsetSpace ~
Selection
-\family default
- dialog described above in section\SpecialChar ~
+\family default
+ dialog described above in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:bullet}
+\begin_inset LatexCommand ref
+reference "sec:bullet"
-\end_inset
+\end_inset
.
-\layout Standard
+\end_layout
+\begin_layout Standard
The two new list styles,
-\family sans
-TickList
-\family default
-and
-\family sans
+\family sans
+TickList
+\family default
+ and
+\family sans
CrossList
-\family default
+\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
+\family sans
Itemize
-\family default
+\family default
environment.
They do however require that you have the
-\family typewriter
+\family typewriter
psnfss
-\family default
+\family default
packages installed.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Figures and Tables
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX redefines the floating tables and figures so that they appear exactly
where they are in the text rather than pushing them to the top of the page
or to some user specified location.
In fact if you change the float placement settings they are simply ignored.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Page Headers and Footers
-\begin_inset LatexCommand \label{sec:foilfoot}
+\begin_inset LatexCommand label
+name "sec:foilfoot"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family sans
-My\SpecialChar ~
+\family sans
+My\InsetSpace ~
Logo
-\family default
+\family default
and
-\family sans
+\family sans
Restriction
-\family default
+\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
+\end_inset
-Typeset by
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX-
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
While the second is meant to provide a classification for the audience,
-\emph on
-e.g.
-
-\emph default
- Confidential.
+\emph on
+e.\InsetSpace \thinspace{}
+g.
+\emph default
+\InsetSpace ~
+Confidential.
It is empty by default.
-\layout Standard
+\end_layout
-The remaining page corners can be filled by
-\family sans
- Right\SpecialChar ~
+\begin_layout Standard
+The remaining page corners can be filled by
+\family sans
+Right\InsetSpace ~
Footer
-\family default
+\family default
(which defaults to page numbers),
-\family sans
-Right\SpecialChar ~
+\family sans
+Right\InsetSpace ~
Header
-\family default
+\family default
(top right) and
-\family sans
-Left\SpecialChar ~
+\family sans
+Left\InsetSpace ~
Header
-\family default
+\family default
(top left).
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Unsupported
-\family sans
+\family sans
Foil
-\family default
+\family default
TeX Goodies
-\begin_inset LatexCommand \label{sec:unsuppfoils}
+\begin_inset LatexCommand label
+name "sec:unsuppfoils"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
All the commands mentioned below need to be set in a
-\family sans
+\family sans
LaTeX
-\family default
+\family default
environment or as
-\family sans
+\family sans
TeX
-\family default
+\family default
within another environment.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Lengths
-\layout Standard
+\end_layout
+\begin_layout Standard
All lengths are adjusted using the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
setlength{
-\family default
-\emph on
+\family default
+\emph on
lengthname
-\family typewriter
-\emph default
+\family typewriter
+\emph default
}{
-\family default
-\emph on
+\family default
+\emph on
newlength
-\family typewriter
-\emph default
+\family typewriter
+\emph default
}
-\family default
+\family default
command.
Where
-\emph on
+\emph on
lengthname
-\emph default
+\emph default
should be replaced by the name given to the length you want to change and
-\emph on
+\emph on
newlength
-\emph default
+\emph default
is the length value.
All lengths should be specified in units of length such as inches (
-\family typewriter
+\family typewriter
in
-\family default
+\family default
), millimeters (
-\family typewriter
+\family typewriter
mm
-\family default
+\family default
) or points (
-\family typewriter
+\family typewriter
pt
-\family default
+\family default
) or relative to some document or font-based length such as
-\family typewriter
+\family typewriter
-\backslash
+\backslash
textwidth
-\family default
+\family default
.
-\layout Standard
+\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
+\family typewriter
-\backslash
+\backslash
foilheadskip
-\family default
+\family default
.
For example, to make
-\emph on
+\emph on
all
-\emph default
+\emph default
foilheads 0.5 inches closer to their bodies put the following in the preamble:
-\family typewriter
+\family typewriter
-\backslash
+\backslash
setlength{
-\backslash
+\backslash
foilheadskip}{-0.5in}
-\layout Standard
+\end_layout
+\begin_layout Standard
The spacings around floats can be adjusted by setting these lengths:
-\layout List
+\end_layout
+
+\begin_layout List
\labelwidthstring MMMMMMMMMMM
+\family typewriter
-\family typewriter
+\backslash
+abovefloatskip
+\family default
+ Separation between the text and the top of the float
+\end_layout
-\backslash
-abovefloatskip
-\family default
-Separation between the text and the top of the float
-\layout List
+\begin_layout List
\labelwidthstring MMMMMMMMMMM
+\family typewriter
-\family typewriter
+\backslash
+abovecaptionskip
+\family default
+ Separation between the float and the caption
+\end_layout
-\backslash
-abovecaptionskip
-\family default
-Separation between the float and the caption
-\layout List
+\begin_layout List
\labelwidthstring MMMMMMMMMMM
+\family typewriter
-\family typewriter
+\backslash
+belowcaptionskip
+\family default
+ Separation between the caption and the following text
+\end_layout
-\backslash
-belowcaptionskip
-\family default
-Separation between the caption and the following text
-\layout List
+\begin_layout List
\labelwidthstring MMMMMMMMMMM
+\family typewriter
-\family typewriter
-
-\backslash
+\backslash
captionwidth
-\family default
+\family default
You can make the captions narrower than the surrounding text by adjusting
this length.
Best done relative to
-\family typewriter
+\family typewriter
-\backslash
+\backslash
textwidth
-\family default
+\family default
.
-\layout Standard
+\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:
-\layout List
-\labelwidthstring MMMMMMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family typewriter
+\family typewriter
-\backslash
+\backslash
abovetitleskip
-\family default
+\family default
Separation from headers to
-\family sans
+\family sans
Title
-\layout List
-\labelwidthstring MMMMMMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family typewriter
+\family typewriter
-\backslash
+\backslash
titleauthorskip
-\family default
+\family default
between
-\family sans
+\family sans
Title
-\family default
+\family default
and
-\family sans
+\family sans
Author
-\family default
+\family default
environments
-\layout List
-\labelwidthstring MMMMMMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family typewriter
+\family typewriter
-\backslash
+\backslash
authorauthorskip
-\family default
+\family default
between multiple
-\family sans
+\family sans
Author
-\family default
+\family default
lines
-\layout List
-\labelwidthstring MMMMMMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family typewriter
+\family typewriter
-\backslash
+\backslash
authordateskip
-\family default
+\family default
between the
-\family sans
+\family sans
Author
-\family default
+\family default
and the
-\family sans
+\family sans
Date
-\layout List
-\labelwidthstring MMMMMMMMMMM
+\end_layout
+\begin_layout List
+\labelwidthstring MMMMMMMMMMM
-\family typewriter
+\family typewriter
-\backslash
+\backslash
dateabstractskip
-\family default
+\family default
between the
-\family sans
+\family sans
Date
-\family default
+\family default
and the
-\family sans
+\family sans
Abstract
-\layout Standard
+\end_layout
+\begin_layout Standard
The last length related command affects all the list environments.
- If you place
-\family typewriter
-
-\backslash
+ If you place
+\family typewriter
+
+\backslash
zerolistvertdimens
-\family default
+\family default
-\emph on
+\emph on
inside
-\emph default
+\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
+\family typewriter
-\backslash
+\backslash
setlength
-\family default
+\family default
like the stuff mentioned above.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Headers and Footers
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family typewriter
+\family typewriter
-\backslash
+\backslash
LogoOn
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
LogoOff
-\family default
+\family default
commands control whether the logo in the
-\family sans
+\family sans
MyLogo
-\family default
+\family default
definition appear on a given page.
If you put
-\family typewriter
+\family typewriter
-\backslash
+\backslash
LogoOff
-\family default
+\family default
in the preamble then none of the foils will have the logo on them.
If you don't want the logo on a particular page place the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
LogoOff
-\family default
+\family default
directly after the foilhead of that page and the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
LogoOn
-\family default
+\family default
directly after the next foilhead.
-\layout Standard
+\end_layout
+\begin_layout Standard
If you decide to use the
-\family sans
+\family sans
fancy
-\family default
+\family default
page style setting in the
-\family sans
-Document\SpecialChar ~
+\family sans
+Document\InsetSpace ~
Layout
-\family default
+\family default
dialog you should probably add
-\family typewriter
+\family typewriter
-\backslash
+\backslash
let
-\backslash
+\backslash
headwidth
-\backslash
+\backslash
textwidth
-\family default
+\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
+\family sans
fancyheadings
-\family default
+\family default
package and the
-\family sans
+\family sans
foils
-\family default
+\family default
class.
-\layout Section
+\end_layout
+\begin_layout Section
Latex8 (IEEE Conference Papers)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Allan Rae
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
Since this class is specifically for writing submissions to IEEE sponsored
conferences I strongly recommend that you get a copy of their Authors Kit.
The
-\family sans
+\family sans
latex.sty
-\family default
+\family default
package and associated bibliography style file is included in the kit.
The Authors Kit is usually sent out by email once your initial submission
has been accepted.
There is a lot of useful information in the Authors Kit explaining formatting
restrictions and so on and I will assume you have read this since that
means I don't have to repeat it all here.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Getting Started
-\layout Standard
+\end_layout
+\begin_layout Standard
[AR\SpecialChar \@.
more to come]
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Supported Environments
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Author
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
E-mail
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Affiliation
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Abstract
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Section
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
SubSection
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Caption
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Differences Between Screen and Paper
-\layout Standard
+\end_layout
+\begin_layout Standard
There are slight differences in appearance mainly with the presentation
of section counters.
On screen the trailing period of the section counter is missing but it
will appear in the output so don't let this worry you.
-\layout Section
+\end_layout
+\begin_layout Section
Hollywood (Hollywood spec scripts)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\shape smallcaps
+\shape smallcaps
Garst Reese
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
Getting the format of a Hollywood script right is a
\begin_inset Quotes eld
-\end_inset
+\end_inset
rite of passage.
\begin_inset Quotes erd
-\end_inset
+\end_inset
It is designed to make the readers focus on content and to be easy and
familiar for the actors to read.
Nothing goes in a script that you cannot see or hear on screen.
The courier 12 pt font should be used throughout.
No italics.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Special problems
-\layout Standard
+\end_layout
+\begin_layout Standard
Speakers' lines should NEVER break in mid-sentence.
If a speaker's lines continue over a page break, repeat the
-\family sans
+\family sans
Speaker
-\family default
+\family default
title followed by (Cont'd).
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Special features
-\layout Standard
+\end_layout
+\begin_layout Standard
Insert the
-\family sans
+\family sans
Speaker
-\family default
+\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.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Paper size and Margins
-\layout Standard
+\end_layout
+\begin_layout Standard
USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Environments
-\layout Standard
+\end_layout
+\begin_layout Standard
The following environments are available.
You can use hollywood.bind to get the bind keys shown at the right.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard
-\newline
+\newline
-\family default
+\family default
Used where nothing else works.
Try to avoid it.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
FADE_IN
-\family default
+\family default
:
-\hfill
+\hfill
-\family sans
+\family sans
M-z S-I
-\family default
+\family default
-\newline
+\newline
Usually followed by something like
\begin_inset Quotes eld
-\end_inset
+\end_inset
on Sally waking up.
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
INT:
-\hfill
+\hfill
M-z i
-\newline
+\newline
-\family default
+\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.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
EXT:
-\hfill
+\hfill
M-z e
-\newline
+\newline
-\family default
+\family default
Introduces a new EXTERIOR camera set-up.
Everthing on this line in CAPS.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Speaker
-\hfill
+\hfill
M-z s
-\newline
+\newline
-\family default
+\family default
The character speaking.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Parenthetical
-\hfill
+\hfill
M-z p
-\newline
+\newline
-\family default
+\family default
Instructions to the speaker.
The () are automatically inserted, but only the ( will show in LyX.
Both will be printed.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Dialogue
-\hfill
+\hfill
M-z d
-\newline
+\newline
-\family default
+\family default
What the
-\family sans
+\family sans
Speaker
-\family default
+\family default
says.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Transition
-\hfill
+\hfill
M-z t
-\newline
+\newline
-\family default
+\family default
Camera movement instruction.
- e.g.
- CUT TO:
-\layout Itemize
+ e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+CUT TO:
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
FADE OUT:
-\hfill
+\hfill
M-z S-I
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Author
-\hfill
+\hfill
M-z S-A
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\hfill
+\hfill
M-z S-T
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Right_Address
-\hfill
+\hfill
M-z r
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Script jargon
-\layout Itemize
+\end_layout
+\begin_layout Itemize
(O.S) --- off screen
-\layout Itemize
+\end_layout
+\begin_layout Itemize
(V.0) --- voice over
-\layout Itemize
+\end_layout
+\begin_layout Itemize
b.g.
--- background
-\layout Itemize
+\end_layout
+\begin_layout Itemize
C.U.
--- close-up
-\layout Itemize
+\end_layout
+\begin_layout Itemize
PAN --- camera movement
-\layout Itemize
+\end_layout
+\begin_layout Itemize
INSERT --- cut to close-up of
-\layout Section
+\end_layout
+\begin_layout Section
Broadway
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\shape smallcaps
+\shape smallcaps
Garst Reese
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
Broadway is for writing plays.
The format is more decorative than Hollywood, and much less standardized.
This format should be suitable for workshops.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Special problems
-\layout Standard
+\end_layout
+\begin_layout Standard
The same as in Hollywood.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Special features
-\layout Standard
+\end_layout
+\begin_layout Standard
Insert the
-\family sans
+\family sans
Speaker
-\family default
+\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.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Paper size and Margins
-\layout Standard
+\end_layout
+\begin_layout Standard
USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Environments
-\layout Standard
+\end_layout
+\begin_layout Standard
The following environments are available.
You can use broadway.bind to get the bind keys shown at the right.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard
-\newline
+\newline
-\family default
+\family default
You should not have to use this, but it is here for anything that does not
fit otherwise.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Narrative
-\hfill
+\hfill
M-z n
-\newline
+\newline
-\family default
+\family default
Used to describe stage setting and the action.
First use of speaker names in all CAPs.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
ACT
-\hfill
+\hfill
M-z a
-\newline
+\newline
-\family default
+\family default
Automatically numbered.
On screen it will be arabic, but will print as Roman.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
ACT*
-\hfill
+\hfill
M-z S at
-\newline
+\newline
-\family default
+\family default
Subtitle for
-\family sans
+\family sans
ACT.
-
-\family default
-It is just centered text.
-\layout Itemize
+\family default
+ It is just centered text.
+\end_layout
-\family sans
+\begin_layout Itemize
+
+\family sans
SCENE
-\hfill
+\hfill
M-z S-S
-\newline
+\newline
-\family default
+\family default
Not automatically numbered.
You supply the number.
This is because I couldn't figure out how.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
AT_RISE:
-\hfill
+\hfill
M-z S-R
-\newline
+\newline
-\family default
+\family default
A special case of Narrative to describe the setting and action as the curtain
rises.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Speaker
-\hfill
+\hfill
M-z s
-\newline
+\newline
-\family default
+\family default
The speaker's (actor's) title, centered in all CAPS.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Parenthetical
-\hfill
+\hfill
M-z p
-\newline
+\newline
-\family default
+\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
+\family sans
Dialogue
-\family default
+\family default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Dialogue
-\hfill
+\hfill
M-z d
-\newline
+\newline
-\family default
+\family default
What the Speaker says.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
CURTAIN
-\hfill
+\hfill
M-z S-C
-\newline
+\newline
-\family default
+\family default
The curtain comes down.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\hfill
+\hfill
M-z S-T
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Author
-\hfill
+\hfill
M-z S-A
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Right_Address
-\hfill
+\hfill
M-z r
-\layout Standard
+\end_layout
+\begin_layout Standard
Hello there.
-\layout Section
+\end_layout
+\begin_layout Section
RevTeX4
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Amir Karger
-\layout Standard
-\added_space_top bigskip \noindent
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
The
-\family sans
-Revtex\SpecialChar ~
+\family sans
+Revtex\InsetSpace ~
4
-\family default
+\family default
textclass works with the American Physical Sociey's RevTeX 4.0 (the
\begin_inset Formula $\beta$
-\end_inset
+\end_inset
release of May, 1999) class.
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX has a
-\family sans
+\family sans
Revtex
-\family default
+\family default
textclass, which works with RevTeX 3.1.
However, v3.1 is basically obsolete, as it works with LaTeX 2.09.
That means that it doesn't interact very well with LyX, which requires
LaTeX2e, although it has been kludged to work.
Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
LyX with the
-\family sans
-RevTeX\SpecialChar ~
+\family sans
+RevTeX\InsetSpace ~
4
-\family default
+\family default
textclass should also be pretty easy to use.
-\layout Standard
+\end_layout
+\begin_layout Standard
These documents are supposed to be used in
-\emph on
+\emph on
addition
-\emph default
+\emph default
to the RevTeX 4.0 documents, so we don't describe any of the special RevTeX
macros, and assume you'll know what to put in the preamble if necessary.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Installation
-\layout Standard
+\end_layout
+\begin_layout Standard
All you need to do is install RevTeX 4, as described in the package's README
file.
- the package can be found at
-\begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
+ The package can be found at
+\begin_inset LatexCommand url
+name "The RevTeX 4 Web Site"
+target "http://publish.aps.org/revtex4/"
-\end_inset
+\end_inset
.
Install it somewhere that LaTeX can see it.
(i.e., not the directory where you installed the class file.) Then, if you
reconfigure LyX, it will find the class file and let you use the RevTeX4
textclass.
-\layout Standard
+\end_layout
+\begin_layout Standard
Probably the easiest way to get started is either to import a RevTeX 4 document
using
-\family typewriter
+\family typewriter
reLyX
-\family default
+\family default
, or to use the
-\family sans
-Revtex\SpecialChar ~
+\family sans
+Revtex\InsetSpace ~
4
-\family default
+\family default
template, found in the templates directory.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Preamble Matter
-\layout Standard
+\end_layout
+\begin_layout Standard
Optional arguments to
-\family typewriter
+\family typewriter
-\backslash
+\backslash
documentclass
-\family default
+\family default
, like
\begin_inset Quotes eld
-\end_inset
+\end_inset
preprint
\begin_inset Quotes erd
-\end_inset
+\end_inset
and
\begin_inset Quotes eld
-\end_inset
+\end_inset
aps
\begin_inset Quotes erd
-\end_inset
+\end_inset
, go in the
-\family sans
+\family sans
E
-\bar under
+\bar under
x
-\bar default
-tra\SpecialChar ~
+\bar default
+tra\InsetSpace ~
Options
-\family default
+\family default
field in the
-\family sans
-Document\SpecialChar ~
+\family sans
+Document\InsetSpace ~
Layout
-\family default
+\family default
dialog, as usual.
Remember that in RevTeX, at least one optional argument is required!
-\layout Standard
+\end_layout
+\begin_layout Standard
Other preamble matter, like
-\family typewriter
+\family typewriter
-\backslash
+\backslash
draft
-\family default
- etc.
- goes in the
-\family sans
-Latex\SpecialChar ~
+\family default
+ etc.\InsetSpace ~
+goes in the
+\family sans
+La
+\family default
+T
+\family sans
+eX\InsetSpace ~
Preamble
-\family default
+\family default
dialog, also as usual.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Layouts
-\layout Standard
+\end_layout
+\begin_layout Standard
The layouts basically correspond to the commands in RevTeX4.0.
For example, the Email layout corresponds to
-\family typewriter
+\family typewriter
-\backslash
+\backslash
email{}
-\family default
+\family default
.
Note that (at least as of RevTeX 4.0 Beta), the
-\family sans
+\family sans
Address
-\family default
+\family default
and
-\family sans
+\family sans
Affiliation
-\family default
+\family default
layouts are exactly equivalent, so you shouldn't need to use both.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
In case you're curious, both were included so that
-\family typewriter
+\family typewriter
reLyX
-\family default
+\family default
would be able to translate both
-\family typewriter
+\family typewriter
-\backslash
+\backslash
address
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
affiliation
-\family default
+\family default
.
-\end_inset
+\end_layout
+\end_inset
-\layout Subsection
+\end_layout
+
+\begin_layout Subsection
Important Notes
-\layout Standard
+\end_layout
+\begin_layout Standard
There are a couple of important unique aspects of RevTeX 4 which might cause
bugs that will be even more confusing in LyX.
-\layout Standard
+\end_layout
+\begin_layout Standard
In RevTeX, the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
thanks
-\family default
+\family default
command goes
-\emph on
+\emph on
outside
-\emph default
+\emph default
the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
author
-\family default
+\family default
command.
The LyX equivalent is that there is a separate Thanks layout.
Do
-\emph on
+\emph on
not
-\emph default
+\emph default
write footnotes in the
-\family sans
+\family sans
Author
-\family default
+\family default
layout, or weird things may happen.
See the RevTeX 4 documentation for more details.
-\layout Standard
+\end_layout
+\begin_layout Standard
Also, the
-\family sans
-Author\SpecialChar ~
+\family sans
+Author\InsetSpace ~
Email
-\family default
+\family default
,
-\family sans
-Author\SpecialChar ~
+\family sans
+Author\InsetSpace ~
URL
-\family default
+\family default
, and
-\family sans
+\family sans
Thanks
-\family default
+\family default
layouts must be placed
-\emph on
+\emph on
in between
-\emph default
+\emph default
the
-\family sans
+\family sans
Author
-\family default
+\family default
layout and the corresponding
-\family sans
+\family sans
Address
-\family default
+\family default
(or equivalent
-\family sans
+\family sans
Affiliation
-\family default
+\family default
) layout.
If you put the
-\family sans
+\family sans
Thanks
-\family default
+\family default
after the
-\family sans
+\family sans
Address
-\family default
+\family default
, the LaTeX won't compile.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Drawbacks
-\layout Standard
+\end_layout
+\begin_layout Standard
The main problem with this layout is that you can't use the optional arguments
to layouts like Email and Title.
(The problem is not unique to this layout; you can't use optional arguments
to the Section layouts either.) This means that after you export that file
to LaTeX (which you'll need to do eventually to send it in to APS), you'll
need to edit the LaTeX file with a text editor to add the optional arguments
- to set, e.g., the running title for the page headers.
+ to set, e.\InsetSpace \thinspace{}
+g., the running title for the page headers.
Lacking these layouts makes the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
altaffiliation
-\family default
+\family default
(and the equivalent
-\family typewriter
+\family typewriter
-\backslash
+\backslash
altaddress
-\family default
+\family default
) useless, so the corresponding layouts don't exist, and will have to be
added by hand.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
-\emph on
+\emph on
Note from JMarc:
-\emph default
+\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_inset
+\end_layout
+
+\end_inset
-\layout Section
+\end_layout
+\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
\begin_inset OptArg
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
The
-\family typewriter
+\family typewriter
mw
-\family default
+\family default
Classes
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
+
+\begin_layout Standard
by
-\noun on
+\noun on
Tomasz Luczak
-\layout Standard
+\end_layout
-The LyX document classes
-\emph on
- article (mwart)
-\emph default
+\begin_layout Standard
+The LyX document classes
+\emph on
+article (mwart)
+\emph default
,
-\emph on
+\emph on
report (mwrep)
-\emph default
+\emph default
and
-\emph on
+\emph on
book
-\emph default
+\emph default
-\emph on
+\emph on
(mwbk)
-\emph default
+\emph default
correspond to the LaTeX document classes
-\family typewriter
+\family typewriter
mwart.cls
-\family default
+\family default
,
-\family typewriter
+\family typewriter
mwrep.cls
-\family default
+\family default
and
-\family typewriter
+\family typewriter
mwbk.cls
-\family default
+\family default
, resp.
They are replacements for the standard document classes
-\family typewriter
+\family typewriter
article.cls
-\family default
+\family default
,
-\family typewriter
+\family typewriter
report.cls
-\family default
+\family default
and
-\family typewriter
+\family typewriter
book.cls
-\family default
+\family default
, resp., and fit better to Polish typography conventions in a number of points.
-\layout Standard
+\end_layout
+\begin_layout Standard
Basic differences:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Unnumbered titles (with star, eg.
-\family sans
+\family sans
Section*
-\family default
+\family default
) are added into table of contents,
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Additional page styles:
-\begin_deeper
-\layout Description
+\end_layout
+\begin_deeper
+\begin_layout Description
uheadings header with separated lines,
-\layout Description
+\end_layout
+\begin_layout Description
myheadings custom header, contents headers via commands:
-\family typewriter
+\family typewriter
-\backslash
+\backslash
markright
-\family default
+\family default
and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
markboth
-\family default
+\family default
,
-\layout Description
+\end_layout
+\begin_layout Description
myuheadings custom header with separated lines,
-\layout Description
+\end_layout
+\begin_layout Description
outer page number is placed on outer side of page
-\end_deeper
-\layout Itemize
+\end_layout
+\end_deeper
+\begin_layout Itemize
Options
-\begin_deeper
-\layout Description
+\end_layout
+\begin_deeper
+\begin_layout Description
rmheadings serif titles --- default,
-\layout Description
+\end_layout
+\begin_layout Description
sfheadings sansserif titles,
-\layout Description
+\end_layout
+\begin_layout Description
authortitle on title page first placed is author next title --- default,
-\layout Description
+\end_layout
+\begin_layout Description
titleauthor on title page first placed is title next author,
-\layout Description
+\end_layout
+\begin_layout Description
withmarginpar reserve place on page for margins.
-\end_deeper
-\layout Section
+\end_layout
+\end_deeper
+\begin_layout Section
Elsevier Journals
-\layout Standard
+\end_layout
+\begin_layout Standard
By
-\noun on
+\noun on
Rod Pinna
-\layout Standard
+\end_layout
+\begin_layout Standard
Elsevier Science Publishers B.V.
provides a standard LaTeX document class (
-\family typewriter
+\family typewriter
elsart.cls
-\family default
+\family default
) for submitting articles to their various journals.
The style file can be downloaded directly from their web site:
-\begin_inset LatexCommand \url{http://authors.elsevier.com/}
+\begin_inset LatexCommand url
+target "http://authors.elsevier.com/"
-\end_inset
+\end_inset
.
Instructions are supplied along with the class file, which details the
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.
-\layout Standard
+\end_layout
+\begin_layout Standard
To make use of
-\family typewriter
+\family typewriter
elsart.cls
-\family default
+\family default
, a file
-\family typewriter
+\family typewriter
elsart.layout
-\family default
+\family default
is supplied.
As the Elsevier class file is based mainly on the standard article class,
most of the normal functionality is provided.
are similar to the AMS environments.
These commands are all described in the Elsevier documentation, and are
available in LyX.
-\layout Standard
+\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,
should be used.
Essentially, Elsevier require as
\begin_inset Quotes eld
-\end_inset
+\end_inset
clean
\begin_inset Quotes erd
-\end_inset
+\end_inset
a
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
LaTeX
-\end_inset
+\end_layout
+
+\end_inset
file as possible, as their intention is to take the supplied file and replace
the class file with one for the particular journal to which the paper has
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.
-\layout Section
+\end_layout
+\begin_layout Section
Memoir
-\layout Standard
+\end_layout
+\begin_layout Standard
By
-\noun on
-Jürgen Spitzmüller
-\layout Subsection
+\noun on
+Jürgen Spitzmüller
+\end_layout
+\begin_layout Subsection
Overview
-\layout Standard
+\end_layout
+\begin_layout Standard
Memoir is a very powerful and constantly evolving class.
It has been designed with regard to fictional and non-fictional literature.
Its aim is to let the user have maximum control over the typesetting of
his document.
Memoir is based on the standard book class, but it can also emulate the
article class (see below).
-\layout Standard
+\end_layout
+\begin_layout Standard
Peter Wilson, the developer of Memoir, is known as the author of lots of
useful packages in the LaTeX world.
Most of them have been merged with Memoir.
LyX, though, does not support all of these goodies natively.
Some of them might be added to forthcoming releases
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
You are invited to send suggestions to
-\begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
+\begin_inset LatexCommand url
+target "lyx-devel@lists.lyx.org"
-\end_inset
+\end_inset
.
-\end_inset
+\end_layout
+
+\end_inset
, lots will probably never, due to the limitations of LyX's framework.
Of course you can still use all features with the help of some native LaTeX
commands (ERT
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Cf.
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
-section\SpecialChar ~
+section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
+\begin_inset LatexCommand ref
+reference "sec:Inserting-LaTeX-Code"
-\end_inset
+\end_inset
for details.
-\end_inset
+\end_layout
+
+\end_inset
).
In this section, we can only list those features which are natively supported
For detailed descriptions (and for the rest of features) we are recommending
to have a look at the detailed manual of the Memoir class
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Cf.
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
-\begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
+\begin_inset LatexCommand url
+target "CTAN:/macros/latex/memoir/memman.pdf"
-\end_inset
+\end_inset
.
-\end_inset
+\end_layout
+
+\end_inset
, which is not only a user guide for the class, but also both a comprehensive
description on good typesetting and a superb example for good typesetting
itself.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Basic features and restrictions
-\layout Standard
+\end_layout
+\begin_layout Standard
Memoir supports basically all features of the standard book classes.
There are, however, some differences, as follows:
-\layout Description
+\end_layout
-Font\SpecialChar ~
+\begin_layout Description
+Font\InsetSpace ~
sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
17
-\layout Description
+\end_layout
-Page\SpecialChar ~
+\begin_layout Description
+Page\InsetSpace ~
style: The fancy page style is not supported, due to a command clash
between Memoir and the fancyhdr package (they are both defining a command
with the same name, which confuses LaTeX).
Instead, Memoir comes with a bunch of own page styles (see
-\family sans
+\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
-Page\SpecialChar ~
+Page\InsetSpace ~
Style
-\family default
+\family default
).
If you want to use these for the chapter pages, you have to use the command
-\family typewriter
+\family typewriter
-\backslash
+\backslash
chapterstyle
-\family default
+\family default
in the main text or in preamble (e.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
,
-\end_inset
+\end_layout
+
+\end_inset
g.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
-\end_inset
+\end_layout
+\end_inset
-\family typewriter
-\backslash
+\family typewriter
+
+\backslash
chapterstyle{companion}
-\family default
+\family default
).
-\layout Description
+\end_layout
+\begin_layout Description
Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
an optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
In LyX, you can do this via
-\family sans
+\family sans
Insert\SpecialChar \menuseparator
-Short\SpecialChar ~
+Short\InsetSpace ~
Title
-\family default
+\family default
at the beginning of a chapter/section.
Memoir features a second optional argument and thus separates the table
of contents from the header.
Simply insert two optional arguments if you need this feature, the first
one containing the short title for the Table of Contents, the second one
containing an alternative short title for the headers.
-\layout Description
+\end_layout
+\begin_layout Description
TOC/LOT/LOF: In the standard classes (and in many other classes), the table
of contents, the list of figures and the list of table start a new page
automatically.
Memoir does not follow this route.
You have to insert a page break yourself, if you want to have one.
-\layout Description
+\end_layout
+\begin_layout Description
Titlepage: For some unknown reason, Memoir uses pagination on the title
page (in the standard classes, title pages are
\begin_inset Quotes eld
-\end_inset
+\end_inset
empty
\begin_inset Quotes erd
-\end_inset
+\end_inset
, i.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
,
-\end_inset
+\end_layout
+
+\end_inset
e.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
without pagina).
If you want an empty title page, type
-\family typewriter
+\family typewriter
-\backslash
-aliaspagestyle{title}{empty}
-\family default
-in the preamble.
-\layout Description
+\backslash
+aliaspagestyle{title}{empty}
+\family default
+ in the preamble.
+\end_layout
+\begin_layout Description
Article: With the class option
-\emph on
-article
-\emph default
-(to be inserted in
-\family sans
+\emph on
+article
+\emph default
+ (to be inserted in
+\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
-Extra\SpecialChar ~
+Extra\InsetSpace ~
Options
-\family default
+\family default
), you can emulate article style.
That is, counters (footnotes, figures, tables etc.) will not be reset on
new chapters, chapters don't start a new page (but are---in contrary to
\begin_inset Quotes eld
-\end_inset
+\end_inset
real
\begin_inset Quotes erd
-\end_inset
+\end_inset
article classes---still allowed), parts, though, use their own page, as
in book.
-\layout Description
+\end_layout
+\begin_layout Description
Oldfontcommands: By default, Memoir does not allow the use of the deprecated
font commands, which have been used in the old LaTeX version 2.09 (e.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
,
-\end_inset
+\end_layout
+
+\end_inset
g.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
-\end_inset
+\end_layout
+\end_inset
-\family typewriter
-\backslash
+\family typewriter
+
+\backslash
rm
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
it
-\family default
+\family default
).
It produces an error and stops LaTeX whenever such a command appears.
The class option
-\emph on
+\emph on
oldfontcommands
-\emph default
+\emph default
reallows the commands and spits out warnings instead (which does at least
not stop LaTeX).
Since a lot of packages and particularly BibTeX style files are still using
those commands, we have decided to use this option by default.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Extra features
-\layout Standard
+\end_layout
+\begin_layout Standard
We will only describe the features supported by LyX (which is not much currently
).
Please consult the Memoir manual
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Cf.
\begin_inset ERT
-status Collapsed
+status collapsed
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
-\end_inset
+\end_layout
+
+\end_inset
-\begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
+\begin_inset LatexCommand url
+target "CTAN:/macros/latex/memoir/memman.pdf"
-\end_inset
+\end_inset
.
-\end_inset
+\end_layout
+
+\end_inset
for details.
-\layout Description
+\end_layout
+\begin_layout Description
Abstract: You may wonder why an abstract is an extra feature.
Well, it is in book class.
Usually books don't have abstracts.
Memoir, however, has.
- You can use it whereever and how often you like.
-\layout Description
+ You can use it wherever and how often you like.
+\end_layout
+\begin_layout Description
Chapterprecis: You may know this from belletristic: The contents of a chapter
is shortly described below the title and also in the table of contents
(e.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
,
-\end_inset
+\end_layout
+
+\end_inset
g.
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
-\end_inset
+\end_layout
+\end_inset
-\emph on
+
+\emph on
Our hero arrives in Troia; he loses some friends; he finds others
-\emph default
+\emph default
).
Chapterprecis does exactly this.
It is therefore only sensible below a chapter.
-\layout Description
+\end_layout
+\begin_layout Description
Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
The epigraph environment provides an elegant way of typesetting such a
motto.
needs two arguments (text and source).
In this case, we have to use curly brackets (in TeX mode) between the two
arguments:
-\emph on
+\emph on
<smart slogan>
-\emph default
+\emph default
-\family typewriter
+\family typewriter
}{
-\family default
+\family default
-\emph on
+\emph on
<author of the slogan>.
-\layout Description
+\end_layout
+\begin_layout Description
Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
complex figurative poems).
- Lyx can only support a few of them.
+ LyX can only support a few of them.
One is poemtitle, which is a centered title for poems, which will also
be added to the table of contents (verse is the standard environment for
poems.
Memoir has some enhanced versions of verse, but you need to use ERT, because
they have to be nested inside regular verse environments, which is not
possible with LyX).
-\layout Description
+\end_layout
+\begin_layout Description
Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
-\layout Chapter
+\end_layout
+\begin_layout Chapter
Importing and Exporting Alternate File Formats
\begin_inset OptArg
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Importing and Exporting
-\end_inset
+\end_layout
+\end_inset
-\layout Section
+\end_layout
+
+\begin_layout Section
Considerations
-\layout Standard
+\end_layout
+\begin_layout Standard
Importing and exporting LyX documents from/to other formats has been touched
on briefly in the
-\emph on
+\emph on
User Guide
-\emph default
+\emph default
.
Here we describe more of the gory details needed to understand just what
is going on when you click on the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
I
-\bar default
+\bar default
mport
-\family default
+\family default
and
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
E
-\bar under
+\bar under
x
-\bar default
+\bar default
port
-\family default
+\family default
menu items.
-\layout Section
+\end_layout
+\begin_layout Section
Importing Other Formats
-\layout Subsection
+\end_layout
+\begin_layout Subsection
LaTeX
-\layout Standard
+\end_layout
+\begin_layout Standard
Translating from LaTeX into LyX is performed by a Perl script called reLyX.
Although it is a standalone program which can be called from the command
line, LyX will call it automatically when a LaTeX document is imported.
- See section\SpecialChar ~
+ See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:reLyX}
+\begin_inset LatexCommand ref
+reference "sec:reLyX"
-\end_inset
+\end_inset
for a complete description.
There are no user tunable parameters for reLyX within LyX.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
ASCII Text
-\layout Standard
+\end_layout
+\begin_layout Standard
When importing plain ASCII text, there are two methods of reading the file.
Importing
\begin_inset Quotes eld
-\end_inset
+\end_inset
as lines
\begin_inset Quotes erd
-\end_inset
+\end_inset
preserves all the linebreaks in the ASCII; to LyX, then, each line looks
like a paragraph.
Importing
\begin_inset Quotes eld
-\end_inset
+\end_inset
as paragraphs
\begin_inset Quotes erd
-\end_inset
+\end_inset
assumes that consecutive lines separated by only a single linebreak form
a single paragraph.
Successive linebreaks with no intervening text are thus assumed to be paragraph
delimiters.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Noweb
-\layout Standard
+\end_layout
+\begin_layout Standard
-\emph on
+\emph on
[Editor's note: Needs to be written, obviously - any volunteers? --- mer]
-\layout Section
+\end_layout
+\begin_layout Section
Exporting Other Formats
-\layout Subsection
-
+\end_layout
+
+\begin_layout Standard
+The output formats listed here in the following are also explained concerning
+ possible graphics formats in the
+\emph on
+Embedded Objects
+\emph default
+ manual.
+\end_layout
+
+\begin_layout Subsection
LaTeX
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX generates two types of LaTeX files: stripped down versions for the normal
processing (
-\family sans
+\family sans
View DVI
-\family default
+\family default
, etc.) which one normally never sees
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
The resulting file is a perfectly valid LaTeX file, though the preamble
might look a bit strange since it includes some definitions used by LyX
which wouldn't show up in most human-written files.
-\end_inset
+\end_layout
+
+\end_inset
, and human readable forms which are suitable for exchanging with your colleague
s.
The only settable option for the translation is the line length of the
output file.
The default is 65 characters, but it can be set in
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
references
-\family default
+\family default
using the
-\family sans
-\bar under
+\family sans
+\bar under
A
-\bar default
-scii\SpecialChar ~
-line\SpecialChar ~
+\bar default
+scii\InsetSpace ~
+line\InsetSpace ~
length
-\family default
+\family default
field.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Device Independent Files
-\layout Standard
+\end_layout
+\begin_layout Standard
Device Independent files (DVI files) are produced by running LaTeX on your
document.
There are no user settable options.
-\layout Subsection
+\end_layout
-PostScript®
-\layout Standard
+\begin_layout Subsection
+PostScript
+\end_layout
-The next step in the conversion chain is converting a DVI file into Postscript®.
+\begin_layout Standard
+The next step in the conversion chain is converting a DVI file into Postscript.
You can either use
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
E
-\bar default
+\bar default
xport
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
+\family sans
Pos
-\bar under
+\bar under
t
-\bar default
+\bar default
script
-\family default
+\family default
or, if you need more control on the result,
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
rint
-\family default
+\family default
.
If you use the later, note that it is possible to configure, in
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
P
-\bar default
+\bar default
references
-\family default
+\family default
, the options passed to the dvips program to achieve different effects.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
ASCII text
-\layout Standard
+\end_layout
+\begin_layout Standard
Exporting as ASCII attempts to preserve the
\begin_inset Quotes eld
-\end_inset
+\end_inset
shape
\begin_inset Quotes erd
-\end_inset
+\end_inset
of the document as well as possible, but things like centering and indentation
are thrown out; paragraphs are separated by blank lines.
Section numbering and cross-references are done correctly, so the resulting
text files is remarkably readable.
The only changeable option is the length of lines, as for LaTeX output.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
HTML
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX documents can be converted to hypertext markup, usually by converting
to LaTeX first, then converting that to HTML\SpecialChar \@.
- Three LaTeX
+ Four LaTeX
\begin_inset Formula $\rightarrow$
-\end_inset
+\end_inset
HTML converters are currently known to LyX:
-\family typewriter
+\family typewriter
tth
-\family default
+\family default
,
-\family typewriter
+\family typewriter
latex2html
-\family default
-, and
-\family typewriter
+\family default
+,
+\family typewriter
hevea
-\family default
+\family default
+ and
+\family typewriter
+htlatex
+\family default
.
Though they are autodetected, you can overide the selection in preferences.
You can also include further command line options in this dialog.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
PDF
-\layout Standard
-\added_space_bottom bigskip
+\end_layout
+
+\begin_layout Standard
by
-\noun on
+\noun on
Dekel Tsur
-\noun default
+\noun default
(mostly)
-\layout Standard
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+\begin_layout Standard
The fastest way to generate a basic PDF file (no tags, links, etc.) with
- any version of LyX is to save the document as a Postscript® file, then
- run the
-\family typewriter
+ any version of LyX is to save the document as a Postscript file, then run
+ the
+\family typewriter
ps2pdf
-\family default
+\family default
command on it.
Starting with version 1.1.6, the menu item
-\family sans
+\family sans
File->Export->PDF
-\family default
+\family default
will do all this for you.
There are some issues with fonts that you need to pay attention to: see
- Section\SpecialChar ~
+ Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:badfonts}
+\begin_inset LatexCommand ref
+reference "sec:badfonts"
-\end_inset
+\end_inset
.
Also, as of version 1.1.6, there is a better method that will generate much
more sophisticated files.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Use pdfLaTeX
-\layout Standard
-
-With pdfLaTeX you need to convert your eps figures to PDF (see Section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{sec:pdfeps}
-
-\end_inset
+\end_layout
-), and you cannot use pstricks.
+\begin_layout Standard
+With pdfLaTeX you cannot use pstricks.
On the other hand, with pdfLaTeX it is possible to insert directly images
- in JPEG or PNG format, use TrueType fonts, and more.
-\layout Subsubsection
+ in JPEG, PDF or PNG format, use TrueType fonts, and more.
+\end_layout
+\begin_layout Subsubsection
Why does the text look so bad when viewed with Acrobat Reader?
-\begin_inset LatexCommand \label{sec:badfonts}
+\begin_inset LatexCommand label
+name "sec:badfonts"
-\end_inset
+\end_inset
\begin_inset OptArg
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Bad Fonts in Acrobat Reader
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
When creating a PDF from the LyX file, you need to use outline font instead
of the default bitmap fonts (in fact, you should also use outline fonts
for Postscript files).
- Recent LaTeX distributions come with Postscript® Type 1 version of the
- standard (Computer Modern) fonts.
+ Recent LaTeX distributions come with Postscript Type 1 version of the standard
+ (Computer Modern) fonts.
pdfLaTeX uses these font by default.
Dvips doesn't use these fonts by default, so to make it use them, add the
following to lines to your
-\family typewriter
+\family typewriter
~/.dvipsrc
-\family default
+\family default
file
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
p+ psfonts.cmz
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
p+ psfonts.amz
-\layout Standard
+\end_layout
+\begin_layout Standard
If the default LaTeX font encoding (OT1) is used, nothing else need to be
done.
However, if the T1 font encoding is used, then LaTeX uses the newer EC
The solution is to use the ae package which emulates T1 coded fonts using
the standard CM fonts.
This is done by adding
-\family typewriter
+\family typewriter
-\backslash
+\backslash
usepackage{ae,aecompl}
-\family default
+\family default
to the preamble of the LyX file.
- However, some glyphs are missing from the CM fonts (e.g.
- eth, thorn), and they are taken from the EC fonts.
+ However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+eth, thorn), and
+ they are taken from the EC fonts.
Therefore you get these glyphs as bitmaps.
-\layout Standard
+\end_layout
+\begin_layout Standard
Note: LyX uses by default the T1 font encoding.
If you wish to use the default font encoding (this is not recommended,
unless you only write English documents), clear the field
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
-eX\SpecialChar ~
+\bar default
+eX\InsetSpace ~
encoding
-\family default
+\family default
in preferences (tabs
-\family sans
+\family sans
Outputs
-\family default
+\family default
,
-\family sans
+\family sans
Misc
-\family default
+\family default
).
-\layout Standard
+\end_layout
-An alternate option is to use the standard Postscript® fonts instead of
- the Computer Modern fonts.
+\begin_layout Standard
+An alternate option is to use the standard Postscript fonts instead of the
+ Computer Modern fonts.
To do that, you need to select
-\family sans
+\family sans
pslatex
-\family default
+\family default
as the global font in the document layout dialog.
- When using the Postscript® fonts, the result PDF file is smaller as the
+ When using the Postscript fonts, the result PDF file is smaller as the
fonts are not saved into the file.
- Furthermore, the Postscript® fonts include all T1 glyphs.
- On the other hand, the Postscript® fonts have no bold symbol font, so poor
- man's bold must be used (see Section\SpecialChar ~
+ Furthermore, the Postscript fonts include all T1 glyphs.
+ On the other hand, the Postscript fonts have no bold symbol font, so poor
+ man's bold must be used (see Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:pdfbold}
+\begin_inset LatexCommand ref
+reference "sec:pdfbold"
-\end_inset
+\end_inset
).
- The Postscript® fonts also look different from the Computer Modern fonts.
-\layout Standard
+ The Postscript fonts also look different from the Computer Modern fonts.
+\end_layout
-To sum up, both the Computer Modern and the Postscript® fonts gives good
+\begin_layout Standard
+To sum up, both the Computer Modern and the Postscript fonts gives good
results (with few exceptions).
The decision of which one to use is a matter of taste.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Why doesn't the
-\backslash
+\backslash
boldsymbol{} command work when I use pslatex?
-\begin_inset LatexCommand \label{sec:pdfbold}
-
-\end_inset
-
-
-\begin_inset OptArg
-collapsed true
-
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-boldsymbol{}
-\family default
- and
-\family typewriter
-pslatex
-\end_inset
-
-
-\layout Standard
-
-The Postscript® fonts do not have a bold symbol font.
- The solution is to use the
-\family typewriter
-
-\backslash
-pmb{}
-\family default
- (poor man's bold) command.
-\layout Standard
-
-It is possible to redefine the
-\family typewriter
-
-\backslash
-boldsymbol
-\family default
- command to use
-\family typewriter
-
-\backslash
-pmb
-\family default
- by putting
-\layout LyX-Code
-
-
-\backslash
-renewcommand{
-\backslash
-boldsymbol}[1]{
-\backslash
-pmb{#1}}
-\layout Standard
-
-in the preamble.
-\layout Subsubsection
-
-Is it possible to do write latex code which is processed only when running
- pdfLaTeX?
-\begin_inset OptArg
-collapsed true
-
-\layout Standard
-
-Conditionals with pdfLaTeX
-\end_inset
-
-
-\layout Standard
-
-Yes.
- Here is an example:
-\layout LyX-Code
-
-
-\backslash
-newif
-\backslash
-ifpdf
-\layout LyX-Code
-
-
-\backslash
-ifx
-\backslash
-pdfoutput
-\backslash
-undefined
-\layout LyX-Code
-
-
-\backslash
-pdffalse
-\layout LyX-Code
-
-
-\backslash
-else
-\layout LyX-Code
-
-
-\backslash
-pdftrue
-\layout LyX-Code
-
-
-\backslash
-fi
-\layout LyX-Code
-
-\layout LyX-Code
-
-
-\backslash
-ifpdf
-\layout LyX-Code
-
-
-\backslash
-pdfinfo { /Author (your name and e-mail address)
-\layout LyX-Code
-
- /Title (official title -- i.e., title element)
-\layout LyX-Code
-
- /Subject (one line description of the document)
-\layout LyX-Code
-
- }
-\layout LyX-Code
-
-
-\backslash
-pdfcatalog { /PageMode (/UseNone)
-\layout LyX-Code
-
- % /OpenAction (fitbh)
-\layout LyX-Code
-
- }
-\layout LyX-Code
-
-
-\backslash
-usepackage[pdftex]{hyperref}
-\layout LyX-Code
-
-
-\backslash
-else
-\layout LyX-Code
-
-
-\backslash
-usepackage[ps2pdf]{hyperref}
-\layout LyX-Code
-
-
-\backslash
-fi
-\layout Subsubsection
-
-How can I make URLs clickable ?
-\layout Standard
-
-See the references here :
-\layout Standard
-
+\begin_inset LatexCommand label
+name "sec:pdfbold"
-\begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
+\end_inset
-\end_inset
+\begin_inset OptArg
+status collapsed
-\layout Subsection
-
-Custom
-\layout Standard
-
-Custom exports are possible if you have some particularly weird format you
- wish to convert to, assuming you have the relevant converter, of course.
- The format of the
-\emph on
-input
-\emph default
- file can be chosen in the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-ustom
-\family default
-dialog; LyX will automatically convert the file to this point, then feed
- it to your custom converter.
- The possible values are all formats that LyX can produce from its own documents.
-
-\layout Standard
-
-The converter command is also specified in the dialog.It should be a completely
- qualified command line which uses the variable
-\family typewriter
-$$FName
-\family default
- to specify the name of the file.
- If this variable is not given, then the file will be sent to the standard
- input of your command.
- You may have to apply a bit of ingenuity to escape this sequence correctly
- so that it is compatible with your shell.
-
-\layout Standard
-
-While it is not possible to save this command using the
-\family sans
-Preferences
-\family default
-dialog, you can manually edit your
-\family typewriter
-.lyx/preferences
-\family default
- to add a line like
-\layout LyX-Code
-
-
-\backslash
-custom_export_command "mycommand $$FName"
-\layout Section
-
-The Complete reLyX Description
-\begin_inset LatexCommand \label{sec:reLyX}
-
-\end_inset
-
-
-\layout Subsection
-
-Synopsis
-\layout Standard
-
-The simplest way to use reLyX is via the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-mport
-\family default
- command in LyX.
- That runs reLyX on the given file and loads the resulting file into LyX.
- You should try that first, and call it from the command line only if you
- need to use more complicated options.
-\layout Standard
-
-
-\series bold
-reLyX
-\series default
- [
-\series bold
--c
-\series default
-
-\shape italic
-textclass
-\shape default
- ] [
-\series bold
--df
-\series default
- ] [
-\series bold
--o
-\series default
-
-\shape italic
-outputdir
-\shape default
- ] [
-\series bold
- -r
-\series default
-\shape italic
- renv1
-\shape default
-[,
-\shape italic
-renv2
-\shape default
-...]] [
-\series bold
- -s
-\series default
-\shape italic
- sfile1
-\shape default
-[,
-\shape italic
-sfile2
-\shape default
-...]]
-\emph on
-inputfile
-\layout Standard
-
-
-\series bold
-reLyX
-\series default
-
-\series bold
--p
-\series default
-
-\series bold
--c
-\series default
-
-\shape italic
-textclass
-\shape default
- [
-\series bold
--df
-\series default
- ] [
-\series bold
--o
-\series default
-
-\shape italic
-outputdir
-\shape default
- ] [
-\series bold
- -r
-\series default
-\shape italic
- renv1
-\shape default
-[,
-\shape italic
-renv2
-\shape default
-...]] [
-\series bold
- -s
-\series default
-\shape italic
- sfile1
-\shape default
-[,
-\shape italic
-sfile2
-\shape default
-...]]
-\emph on
-inputfiles
-\layout Standard
-
-
-\series bold
-reLyX
-\series default
-
-\series bold
--h
-\layout Subsection
-
-Options
-\layout Description
-
-
-\series bold
--c
-\series default
- Class.
- By default, when reLyX sees a
-\family typewriter
-
-\backslash
-documentclass{foo}
-\family default
- command, it creates a file of textclass
-\begin_inset Quotes eld
-\end_inset
-
-foo
-\begin_inset Quotes erd
-\end_inset
-
- and reads the LyX layout file for that class.
- Use
-\series bold
--c
-\series default
- to declare a different textclass (and read a different layout file).
-\layout Description
-
-
-\series bold
--d
-\series default
- Debug.
- By default, reLyX gives sparse output and deletes the temporary files which
- were created during translation.
- Using the
-\series bold
--d
-\series default
- flag will create much more output (both to stdout and stderr) and leave
- the temporary files around.
-\layout Description
-
-
-\series bold
--f
-\series default
- Force.
- reLyX will not run if the
-\family typewriter
-.lyx
-\family default
- file it would generate already exists Use the
-\series bold
--f
-\series default
- option (carefully) to clobber any existing files.
-\layout Description
-
-
-\series bold
--h
-\series default
- Help.
- Print out usage information and quit
-\layout Description
-
-
-\series bold
--o
-\series default
- Output directory.
- With this option, all temporary files and LyX output files (for the given
- input file, for any included files, or for any file fragments given with
- the
-\series bold
--p
-\series default
- option) will be put into
-\shape italic
-outputdir
-\shape default
-.
- Otherwise, for each file
-\emph on
-dir/foo.tex
-\emph default
-, the temporary files and the LyX output file will be created in
-\emph on
-dir
-\emph default
-.
- This can be useful if a file includes files from other directories which
- you want to consolidate in one directory, or if you don't have write permission
- on the directory the LaTeX files are in.
-\layout Description
-
-
-\series bold
--p
-\series default
- Partial file.
- The input files are LaTeX fragments, with no preamble matter or
-\family typewriter
-
-\backslash
-begin{document}
-\family default
- commands.
- This option requires the
-\series bold
--c
-\series default
- option, since there are no
-\family typewriter
-
-\backslash
-documentclass
-\family default
- commands in the files reLyX is translating.
- When using this option, you can translate more than one file, as long as
- all files are the same class.
- The LyX file created by reLyX can be included in an existing LyX file using
-
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Fil
-\bar under
-e
-\bar default
-\SpecialChar \menuseparator
-Ly
-\bar under
-X
-\bar default
-\SpecialChar ~
-Document
-\family default
-.
-\layout Description
-
-
-\series bold
--r
-\series default
- Regular environments (see the Section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{sub:relyx-syntax}
-
-\end_inset
-
-).
- If you give more than one environment, separate them with commas (not
- spaces).
- You'll probably need to quote the environment list, especially if it has
- asterisk environments (foo*) in it.
- If you use this command often, considering creating a personal syntax file.
-\layout Description
-
-
-\series bold
--s
-\series default
- Syntax files.
- Input (one or more quoted, comma-separated) syntax files to read in addition
- to the default.
- (see the section Section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{sub:relyx-syntax}
-
-\end_inset
-
- for details).
-\layout Subsection
-
-Description
-\layout Subsubsection
-
-Introduction
-\layout Standard
-
-reLyX will create a LyX file
-\emph on
-dir/foo.lyx
-\emph default
- from the LaTeX file
-\emph on
-dir/foo.tex
-\emph default
- (unless the
-\series bold
--o
-\series default
- option is used).
-\layout Standard
-
-Suffixes
-\family typewriter
-.tex
-\family default
-,
-\family typewriter
-.ltx
-\family default
- and
-\family typewriter
-.latex
-\family default
- are supported.
- If
-\emph on
-inputfile
-\emph default
- does not exist and does not have one of these suffixes, reLyX will try
- to translate
-\emph on
-inputfile.tex
-\emph default
-.
- (This is similar to the behavior of LaTeX.)
-\layout Standard
-
-The purpose of reLyX is to translate
-\shape italic
-well-behaved
-\shape default
- LaTeX2e into LyX.
- If your LaTeX file doesn't compile---or if you do weird things, like redefining
- standard LaTeX commands---it may choke.
- LaTeX209 will often be translated correctly, but it's not guaranteed.
-\layout Standard
-
-reLyX has some bugs and lacks a few features.
- However, its main goals are:
-\layout Itemize
-
-Get through a well-behaved LaTeX2e file without crashing
-\layout Itemize
-
-Translate a lot of that file.
-\layout Itemize
-
-Localize the parts that can't be translated and copy them in TeX mode
-\layout Standard
-
-It achieves these main goals pretty well on most files.
-\layout Standard
-
-There are many improvements that can and will be made to reLyX in the future.
- However, we wanted to get reLyX out there early on, to make it easier for
- new LyX users to read in their existing LaTeX files.
-\layout Subsubsection
-
-Usage
-\layout Standard
-
-Here's a more lengthy description of what you should do to translate a LaTeX
- document into LyX.
-\layout Itemize
-
-Run reLyX.
-\begin_deeper
-\layout Standard
-
-reLyX will inform you of its progress and give any warnings to stderr, so
- if you don't want any output at all, try (in csh)
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-reLyX foo.tex >& /dev/null
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- or (in bash)
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-reLyX foo.tex
-\family default
-
-\family typewriter
-2>&1 >/dev/null
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- You should NOT redirect standard output to
-\family typewriter
-foo.lyx
-\family default
-.
-
-\end_deeper
-\layout Itemize
-
-Run LyX on the resulting .lyx file.
-\begin_deeper
-\layout Standard
-
-In theory, most of the file will have been translated, and anything that's
- untranslatable will be highlighted in red (TeX mode).
- In theory, LyX will be able to read in the file, and to create printed
- documents from it, because all that untranslated red stuff will be passed
- directly back to LaTeX, which LyX uses as a backend.
- Unfortunately, reality doesn't always reflect theory.
- If reLyX crashes, or LyX cannot read the generated LyX file, see Section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{sub:relyx-bugs}
-
-\end_inset
-
- or the
-\family typewriter
-BUGS
-\family default
- file.
-\end_deeper
-\layout Itemize
-
-Change things that are in ERT boxes (TeX code) by hand in LyX.
-\begin_deeper
-\layout Standard
-
-As mentioned above, you should be able to print out the LyX file even without
- doing this.
- However, changing a command in TeX mode to the corresponding LyX object
- will allow you to take advantage of LyX's WYSIWYM editing.
-\layout Standard
-
-reLyX is not guaranteed to create a LyX file which generates exactly the
- same output as the LaTeX file, but it should come close.
- reLyX will generally err on the side of translating less to ensure that
- dvi or ps files are accurate, even though this leads to more
-\begin_inset Quotes eld
-\end_inset
-
-evil red text
-\begin_inset Quotes erd
-\end_inset
-
- and less WYSIWYM.
-\end_deeper
-\layout Itemize
-
-PROOFREAD THE DOCUMENT!!
-\begin_deeper
-\layout Standard
-
-I'm sure you were planning on doing this anyway, but it's particularly important
- after translating a LaTeX document.
- reLyX is, at least now, better at
-\begin_inset Quotes eld
-\end_inset
-
-macro-translating
-\begin_inset Quotes erd
-\end_inset
-
- (translating the whole document) than
-\begin_inset Quotes eld
-\end_inset
-
-micro-translating
-\begin_inset Quotes erd
-\end_inset
-
- (translating every little detail).
- For example, you may see extra spaces or deleted spaces.
- Space handling has improved, but it's not perfect.
-\end_deeper
-\layout Subsubsection
-
-What reLyX Can Handle
-\layout Standard
-
-reLyX understands many LaTeX commands.
- It will translate:
-\layout Itemize
-
-regular text, including mini-commands like ~, '',
-\family typewriter
-
-\backslash
-@
-\family default
-,
-\family typewriter
-
-\backslash
-TeX
-\family default
-, as well as accented characters like
-\family typewriter
-
-\backslash
-'{a}
-\family default
-, and the special cases ?` and !`
-\layout Itemize
-
-title commands like
-\family typewriter
-
-\backslash
-author
-\family default
-,
-\family typewriter
-
-\backslash
-date
-\family default
-,
-\family typewriter
-
-\backslash
-title
-\family default
-,
-\family typewriter
-
-\backslash
-thanks
-\family default
- and the abstract environment
-\layout Itemize
-
-heading commands like
-\family typewriter
-
-\backslash
-section
-\family default
- including starred commands (
-\family typewriter
-
-\backslash
-section*
-\family default
-)
-\layout Itemize
-
-Environments:
-\family typewriter
-quote
-\family default
-,
-\family typewriter
-quotation
-\family default
-, and
-\family typewriter
-verse
-\family default
-;
-\family typewriter
-center
-\family default
-,
-\family typewriter
-flushright
-\family default
-, and
-\family typewriter
-flushleft
-\layout Itemize
-
-
-\family typewriter
-itemize
-\family default
-,
-\family typewriter
-enumerate
-\family default
-, and
-\family typewriter
-description
-\family default
- environments, and their
-\family typewriter
-
-\backslash
-item
-\family default
- commands.
- Also, well-behaved nested lists
-\layout Itemize
-
-cross-referencing commands:
-\family typewriter
-
-\backslash
-ref
-\family default
-,
-\family typewriter
-
-\backslash
-pageref
-\family default
-,
-\family typewriter
-
-\backslash
-label
-\family default
-, and
-\family typewriter
-
-\backslash
-cite
-\layout Itemize
-
-
-\family typewriter
-
-\backslash
-footnote
-\family default
- and
-\family typewriter
-
-\backslash
-margin
-\layout Itemize
-
-font-changing commands including
-\family typewriter
-
-\backslash
-em
-\family default
-,
-\family typewriter
-
-\backslash
-emph
-\family default
-,
-\family typewriter
-
-\backslash
-textit
-\family default
-, and corresponding commands to change family, size, series, and shape
-\layout Itemize
-
-
-\family typewriter
-
-\backslash
-input{foo}
-\family default
- (or
-\family typewriter
-
-\backslash
-input{foo.blah}
-\family default
-) and
-\family typewriter
-
-\backslash
-include{foo}
-\family default
-.
- Plain TeX
-\family typewriter
-
-\backslash
-input
-\family default
- command
-\begin_inset Quotes erd
-\end_inset
-
-
-\family typewriter
-
-\backslash
-input foo.tex
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- is also supported.
-\layout Itemize
-
-
-\family typewriter
-tabular
-\family default
- environment, and commands that go inside it like
-\family typewriter
-
-\backslash
-hline
-\family default
-,
-\family typewriter
-
-\backslash
-cline
-\family default
-, and
-\family typewriter
-
-\backslash
-multicolumn
-\family default
- (but see below)
-\layout Itemize
-
-float environments
-\family typewriter
-table
-\family default
- and
-\family typewriter
-table*
-\family default
-, as well as
-\family typewriter
-
-\backslash
-caption
-\family default
- commands within them
-\layout Itemize
-
-
-\family typewriter
-thebibliography
-\family default
- environment and
-\family typewriter
-
-\backslash
-bibitem
-\family default
- command, as well as BibTeX's
-\family typewriter
-
-\backslash
-bibliography
-\family default
- and
-\family typewriter
-
-\backslash
-bibliographystyle
-\family default
- commands
-\layout Itemize
-
-miscellaneous commands:
-\family typewriter
-
-\backslash
-hfill
-\family default
-,
-\family typewriter
-
-\backslash
-
-\backslash
-
-\family default
-,
-\family typewriter
-
-\backslash
-noindent
-\family default
-,
-\family typewriter
-
-\backslash
-ldots
-\family default
-...
-\layout Itemize
-
-documentclass-specific environments (and some commands) which can be translated
- to LyX layouts
-\layout Itemize
-
-arguments to certain untranslatable commands (e.g.
-
-\family typewriter
-
-\backslash
-mbox
-\family default
-)
-\layout Standard
-
-Some of this support may not be 100% yet.
- See below for details
-\layout Standard
-
-reLyX copies math (almost) verbatim from your LaTeX file.
- Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
- by LyX should work just fine.
- A few math commands which are not supported by LyX will be replaced with
- their equivalents, e.g.,
-\family typewriter
-
-\backslash
-to
-\family default
- is converted to
-\family typewriter
-
-\backslash
-rightarrow
-\family default
-.
- See the section on
-\shape italic
-Syntax Files
-\shape default
- for more details.
-\layout Standard
-
-reLyX will also copy any preamble commands (i.e., anything before
-\family typewriter
-
-\backslash
-begin{document}
-\family default
-) verbatim, so fancy stuff you've got in your preamble should be conserved
- in dvi and printed documents, although it will not of course show up in
- the LyX window.
- Check the preamble to make sure.
-\layout Subsubsection
-
-What reLyX Can't Handle --- But it's OK
-\layout Itemize
-
-figures and
-\family typewriter
-tabular*
-\family default
- tables
-\layout Itemize
-
-minipages
-\layout Itemize
-
-spacing commands (
-\family typewriter
-
-\backslash
-vspace
-\family default
-,
-\family typewriter
-
-\backslash
-pagebreak
-\family default
-,
-\family typewriter
-
-\backslash
-par
-\family default
-)
-\layout Itemize
-
-
-\family typewriter
-
-\backslash
-centering
-\family default
-,
-\family typewriter
-
-\backslash
-raggedleft
-\family default
-,
-\family typewriter
-
-\backslash
-raggedright
-\layout Itemize
-
-
-\family typewriter
-
-\backslash
-verb
-\family default
- and
-\family typewriter
-verbatim
-\family default
- environment.
- reLyX is careful to copy
-\shape italic
-exactly
-\shape default
- in this case, including comments and whitespace.
-\layout Itemize
-
-some unknown (e.g., user-defined) environments and commands
-\layout Standard
-
-reLyX copies unknown commands, along with their arguments, verbatim into
- the LyX file.
- Also, if it sees a
-\family typewriter
-
-\backslash
-begin{foo}
-\family default
- where it doesn't recognize the
-\begin_inset Quotes eld
-\end_inset
-
-foo
-\begin_inset Quotes erd
-\end_inset
-
- environment, it will copy verbatim until it sees
-\family typewriter
-
-\backslash
-end{foo}
-\family default
- (unless you use the
-\series bold
--r
-\series default
- option).
- Hopefully, then, most of these unknown commands won't cause reLyX to break;
- they'll merely require you to do some editing once you've loaded the file
- up in LyX.
- That should be less painful than editing either the
-\family typewriter
-.tex
-\family default
- or the
-\family typewriter
-.lyx
-\family default
- file using a text editor.
-\layout Subsubsection
-
-What reLyX Handles Badly --- a.\SpecialChar ~
-k.\SpecialChar ~
-a.
- BUGS
-\begin_inset LatexCommand \label{sub:relyx-bugs}
-
-\end_inset
-
-
-\layout Standard
-
-Since reLyX is relatively new, it's got a number of problems.
- As it matures, these bugs will be squished.
- A number of bugs and missing features can be found listed on the LyX bug
- tracker,
-\begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
-
-\end_inset
-
-.
-\layout Standard
-
-If reLyX is choking on something, or LyX can't read it after reLyX translates
- it, the best thing to do is to put
-\family typewriter
-
-\backslash
-begin{reLyXskip}
-\family default
- before the offending text, and
-\family typewriter
-
-\backslash
-end{reLyXskip}
-\family default
- after it.
- I call this a
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- block.
- reLyX will copy this block exactly, in TeX mode.
- Then edit the resulting LyX file, and translate the unknown stuff by hand.
- The
-\family typewriter
-reLyXskip
-\family default
- environment is magical; the
-\family typewriter
-
-\backslash
-begin
-\family default
- and
-\family typewriter
-
-\backslash
-end
-\family default
- commands will not be put into the LyX file.
-\layout Itemize
-
-
-\begin_inset Quotes eld
-\end_inset
-
-Exact
-\begin_inset Quotes erd
-\end_inset
-
- copying of unknown environments and commands isn't quite exact.
- Specifically, newlines and comments may be lost.
- This will yield ugly LyX, but in almost all cases the output will be the
- same.
- However, certain parts of the file will be copied perfectly, including
- whitespace and comments.
- This includes: the LaTeX preamble,
-\family typewriter
-verbatim
-\family default
- environments and
-\family typewriter
-
-\backslash
-verb
-\family default
- commands, and skip blocks.
-\layout Itemize
-
-reLyX translates only a few options to the
-\family typewriter
-
-\backslash
-documentclass
-\family default
- command.
- (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
- landscape, and [one|two]column.) Other options are placed in the extra class
- options field in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-\begin_deeper
-\layout Standard
-
-More importantly, reLyX doesn't translate
-\family typewriter
-
-\backslash
-usepackage
-\family default
- commands, margin commands,
-\family typewriter
-
-\backslash
-newcommand
-\family default
-s, or, in fact, anything else from the preamble.
- It simply copies them into the LaTeX preamble.
- If you have margin commands in your preamble, then the LyX file will generate
- the right margins.
- However, these margins will override any margins you set in the LyX
-\family sans
-\bar under
-D
-\bar default
-ocument
-\bar under
-\SpecialChar \menuseparator
-S
-\bar default
-ettings
-\family default
- dialog.
- So you should remove the options from the preamble to be safe.
- The same goes for setting your language with babel,
-\family typewriter
-
-\backslash
-inputencoding
-\family default
-,
-\family typewriter
-
-\backslash
-pagestyle
-\family default
-, etc.
-\end_deeper
-\layout Itemize
-
-The foil class has a couple bugs.
- reLyX may do weird things with optional arguments to
-\family typewriter
-
-\backslash
-foilhead
-\family default
- commands.
- Also, it may handle
-\family typewriter
-
-\backslash
-begin{dinglist}
-\family default
- incorrectly (although the stuff in the environment should translate normally).
-\layout Standard
-
-reLyX is hopefully rather robust.
- As mentioned above, it may not translate your file perfectly, but it shouldn't
- crash.
- If it does crash---and the problem is not one of those mentioned above
- or in the
-\emph on
-BUGS
-\emph default
- file---see Section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{sub:relyx-bug-reports}
-
-\end_inset
-
-.
-\layout Subsubsection
-
-What LyX Can't Handle
-\layout Standard
-
-LyX itself is missing a couple features, such that even if reLyX translates
- things perfectly, LyX may still have trouble reading it.
- If you really need these features, you can export your final document as
- LaTeX, and put them back in.
- See
-\emph on
-BUGS
-\emph default
- for more details on these bugs.
-\layout Itemize
-
-For a number of commands, LyX does not support the optional argument.
- Examples include
-\family typewriter
-
-\backslash
-sqrt
-\family default
-,
-\family typewriter
-
-\backslash
-chapter
-\family default
- (and other sectioning commands), and
-\family typewriter
-
-\backslash
-
-\backslash
-
-\family default
-.
- reLyX will automatically discard the optional arguments with a warning
- to stdout.
- LyX also ignores the width argument for the
-\family typewriter
-thebibliography
-\family default
- environment.
-\layout Itemize
-
-Centering (or right or left justifying) works on full paragraphs.
-\layout Itemize
-
-LyX support for tables isn't perfect.
- For complicated tables, use a
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- block, so that they will be copied in TeX mode.
-\layout Itemize
-
-The LyX math editor can't handle the AMS-LaTeX math environments align,
- split, etc.
- So those environments will be copied in TeX mode.
- You can change
-\family typewriter
-equation*
-\family default
- environments to the exactly equivalent displaymath, and then they will
- be translated correctly.
-\layout Subsection
-
-Examples
-\layout Standard
-
-
-\family typewriter
-reLyX -df -o
-\begin_inset Quotes eld
-\end_inset
-
-my/dir
-\begin_inset Quotes erd
-\end_inset
-
- -r
-\begin_inset Quotes eld
-\end_inset
-
-myenv
-\begin_inset Quotes erd
-\end_inset
-
- foo.tex > foo.debug
-\layout Standard
-
-The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
- When it finds a
-\family typewriter
-
-\backslash
-begin{myenv} ...
-
-\backslash
-end{myenv}
-\family default
- block, it will translate the stuff within the block, but copy the
-\family typewriter
-
-\backslash
-begin
-\family default
- and
-\family typewriter
-
-\backslash
-end
-\family default
- commands in TeX mode.
- Finally, I'm going to keep the temporary files around (they will also
- be in my/dir/) and output lots of debugging information into the file foo.debug.
-\layout Subsection
-
-Notes
-\layout Subsubsection
-
-Bug Reports
-\begin_inset LatexCommand \label{sub:relyx-bug-reports}
-
-\end_inset
-
-
-\layout Standard
-
-If reLyX is crashing or otherwise acting strangely---in ways other than
- those described in Section\SpecialChar ~
-
-\begin_inset LatexCommand \ref{sub:relyx-bugs}
-
-\end_inset
-
- or the bug tracker---then please run reLyX
-\series bold
- -d
-\series default
-.
- That will allow you to figure out where in the reLyXing process it crashed.
- That, in turn, will allow you to write a better bug report, which will
- allow the developers to fix it more quickly and easily.
-\layout Standard
-
-Bug reports should be sent to the LyX developers' mailing list.
- Its address is currently
-\family typewriter
-lyx-devel@lists.lyx.org
-\family default
-.
- If you are running reLyX on a huge file, please do not send all of the
- output in your bug report.
- Just include the last ten or twenty lines of output, along with the piece
- of the LaTeX file it crashed on.
- Or, even better, attach a small but complete file which causes the same
- problem as your original file.
-\layout Subsubsection
-
-Implementation Details:
-\layout Standard
-
-reLyX makes several
-\begin_inset Quotes eld
-\end_inset
-
-passes
-\begin_inset Quotes erd
-\end_inset
-
- in order to translate a TeX file.
- On each pass, it creates one or two files.
-\layout Description
-
-Pass\SpecialChar ~
-0 \SpecialChar ~
-
-\newline
-Before doing anything, read the syntax file (or files).
-\layout Description
-
-Pass\SpecialChar ~
-1a \SpecialChar ~
-
-\newline
-Split preamble (anything before a
-\family typewriter
-
-\backslash
-begin{document}
-\family default
- command) off the rest of the file.
- It saves the two pieces in separate files.
- This is necessary because there may be very strange stuff in a preamble.
- It also ignores anything after the
-\family typewriter
-
-\backslash
-end{document}
-\family default
-, on the assumption that it isn't LaTeX.
-\layout Description
-
-Pass\SpecialChar ~
-1b \SpecialChar ~
-
-\newline
-Translate the preamble.
- Currently, that just means translating the
-\family typewriter
-
-\backslash
-documentclass
-\family default
- command and copying the rest exactly into the LyX preamble.
-\begin_deeper
-\layout Standard
-
-Once you know what class the document is, read the LyX layout file for that
- class.
-\end_deeper
-\layout Description
-
-Pass\SpecialChar ~
-2 \SpecialChar ~
-
-\newline
-
-\begin_inset Quotes eld
-\end_inset
-
-Clean
-\begin_inset Quotes erd
-\end_inset
-
- the TeX file, generating slightly stricter LaTeX.
- This includes:
-\begin_deeper
-\layout Itemize
-
-Change, e.g.,
-\family typewriter
-x^2
-\family default
- to the equivalent but clearer
-\family typewriter
-x^{2}
-\layout Itemize
-
-Removing optional arguments that LyX can't handle (e.g., from
-\family typewriter
-
-\backslash
-sqrt
-\family default
-)
-\layout Itemize
-
-Changing
-\family typewriter
-{
-\backslash
-em foo}
-\family default
- to
-\family typewriter
-
-\backslash
-emph{foo}
-\family default
-, etc.
- This is necessary because LyX always writes out the non-local forms anyway.
- This should very rarely make a difference.
-\end_deeper
-\layout Description
-
-Pass\SpecialChar ~
-3 \SpecialChar ~
-
-\newline
-Translate LaTeX text, commands, and environments to LyX.
-\layout Description
-
-Pass\SpecialChar ~
-4 \SpecialChar ~
-
-\newline
-Put the two pieces back together, and do some final tweaking, to generate
- the LyX file
-\layout Standard
-
-If there are any
-\family typewriter
-
-\backslash
-input
-\family default
- or
-\family typewriter
-
-\backslash
-include
-\family default
- commands, reLyX will loop back to the beginning and translate those.
- It assumes that the included files are the same class as the main file,
- and that they have no preamble matter.
- (If you have an
-\family typewriter
-
-\backslash
-input
-\family default
- command in the preamble of a file, the command will be copied exactly into
- the LaTeX preamble portion of the LyX file, so the included file won't
- be translated.) So when translating included files, it skips passes 0 and
- 1.
-\layout Standard
-
-If reLyX doesn't find a file you wanted to include, it will give a warning,
- but will continue to translate any files it does find.
-\layout Subsubsection
-
-Layout Files
-\layout Standard
-
-reLyX reads a LyX layout file to know how to handle LaTeX environments and
- commands which get translated to LyX layouts.
- This file will include all
-\begin_inset Quotes eld
-\end_inset
-
-normal
-\begin_inset Quotes erd
-\end_inset
-
- non-math environments (i.e., including quote and itemize, but not tabular,
- minipage, and some other fancy environments), and commands like
-\family typewriter
-
-\backslash
-section
-\family default
- and
-\family typewriter
-
-\backslash
-title
-\family default
-.
- If you want to reLyX a class that doesn't have an existing layout file,
- then you'll have to create a layout file.
- But you have to do this anyway, in order to LyX the file, since LyX depends
- on layout files to know how to display and process its files.
- Check the LyX documentation for help with this task (which can be hard
- or easy, depending on the class you want to create a layout file for.) If
- your class is quite similar to a class that has a layout file, then consider
- using the
-\series bold
--c
-\series default
- option.
-\layout Subsubsection
-
-Syntax Files
-\begin_inset LatexCommand \label{sub:relyx-syntax}
-
-\end_inset
-
-
-\layout Standard
-
-reLyX always reads at least one syntax file, called the default syntax file.
- reLyX will read your personal syntax file if it exists; otherwise it will
- read the system-wide file.
- reLyX will read additional syntax files if you specify them with the
-\series bold
--s
-\series default
- option.
- (These extra files should have the same format as the default file, but
- will tend to be shorter, since they only have to specify extra commands
- not found in the default file.) A syntax file tells reLyX a few things.
-\layout Standard
-
-First, it describes the syntax of each command, that is, how many required
- arguments and how many optional arguments the command takes.
- Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
- it doesn't know how to translate.
- The syntax file simply has a command, followed by braces or brackets describing
- its arguments in the correct order.
- For example, a syntax file entry
-\family typewriter
-
-\backslash
-bibitem[]{}
-\family default
- means that the
-\family typewriter
-
-\backslash
-bibitem
-\family default
- command takes an optional argument followed by a required one, while the
- entry
-\family typewriter
-
-\backslash
-bf
-\family default
- means that the
-\family typewriter
-
-\backslash
-bf
-\family default
- command takes no arguments at all.
- When reLyX encounters a token that it doesn't know how to translate into
- LyX, it will copy the token---along with the correct number of arguments---exac
-tly.
- If the token is not in the syntax file, then reLyX just copies as many
- arguments as it finds.
- This means that it may copy too much.
- But since the user can specify additional syntax files, that shouldn't
- happen often.
-\layout Standard
-
-Some commands that cannot be translated to LyX, like
-\family typewriter
-
-\backslash
-mbox
-\family default
-, have as one of their arguments regular LaTeX text.
- If the string
-\begin_inset Quotes eld
-\end_inset
-
-translate
-\begin_inset Quotes erd
-\end_inset
-
- is put into an argument of an (untranslatable) command in the syntax file,
- then reLyX will translate that argument instead of copying it verbatim.
- So, for example, the default syntax file has
-\family typewriter
-
-\backslash
-raisebox{}[][]{translate}
-\family default
-.
- This means that the
-\family typewriter
-
-\backslash
-raisebox
-\family default
- command and the first argument (and optional arguments if they exist) are
- copied in TeX mode, but the last argument (which may contain math, complicated
- LaTeX, other untranslatable commands, etc.) will be translated into LyX.
- You can't use
-\begin_inset Quotes eld
-\end_inset
-
-translate
-\begin_inset Quotes erd
-\end_inset
-
- on optional arguments.
-\layout Standard
-
-User-defined syntax files are allowed to define new commands and their syntax,
- or override the number of arguments for a command given in the default
- syntax file.
- (E.g., if you're using a style that gives an extra argument to some command...)
- However, this will only be useful for commands copied in TeX mode.
- Commands which are actually translated by reLyX (like
-\family typewriter
-
-\backslash
-item
-\family default
-) have their argument syntax hard-coded.
- The hard-coded commands are identified in the default syntax file.
-\layout Standard
-
-Second, the syntax file describes any
-\begin_inset Quotes eld
-\end_inset
-
-regular environments
-\begin_inset Quotes erd
-\end_inset
-
-.
- Usually, an entire unknown environment will be copied in TeX mode.
- If you define a regular environment
-\begin_inset Quotes eld
-\end_inset
-
-foo
-\begin_inset Quotes erd
-\end_inset
-
-, though, then only the
-\family typewriter
-
-\backslash
-begin{foo}
-\family default
- and
-\family typewriter
-
-\backslash
-end{foo}
-\family default
- commands will be copied in TeX mode; the text within the environment will
- be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
- copied into TeX mode.
- Don't try to declare
-\family typewriter
-tabbing
-\family default
- and
-\family typewriter
-picture
-\family default
- as regular environments, as the text within those environments will confuse
- reLyX; use this capability for new environments you create that have plain
- text or math or simple commands in them.
- You also can't declare unknown math environments (like
-\family typewriter
-equation*
-\family default
-) as regular environments, either, since the LyX math editor won't understand
- them.
- The names of regular environments appear, whitespace-separated, between
-
-\family typewriter
-
-\backslash
-begin{reLyXre}
-\family default
- and
-\family typewriter
-
-\backslash
-end{reLyXre}
-\family default
- statements in the syntax file.
- (If you have a regular environment which you won't use very often, you
- can use the
-\series bold
--r
-\series default
- option rather than writing a syntax file.)
-\layout Standard
-
-Third, the syntax file describes a math translation table.
- The LyX math editor doesn't support a few commands.
- For example,
-\family typewriter
-_
-\family default
- is supported, but the equivalent
-\family typewriter
-
-\backslash
-sb
-\family default
- is not.
- Put any commands you'd like translate between
-\family typewriter
-
-\backslash
-begin{reLyXmt}
-\family default
- and
-\family typewriter
-
-\backslash
-end{reLyXmt}
-\family default
- statements.
- The statement
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-| {
-\backslash
-Vert}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- means that any
-\family typewriter
-
-\backslash
-|
-\family default
- in math mode will be converted to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-Vert
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\family typewriter
-
-\family default
-(in cases where a token made up of a backslash and a non-letter is translated
- to something with letters at the end, a space is added by reLyX.
- That way,
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-|a
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- is correctly translated to
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+\family typewriter
-\family typewriter
+\backslash
+boldsymbol{}
+\family default
+ and
+\family typewriter
+pslatex
+\end_layout
-\backslash
-Vert a
-\family default
+\end_inset
-\begin_inset Quotes erd
-\end_inset
-).
-\layout Subsubsection
+\end_layout
-Miscellaneous
-\layout Standard
+\begin_layout Standard
+The Postscript fonts do not have a bold symbol font.
+ The solution is to use the
+\family typewriter
-You need Perl version 5.002 or later to run reLyX.
- <plug> If you don't have Perl, you should get it anyway (at
-\begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
+\backslash
+pmb{}
+\family default
+ (poor man's bold) command.
+\end_layout
-\end_inset
+\begin_layout Standard
+It is possible to redefine the
+\family typewriter
-), because it's a really useful tool for pretty much anything.
- </plug>
-\layout Subsection
+\backslash
+boldsymbol
+\family default
+ command to use
+\family typewriter
-Diagnostics
-\layout Standard
+\backslash
+pmb
+\family default
+ by putting
+\end_layout
-reLyX should always explain why it crashes, if it crashes.
- Some diagnostics may be very technical, though, if they come from the guts
- of the code.
- reLyX gives much more information while running if you use the
-\series bold
--d
-\series default
- option, but you shouldn't need that unless something goes wrong.
-\layout Standard
+\begin_layout LyX-Code
-When it's finished, reLyX will tell you if it finished successfully or died
- due to some error.
-\layout Subsection
+\backslash
+renewcommand{
+\backslash
+boldsymbol}[1]{
+\backslash
+pmb{#1}}
+\end_layout
-Warnings
-\layout Standard
+\begin_layout Standard
+in the preamble.
+\end_layout
-Always keep a copy of your original LaTeX files either under a different
- name or in a different directory.
- There are a couple ways in which using LyX could lead to overwriting the
- original LaTeX file.
-\layout Standard
+\begin_layout Subsubsection
+Is it possible to do write LaTeX-code which is processed only when running
+ pdfLaTeX?
+\begin_inset OptArg
+status collapsed
-If you import
-\family typewriter
-foo.tex
-\family default
- to create
-\family typewriter
-foo.lyx
-\family default
-, then edit
-\family typewriter
-foo.lyx
-\family default
- and want to re-export it, note that it will overwrite the original
-\family typewriter
-foo.tex
-\family default
-.
- (LyX will
-\emph on
-not
-\emph default
- ask you if you want to overwrite it.)
-\layout Standard
+\begin_layout Standard
+Conditionals with pdfLaTeX
+\end_layout
-If you have chosen not to use a temporary directory in the preferences,
- then LyX will create its temporary files in your current directory, which
- means your LaTeX original may be overwritten (without a warning from LyX)
- when you
-\begin_inset Quotes eld
-\end_inset
+\end_inset
-view dvi
-\begin_inset Quotes erd
-\end_inset
- or print the LyX document.
-\layout Subsection
+\end_layout
-Files
-\layout Description
+\begin_layout Standard
+Yes you can do this with the
+\family typewriter
+ifpdf.sty
+\family default
+ package.
+ Here is an example:
+\end_layout
+\begin_layout LyX-Code
-\family typewriter
-\series medium
-MY_LYXDIR/layouts/*.layout
-\family default
-\series default
- \SpecialChar ~
+\end_layout
-\newline
-User's personal layout files for document classes
-\layout Description
+\begin_layout LyX-Code
+\backslash
+usepackage{ifpdf}
+\end_layout
-\family typewriter
-\series medium
-MY_LYXDIR/reLyX/syntax.default
-\family default
-\series default
- \SpecialChar ~
+\begin_layout LyX-Code
-\newline
-User's personal syntax file
-\layout Description
+\backslash
+ifpdf
+\end_layout
+\begin_layout LyX-Code
+
+\backslash
+pdfinfo { /Author (your name and e-mail address)
+\end_layout
-\family typewriter
-\series medium
-LIBDIR/layouts/*.layout
-\family default
-\series default
- \SpecialChar ~
+\begin_layout LyX-Code
+ /Title (official title -- i.e., title element)
+\end_layout
-\newline
-System-wide layout files for document classes
-\layout Description
+\begin_layout LyX-Code
+ /Subject (one line description of the document)
+\end_layout
+\begin_layout LyX-Code
+ }
+\end_layout
-\family typewriter
-\series medium
-LIBDIR/reLyX/syntax.default
-\family default
-\series default
- \SpecialChar ~
+\begin_layout LyX-Code
+
+\backslash
+pdfcatalog { /PageMode (/UseNone)
+\end_layout
-\newline
-System-wide LaTeX syntax file
-\layout Standard
+\begin_layout LyX-Code
+ % /OpenAction (fitbh)
+\end_layout
+\begin_layout LyX-Code
+ }
+\end_layout
-\family typewriter
-LIBDIR
-\family default
- is the system-wide LyX directory, usually something like
-\family typewriter
-/usr/local/share/lyx/
-\family default
-.
-
-\family typewriter
-MY_LYXDIR
-\family default
- is your personal LyX directory, something like
-\family typewriter
-.lyx/
-\family default
- in your home directory.
- You can see their actual values in the
-\family sans
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-About\SpecialChar ~
-Ly
-\bar under
-X
-\family default
-\bar default
- dialog.
-\layout Subsection
+\begin_layout LyX-Code
+
+\backslash
+usepackage[pdftex]{hyperref}
+\end_layout
-See also
-\layout Standard
+\begin_layout LyX-Code
+\backslash
+else
+\end_layout
-\shape italic
-lyx
-\shape default
-(1),
-\shape italic
-latex
-\shape default
-(1)
-\layout Subsection
+\begin_layout LyX-Code
+
+\backslash
+usepackage[ps2pdf]{hyperref}
+\end_layout
-Authors
-\layout Standard
+\begin_layout LyX-Code
-Copyright (c) 1998--9
-\noun on
-Amir Karger
-\noun default
- (
-\family typewriter
-karger@voth.chem.utah.edu
-\family default
-)
-\layout Standard
+\backslash
+fi
+\end_layout
-Code contributors:
-\layout Itemize
+\begin_layout Subsubsection
+How can I make URLs clickable?
+\end_layout
+\begin_layout Standard
+See the references here:
+\end_layout
-\noun on
-John Weiss
-\noun default
- wrote the original CleanTeX pass.
-\layout Itemize
+\begin_layout Standard
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
+\end_inset
-\noun on
-Etienne Grossmann
-\layout Itemize
+\end_layout
-\noun on
-Jos\i \'{e}
- Ab\i \'{\i}
-lio Oliveira Matos
-\layout Itemize
+\begin_layout Subsection
+Custom
+\end_layout
+\begin_layout Standard
+Custom exports are possible if you have some particularly weird format you
+ wish to convert to, assuming you have the relevant converter, of course.
+ The format of the
+\emph on
+input
+\emph default
+ file can be chosen in the
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\noun on
-David Suarez de Lis
-\layout Standard
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
-Other contributors:
-\layout Itemize
+\bar under
+C
+\bar default
+ustom
+\family default
+ dialog; LyX will automatically convert the file to this point, then feed
+ it to your custom converter.
+ The possible values are all formats that LyX can produce from its own documents.
+
+\end_layout
+\begin_layout Standard
+The converter command is also specified in the dialog.
+ It should be a completely qualified command line which uses the variable
+
+\family typewriter
+$$FName
+\family default
+ to specify the name of the file.
+ If this variable is not given, then the file will be sent to the standard
+ input of your command.
+ You may have to apply a bit of ingenuity to escape this sequence correctly
+ so that it is compatible with your shell.
+
+\end_layout
-\noun on
-Jean-Marc Lasgouttes
-\noun default
- worked on the wrapper script and offered lots of bug reports, advice, and
- feature suggestions.
-\layout Itemize
+\begin_layout Standard
+While it is not possible to save this command using the
+\family sans
+Preferences
+\family default
+ dialog, you can manually edit your
+\family typewriter
+.lyx/preferences
+\family default
+ to add a line like
+\end_layout
+\begin_layout LyX-Code
-\noun on
-Asger K.
- Alstrup Nielsen
-\noun default
- and
-\noun on
-Marc Pavese
-\noun default
- provided advice.
-\layout Itemize
-
-Various members of the LyX developers' and users' lists provided bug reports
- and feature suggestions.
-\layout Standard
-
-reLyX uses a modified version the Perl TeX parser
-\family typewriter
-Text::TeX
-\family default
- package written by
-\noun on
-Ilya Zakharevich
-\noun default
- (
-\family typewriter
-ilya@math.ohio-state.edu
-\family default
-), available on CPAN.
-\layout Chapter
+\backslash
+custom_export_command "mycommand $$FName"
+\end_layout
+\begin_layout Chapter
LyX Features needing Extra Software
-\layout Section
+\end_layout
+\begin_layout Section
Using LyX with SGML-Tools (aka LinuxDoc)
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Paul Evans
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Overview
-\layout Standard
+\end_layout
+\begin_layout Standard
LinuxDoc is a document class available in LyX if you have the
-\family typewriter
+\family typewriter
sgml-tools
-\family default
+\family default
package installed.
You can use it to produce documents in the so-called Standardized General
Mark-up Language (SGML) in the particular format used by the Linux Documentatio
n Project.
That is obviously helpful if you are contributing to that project.
You can use the SGML format with the
-\family typewriter
+\family typewriter
sgml-tools
-\family default
- package of scripts and programs (to produce other formats, including Latex,
+\family default
+ package of scripts and programs (to produce other formats, including LaTeX,
HTML, plain text, man pages and\SpecialChar \ldots{}
).
You may therefore prefer to use this document class if you want to write
something that can be easily translated into other formats.
-\layout Standard
+\end_layout
+\begin_layout Standard
You will find that LinuxDoc has fewer layout options than the other text
classes in LyX.
This is mainly so that the translations into other formats have a chance
of making some sense.
In this section we describe:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
how to setup and use a document in LinuxDoc
-\layout Itemize
+\end_layout
+\begin_layout Itemize
how to use the tags in LinuxDoc to layout your document
-\layout Itemize
+\end_layout
+\begin_layout Itemize
how to use the SGML packages to produce the various formats
-\layout Itemize
+\end_layout
+\begin_layout Itemize
how to sort out some problems.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Preparing and using a LinuxDoc document
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Getting started
-\layout Standard
+\end_layout
+\begin_layout Standard
You start by selecting the LinuxDoc class using the
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
ocument\SpecialChar \menuseparator
-\bar under
+\bar under
S
-\bar default
+\bar default
ettings
-\family default
+\family default
dialog.
-
-\family sans
-
-\family default
-Then you will find that there are fewer paragraph environments than for
+ Then you will find that there are fewer paragraph environments than for
most other classes.
You can see them on the pull down box on the left of the tool bar.
- How to use them is described in section\SpecialChar ~
+ How to use them is described in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:sgmlparas}
+\begin_inset LatexCommand ref
+reference "sec:sgmlparas"
-\end_inset
+\end_inset
.
-\layout Standard
+\end_layout
+\begin_layout Standard
You
-\emph on
+\emph on
must
-\emph default
+\emph default
enter a title for the document, followed by an author, marking each with
the appropriate paragraph environment.
If you don't do this, you will get errors when you try to print the file.
You can then enter the date and an abstract.
The document proper must start with a Section paragraph environment rather
than any standard layout.
-\layout Standard
+\end_layout
+\begin_layout Standard
After that you can prepare a document as usual using the available range
of paragraph environments.
- See section\SpecialChar ~
+ See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:sgmlparas}
+\begin_inset LatexCommand ref
+reference "sec:sgmlparas"
-\end_inset
+\end_inset
for the full list and their uses.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Output from LinuxDoc
-\layout Standard
+\end_layout
+\begin_layout Standard
You can print and save these documents in the normal way.
To use the other features of the SGML package you need to save your document
as LinuxDoc; this is a version in which the document is translated into
the basic sgml tags.
- Use
-\family sans
-
-\bar under
+ Use
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
E
-\bar default
+\bar default
xport\SpecialChar \menuseparator
Linu
-\bar under
+\bar under
x
-\bar default
+\bar default
Doc.
-\family default
+\family default
You will get a file with the same name and a
-\family typewriter
+\family typewriter
.sgml
-\family default
+\family default
extension rather than a
-\family typewriter
+\family typewriter
.lyx
-\family default
+\family default
extension.
- See\SpecialChar ~
+ See\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:sgmloperate}
+\begin_inset LatexCommand ref
+reference "sec:sgmloperate"
-\end_inset
+\end_inset
on how you than make use of this file.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Using the paragraph environments in LinuxDoc
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
The Structure of a LinuxDoc Document
-\layout Standard
+\end_layout
+\begin_layout Standard
There is a formal structure for LinuxDoc which limits how you can place
tags.
There are two parts to all documents:
-\layout Description
+\end_layout
+\begin_layout Description
Header: this is everything up to the first time you insert a Section layout
marker.
It can include title, author, date, abstract and ToC.
You must include the first two.
-\layout Description
+\end_layout
+\begin_layout Description
Body: from the beginning of the first section onwards.
All other tags are allowed.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
The LinuxDoc Paragraph Environments
-\layout Standard
+\end_layout
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:sgmlparas"
-\begin_inset LatexCommand \label{sec:sgmlparas}
-
-\end_inset
+\end_inset
Here is a list of all the tags you will find listed on the layout bar in
the order they come there, with some comments where the purpose or use
is not obvious:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Standard:
-\family roman
- works as described in [cross reference]
-\layout Itemize
+\family default
+
+\family roman
+works as described in [cross reference]
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Title
-\family default
+\family default
: This will appear at the top left of the document when printed, above a
heavy horizontal rule, although you will not see this on the LyX screen.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Section, Subsection, Subsubsection, Paragraph and Subparagraph:
-\family default
+\family default
all do what you would expect and in the usual order.
Whether they are numbered or not is controlled by the
-\family sans
-Section\SpecialChar ~
-number\SpecialChar ~
+\family sans
+Section\InsetSpace ~
+number\InsetSpace ~
depth
-\family default
+\family default
setting.
You cannot get the equivalent number free versions in any other way; there
is no
-\family sans
+\family sans
Section*
-\family default
+\family default
or similar
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Enumerate:
-\family default
+\family default
As usual this produces a numbered and indented list as described in the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-Itemize:
-\family roman
-Again much the same as in the other classes: see the
-\emph on
+\family sans
+Itemize:
+\family default
+
+\family roman
+Again much the same as in the other classes: see the
+\family default
+
+\family roman
+\emph on
User's Guide
-\emph default
+\emph default
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Description
-\family default
+\family default
: As explained in the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
.
Remember that if you want the bold element at the start of a description
to be more than one word then you need to put protected spaces between
the words.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
-Verbatim:
-\family default
-As usual.
-\layout Itemize
+\family sans
+Verbatim:
+\family default
+ As usual.
+\end_layout
+\begin_layout Itemize
-\family sans
-Code: similar to the Lyx-Code
-\family roman
- environment
-\layout Itemize
+\family sans
+Code: similar to the LyX-Code
+\family default
+
+\family roman
+environment
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Author
-\family default
+\family default
: Anything you mark with this will appear on the left of the heading of
the document, under the heavy rule.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Date:
-\family default
+\family default
Anything you mark with this will appear on the right of the heading under
the rule.
You do not have to make this a date.
- Any text can be entered, e.\SpecialChar ~
+ Any text can be entered, e.\InsetSpace ~
g.
a version number.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
Abstract
-\family default
+\family default
: You can use this to produce a free standing paragraph after the author
and date, and before the first section.
You are only allowed one such paragraph.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
-\emph on
+\emph on
Author's note.
-
-\emph default
-This needs checking ---
-\emph on
+
+\emph default
+ This needs checking ---
+\emph on
pe.
-\end_inset
+\end_layout
+\end_inset
-\layout Itemize
+\end_layout
-\family sans
+\begin_layout Itemize
+
+\family sans
Displaymath
-\family default
+\family default
:
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
-\emph on
-Author's note:
-\emph default
-I have not yet checked this ---
-\emph on
+\emph on
+Author's note:
+\emph default
+ I have not yet checked this ---
+\emph on
pe.
-\end_inset
+\end_layout
+\end_inset
-\layout Subsubsection
+\end_layout
+
+\begin_layout Subsubsection
Other document features
-\layout Standard
+\end_layout
+\begin_layout Standard
You can also use the
-\family sans
-Layout
-\family default
-menu to set fonts or to emphasis words.
+\family sans
+Layout
+\family default
+ menu to set fonts or to emphasis words.
You can also use the table of contents as usual; see the corresponding
section of the
-\emph on
+\emph on
User's Guide
-\emph default
+\emph default
.
- Although you will find some some other features on the menus e.\SpecialChar ~
+ Although you will find some some other features on the menus e.\InsetSpace ~
g.
inserting footnotes.
There is some doubt about whether these will work correctly.
\begin_inset Foot
-collapsed true
+status collapsed
-\layout Standard
+\begin_layout Standard
+\emph on
+Author's note:
+\emph default
+ Again still checking to see whether this is my system
+\emph on
+---pe.
+\end_layout
-\emph on
-Author's note:
-\emph default
-Again still checking to see whether this is my system
-\emph on
- ---pe.
-\end_inset
+\end_inset
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Cross references and HTML
-\layout Standard
+\end_layout
-On the
-\family sans
- Insert
-\family default
+\begin_layout Standard
+On the
+\family sans
+Insert
+\family default
menu you will find two new options relating to the inclusion of URL addresses.
If you use either option you will find some highlighted TeX code inserted
into your document in three separate blocks with spaces available between.
The blocks will be:
-\layout Quote
+\end_layout
+\begin_layout Quote
-\family typewriter
+\family typewriter
-\backslash
+\backslash
htmlurl{
-\family default
+\family default
or
-\family typewriter
+\family typewriter
-\backslash
+\backslash
url{
-\family roman
+\family roman
-\hfill
+\hfill
space
-\family default
+\family default
-\family typewriter
+\family typewriter
-\hfill
+\hfill
}{
-\family roman
+\family roman
-\hfill
+\hfill
space
-\hfill
+\hfill
-\family typewriter
+\family typewriter
}
-\layout Standard
+\end_layout
+\begin_layout Standard
You insert a full HTML tag between the first and second blocks.
This can be
-\begin_inset LatexCommand \url{http://any.address}
+\begin_inset LatexCommand url
+target "http://any.address"
-\end_inset
+\end_inset
or other valid tags such as
-\begin_inset LatexCommand \url{mailto:me@my.address}
+\begin_inset LatexCommand url
+target "mailto:me@my.address"
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
.
-\family default
+\family default
Then y
-\family roman
-ou
-\family default
-insert some description between the second and third blocks.
+\family roman
+ou
+\family default
+ insert some description between the second and third blocks.
The differences are:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
-\family sans
+\family sans
URL:
-\family roman
- both the HTML tag and the description will appear in the document
-\layout Itemize
+\family default
+
+\family roman
+both the HTML tag and the description will appear in the document
+\end_layout
+\begin_layout Itemize
-\family sans
-HTML\SpecialChar ~
-URL:
-\family roman
+\family sans
+HTML\InsetSpace ~
+URL:
+\family default
+
+\family roman
only the description appears in the printed version
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Using the LinuxDoc Sgml scripts
-\begin_inset Note
-collapsed true
-
-\layout Standard
+\begin_inset Note Note
+status collapsed
+\begin_layout Standard
This section is completely outdated.
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
-\begin_inset LatexCommand \label{sec:sgmloperate}
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:sgmloperate"
-\end_inset
+\end_inset
You can use LinuxDoc as a text class without any additional scripts or programs,
but there is not much point in doing this.
All you will get is a document that looks like a
-\emph on
+\emph on
Linux Documentation Project Howto
-\family sans
-\emph default
+\family sans
+\emph default
.
-
-\family default
-To do the document translation you need to get and install the
-\family typewriter
-sgml-tools-1.0.x.tar.gz
-\family default
-(with
+
+\family default
+ To do the document translation you need to get and install the
+\family typewriter
+sgml-tools-1.0.x.tar.gz
+\family default
+ (with
\begin_inset Formula $x\geq3$
-\end_inset
+\end_inset
) package from
-\family roman
+\family roman
the SGML-Tools WWW Page
-\family default
+\family default
at
-\layout LyX-Code
-
+\end_layout
-\family roman
+\begin_layout LyX-Code
-\begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
+\family roman
+\begin_inset LatexCommand url
+target "http://pobox.com/~cg/sgmltools"
-\end_inset
+\end_inset
-\family default
+\family default
-\layout Standard
+\end_layout
+\begin_layout Standard
Alternatively, you can go to the
-\family typewriter
+\family typewriter
sunsite
-\family default
+\family default
archive at
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
has not yet been made available at
-\family typewriter
+\family typewriter
sunsite
-\family default
+\family default
.
-\end_inset
+\end_layout
+\end_inset
-\layout LyX-Code
+\end_layout
-\family roman
+\begin_layout LyX-Code
-\begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
+\family roman
+\begin_inset LatexCommand url
+target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
-\family roman
+\family roman
The
-\family default
+\family default
file
-\family typewriter
+\family typewriter
sgml-tools-1.0.x.tar.gz
-\family default
+\family default
contains everything that you need to write SGML documents and convert them
to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
-\layout Standard
+\end_layout
+\begin_layout Standard
This package was renamed from
-\family typewriter
+\family typewriter
linuxdoc-sgml-1.5.tar.gz
-\family default
+\family default
in January 1997.
-\layout Standard
+\end_layout
+\begin_layout Standard
Follow the instructions in that package on how to install it and how to
use it.
All this has to be done outside of LyX, before you can use the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
E
-\bar default
+\bar default
xport\SpecialChar \menuseparator
-as\SpecialChar ~
-LinuxDoc
-\family roman
+as\InsetSpace ~
+LinuxDoc
+\family default
+
+\family roman
option.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Troubleshooting LinuxDoc
-\layout Standard
+\end_layout
+\begin_layout Standard
When you print or preview a LinuxDoc document some checking is done of the
tags before LaTeX is run.
Some errors are trapped here, especially those concerning the structure
You may have to look at the files directly to discover what is wrong.
Most problems seem to come from the use of options that are not fully available
in the text class.
-\layout Section
+\end_layout
+\begin_layout Section
Checking TeX
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
+\noun on
Asger Alstrup
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\end_layout
+\begin_layout Standard
Under the
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools
-\family default
+\family default
menu, you'll find a
-\family sans
-\bar under
+\family sans
+\bar under
C
-\bar default
-heck\SpecialChar ~
+\bar default
+heck\InsetSpace ~
TeX
-\family default
+\family default
command.
This feature requires you to have the
-\family typewriter
+\family typewriter
chktex
-\family default
+\family default
program installed, and is grayed out if you don't have it.
You can get it from your nearest CTAN mirror, or over the Web from
-\begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
+\begin_inset LatexCommand url
+target "http://www.ifi.uio.no/~jensthi/chktex/"
-\end_inset
+\end_inset
.
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
package is a program that was written by
-\noun on
+\noun on
Jens T.
Berger Thielemann
-\noun default
+\noun default
in frustration because some constructs in LaTeX are sometimes non-intuitive,
and easy to forget.
The program runs over your LaTeX file and checks the integrity of the file,
and flags some common errors.
In other technical words, it is
-\family typewriter
+\family typewriter
Lint
-\family default
+\family default
for LaTeX.
-\layout Standard
+\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
+\family typewriter
Lint
-\family default
+\family default
not only checks the
-\emph on
+\emph on
syntax
-\emph default
+\emph default
of C programs, but also does
-\emph on
+\emph on
semantic
-\emph default
+\emph default
checks for type-errors,
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
catches some common
-\emph on
+\emph on
typographic
-\emph default
+\emph default
errors, in addition to the syntactical ones.
Specifically,
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
is capable of detecting several common errors, such as
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Ellipsis detection:
-\newline
+\newline
Use \SpecialChar \ldots{}
instead of ...
-\layout Itemize
+\end_layout
+\begin_layout Itemize
No space in front of/after parenthesis:
-\newline
+\newline
( wrong spacing )
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Enforcement of normal space after common abbreviations:
-\newline
+\newline
e.
g.
is too wide spacing.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Enforcement of end-of-sentence space when the last sentence ends with a
capital letter:
-\newline
+\newline
This is a TEST.
And this is wrong spacing.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Space in front of labels and similar commands:
-\newline
-The label should stick right up to the text to avoid falling to a wrong
- page.
+\newline
+The label should stick right
+ up to the text to avoid falling to a wrong page.
-\begin_inset LatexCommand \label{sec:chktex}
+\begin_inset LatexCommand label
+name "sec:chktex"
-\end_inset
+\end_inset
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
This footnote is in danger of falling off to a wrong page
-\end_inset
+\end_layout
+
+\end_inset
The label is separated too much.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Space in front of references, instead of hard spaces:
-\newline
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
+\newline
+In you are in bad luck,
+ the text will break right between the referenced text and reference number,
+ and that's a pity.
See section
-\begin_inset LatexCommand \ref{sec:chktex}
+\begin_inset LatexCommand ref
+reference "sec:chktex"
-\end_inset
+\end_inset
.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Use of
\begin_inset Quotes eld
-\end_inset
+\end_inset
x
\begin_inset Quotes erd
-\end_inset
+\end_inset
instead of
\begin_inset Formula $\times$
-\end_inset
+\end_inset
between numbers:
-\newline
+\newline
2x2 looks cheap compared to
\begin_inset Formula $2\times2$
-\end_inset
+\end_inset
.
-\layout Standard
+\end_layout
+\begin_layout Standard
and more \SpecialChar \ldots{}
It is an invaluable tool when you are
\begin_inset Quotes eld
-\end_inset
+\end_inset
finishing up
\begin_inset Quotes erd
-\end_inset
+\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.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
How to use it
-\layout Standard
+\end_layout
+\begin_layout Standard
If you have the program installed, usage is as simple as choosing
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools\SpecialChar \menuseparator
-\bar under
+\bar under
C
-\bar default
-heck\SpecialChar ~
+\bar default
+heck\InsetSpace ~
TeX
-\family default
+\family default
.
This will make LyX generate a LaTeX file of your document, start
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
to check it, and then make LyX insert
\begin_inset Quotes eld
-\end_inset
+\end_inset
error boxes
\begin_inset Quotes erd
-\end_inset
+\end_inset
with the warnings from
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
, if there were any.
The warnings will be placed close to the point of the mistake, and you
can quickly find them by using the
-\family sans
-\bar under
+\family sans
+\bar under
N
-\bar default
+\bar default
avigate\SpecialChar \menuseparator
-\bar under
+\bar under
E
-\bar default
+\bar default
rror
-\family default
+\family default
menu item, or the shortcut key
-\family sans
+\family sans
C-g
-\family default
+\family default
from the default
-\family typewriter
+\family typewriter
cua
-\family default
+\family default
bind file.
Open the error boxes by clicking on them with the mouse, or use the shortcut
key
-\family sans
+\family sans
C-i
-\family default
+\family default
from
-\family typewriter
+\family typewriter
cua
-\family default
+\family default
bindings, or the corresponding
-\family sans
+\family sans
C-o
-\family default
+\family default
for the alternate
-\family typewriter
+\family typewriter
emacs
-\family default
+\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
+\family sans
ChkTeX
-\family default
+\family default
, and this gap can make some warnings seem arcane or just right down plain
silly.
-\layout Standard
+\end_layout
+\begin_layout Standard
This document is an excellent testing bed for the feature, and it should
provide quite a few warnings for you to fiddle with.
Since computers are only so smart, expect most of the warnings to be false
alarms, though.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
How to fine tune it
-\layout Standard
+\end_layout
+\begin_layout Standard
Sometimes, you'll find that
-\family sans
+\family sans
ChkTeX
-\family default
+\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
+\family sans
ChkTeX
-\family default
+\family default
to get better along with you.
Another choice in the most desperate situations is to use
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew\SpecialChar \menuseparator
-\bar under
+\bar under
R
-\bar default
-emove\SpecialChar ~
-All\SpecialChar ~
-Error\SpecialChar ~
+\bar default
+emove\InsetSpace ~
+All\InsetSpace ~
+Error\InsetSpace ~
Boxes
-\family default
+\family default
, which will get rid of all warnings instantly.
-\layout Standard
+\end_layout
+\begin_layout Standard
Although
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
-\emph on
+\emph on
is
-\emph default
+\emph default
very configurable and extensible, you shouldn't expect to solve all problems
with
-\family sans
+\family sans
ChkTeX
-\family default
+\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
+\family sans
ChkTeX
-\family default
+\family default
output
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
You can inspect the specific output from
-\family sans
+\family sans
chktex
-\family default
+\family default
by using
-\family sans
+\family sans
Edit\SpecialChar \menuseparator
-View\SpecialChar ~
-LaTeX\SpecialChar ~
+View\InsetSpace ~
+LaTeX\InsetSpace ~
Log
-\family default
+\family default
right after a
-\family sans
+\family sans
chktex
-\family default
+\family default
run.
-\end_inset
+\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:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Fine tune the
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
invocation command line in
-\family sans
+\family sans
Preferences
-\family default
+\family default
(tabs
-\family sans
+\family sans
Outputs
-\family default
+\family default
,
-\family sans
+\family sans
Misc
-\family default
+\family default
), or the global
-\family sans
+\family sans
ChkTeX
-\family default
+\family default
installation configuration file (usually with the file
-\family typewriter
+\family typewriter
/usr/local/share/chktexrc
-\family default
+\family default
).
See below to learn what warnings can be enabled and disabled on the command
line.
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Export your document as a raw LaTeX file using
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
E
-\bar default
+\bar default
xport\SpecialChar \menuseparator
-\bar under
+\bar under
L
-\bar default
+\bar default
aTeX
-\family default
+\family default
and run
-\family typewriter
+\family typewriter
chktex
-\family default
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
Here follows the warning messages that can be enabled and disabled in
-\family sans
+\family sans
Preferences
-\family default
+\family default
.
Use
-\family typewriter
+\family typewriter
-n#
-\family default
+\family default
to disable a warning, and
-\family typewriter
+\family typewriter
-w#
-\family default
+\family default
to enable a warning.
The emphasized entries are disabled by default, because the default is
"
-\family typewriter
+\family typewriter
chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
-\family default
+\family default
".
-\layout Standard
+\end_layout
+\begin_layout Standard
Notice that you should only use the options that enable and disable warnings,
because LyX relies on some of the other command line parameters to be set
in a specific way to have a chance to communicate with
-\family typewriter
+\family typewriter
chktex
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
Command terminated with space.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Non-breaking space (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
~
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
) should have been used.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
You should enclose the previous parenthesis with
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Italic correction (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
/
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
) found in non-italic buffer.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Italic correction (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
/
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
) found more than once.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
No italic correction (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
/
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
) found.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Accent command
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
cmd
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
needs use of
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
cmd
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Wrong length of dash may have been used.
-\layout Enumerate
-
+\end_layout
-\size small
-\emph on
+\begin_layout Enumerate
+\size small
+\emph on
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
expected, found
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Solo
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
found.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should use
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
to achieve an ellipsis.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Inter-word spacing (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
-
-\family default
+\backslash
+\family default
+
\begin_inset Quotes eld
-\end_inset
+\end_inset
) should perhaps be used.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Inter-sentence spacing (
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
@
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
) should perhaps be used.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Could not find argument for command.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
No match found for
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Math mode still on at end of LaTeX file.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Number of
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
char
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
doesn't match the number of
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
char
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should use either
-\family typewriter
+\family typewriter
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family default
+\family default
or
-\family typewriter
+\family typewriter
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\family default
+\family default
as an alternative to
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
"
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should use "
-\family typewriter
+\family typewriter
'
-\family default
+\family default
" (ASCII 39) instead of "
-\family typewriter
-´
-\family default
+\family typewriter
+´
+\family default
" (ASCII 180).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
User-specified pattern found.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
This command might not be intended.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
Comment displayed.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Either
-\family typewriter
+\family typewriter
''
-\backslash
+\backslash
,'
-\family default
+\family default
or
-\family typewriter
+\family typewriter
'
-\backslash
+\backslash
,''
-\family default
+\family default
will look better.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Delete this space to maintain correct page references.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
You might wish to put this between a pair of
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
{}
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You ought to remove spaces in front of punctuation.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Could not execute LaTeX command.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Don't use
-\family typewriter
+\family typewriter
-\backslash
+\backslash
/
-\family default
+\family default
in front of small punctuation.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\family typewriter
-\size small
+\family typewriter
+\size small
$
-\backslash
+\backslash
times$
-\family default
+\family default
may look prettier here.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
Multiple spaces detected in output.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
This text may be ignored.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Use
-\family typewriter
+\family typewriter
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family default
+\family default
to begin quotation, not
-\family typewriter
+\family typewriter
'
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Use
-\family typewriter
+\family typewriter
'
-\family default
+\family default
to end quotation, not
-\family typewriter
+\family typewriter
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family default
+\family default
.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Don't mix quotes.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should perhaps use
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
cmd
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
instead.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should put a space in front of/after parenthesis.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should avoid spaces in front of/after parenthesis.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-\emph on
+\size small
+\emph on
You should not use punctuation in front of/after quotes.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
Double space found.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should put punctuation outside inner/inside display math mode.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You ought to not use primitive TeX in LaTeX code.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
+\size small
You should remove spaces in front of
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
-\size small
-
+\size small
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%s
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
is normally not followed by
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
%c
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Standard
+\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
+\family typewriter
lacheck
-\family default
+\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.
-\layout Section
+\end_layout
+\begin_layout Section
Version Control in LyX
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
- Lars Gullik Bjønnes
-\layout Subsection
+\noun on
+ Lars Gullik Bjønnes
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\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.
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.
-\layout Standard
+\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
+\end_inset
rcsintro
\begin_inset Quotes erd
-\end_inset
+\end_inset
(a man file, read it with
-\family typewriter
+\family typewriter
man rcsintro
-\family default
+\family default
).
This file describes all the basic features of RCS.
You should especially notice the comment about a RCS directory, and the
notion of a master RCS file (the file ending in
-\family typewriter
+\family typewriter
,v
-\family default
+\family default
).
-\layout Standard
+\end_layout
+\begin_layout Standard
The implementation in LyX assumes a recent version of the GNU RCS package---no
guarantees are made for older versions.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
RCS commands in LyX
-\layout Standard
+\end_layout
+\begin_layout Standard
The following sections describe the RCS commands supported by LyX.
You can find them in the
-\family sans
-\bar under
+\family sans
+\bar under
F
-\bar default
+\bar default
ile\SpecialChar \menuseparator
-\bar under
+\bar under
V
-\bar default
-ersion\SpecialChar ~
+\bar default
+ersion\InsetSpace ~
Control
-\family default
+\family default
submenu.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
-\family sans
+\family sans
Register
-\layout Standard
+\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
+\family sans
+\bar under
R
-\bar default
+\bar default
egister
-\family default
+\family default
item is grayed out.
-\layout Standard
+\end_layout
+\begin_layout Standard
This command registers your document with RCS\SpecialChar \@.
You are asked interactively
to supply an initial description of the document.
The document is now set in Read-Only mode and you have to
-\family sans
-Check\SpecialChar ~
-Out\SpecialChar ~
-For\SpecialChar ~
+\family sans
+Check\InsetSpace ~
+Out\InsetSpace ~
+For\InsetSpace ~
Edit
-\family default
+\family default
, before making any changes to it.
A document under revision control has a
\begin_inset Quotes eld
-\end_inset
+\end_inset
[RCS:<version> <locker>]
\begin_inset Quotes erd
-\end_inset
+\end_inset
item tagged to the filename in the minibuffer.
-\layout Standard
+\end_layout
+\begin_layout Standard
RCS command that is run:
-\family typewriter
+\family typewriter
ci -q -u -i -t-"<initial description>" <file-name>
-\layout Standard
+\end_layout
+\begin_layout Standard
Read
-\family typewriter
+\family typewriter
man ci
-\family default
+\family default
to understand the switches.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
-\family sans
+\family sans
Check In Changes
-\layout Standard
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
RCS command:
-\family typewriter
+\family typewriter
ci -q -u -m"<description>" <file-name>
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
-\family sans
+\family sans
Check Out For Edit
-\layout Standard
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
RCS command:
-\family typewriter
+\family typewriter
co -q -l <file-name>
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
-\family sans
+\family sans
Revert To Last Version
-\layout Standard
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
RCS command:
-\family typewriter
+\family typewriter
co -f -u<version> <file-name>
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
-\family sans
+\family sans
Undo Last Checkin
-\layout Standard
+\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.
-\layout Standard
+\end_layout
+\begin_layout Standard
RCS command:
-\family typewriter
+\family typewriter
rcs -o<version> <file-name>
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
-\family sans
+\family sans
Show History
-\layout Standard
+\end_layout
+\begin_layout Standard
This show the complete history of the RCS document.
The output of
-\family typewriter
+\family typewriter
rlog <file-name>
-\family default
+\family default
is shown in a browser.
See
-\family typewriter
+\family typewriter
man rlog
-\family default
+\family default
for more info.
-\layout Section
+\end_layout
+\begin_layout Section
Literate Programming
-\layout Standard
+\end_layout
+\begin_layout Standard
Updated by
-\noun on
+\noun on
Kayvan Sylvan
-\noun default
+\noun default
(kayvan@sylvan.com)
-\noun on
+\noun on
,
-\noun default
+\noun default
original documentation written by
-\noun on
+\noun on
Edmar Wienskoski Jr.
-\noun default
+\noun default
(edmar-w-jr@technologist.com)
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Introduction
-\layout Standard
+\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
\begin_inset Quotes eld
-\end_inset
+\end_inset
tangling
\begin_inset Quotes erd
-\end_inset
+\end_inset
and
\begin_inset Quotes eld
-\end_inset
+\end_inset
weaving
\begin_inset Quotes erd
-\end_inset
+\end_inset
means.
If that is not the case, please follow the web links provided in the following
sections.
There is a lot of good documentation out there covering old development
history to the latest tools tips.
-\layout Standard
+\end_layout
+\begin_layout Standard
It is also assumed that you are familiar with LyX itself to a point that
you are comfortable changing your LyX preferences, and X resources file.
If that is not the case please refer to other LyX documentation to cover
your specific needs.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Literate Programming
-\layout Standard
+\end_layout
+\begin_layout Standard
From the Literate Programming FAQ:
-\layout Quotation
+\end_layout
+\begin_layout Quotation
Literate programming is the combination of documentation and source together
in a fashion suited for reading by human beings.
In fact, literate programs should be enjoyable reading, even inviting!
The WEB style of literate programming was created by D.E.
Knuth during the development of his TeX typesetting software.
-\layout Standard
+\end_layout
+\begin_layout Standard
Another excerpt says:
-\layout Quotation
+\end_layout
+\begin_layout Quotation
-\emph on
+\emph on
How is literate programming different from verbose commenting?
-\layout Quotation
+\end_layout
+\begin_layout Quotation
There are three distinguishing characteristics.
In order of importance, they are:
-\begin_deeper
-\layout Itemize
+\end_layout
+\begin_deeper
+\begin_layout Itemize
flexible order of elaboration
-\layout Itemize
+\end_layout
+\begin_layout Itemize
automatic support for browsing
-\layout Itemize
+\end_layout
+\begin_layout Itemize
typeset documentation, especially diagrams and mathematics
-\end_deeper
-\layout Standard
+\end_layout
+\end_deeper
+\begin_layout Standard
Now that I sparked your curiosity, take a look in the references.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
References
-\layout Standard
+\end_layout
+\begin_layout Standard
The complete Literate Programming FAQ can be found at:
-\layout Quote
-
+\end_layout
-\begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
+\begin_layout Quote
+\begin_inset LatexCommand url
+name "Literate Programming FAQ"
+target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
The FAQ lists 23 (twenty three!) different literate programming tools.
Where some are specialized or
\begin_inset Quotes eld
-\end_inset
+\end_inset
tailored
\begin_inset Quotes erd
-\end_inset
+\end_inset
for particular programming languages, while other have general scope.
I selected
-\noun on
+\noun on
Noweb
-\noun default
+\noun default
for my own use for several reasons:
-\layout Itemize
+\end_layout
-It can generate the documentation either in latex or html.
-\layout Itemize
+\begin_layout Itemize
+It can generate the documentation either in LaTeX or HTML.
+\end_layout
+\begin_layout Itemize
It has a open architecture, i.e., it is easy to plug in new filters and to
perform special processing that you may need.
-\layout Itemize
+\end_layout
-There is a good selection of filters available already (the html is one
+\begin_layout Itemize
+There is a good selection of filters available already (the HTML is one
of them).
-\layout Itemize
+\end_layout
+\begin_layout Itemize
It is free.
-\layout Standard
+\end_layout
+\begin_layout Standard
The Noweb web page can be found at:
-\layout Quote
+\end_layout
+\begin_layout Quote
+\begin_inset LatexCommand url
+name "Noweb home page"
+target "http://www.cs.virginia.edu/~nr/noweb/"
-\begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
+\end_inset
-\end_inset
+\end_layout
-\layout Standard
-
+\begin_layout Standard
Starting from there you can reach many other interesting links and even
some literate program examples.
-\layout Subsection
+\end_layout
+
+\begin_layout Subsection
+\begin_inset LatexCommand label
+name "sub:LyX-and-Literate"
+
+\end_inset
LyX and Literate Programming
-\layout Standard
+\end_layout
+\begin_layout Standard
The LyX support for Literate Programming is provided by using the generic
LyX convertors mechanism.
This support is provided in a
\begin_inset Quotes eld
-\end_inset
+\end_inset
Noweb independent
\begin_inset Quotes erd
-\end_inset
+\end_inset
way, i.e., you will be able to use this new LyX feature with some other literate
programming tool of your choice by just changing your LyX preferences.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Generating documents and code (weaving and tangling)
-\layout Paragraph
+\end_layout
+\begin_layout Paragraph
Selecting the document class
-\layout Standard
+\end_layout
+\begin_layout Standard
If you have installed Noweb and LyX successfully, whenever you open a new
document or try to change the document class of an existing one, you will
find that there are three new document classes available:
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Article (Noweb)
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Book (Noweb)
-\layout Itemize
+\end_layout
+\begin_layout Itemize
Report (Noweb)
-\layout Standard
+\end_layout
+\begin_layout Standard
You must select one of them to create your literate documents from.
-\layout Standard
+\end_layout
+\begin_layout Standard
Note that literate documents are not limited to these three classes.
New classes can be generated from other styles like letter or in combination
with other class variations like Article (AMS).
classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
will arrange to insert a new entry, or teach you how to do it.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
It is very simple, it involves the creation of a file with four lines, and
re-running of the auto configuration.
-\end_inset
+\end_layout
+
+\end_inset
Moreover, if you use a literate tool other than Noweb you may need to create
a new set of document classes for it.
-\layout Paragraph
+\end_layout
+\begin_layout Paragraph
Typing code in
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX enables you to write code with a layout named
-\noun on
+\noun on
Scrap
-\noun default
+\noun default
.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
The equivalent Noweb term is
\begin_inset Quotes eld
-\end_inset
+\end_inset
Chunk
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
For historical reasons, I got used to the term
\begin_inset Quotes eld
-\end_inset
+\end_inset
scrap
\begin_inset Quotes erd
-\end_inset
+\end_inset
introduced by other literate tool named Nuweb, which I used for many years
before rendering myself to Noweb.
-\end_inset
+\end_layout
+
+\end_inset
Noweb delimits scraps like this:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
<<My scrap>>=
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
code
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
more code
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
even more code
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
@
-\layout Standard
+\end_layout
+\begin_layout Standard
The problem is that whatever is written in between the << and the
-\family typewriter
+\family typewriter
@
-\family default
+\family default
must be taken literally, i.e., LyX should be prevented from making any special
interpretation of what has been written.
This is handled by a special layout named Scrap, that works like a normal
paragraph but has a free spacing capability.
-\layout Standard
+\end_layout
+\begin_layout Standard
The down side of the Scrap paragraph layout is that consecutive paragraphs
of code will be spaced with one empty line in the source code and also
in the printed documentation.
a newline (ctrl-return).
The example above will look like this:
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
If you have a printed version of this document you will not see any difference
between the previous example and this one.
-\end_inset
+\end_layout
+\end_inset
-\layout LyX-Code
+\end_layout
+
+\begin_layout LyX-Code
<<My scrap>>=
-\newline
+\newline
code
-\newline
+\newline
more code
-\newline
+\newline
even more code
-\newline
+\newline
@
-\layout Standard
+\end_layout
+\begin_layout Standard
This layout works fine.
The only real inconvenience is that you have to type ctrl-return instead
of a plain return.
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
It is in my list of
\begin_inset Quotes eld
-\end_inset
+\end_inset
improvements
\begin_inset Quotes erd
-\end_inset
+\end_inset
to fix that.
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
+
+\begin_layout Standard
As a special note, you can also use the
\begin_inset Quotes eld
-\end_inset
+\end_inset
%def
\begin_inset Quotes erd
-\end_inset
+\end_inset
construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
rence:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
<<My scrap>>=
-\newline
+\newline
def some_function(args):
-\newline
- "This is the doc string for this function."
-\newline
+\newline
+ "This is the doc string for this
+ function."
+\newline
print "My args: ", args
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
@ %def some_function
-\layout Standard
+\end_layout
+\begin_layout Standard
For an example of this usage and the resulting cross-reference output, look
at the Literate python program in
-\emph on
-LIBDIR/examples/listerrors.lyx
-\emph default
-which should make this all clear.
-\layout Paragraph
+\emph on
+LIBDIR/examples/listerrors.lyx
+\emph default
+ which should make this all clear.
+\end_layout
+\begin_layout Paragraph
Generating the documentation
-\layout Standard
+\end_layout
+\begin_layout Standard
At this point you already have a new document file with a proper document
class, and with some code and text on it.
How do I print it? The answer is simple, you select
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew\SpecialChar \menuseparator
-\bar under
+\bar under
D
-\bar default
+\bar default
VI,
-\family default
+\family default
etc.
Just like you would do for a plain document.
No special procedure is required.
-\layout Standard
+\end_layout
+\begin_layout Standard
To help orientate you, I will now explain what happens inside LyX:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
When the
-\family sans
-\bar under
+\family sans
+\bar under
U
-\bar default
+\bar default
pdate\SpecialChar \menuseparator
-\bar under
+\bar under
D
-\bar default
-VI
-\family default
-menu option is chosen, a latex file is generated.
+\bar default
+VI
+\family default
+ menu option is chosen, a LaTeX file is generated.
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
If the document is of any literate class the generated file will be named
with an extension name defined by the
\begin_inset Quotes eld
-\end_inset
+\end_inset
literate
\begin_inset Quotes erd
-\end_inset
+\end_inset
format (defined in the Preferences panel), otherwise the file will have
the usual
-\family typewriter
-.tex
-\family default
-extension.
-\end_deeper
-\layout Enumerate
+\family typewriter
+.tex
+\family default
+ extension.
+\end_layout
+\end_deeper
+\begin_layout Enumerate
Note that the only difference so far is in the name of the file, no special
processing is required by LyX.
Given that you formatted the code using the Scrap layout that, by itself,
takes care of the business.
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
If the document is of any literate class LyX will then use the internal
LyX to Noweb converter, followed by the Noweb to LaTeX converter
\begin_inset Foot
-collapsed false
-
-\layout Standard
+status open
+\begin_layout Standard
The converters are defined in the
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools\SpecialChar \menuseparator
-\bar under
+\bar under
P
-\bar default
+\bar default
references
-\family default
+\family default
panel, under the
\begin_inset Quotes eld
-\end_inset
+\end_inset
Conversion
\begin_inset Quotes erd
-\end_inset
+\end_inset
tab.
-\end_inset
+\end_layout
+
+\end_inset
to generate the LaTeX file.
-\begin_deeper
-\layout Standard
+\end_layout
+\begin_deeper
+\begin_layout Standard
Otherwise it will just skip this step.
-\end_deeper
-\layout Enumerate
+\end_layout
+\end_deeper
+\begin_layout Enumerate
Finally, LaTeX is invoked and the regular post processing continues as in
a plain document.
-\layout Standard
+\end_layout
+\begin_layout Standard
Independence from a particular
\begin_inset Quotes eld
-\end_inset
+\end_inset
literate tool
\begin_inset Quotes erd
-\end_inset
+\end_inset
is easily achieved by changing the commands that are run by the various
converters.
-\layout Paragraph
+\end_layout
+\begin_layout Paragraph
Generating the code
-\layout Standard
+\end_layout
+\begin_layout Standard
When the build menu option is chosen or the corresponding button in the
- toolbar is pressed, a latex file is generated just like step 1 above.
- Next, LyX invokes the
-\family typewriter
- Noweb->Program
-\family default
+ toolbar is pressed, a LaTeX file is generated just like step 1 above.
+ Next, LyX invokes the
+\family typewriter
+Noweb->Program
+\family default
converter.
Typically, this converter (like any other converter), has two parts:
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
The converter program itself.
This program performs the conversion from the one format to the other (in
this case, from the Noweb format to the Program pseudo-format).
-\layout Enumerate
+\end_layout
+\begin_layout Enumerate
The error log parser.
This is a program whose sole purpose is to rewrite error messages in a
format that LyX understands.
This makes it possible for LyX to place error boxes in the right places
in the file buffer.
-\layout Standard
+\end_layout
+\begin_layout Standard
The first part, the
\begin_inset Quotes eld
-\end_inset
+\end_inset
Converter
\begin_inset Quotes erd
-\end_inset
+\end_inset
setting, should be set to
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
build-script $$i
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
This basically means that LyX will call
\begin_inset Quotes eld
-\end_inset
+\end_inset
build-script
\begin_inset Quotes erd
-\end_inset
+\end_inset
(a program or script) with the name of the Noweb file (generally a file
in the LyX temp directory).
-\layout Standard
+\end_layout
+\begin_layout Standard
This is an implementation of
\begin_inset Quotes eld
-\end_inset
+\end_inset
build-script
\begin_inset Quotes erd
-\end_inset
+\end_inset
that you can place in a directory on your path:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
#!/bin/sh
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
#
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
-\layout Standard
+\end_layout
+\begin_layout Standard
The next part of the converter setting is the
\begin_inset Quotes eld
-\end_inset
+\end_inset
Flags
\begin_inset Quotes erd
-\end_inset
+\end_inset
which is to be set to
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
originaldir,parselog=listerrors
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
This will run any errors that are generated by the
\begin_inset Quotes eld
-\end_inset
+\end_inset
build-script
\begin_inset Quotes erd
-\end_inset
+\end_inset
process through the
\begin_inset Quotes eld
-\end_inset
+\end_inset
listerrors
\begin_inset Quotes erd
-\end_inset
+\end_inset
program.
-\layout Standard
+\end_layout
+\begin_layout Standard
The converter code looks in
-\emph on
-MYLYXDIR/scripts
-\emph default
-first, then in
-\emph on
- LIBDIR/scripts
-\emph default
-then on the path for the
+\emph on
+MYLYXDIR/scripts
+\emph default
+ first, then in
+\emph on
+LIBDIR/scripts
+\emph default
+ then on the path for the
\begin_inset Quotes eld
-\end_inset
+\end_inset
listerrors
\begin_inset Quotes erd
-\end_inset
+\end_inset
program.
-\layout Paragraph
+\end_layout
+\begin_layout Paragraph
Build instructions in the document
-\layout Standard
+\end_layout
+\begin_layout Standard
The last piece of the integration between LyX and noweb is the
\begin_inset Quotes eld
-\end_inset
+\end_inset
build-script
\begin_inset Quotes erd
-\end_inset
+\end_inset
scrap.
Generally, the instructions for building your program should be embedded
in a scrap of its own.
The noweb-specific
\begin_inset Quotes eld
-\end_inset
+\end_inset
build-script
\begin_inset Quotes erd
-\end_inset
+\end_inset
above uses the notangle command to look for this scrap (called
\begin_inset Quotes eld
-\end_inset
+\end_inset
build-script
\begin_inset Quotes erd
-\end_inset
+\end_inset
) and runs its contents through
\begin_inset Quotes eld
-\end_inset
+\end_inset
sh
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Standard
+\end_layout
+\begin_layout Standard
Typically, such a scrap would look something like this:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
<<build-script>>=
-\newline
+\newline
#!/bin/sh
-\newline
+\newline
-\newline
+\newline
if [ -z "${NOWEB_SOURCE}" ]
-\newline
+\newline
then
-\newline
+\newline
NOWEB_SOURCE=myfile.nw
-\newline
+\newline
+
fi
-\newline
+\newline
[...
code to extract files ...]
-\newline
+\newline
[...
code to compile files ...]
-\newline
+\newline
@
-\layout Standard
+\end_layout
+\begin_layout Standard
Look in
-\emph on
-LIBDIR/examples/listerrors.lyx
-\emph default
-or in
-\emph on
+\emph on
+LIBDIR/examples/listerrors.lyx
+\emph default
+ or in
+\emph on
LIBDIR/examples/Literate.lyx
-\emph default
+\emph default
which implement two versions of the
\begin_inset Quotes eld
-\end_inset
+\end_inset
listerrors
\begin_inset Quotes erd
-\end_inset
+\end_inset
program for some illustrations of how all of these pieces go together or
in
-\emph on
+\emph on
LIBDIR/examples/noweb2lyx.lyx.
-
-\emph default
-Interestingly, these three files show off the language-indepence of the
+
+\emph default
+ Interestingly, these three files show off the language-indepence of the
LyX literate programming support since they are written in Python, C and
Perl respectively.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Configuring LyX
-\layout Standard
+\end_layout
+\begin_layout Standard
All the Literate Programming support is configured by the
-\family sans
-\bar under
+\family sans
+\bar under
T
-\bar default
+\bar default
ools\SpecialChar \menuseparator
-\bar under
+\bar under
P
-\bar default
+\bar default
references
-\family default
+\family default
panel in the
\begin_inset Quotes eld
-\end_inset
+\end_inset
Conversion
\begin_inset Quotes erd
-\end_inset
+\end_inset
tab.
The important parts are:
-\layout Description
+\end_layout
-the\SpecialChar ~
+\begin_layout Description
+the\InsetSpace ~
\begin_inset Quotes eld
-\end_inset
+\end_inset
literate
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\SpecialChar ~
+\InsetSpace ~
format Set up via the Formats tab, this is where the Noweb-specific pieces
are set up.
The
-\family sans
+\family sans
GUI Name
-\family default
+\family default
is set to
-\family typewriter
+\family typewriter
NoWeb
-\family default
+\family default
, the file extension is set to
-\family typewriter
+\family typewriter
.nw
-\family default
+\family default
.
This tells LyX to create a file with a
-\family typewriter
+\family typewriter
.nw
-\family default
+\family default
extension in the first step of the conversion process.
-\layout Description
+\end_layout
-the\SpecialChar ~
+\begin_layout Description
+the\InsetSpace ~
-\family sans
+\family sans
Program
-\family default
-\SpecialChar ~
+\family default
+\InsetSpace ~
format This is an empty format whose sole purpose is to be the endpoint
of a conversion (which then allows us to set up a converter for it).
-\layout Description
+\end_layout
+\begin_layout Description
-\family sans
+\family sans
NoWeb
-\family default
+\family default
->
-\family sans
+\family sans
LaTeX
-\family default
+\family default
This converter performs the
\begin_inset Quotes eld
-\end_inset
+\end_inset
weaving
\begin_inset Quotes erd
-\end_inset
+\end_inset
of the literate document.
For Noweb, it is set to
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
noweave -delay -index $$i > $$o
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\layout Description
+\end_layout
+\begin_layout Description
-\family sans
+\family sans
NoWeb
-\family default
+\family default
->
-\family sans
+\family sans
Program
-\family default
+\family default
This performs the
\begin_inset Quotes eld
-\end_inset
+\end_inset
tangling step
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
As stated above, the Converter is set to
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
build-script $$i
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
, with Flags set to
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
originaldir,parselog=listerrors
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Debug extensions
-\layout Standard
+\end_layout
+\begin_layout Standard
There is also a new function implemented in the LyX server, the
\begin_inset Quotes eld
-\end_inset
+\end_inset
server-goto-file-row" function, to be used with ddd/gdb or other debugger.
-\layout Standard
+\end_layout
+\begin_layout Standard
When debugging code with ddd/gdb, it is possible to invoke a text editor
at the current execution position with a single key stroke.
The default ddd configuration for that is shift-ctrl-V.
It happens that you can define the editor command line invocation in ddd
- by accessing the
-\family sans
-
-\bar under
+ by accessing the
+\family sans
+\bar under
E
-\bar default
+\bar default
dit\SpecialChar \menuseparator
-\bar under
+\bar under
P
-\bar default
+\bar default
references\SpecialChar \menuseparator
-\bar under
+\bar under
H
-\bar default
-elpers
-\family default
-dialog and changing the "Edit Sources" entry.
-\layout Standard
+\bar default
+elpers
+\family default
+ dialog and changing the "Edit Sources" entry.
+\end_layout
+\begin_layout Standard
I take advantage of the new created LyX server function and this ddd feature,
and set
\begin_inset Quotes eld
-\end_inset
+\end_inset
Edit Sources
\begin_inset Quotes erd
-\end_inset
+\end_inset
to:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
-\layout Standard
+\end_layout
+\begin_layout Standard
With this, whenever you are using ddd and find a point in the program that
you want to edit, you just press shift-ctrl-V (in the ddd window), and
ddd you forward this information to LyX through the LyX server and then
ddd was pointing to.
No more guessing or long scrolling to locate a point in the program back
from debugging !
-\layout Standard
+\end_layout
+\begin_layout Standard
Note however that you must enable the LyX server to get this feature working
(it is disabled by default).
You can enable it in
-\family sans
+\family sans
Preferences
-\family default
+\family default
(tabs
-\family sans
+\family sans
Inputs
-\family default
+\family default
,
-\family sans
+\family sans
Paths
-\family default
+\family default
) by entering in the
-\family sans
+\family sans
LyXserver pipe
-\family default
+\family default
a path like
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
/home/<your-home-directory>/.lyx/lyxpipe
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Read the LyX server documentation in the
-\emph on
+\emph on
Customization Manual
-\emph default
+\emph default
for further information.
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Toolbar extensions
-\layout Standard
+\end_layout
+\begin_layout Standard
There are six new buttons that can be added to your LyX toolbar.
Five of these buttons are short cuts to layout styles:
-\family sans
+\family sans
Standard
-\family default
+\family default
,
-\family sans
+\family sans
Section
-\family default
+\family default
,
-\family sans
+\family sans
LaTeX
-\family default
+\family default
,
-\family sans
+\family sans
LyX-Code
-\family default
+\family default
, and
-\family sans
+\family sans
Scrap
-\family default
+\family default
.
The last one is a short cut to the
\begin_inset Quotes eld
-\end_inset
+\end_inset
Build Program
\begin_inset Quotes erd
-\end_inset
+\end_inset
File menu entry.
-\layout Standard
+\end_layout
+\begin_layout Standard
LyX has a range of buttons that are available for tool bar customization.
In my toolbar I like to combine the six short cuts above with two more:
One for
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
U
-\bar default
+\bar default
pdate
-\family default
+\family default
\SpecialChar \menuseparator
-\family sans
-\bar under
+\family sans
+\bar under
D
-\bar default
+\bar default
VI
-\family default
+\family default
and the other for
-\family sans
-\bar under
+\family sans
+\bar under
V
-\bar default
+\bar default
iew\SpecialChar \menuseparator
-\bar under
+\bar under
D
-\bar default
+\bar default
VI
-\family default
+\family default
File menu entries.
Here is how it looks like:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Toolbar
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Layouts
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "layout Standard"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "layout Section"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "layout LaTeX"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "layout LyX-Code"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "layout Scrap"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Separator
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "buffer-view"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "buffer-typeset"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Icon "build-program"
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
Separator
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
.
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
.
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
.
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
End
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Colors customization
-\layout Standard
+\end_layout
+\begin_layout Standard
There are a number of colors in LyX that can be customized in
-\family sans
+\family sans
Preferences
-\family default
+\family default
.
One of the things that bothers people is the LaTeX font color.
The default color is red, since the scraps uses LaTeX font, and there is
a lot of scraps in literate documents, you may get tired of seeing everything
in red.
You can change it by going to the tabs
-\family sans
+\family sans
Look&Feel
-\family default
+\family default
,
-\family sans
+\family sans
Colors.
-\layout Standard
+\end_layout
+\begin_layout Standard
The next thing is the visible presence of the newline character in the screen.
You can choose the color of this particular character and make it blend
in the background.
equal, that way you still can see it is there, but it is not bothering
you anymore.
-\layout Chapter
+\end_layout
+\begin_layout Chapter
Secrets of the LaTeX Masters
-\begin_inset LatexCommand \label{cha:secrets}
+\begin_inset LatexCommand label
+name "cha:secrets"
-\end_inset
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
Though LyX is a powerful tool, it cannot hope to support everything that
can be done with pure TeX/LaTeX.
However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
as long as you are not afraid to use that
\begin_inset Quotes eld
-\end_inset
+\end_inset
TeX
\begin_inset Quotes erd
-\end_inset
+\end_inset
button on the toolbar or add things to the LaTeX preamble.
This section lists some tips, tricks, and otherwise cool ideas to give
your document that extra little flair.
-\emph on
+\emph on
Do try this at home
-\emph default
+\emph default
, just start with something a little smaller and less important than your
dissertation!
-\layout Standard
+\end_layout
+\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.
A few, however, will need to be downloaded from one of the CTAN archives.
We do not endorse one choice over another, we simply claim that we have
done a particular task with a particular file.
Put on your wizard hat, keep an eye out for dragons, and let us begin.
-\layout Section
-
-Tricks for Footnotes and Margin Notes
-\layout Standard
-
-suggested by
-\noun on
-Robin Socha
-\layout Subsection
-
-Footnotes
-\layout Standard
-
-LyX cannot yet take care of setting the footnote numbering back to 1 after
- each section in the
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-article
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\family roman
- document class or changing the counter style.
- You'll need to insert LaTeX commands like the following to achieve that:
-\layout Standard
-
-
-\begin_inset ERT
-status Inlined
-
-\layout Standard
-
-\backslash
-setcounter{footnote}{0}
-\end_inset
-
- Using
-\family typewriter
-
-\backslash
-setcounter{footnote}{0}
-\family roman
- will set the counter back to 1
-\begin_inset Foot
-collapsed true
-
-\layout Standard
-
-The counter has been set back to 1.
-\end_inset
-
-.
-\layout Standard
-
-The following command will change the numbering to small letters.
- Take a look at the next footnote in your xdvi or ghostview
-\begin_inset ERT
-status Inlined
-
-\layout Standard
-
-\backslash
-renewcommand{
-\backslash
-thefootnote}{
-\backslash
-alph{footnote}}
-\end_inset
-
-:
-\begin_inset Foot
-collapsed true
-
-\layout Standard
-
-This is an example for a footnote with alphabetic numbering.
-\newline
-Use
-\family typewriter
-
-\backslash
-renewcommand{
-\backslash
-thefootnote {
-\backslash
-alph{footnote}}
-\family roman
-to get this.
-\end_inset
-
-
-\layout Standard
-
-The next command sets the counter style back to default, i.e.
-
-\family typewriter
-
-\backslash
-arabic
-\family default
-
-\begin_inset Foot
-collapsed true
-
-\layout Standard
-
-Use
-\family typewriter
-
-\backslash
-renewcommand{
-\backslash
-thefootnote}{
-\backslash
-arabic{footnote}}
-\family roman
- to set the counter--style back to LyX's default, i.e.
-
-\backslash
-arabic.
-\family default
-
-\begin_inset ERT
-status Collapsed
-
-\layout Standard
-
-\backslash
-renewcommand {
-\backslash
-thefootnote} {
-\backslash
-arabic{footnote}}
-\end_inset
-
-
-\end_inset
-
-.
-\layout Standard
-
-You can use
-\family typewriter
-
-\backslash
-arabic
-\family default
-,
-\family typewriter
-
-\backslash
-roman
-\family default
-,
-\family typewriter
-
-\backslash
-Roman
-\family default
-,
-\family typewriter
-
-\backslash
-alph
-\family default
- or
-\family typewriter
-
-\backslash
-Alph
-\family default
- and others as counter styles.
- Just replace the LaTeX command in the above example and rerun TeX to see
- what those styles can do.
-
-\layout Subsection
-
-Margin Notes
-\layout Standard
-
-Here are two examples of neat things you can do to margin notes using LaTeX
- commands.
-\layout Standard
-
-The following command will make a vertical line appear alongside your text---gre
-at for
-\begin_inset Quotes eld
-\end_inset
-
-thumbing
-\begin_inset Quotes erd
-\end_inset
-
-:
-\family typewriter
-
-\backslash
-marginpar{
-\backslash
-rule[-10mm]{30mm}{5mm}}
-\family roman
-.
-\family default
-
-\begin_inset ERT
-status Inlined
-
-\layout Standard
-
-\backslash
-marginpar{
-\backslash
-rule[-10mm]{30mm}{5mm}}
-\end_inset
-
-
-\layout Standard
-
-Check your dvi- or ghostview-output to see what the
-\family typewriter
-
-\backslash
-reversemarginpar
-\family default
-command does to the following margin note.
-\layout Standard
-
-
-\begin_inset ERT
-status Inlined
-
-\layout Standard
-
-\backslash
-reversemarginpar
-\end_inset
-
-
-\begin_inset Marginal
-collapsed true
-
-\layout Standard
-
-This is a
-\newline
-margin note.
-\end_inset
-
-
-\layout Section
+\end_layout
+\begin_layout Section
Multiple Columns
-\layout Standard
+\end_layout
+\begin_layout Standard
by
-\noun on
-Lars Gullik Bjønnes
-\layout Subsection
+\noun on
+Lars Gullik Bjønnes
+\end_layout
+\begin_layout Subsection
Purpose
-\layout Standard
+\end_layout
+\begin_layout Standard
The aim for this chapter
\begin_inset Foot
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Editor's note: Lars' original chapter was a masterful description of how
to use the
-\family typewriter
+\family typewriter
multicol
-\family default
+\family default
package.
However, it was too long to flow smoothly in this document.
I have therefore chosen to excerpt the most important sections here (sorry,
Lars); you can read the original chapter (and more of the story!) in the
example file
-\family typewriter
+\family typewriter
examples/multicol.lyx
-\family default
+\family default
.
--- mer
-\end_inset
+\end_layout
+
+\end_inset
is to show how the LaTeX package
-\family typewriter
+\family typewriter
multicol
-\family default
+\family default
can be used in a LyX document.
As LyX doesn't support the
-\family typewriter
+\family typewriter
multicol
-\family default
+\family default
package natively yet, we have to use some small hacks.
By reading this section it should be obvious how to do this.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Limitations
-\layout Standard
+\end_layout
+\begin_layout Standard
The
-\family typewriter
+\family typewriter
multicol
-\family default
+\family default
package allows switching between one and multicolumn format on the same
page.
Footnotes are handled correctly (for the most part), but will be placed
ion.
At the moment only page-wide floats can be used within the scope of the
environment.
-\layout Subsection
+\end_layout
+\begin_layout Subsection
Examples
-\layout Subsubsection
+\end_layout
+\begin_layout Subsubsection
Two columns
-\layout Standard
+\end_layout
+\begin_layout Standard
If you want to have two columns in your text, you have use LaTeX mode to
insert
-\family typewriter
+\family typewriter
-\backslash
+\backslash
begin{multicols}{2}
-\family default
+\family default
at the point where you want the two column layout to start, and then
-\family typewriter
+\family typewriter
-\backslash
+\backslash
end{multicols}
-\family default
+\family default
where you want it to end.
Like this:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
begin{multicols}{2}
-\end_inset
+\end_layout
+
+\end_inset
+
+\end_layout
-\layout Standard
-\noindent
+\begin_layout Standard
+\noindent
-\series bold
-\size small
+\series bold
+\size small
The Adventure of the Empty House
-\series default
+\series default
-\newline
+\newline
by
-\noun on
+\noun on
Sir Arthur Conan Doyle
-\layout Standard
+\end_layout
+\begin_layout Standard
-\size small
+\size small
It was in the spring of the year 1894 that all London was interested, and
the fashionable world dismayed, by the murder of the Honourable Ronald
Adair under most unusual and inexplicable circumstances.
with them, for I should have considered it my first duty to do so, had
I not been barred by a positive prohibition from his own lips, which was
only withdrawn upon the third of last month.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{multicols}
-\end_inset
+\end_layout
+\end_inset
-\layout Subsubsection
+\end_layout
+
+\begin_layout Subsubsection
Multiple columns
-\layout Standard
+\end_layout
+\begin_layout Standard
The same pattern is used when you want more than two columns:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{multicols}{3}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
-\size footnotesize
+\size footnotesize
It can be imagined that my close intimacy with Sherlock Holmes had interested
me deeply in crime, and that after his disappearance I never failed to
read with care the various problems which came before the public.
found no explanation which appeared to me to be adequate.
At the risk of telling a twice-told tale, I will recapitulate the facts
as they were known to the public at the conclusion of the inquest.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{multicols}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
-You can have have more than 3 columns if you want to, but that might not
- be very pleasant for the eye.
-\layout Subsubsection
+\end_layout
+\begin_layout Standard
+You can have more than 3 columns if you want to, but that might not be very
+ pleasant for the eye.
+\end_layout
+
+\begin_layout Subsubsection
Columns inside columns
-\layout Standard
+\end_layout
+\begin_layout Standard
You can even have columns inside columns:
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{multicols}{2}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
-\size footnotesize
+\size footnotesize
The Honourable Ronald Adair was the second son of the Earl of Maynooth,
at that time governor of one of the Australian colonies.
Adair's mother had returned from Australia to undergo the operation for
cataract, and she, her son Ronald, and her daughter Hilda were living together
at 427 Park Lane.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
begin{multicols}{2}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
-\size footnotesize
+\begin_layout Standard
+
+\size footnotesize
The youth moved in the best society--had, so far as was known, no enemies
and no particular vices.
He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
Yet it was upon this easy-going young aristocrat that death came, in most
strange and unexpected form, between the hours of ten and eleven-twenty
on the night of March 30, 1894.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
end{multicols}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
-\size footnotesize
+\size footnotesize
Ronald Adair was fond of cards--playing continually, but never for such
stakes as would hurt him.
He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
a rubber of whist at the latter club.
He had also played there in the afternoon.
-\size default
+\size default
-\size footnotesize
+\size footnotesize
The evidence of those who had played with him-- Mr.
Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
and that there was a fairly equal fall of the cards.
actually won as much as four hundred and twenty pounds in a sitting, some
weeks before, from Godfrey Milner and Lord Balmoral.
So much for his recent history as it came out at the inquest.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{multicols}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
+
+\begin_layout Standard
Please do read the file
-\family typewriter
+\family typewriter
examples/multicol.lyx
-\family default
+\family default
for more advanced examples including column and header spacing, vertical
separator lines, and more.
-\layout Section
+\end_layout
+\begin_layout Section
Numbering in the
-\family sans
+\family sans
Enumerate
-\family default
+\family default
Paragraph Environment
\begin_inset OptArg
-collapsed true
-
-\layout Standard
+status collapsed
+\begin_layout Standard
Numbering in Enumerate
-\end_inset
+\end_layout
+
+\end_inset
+
+\end_layout
-\layout Standard
-\added_space_bottom bigskip
+\begin_layout Standard
by
-\noun on
+\noun on
John Weiss
-\layout Standard
-\noindent
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
The default numbering for the
-\family sans
+\family sans
Enumerate
-\family default
+\family default
paragraph environment begins with Arabic numbers and ends with uppercase
letters.
Suppose, however, you wanted a different type of numbering scheme.
Here's a quickie example of how to change the numbering scheme:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumi}{
-\backslash
+\backslash
Roman{enumi}.}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumii}{
-\backslash
+\backslash
Alph{enumii}.}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumiii}{
-\backslash
+\backslash
arabic{enumiii}.}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumiv}{
-\backslash
+\backslash
alph{enumiv}.)}
-\layout Standard
+\end_layout
+\begin_layout Standard
\SpecialChar \ldots{}
which changes the numbering scheme to uppercase Roman numerals, uppercase
letters, Arabic numbers, and lowercase letter.
-\layout Standard
+\end_layout
+\begin_layout Standard
Additionally, the previous example also adds a little bit extra to the numbering
scheme.
For example, the first level label actually looks like:
\begin_inset Quotes eld
-\end_inset
+\end_inset
I.
\begin_inset Quotes erd
-\end_inset
+\end_inset
.
For ease of reading, we'll describe what the numbering schemes look like
using a notation something like this: <
\begin_inset Quotes eld
-\end_inset
+\end_inset
I.
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,\SpecialChar ~
+,\InsetSpace ~
\begin_inset Quotes erd
-\end_inset
+\end_inset
A.
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,\SpecialChar ~
+,\InsetSpace ~
\begin_inset Quotes erd
-\end_inset
+\end_inset
1.
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,\SpecialChar ~
+,\InsetSpace ~
\begin_inset Quotes eld
-\end_inset
+\end_inset
a.)
\begin_inset Quotes erd
-\end_inset
+\end_inset
>.
-\layout Standard
+\end_layout
+\begin_layout Standard
As you can see in the example, there is a label command for each nesting
level,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
labelenumi
-\family default
+\family default
\SpecialChar \ldots{}
-\family typewriter
+\family typewriter
-\backslash
+\backslash
labelenumiv
-\family default
+\family default
, as well as a counter,
-\family typewriter
+\family typewriter
enumi
-\family default
+\family default
\SpecialChar \ldots{}
-\family typewriter
+\family typewriter
enumiv
-\family default
+\family default
.
There are also five
\begin_inset Quotes eld
-\end_inset
+\end_inset
number printing
\begin_inset Quotes erd
-\end_inset
+\end_inset
commands,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
arabic{}
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
roman{}
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
Roman{}
-\family default
+\family default
,
-\family typewriter
+\family typewriter
-\backslash
+\backslash
alph{}
-\family default
+\family default
, and
-\family typewriter
+\family typewriter
-\backslash
+\backslash
Alph{}
-\family default
+\family default
, each of which take one counter as an argument.
You can add characters before or after these, but there's no need to add
spaces.
-\layout Standard
+\end_layout
+\begin_layout Standard
You can get really fancy with these.
For example:
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumi}{
-\backslash
+\backslash
#
-\backslash
+\backslash
Alph{enumi}
-\backslash
+\backslash
#}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumii}{
-\backslash
+\backslash
Alph{enumi}.
-\backslash
+\backslash
arabic{enumii}}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumiii}{
-\backslash
+\backslash
alph{enumiii}+}
-\layout LyX-Code
+\end_layout
+\begin_layout LyX-Code
-\backslash
+\backslash
renewcommand{
-\backslash
+\backslash
labelenumiv}{(
-\backslash
+\backslash
roman{enumiv})}
-\layout Standard
+\end_layout
+\begin_layout Standard
produces the somewhat out of hand numbering scheme: <
\begin_inset Quotes eld
-\end_inset
+\end_inset
#A#
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,\SpecialChar ~
+,\InsetSpace ~
\begin_inset Quotes erd
-\end_inset
+\end_inset
A.1
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,\SpecialChar ~
+,\InsetSpace ~
\begin_inset Quotes erd
-\end_inset
+\end_inset
a+
\begin_inset Quotes erd
-\end_inset
+\end_inset
-,\SpecialChar ~
+,\InsetSpace ~
\begin_inset Quotes eld
-\end_inset
+\end_inset
(i)
\begin_inset Quotes erd
-\end_inset
+\end_inset
>.
-\layout Section
-
-Extra Space Between Table Rows
-\layout Standard
-\added_space_bottom bigskip
-by
-\noun on
-Mike Ressler
-\layout Standard
-\noindent
-LaTeX allows you to put a bit of extra space between rows in a table by
- giving an optional argument to the end-of-row specifier (
-\family typewriter
-
-\backslash
-
-\backslash
-
-\family default
-).
- LyX has not yet implemented this in a formal way, so here are two dirty
- little tricks to do the same job.
-
-\layout Standard
-
-The first is the more formal, but longwinded way to do it.
- In the LaTeX preamble, add the following command definition:
-\layout Standard
-
-
-\family typewriter
-
-\backslash
-newcommand{
-\backslash
-extratablespace}[1]{
-\backslash
-noalign{vskip#1}}
-\family default
- This command takes a single argument---the amount of space you would like
- to insert.
- Insert the command in the first column of the row
-\emph on
-after
-\emph default
- where you would like the space to appear.
- Here is an example (I've removed all the borders using
-\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-Tabl
-\bar under
-e
-\family default
-\bar default
-):
-\layout Standard
-\align center
-
-\begin_inset Tabular
-<lyxtabular version="3" rows="4" columns="3">
-<features>
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Minerals
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Calcite
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Dolomite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Graphite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-
-\begin_inset ERT
-status Collapsed
-
-\layout Standard
-
-\backslash
-extratablespace{2ex}
-\end_inset
-
-Rocks
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Limestone
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Sandstone
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Andesite
-\end_inset
-</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\layout Standard
-
-The second method is faster, but will make typographers and TeXperts all
- over the world groan.
- Simply put an end of row specifier with optional argument at the same spot.
- No fancy definitions are needed as in the above example, but there will
- be more space inserted than you specified because you essentially added
- a blank row plus the extra space.
- If the space added is too much, simply use a negative number, like so:
-\layout Standard
-\align center
-
-\begin_inset Tabular
-<lyxtabular version="3" rows="4" columns="3">
-<features>
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Minerals
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Calcite
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Dolomite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
+\end_layout
+\begin_layout Section
+Dropped Capitals
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Graphite
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
+\end_layout
-\layout Standard
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
+\end_layout
+\begin_layout Standard
+\noindent
\begin_inset ERT
-status Collapsed
-
-\layout Standard
-
-\backslash
-
-\backslash
-[-1ex]
-\end_inset
-
- Rocks
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Limestone
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Sandstone
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\layout Standard
-
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Andesite
-\end_inset
-</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\layout Standard
-
-It's short, sweet, and gets the job done quickly, even if it is really ugly.
- You may put away the rotten vegetables now! I promise I won't suggest anything
- else like that!
-\layout Section
-
-Dropped Capitals
-\layout Standard
-\added_space_bottom bigskip
-by
-\noun on
-Mike Ressler
-\layout Standard
-\noindent
+status collapsed
-\begin_inset ERT
-status Collapsed
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
newfont{
-\backslash
+\backslash
tmpfont}{cmr17 scaled 2500}{
-\backslash
+\backslash
tmpfont T}
-\backslash
+\backslash
vspace*{-8.4ex}
-\end_inset
+\end_layout
+
+\end_inset
-\layout Standard
-\noindent
+\end_layout
+\begin_layout Standard
+\noindent
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
hangindent=3.3em
-\backslash
+\backslash
hangafter=-3
-\end_inset
+\end_layout
+
+\end_inset
hose of you who like the style of old books probably also like
\begin_inset Quotes eld
-\end_inset
+\end_inset
dropped capitals
\begin_inset Quotes erd
-\end_inset
+\end_inset
---those large capital letters which begin each new chapter or section.
Implementing them with plain LyX/LaTeX is straightforward (assuming you
know some plain TeX!) but does require a lot of work and many iterations,
as you can see by all the ugly TeX-mode stuff at the beginning of this
paragraph.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
verb+
-\backslash
+\backslash
bigdrop{-1em}{3}{ptmri}{T}+
-\end_inset
+\end_layout
+
+\end_inset
here is a much easier way of doing this, of course.
The
-\family typewriter
+\family typewriter
dropcaps
-\family default
+\family default
(or the newer
-\family typewriter
+\family typewriter
dropping
-\family default
+\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
it within this document, but if you copy this paragraph to a new document,
delete the
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
-\backslash
+\backslash
verb
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
and the pluses from the TeX code at the beginning of the paragraph, and
add
-\family typewriter
+\family typewriter
-\backslash
+\backslash
usepackage{dropcaps}
-\family default
+\family default
to your LaTeX preamble, you will get a nice Times Roman Italic
\begin_inset Quotes eld
-\end_inset
+\end_inset
T
\begin_inset Quotes erd
-\end_inset
+\end_inset
, whose height is three lines of text and which protrudes 1 em into the
margin.
(Make certain you have copied
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
dropcaps.sty
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
into a directory where TeX can see it.) The first argument is the amount
of indentation; in this case the negative sign moves it into the margin.
The second argument is the height of the letter in number of lines of text.
The third argument is the font name: virtually anything which has a tfm
file should work (wade through the
-\family typewriter
+\family typewriter
.../texmf/fonts/tfm
-\family default
+\family default
directory for possibilities).
My personal favorite is
\begin_inset Quotes eld
-\end_inset
+\end_inset
-\family typewriter
+\family typewriter
yinit
-\family default
+\family default
\begin_inset Quotes erd
-\end_inset
+\end_inset
, a fancy German font specifically designed for dropped capitals.
The fourth argument is the letter (or letters) to be dropped.
The
-\family typewriter
+\family typewriter
dropping
-\family default
+\family default
package also offers the
-\family typewriter
+\family typewriter
-\backslash
+\backslash
bigdrop
-\family default
+\family default
command, as well as a slightly simplified
-\family typewriter
+\family typewriter
-\backslash
+\backslash
dropping
-\family default
+\family default
command.
-\layout Section
+\end_layout
+\begin_layout Section
Non-standard Paragraph Shapes
-\layout Standard
-\added_space_bottom bigskip
+\end_layout
+
+\begin_layout Standard
by
-\noun on
+\noun on
Mike Ressler
-\layout Standard
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
-\layout Standard
+\begin_layout Standard
-\backslash
+
+\backslash
begin{sloppypar}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
newdimen
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
-\backslash
+\backslash
setlength{
-\backslash
+\backslash
varunit}{4.5in}
-\end_inset
+\end_layout
+\end_inset
-\layout Standard
-\noindent
+\end_layout
+
+\begin_layout Standard
+\noindent
\begin_inset ERT
-status Collapsed
+status collapsed
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
parshape 19 0.45
-\backslash
+\backslash
varunit 0.332
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.40
-\backslash
+\backslash
varunit 0.300
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.35
-\backslash
+\backslash
varunit 0.293
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.30
-\backslash
+\backslash
varunit 0.300
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.25
-\backslash
+\backslash
varunit 0.317
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.20
-\backslash
+\backslash
varunit 0.342
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.15
-\backslash
+\backslash
varunit 0.373
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.10
-\backslash
+\backslash
varunit 0.410
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.05
-\backslash
+\backslash
varunit 0.453
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.00
-\backslash
+\backslash
varunit 0.500
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.05
-\backslash
+\backslash
varunit 0.453
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.10
-\backslash
+\backslash
varunit 0.410
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.15
-\backslash
+\backslash
varunit 0.373
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.20
-\backslash
+\backslash
varunit 0.342
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.25
-\backslash
+\backslash
varunit 0.317
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.30
-\backslash
+\backslash
varunit 0.300
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.35
-\backslash
+\backslash
varunit 0.293
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.40
-\backslash
+\backslash
varunit 0.300
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
0.45
-\backslash
+\backslash
varunit 0.332
-\backslash
+\backslash
varunit
-\newline
+\end_layout
+
+\begin_layout Standard
+
+\end_layout
-\end_inset
+\end_inset
There are times when the tyranny of rectangular paragraphs must be overthrown.
In such situations, a call to the delightful plain TeX command
-\family typewriter
+\family typewriter
-\backslash
+\backslash
parshape
-\family default
+\family default
is called for.
As you can see, completely arbitrary shapes can be laid out with a suitable
set of linelength definitions.
of situations such as finely tuned dropped capitals, word wrapping around
non-rectangular graphics, etc.
which will benefit from such handcrafting.
-\layout Standard
-\added_space_top bigskip
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
The syntax is
-\family typewriter
+\family typewriter
-\backslash
+\backslash
parshape numlines #1indent #1length #2indent #2length \SpecialChar \ldots{}
#nindent #nlength
-\family default
+\family default
, where
-\family typewriter
+\family typewriter
numlines
-\family default
+\family default
is the number of lines of text which define the paragraph.
If there turn out to be fewer lines, the shape is truncated; if there are
more, the excess lines have the same dimensions as the last line of the
definition.
The
-\family typewriter
+\family typewriter
#nindent
-\family default
+\family default
and
-\family typewriter
+\family typewriter
#nlength
-\family default
+\family default
entries specify the indentation of the line from the left margin, and the
length of the line as measured from that point.
The shape applies only to the current paragraph; everything is reset to
normal for the next paragraph.
-\layout Standard
-
+\end_layout
+\begin_layout Standard
\begin_inset ERT
-status Inlined
+status inlined
+
+\begin_layout Standard
-\layout Standard
-\backslash
+\backslash
end{sloppypar}
-\end_inset
+\end_layout
+\end_inset
-\layout Section
+\end_layout
+
+\begin_layout Section
Summary
-\layout Standard
+\end_layout
+\begin_layout Standard
As you can see, the examples in this section range from the useful to the
whimsical.
While I don't expect that anyone will ever need the paragraph shape demonstrate
TeX is a fantastically powerful typesetting system and all that power is
available to you since LyX uses it as its backend.
Happy LyXing!
-\the_end
+\end_layout
+
+\end_body
+\end_document
projects / lyx.git / blobdiff