#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 243
+\lyxformat 245
\begin_document
\begin_header
\textclass book
\paragraph_separation indent
\defskip medskip
\quotes_language english
-\quotes_times 2
\papercolumns 1
\papersides 2
\paperpagestyle headings
\begin_body
\begin_layout Title
-
Extended LyX Features
\end_layout
\begin_layout Author
-
by the LyX Team
\begin_inset Foot
status collapsed
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \tableofcontents{}
\end_inset
\end_layout
\begin_layout Chapter
-
Introduction
\end_layout
\begin_layout Standard
-
The
\emph on
Extended LyX Features
\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
\end_layout
\begin_layout Standard
-
Of course, with all of this extra documentation,
\emph on
Extended LyX Features
\end_layout
\begin_layout Standard
-
If you haven't read the
\emph on
Introduction
\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
\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
\end_layout
\begin_layout Chapter
-
LyX and LaTeX
\end_layout
\begin_layout Section
-
How LyX Uses LaTeX
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:lyxandlatex}
\end_inset
\end_layout
\begin_layout Standard
-
At one time, we called LyX a
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
There are several commands that automatically invoke LaTeX.
They are:
\end_layout
\begin_layout Itemize
-
\family sans
\bar under
V
\begin_layout Itemize
-
\family sans
\bar under
V
\begin_layout Itemize
-
\family sans
\bar under
F
\begin_layout Itemize
-
\family sans
\bar under
F
\end_layout
\begin_layout Standard
-
They will only invoke LaTeX if the file has changed since the last time
LaTeX was run.
\end_layout
\begin_layout Standard
-
When you run LaTeX on the file you're editing, LyX performs these steps:
\end_layout
\begin_layout Enumerate
-
Convert the document to LaTeX and save to a file with the extension
\family typewriter
.tex
\end_layout
\begin_layout Enumerate
-
Run LaTeX on the
\family typewriter
.tex
\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.
\end_layout
\begin_layout Standard
-
If you've run LaTeX using
\family sans
View\InsetSpace ~
\end_layout
\begin_layout Itemize
-
Run
\family typewriter
dvips
\begin_deeper
\begin_layout Itemize
-
For
\family sans
View\InsetSpace ~
\end_layout
\begin_layout Itemize
-
For
\family sans
\bar under
\family default
, as expected.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
Execute
\family typewriter
ghostview
\end_layout
\begin_layout Section
-
-
\begin_inset Quotes eld
\end_inset
\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.
\end_layout
\begin_layout Standard
-
We're going to set the record straight.
LyX produces two kinds of LaTeX files.
One is human readable.
\end_layout
\begin_layout Section
-
Translating LaTeX files into LyX
\end_layout
\begin_layout Standard
-
You can import a LaTeX file into LyX by using the
\family sans
\bar under
\begin_layout Standard
-
\family typewriter
reLyX
\family default
\begin_layout Standard
-
\family typewriter
reLyX
\family default
\end_layout
\begin_layout Standard
-
If you can't get
\family typewriter
reLyX
\end_layout
\begin_layout Section
-
Inserting LaTeX Code into LyX Documents
\begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:latexcodes}
\end_inset
\end_layout
\begin_layout Standard
-
You can switch between all three by right-clicking on the ERT.
Note that if you want more than one line of LaTeX commands, you cannot
use the inlined mode.
\end_layout
\begin_layout Standard
-
Here's an example of inserting LaTeX commands in a LyX document.
The code looks like this:
\end_layout
\begin_layout LyX-Code
-
\backslash
begin{tabular}{ll}
\newline
\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.
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status collapsed
\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.
+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
\end_layout
\begin_layout Standard
-This ...
+This ...
+
\end_layout
\begin_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
\end_layout
\begin_layout Standard
-
There are a few last notes to emphasize:
\end_layout
\begin_layout Itemize
-
Inside of LyX, LaTeX code appears
\emph on
in red
\end_layout
\begin_layout Itemize
-
LyX
\emph on
does not
\end_layout
\begin_layout Itemize
-
Beware reinventing the wheel.
\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.
status open
\begin_layout Standard
-
Note from
\noun on
John Weiss
\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
\end_layout
\begin_layout Standard
-
There are a number of LaTeX commands which have to be placed before the
beginning of the actual text.
They go into the preamble, and this is explained in the next section.
\end_layout
\begin_layout Section
-
LyX and the LaTeX Preamble
\end_layout
\begin_layout Subsection
-
About the LaTeX Preamble
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:preamble}
\end_inset
\end_layout
\begin_layout Standard
-
The LaTeX preamble comes at the very beginning of a document,
\emph on
before
\end_layout
\begin_layout Itemize
-
declare the document class.
LyX already does this for you.
\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
Be sure to submit your efforts to the LyX Team for inclusion in future
versions!
\end_layout
+
\end_deeper
\begin_layout Itemize
-
declare the usage of packages.
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
\end_layout
\begin_layout Itemize
-
set counters, variables, lengths and widths.
There are several LaTeX counters and variables which
\emph on
\end_layout
\begin_layout Itemize
-
declare user defined commands [with
\family typewriter
\end_layout
\begin_layout Standard
-
LyX adds its own set of definitions to the preamble of the
\family typewriter
.tex
\end_layout
\begin_layout Subsection
-
Changing the Preamble
\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.
\end_layout
\begin_layout Enumerate
-
Select
\family sans
\bar under
\end_layout
\begin_layout Enumerate
-
Use the preamble contents you've added as your default template (see
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
LyX adds anything in the
\family sans
\bar under
\end_layout
\begin_layout Subsection
-
Examples
\end_layout
\begin_layout Standard
-
Here are some examples of what you can add to a preamble, and what they
do:
\end_layout
\begin_layout Subsubsection
-
Example #1: Offsets
\end_layout
\begin_layout Standard
-
There are two variables under LaTeX that control page position:
\family typewriter
\end_layout
\begin_layout Standard
-
The default values for
\family typewriter
\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
\begin_layout LyX-Code
-
\backslash
setlength{
\backslash
\begin_layout LyX-Code
-
\backslash
setlength{
\backslash
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
and your margins should now be correct.
\end_layout
\begin_layout Subsubsection
-
Example #2: Labels
\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
\end_layout
\begin_layout Standard
-
First, make sure you're using the
\family sans
article
\begin_layout LyX-Code
-
\backslash
usepackage{labels}
\end_layout
\begin_layout LyX-Code
-
\backslash
LabelCols=3
\end_layout
\begin_layout LyX-Code
-
\backslash
LabelRows=7
\end_layout
\begin_layout LyX-Code
-
\backslash
LeftBorder=8mm
\end_layout
\begin_layout LyX-Code
-
\backslash
RightBorder=8mm
\end_layout
\begin_layout LyX-Code
-
\backslash
TopBorder=9mm
\end_layout
\begin_layout LyX-Code
-
\backslash
BottomBorder=2mm
\end_layout
\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
\end_layout
\begin_layout Standard
-
Someday, someone may write a LyX layout file to support this package directly.
Maybe that someone is you.
\end_layout
\begin_layout Subsubsection
-
Example #3: Paragraph Indentation
\end_layout
\begin_layout Standard
-
Americans are trained to indent the first line of
\emph on
every
status collapsed
\begin_layout Standard
-
Note from
\noun on
John Weiss
\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
\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:
\end_layout
\begin_layout LyX-Code
-
\backslash
usepackage{indentfirst}
\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.
\end_layout
\begin_layout Subsubsection
-
Example #4: This Document
\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
\end_layout
\begin_layout Section
-
LyX and LaTeX Errors
\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.
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_layout
\end_layout
\begin_layout Standard
-
You can navigate through the errors by using
\family sans
\bar under
\end_layout
\begin_layout Standard
-
Some folks also like to look at the log file directly, accessible from
\family sans
\end_layout
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
Anything beginning with these word is a warning message for the purpose
of
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
You can by-and-large ignore these.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_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.
\end_layout
\begin_layout Standard
-
You can safely ignore these.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
LaTeX absolutely
\emph on
loves
\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_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
Not quite as common as its cousin.
LaTeX seems to like to print lines that are a bit too wide as opposed to
ones that are a bit too narrow.
\end_layout
\begin_layout Standard
-
You can ignore these, too.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
Warnings about troubles breaking the page.
Once again, just look at the output.
Your eyes will tell you where something has gone wrong.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
The file
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
If you
\emph on
did
command, and the package in question isn't installed, you'll need to install
it yourself.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
Error messages beginning with this are trying to tell you that you specified
a bad or undefined option to a package.
Check the package's documentation.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\begin_deeper
\begin_layout Standard
-
If you've inserted LaTeX code into your document, but made a typo, you'll
get one of these.
You may have forgotten to load a package.
In any case, this error message usually means that you used an undefined
command.
\end_layout
+
\end_deeper
\begin_layout Standard
-
There are other error and warning messages.
Some are self-explanatory.
These are usually LaTeX messages.
\end_layout
\begin_layout Standard
-
There's a general sequence you should follow if you get error messages:
\end_layout
\begin_layout Enumerate
-
Look at the LaTeX code you inserted for typos.
\end_layout
\begin_layout Enumerate
-
If there are no typos, check and see that you used the command(s) correctly.
\end_layout
\begin_layout Enumerate
-
If you get a bunch of error boxes piled up at the very top of the document,
it means that there are errors in the preamble.
Start debugging your preamble.
\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.
\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
\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
\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.
\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
\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
\begin_layout Enumerate
-
rescale the figure so it fits.
\end_layout
\begin_layout Enumerate
-
trim down the table so it fits.
\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_layout
+
\end_deeper
\begin_layout Standard
-
If all this doesn't help --- well, then
\emph on
perhaps
\end_layout
\begin_layout Chapter
-
Supplemental Tools
\end_layout
\begin_layout Section
-
Preparing a Bibliography with BibTeX
+\begin_inset LatexCommand \label{sec:Preparing-a-Bibliography}
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
+\noun default
+ and
+\noun on
+Jürgen Spitzmüller
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
\noindent
STOP! If you don't know what BibTeX is, or have a reasonably good idea of
\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
\end_layout
\begin_layout Standard
-
To use BibTeX with LyX, first read the
\emph on
User Guide
\end_layout
\begin_layout Description
-
Database: enter the name of your
\family typewriter
.bib
\end_layout
\begin_layout Description
-
Style: enter the name of your BibTeX style file *without* the
\family typewriter
.bst
\end_layout
\begin_layout Standard
-
For each citation, assuming that the source is in the
\family typewriter
.bib
\end_layout
-\begin_layout Section
-
-Making an Index
+\begin_layout Subsection
+Alternative Citation Styles
\end_layout
\begin_layout Standard
+Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
-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
+\begin_inset Quotes eld
+\end_inset
+
+[12]
+\begin_inset Quotes erd
+\end_inset
+
+) to refer to a cited work.
+ However, in many scientific disciplines, other citation styles are in use.
+ The most common one is the author-year style (e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
+
+\begin_inset Quotes eld
+\end_inset
+
+Knuth 1984a
+\begin_inset Quotes erd
+\end_inset
+
+).
+ LyX supports two packages that provide this style,
\family typewriter
-makeindex
+natbib
\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.
+ and
+\family typewriter
+jurabib
+\family default
+.
+ 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
\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 ~
-
+The handling of both packages in LyX is basically the same.
+ Go to
\family sans
-T
\bar under
-O
+D
\bar default
-C\SpecialChar \menuseparator
+ocument\SpecialChar \menuseparator
\bar under
-I
+S
\bar default
-ndex
+ettings
\family default
-\InsetSpace ~
-
+and select the
\family sans
-List
+Bibliography
\family default
-.
- Then, for each word you would like to include in the index, go to the end
- of that word and click on
+ pane (with the xforms frontend: the
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ndex
+Extras
+\family default
+ tab).
+ Then select
+\family sans
+Natbib
+\family default
+ or
+\family sans
+Jurabib
+\family default
+.
+ 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
+
+Knuth 1984
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Knuth (1984)
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Knuth, 1984
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+1984
+\begin_inset Quotes erd
+\end_inset
+
+ etc.).
+ Note that both packages need specifically designed style files (they both
+ ship their own, while there are lots of additional style files and even
+ an interactive style file builder
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+See
+\begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/}
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ for
+\family typewriter
+natbib
+\family default
+ available).
+\end_layout
+
+\begin_layout Subsection
+Sectionated Bibliographies
+\begin_inset LatexCommand \label{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
+
+must have
+\begin_inset Quotes erd
+\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{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
+
+Sources
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+Scientific works
+\begin_inset Quotes erd
+\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
+.
+
+\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{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
+
+all cited references
+\begin_inset Quotes erd
+\end_inset
+
+ of the specified database(s) (which is the default),
+\begin_inset Quotes eld
+\end_inset
+
+all uncited references
+\begin_inset Quotes erd
+\end_inset
+
+ or even
+\begin_inset Quotes eld
+\end_inset
+
+all references
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This might be useful if you would like to separate your bibliography into
+ three sections:
+\begin_inset Quotes eld
+\end_inset
+
+Cited sources
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
+Uncited sources
+\begin_inset Quotes erd
+\end_inset
+
+, and
+\begin_inset Quotes eld
+\end_inset
+
+Scientific works
+\begin_inset Quotes erd
+\end_inset
+
+.
+ 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{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{sec:Inserting-LaTeX-Code}
+
+\end_inset
+
+).
+\begin_inset Foot
+status collapsed
+
+\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
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+First, 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
+.
+ In the document, you have to enclose the sections, which shall contain
+ their own bibliography (including the BibTeX reference itself), between
+
+\family typewriter
+
+\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
+
+\begin_layout Section
+Making an Index
+\end_layout
+
+\begin_layout Standard
+A good index is one of the hardest things to make in a lengthy document,
+ but LyX helps make things a bit simpler by interfacing to the
+\family typewriter
+makeindex
+\family default
+ program which is found in most recent LaTeX distributions.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+In the
+\family sans
+\series default
+\shape default
+\size default
+\emph default
+\bar 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 typewriter
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+xindy
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+.
+\end_layout
+
+\end_inset
+
+ Inserting an index and marking words to include in it works much the same
+ way as preparing a bibliography as mentioned in the last section.
+\end_layout
+
+\begin_layout Standard
+First, go to the end of your file and select
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+List
+\family default
+\InsetSpace ~
+/\InsetSpace ~
+
+\family sans
+T
+\bar under
+O
+\bar default
+C\SpecialChar \menuseparator
+
+\bar under
+I
+\bar default
+ndex
+\family default
+\InsetSpace ~
+
+\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
+
+\bar under
+I
+\bar default
+ndex
\family default
\InsetSpace ~
\end_layout
\begin_layout Standard
-
Be careful not to put spaces between the word in the text and the index
marker; apparently the wrong page number can be produced if this happens.
\end_layout
\begin_layout Section
-
Multipart Documents
\end_layout
\begin_layout Subsection
-
General Operation
\end_layout
\begin_layout Standard
-
When you are working on a large file with many sections, it is often convenient
to break up the document into several files, or perhaps you have something
where a table may change from time to time, but the preceding text does
\end_layout
\begin_layout Standard
-
LyX allows you to include files quite easily with
\family sans
\bar under
\end_layout
\begin_layout Standard
-
The file selection box should by now be obvious.
The three inclusion methods are
\begin_inset Quotes eld
\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.
\end_layout
\begin_layout Standard
-
A
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsection
-
Cross-References Between Files
\end_layout
\begin_layout Standard
-
It is possible to set up cross-references between the different files.
First, open all the files in question: let's call them A and B in a two
file example, where B is included in A.
\end_layout
\begin_layout Section
-
Algorithms
\end_layout
\begin_layout Standard
-
The package
\family sans
algorithm
\end_layout
\begin_layout Section
-
Subfigures
\end_layout
\begin_layout Standard
-
The package
\family sans
subfigure
\end_layout
\begin_layout Section
-
Fancy Headers and Footers
\end_layout
\begin_layout Standard
-
The default page layout is rather plain; for an article document class,
all you get is a centered page number at the bottom of the page.
This document is the book class, so it appears to be a bit fancier, but
\end_layout
\begin_layout Standard
-
The page header is divided into three fields, not surprisingly labeled
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
-
\family typewriter
\backslash
\end_layout
\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
\begin_layout Standard
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
Let's get really fancy: lets put the section number with the word
\begin_inset Quotes eld
\end_inset
\begin_layout Standard
-
\family typewriter
\backslash
\begin_layout Standard
-
\family typewriter
\backslash
\begin_layout Standard
-
\family typewriter
\backslash
\begin_layout Standard
-
\family typewriter
\backslash
\begin_layout Standard
-
\family typewriter
\backslash
\begin_layout Standard
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
The codes
\family typewriter
\end_layout
\begin_layout Standard
-
The thicknesses of the horizontal rules drawn beneath the header and above
the footer can also be modified.
If you don't want one of the headers, set its thickness to 0.
\end_layout
\begin_layout Standard
-
You can switch the header/footer settings on and off for individual pages
using commands like
\family typewriter
\end_layout
\begin_layout Standard
-
There are more complex commands which will let you insert things in the
upper left on odd numbered pages, etc., but I will refer you to the
\family typewriter
\end_layout
\begin_layout Standard
-
As a final example, it is possible to include an Encapsulated PostScript®
file in the header or footer.
Suppose you want to put a company logo in the upper lefthand corner.
\begin_layout Standard
-
\family typewriter
\backslash
\end_layout
\begin_layout Section
-
Minipages
\end_layout
\begin_layout Standard
-
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.\InsetSpace ~
\end_layout
\begin_layout Standard
-
Minipages in LyX have their own collapsable box; insert one via
\family sans
\bar under
\end_layout
\begin_layout Standard
-
If you place two minipages side-by-side, you can use
\family sans
\bar under
\end_layout
\begin_layout Standard
-
-
\begin_inset Box Frameless
position "t"
hor_pos "c"
status open
\begin_layout Standard
-
This is a minipage which does not use hfill.
This is the second sentence of a minipage which does not use hfill.
\end_layout
\end_layout
\begin_layout Standard
-
-
\begin_inset Box Frameless
position "t"
hor_pos "c"
status open
\begin_layout Standard
-
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_layout
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace medskip
\end_inset
\end_layout
\begin_layout Standard
-
Here is some normal text to separate the two examples.
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace medskip
\end_inset
\end_layout
-
\begin_layout Standard
-
-
\begin_inset Box Frameless
position "t"
hor_pos "c"
status open
\begin_layout Standard
-
This is a minipage which does use hfill.
This is the second sentence of a minipage which does use hfill.
\end_layout
status open
\begin_layout Standard
-
This is a second minipage which does use hfill.
This is the second sentence of a second minipage which does use hfill.
\end_layout
\end_layout
\begin_layout Section
-
Wrapping Text Around Figures
\begin_inset LatexCommand \label{sec:floatflt}
\end_layout
\begin_layout Standard
-
-
\begin_inset Wrap figure
placement r
width "6cm"
status open
\begin_layout Standard
-
-
\begin_inset Graphics
filename mobius.eps
display color
\end_layout
\begin_layout Caption
-
This is a wrapped figure, and this is the brilliant caption that describes
it
\end_layout
\end_layout
\begin_layout Standard
-
A very frequently asked question is whether text can be made to
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
At the right is a figure of a mobius strip---you should have already seen
this in the
\emph on
\end_layout
\begin_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.
\end_layout
\begin_layout Section
-
Extra Table Options
\end_layout
\begin_layout Standard
-
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
\end_layout
\begin_layout Subsection
-
Removing Extra Column Space
\end_layout
\begin_layout Standard
-
Here is a standard table:
\end_layout
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="2">
<features>
<column alignment="left" valignment="top" width="0pt">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\end_layout
\begin_layout Standard
-
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.
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="2">
<features>
<column alignment="left" valignment="top" width="0pt" special="@{} l">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\end_layout
\begin_layout Standard
-
In this case, the column specifier for the left column was set to
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsection
-
Changing the Column Separator Character
\end_layout
\begin_layout Standard
-
Now suppose you really wanted, for reasons that are completely opaque, to
use
\begin_inset Formula $\sqrt{\pi}$
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="3" columns="2">
<features>
<column alignment="left" valignment="top" width="0pt">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\end_layout
\begin_layout Subsection
-
Making a Decimal Point Aligned Column
\end_layout
\begin_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.
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="5" columns="3">
<features>
<column alignment="center" valignment="top" width="0pt">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\bar no
\noun off
\color none
-
\begin_inset Formula $\pi$
\end_inset
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\bar no
\noun off
\color none
-
\begin_inset Formula $\pi^{\pi}$
\end_inset
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\bar no
\noun off
\color none
-
\begin_inset Formula $(\pi^{\pi})^{\pi}$
\end_inset
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\bar no
\noun off
\color none
-
\begin_inset Formula $\pi^{\pi^{\pi}}$
\end_inset
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\end_layout
\begin_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.
\end_layout
\begin_layout Standard
-
Perhaps it is best if I described just what I did: first, create a 3
\begin_inset Formula $\times$
\end_inset
\end_layout
\begin_layout Subsection
-
A Better Decimal-Alignment Solution
\end_layout
\begin_layout Standard
-
An alternative way to have decimal alignment in tables is through the
\family typewriter
dcolumn
\begin_layout LyX-Code
-
\backslash
usepackage{dcolumn}
\end_layout
\begin_layout LyX-Code
-
\backslash
newcolumntype{d}[1]{D{.}{.}{#1}}
\end_layout
\begin_layout Standard
-
To have a column decimally aligned, enter in the
\family sans
Special Column Alignment
\end_layout
\begin_layout LyX-Code
-
d{number of decimals of the data}
\end_layout
\begin_layout Standard
-
To create extra column space just increase the number of decimals in
\family typewriter
d{}
\end_layout
\begin_layout Standard
-
This method offers the same flexibility as the
\family typewriter
dcolumn
\end_layout
\begin_layout LyX-Code
-
D{inputsep}{outputsep}{decimal places}
\end_layout
\begin_layout Standard
-
The interested reader is directed towards the
\family typewriter
dcolumn
\end_layout
\begin_layout Section
-
Itemize Bullet Selection
\begin_inset LatexCommand \label{sec:bullet}
\end_layout
\begin_layout Standard
-
by
\noun on
Allan Rae
\end_layout
\begin_layout Subsection
-
Introduction
\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.
status collapsed
\begin_layout Standard
-
Well, actually you can but you'll have to do it by hand.
\end_layout
\end_layout
\begin_layout Subsection
-
How it looks
\end_layout
\begin_layout Standard
-
Open the dialog by selecting the
\family sans
\bar under
\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.
\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.
\end_layout
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="7" columns="2">
<features>
<column alignment="center" valignment="top" leftline="true" width="0pt">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family sans
\series medium
\shape up
\begin_layout Standard
-
\series medium
\shape up
\size normal
\begin_layout Standard
-
\family sans
\series medium
\shape up
\begin_layout Standard
-
\family typewriter
\series medium
\shape up
\begin_layout Standard
-
\family sans
\series medium
\shape up
\begin_layout Standard
-
\family typewriter
\series medium
\shape up
\begin_layout Standard
-
\family sans
\series medium
\shape up
\begin_layout Standard
-
\family typewriter
\series medium
\shape up
\begin_layout Standard
-
\family sans
\series medium
\shape up
\begin_layout Standard
-
\family typewriter
\series medium
\shape up
\begin_layout Standard
-
\family sans
\series medium
\shape up
\begin_layout Standard
-
\family typewriter
\series medium
\shape up
\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.
\end_layout
\begin_layout Subsection
-
How to use it
\end_layout
\begin_layout Standard
-
Select which bullet depth you want to change then select the bullet shape
and size.
\end_layout
\begin_layout Standard
-
You can reset a bullet shape to the default simply by clicking your right
mouse button on the appropriate bullet depth button.
\end_layout
\begin_layout Standard
-
If you
\emph on
really
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Itemize
-
Use the LaTeX command
\family typewriter
\end_layout
\begin_layout Itemize
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\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:
\end_layout
\begin_layout Chapter
-
Special Document Classes
\end_layout
\begin_layout Section
-
AMS LaTeX
\end_layout
\begin_layout Standard
-
by
\noun on
David Johnson
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\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_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
\end_layout
\begin_layout Enumerate
-
amsart-plain: This one is even more terse, since all the environments are
unnumbered.
\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
\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
\end_layout
\begin_layout Subsection
-
What these layouts provide
\end_layout
\begin_layout Standard
-
There is a long list of included environments provided by these layouts.
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
\end_layout
\begin_layout Description
-
Theorem This is typically used for the statements of major results.
The word
\begin_inset Quotes eld
\end_layout
\begin_layout Description
-
Corollary This is used for statements which follow fairly directly from
previous statements.
Again, these can be major results.
\end_layout
\begin_layout Description
-
Lemma These are smaller results needed to prove other statements.
\end_layout
\begin_layout Description
-
Proposition These are less major results which (hopefully) add to the general
theory being discussed.
\end_layout
\begin_layout Description
-
Conjecture These are statements provided without justification, which the
author does not know how to prove, but which seem to be true (to the author,
at least).
\end_layout
\begin_layout Description
-
Criterion A required condition.
\end_layout
\begin_layout Description
-
Algorithm A general procedure to be used.
\end_layout
\begin_layout Description
-
Axiom This is a property or statement taken as true within the system being
discussed.
\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.
\end_layout
\begin_layout Description
-
Example Typeset similarly to Definition.
\end_layout
\begin_layout Description
-
Condition
\end_layout
\begin_layout Description
-
Problem
\end_layout
\begin_layout Description
-
Exercise
\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.
\end_layout
\begin_layout Description
-
Note Set similarly to the Remark environment.
\end_layout
\begin_layout Description
-
Notation
\end_layout
\begin_layout Description
-
Claim
\end_layout
\begin_layout Description
-
Summary
\end_layout
\begin_layout Description
-
Acknowledgement
\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
\end_layout
\begin_layout Description
-
Conclusion
\end_layout
\begin_layout Description
-
Fact
\end_layout
\begin_layout Description
-
Proof The word
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Description
-
Address This should be the author's permanent address.
\end_layout
\begin_layout Description
-
Current\InsetSpace ~
Address This should be the author's temporary address at the time
of submission, if different from the Address.
\end_layout
\begin_layout Description
-
Email Author's e-mail address
\end_layout
\begin_layout Description
-
URL Author's Web address, if desired.
\end_layout
\begin_layout Description
-
Keywords Key words or phrases used to identify specific topics discussed
in the paper.
\end_layout
\begin_layout Description
-
Subjectclass These refer to the AMS Subject Classifications, published and
described in
\emph on
\end_layout
\begin_layout Description
-
Thanks
\end_layout
\begin_layout Description
-
Dedicatory
\end_layout
\begin_layout Description
-
Translator
\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.
\end_layout
\begin_layout Section
-
Dinbrief
\end_layout
\begin_layout Standard
-
The document class
\family sans
dinbrief
\end_layout
\begin_layout Section
-
Paper
\end_layout
\begin_layout Standard
-
The document class
\family sans
paper
\end_layout
\begin_layout Section
-
A&A Paper
\end_layout
\begin_layout Standard
-
by
\noun on
Peter Sütterlin
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
This section describes how LyX can be used to write articles for submission
to the scientific journal
\emph on
This package can be downloaded from the ftp site
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace medskip
\end_inset
\begin_layout Standard
\align center
-
\begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
\end_inset
\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
\end_layout
\begin_layout Subsection
-
Getting started
\end_layout
\begin_layout Standard
-
It is recommended you start from the example template distributed with LyX.
If you are not using a template, note the following settings:
\end_layout
\begin_layout Itemize
-
Select
\family sans
article (A&A)
\end_layout
\begin_layout Itemize
-
Don't change the option
\family sans
Page\InsetSpace ~
\end_layout
\begin_layout Subsection
-
The header block
\end_layout
\begin_layout Standard
-
First thing to enter is the header information.
It consists of seven entries, of which some are optional.
They are
\begin_layout Itemize
-
\family sans
Title
\family default
\begin_layout Itemize
-
\family sans
Subtitle
\family default
\begin_layout Itemize
-
\family sans
Author
\family default
\begin_layout Itemize
-
\family sans
Address
\family default
\begin_layout Itemize
-
\family sans
Offprints
\family default
\begin_layout Itemize
-
\family sans
Mail
\family default
\begin_layout Itemize
-
\family sans
Date
\family default
\end_layout
\begin_layout Standard
-
There is no need to issue the
\family typewriter
\end_layout
\begin_layout Standard
-
If you want to place footnotes in the header block, e.g.
\begin_inset ERT
status collapsed
\end_layout
\begin_layout Standard
-
In addition to these topics, the macros use three additional LaTeX commands
that have no counterpart in LyX:
\end_layout
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
In all cases, the appropriate command has to be entered in LyX an marked
as LaTeX code.
See the examples.
\end_layout
\begin_layout Subsection
-
The abstract
\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.
\end_layout
\begin_layout Subsection
-
Supported environments
\end_layout
\begin_layout Standard
-
The A&A paper layout supports the following environments for structuring
your text:
\end_layout
\begin_layout Itemize
-
\family sans
Standard
\end_layout
\begin_layout Itemize
-
\family sans
Section
\end_layout
\begin_layout Itemize
-
\family sans
Subsection
\end_layout
\begin_layout Itemize
-
\family sans
Subsubsection
\end_layout
\begin_layout Itemize
-
\family sans
Itemize
\end_layout
\begin_layout Itemize
-
\family sans
Enumerate
\end_layout
\begin_layout Itemize
-
\family sans
Description
\end_layout
\begin_layout Itemize
-
\family sans
Caption
\end_layout
\begin_layout Itemize
-
\family sans
Abstract
\end_layout
\begin_layout Itemize
-
\family sans
Acknowledgment
\end_layout
\begin_layout Itemize
-
\family sans
Bibliography
\end_layout
\begin_layout Itemize
-
\family sans
LaTeX
\end_layout
\begin_layout Subsection
-
Commands not supported by LyX
\end_layout
\begin_layout Standard
-
Some commands are not yet supported by the
\family sans
paper (A&A)
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
If you want to use any of these commands, you have to enter them yourself.
\series bold
\end_layout
\begin_layout Subsection
-
Figure and Table Floats
\end_layout
\begin_layout Standard
-
LyX provides support for the necessary float environments
\family sans
figure, figure*, table
\end_layout
\begin_layout Standard
-
There is
\family sans
\end_layout
\begin_layout Enumerate
-
Create a wide figure float:
\family sans
\bar under
\end_layout
\begin_layout Enumerate
-
Enter your caption text.
\end_layout
\begin_layout Enumerate
-
Press
\family sans
Return
\end_layout
\begin_layout Enumerate
-
Insert your figure
\end_layout
\begin_layout Enumerate
-
Position the cursor behind the figure and insert a horizontal fill:
\family sans
\bar under
\end_layout
\begin_layout Enumerate
-
Switch to LaTeX mode:
\family sans
M-c\InsetSpace ~
\end_layout
\begin_layout Enumerate
-
Enter
\family typewriter
\end_layout
\begin_layout Enumerate
-
Position the cursor behind the caption text, switch to LaTeX mode and insert
the closing brace:
\family sans
\end_layout
\begin_layout Standard
-
Also, refer to the figures in the example paper.
\end_layout
\begin_layout Subsection
-
Referee layout
\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
\end_layout
\begin_layout Subsection
-
The example paper
\end_layout
\begin_layout Standard
-
The
\family sans
Examples
\end_layout
\begin_layout Section
-
AASTeX
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
AASTeX is a set of macros produced by the American Astronomical Society
to facilitate electronic manuscript submission to the three journals they
publish: the Astrophysical Journal (including the Letters and Supplement),
The AASTeX package may be downloaded from the AASTeX Web site
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace medskip
\end_inset
\begin_layout Standard
\align center
-
\begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
\end_inset
\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
\end_layout
\begin_layout Subsection
-
Starting a New Paper
\end_layout
\begin_layout Standard
-
I strongly suggest that you start with the AASTeX template file.
Click on
\family sans
\end_layout
\begin_layout Subsection
-
Finishing Your Paper
\end_layout
\begin_layout Standard
-
When the paper is finished to your satisfaction and previews/prints correctly,
there are a few
\begin_inset Quotes eld
\end_layout
\begin_layout Enumerate
-
Export your paper as a LaTeX file (
\family sans
\bar under
\end_layout
\begin_layout Enumerate
-
Edit the resulting
\family typewriter
.tex
\begin_deeper
\begin_layout Enumerate
-
remove the comment lines before the
\family typewriter
\end_layout
\begin_layout Enumerate
-
remove the
\family typewriter
\end_layout
\begin_layout Enumerate
-
remove everything between (and including) the
\family typewriter
\family default
file).
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Run the resulting file through LaTeX to make sure it still processes correctly.
\end_layout
\begin_layout Enumerate
-
Reread the journal requirements to make sure your filenames and formats
are correct.
\end_layout
\begin_layout Enumerate
-
Submit it.
\end_layout
\begin_layout Subsection
-
Comments On Specific Commands
\end_layout
\begin_layout Standard
-
I will not describe the detailed usage of the individual AASTeX commands:
the AASTeX User Guide (
\family typewriter
\end_layout
\begin_layout Subsubsection
-
Things that work as expected
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\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
\end_layout
\begin_layout Standard
-
The following style options also work correctly:
\family typewriter
longabstract
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Subsubsection
-
Things that work, but require more comment
\end_layout
\begin_layout Standard
-
The following items work, but require a little more discussion:
\end_layout
\begin_layout Itemize
-
These items are reserved for use by the journal editors, but you can put
them into the LaTeX preamble if you feel compelled to do so:
\family typewriter
\end_layout
\begin_layout Itemize
-
These items may be placed in the LaTeX preamble, and are included as blanks
in the template file:
\family typewriter
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\end_layout
\begin_layout Subsubsection
-
Things not implemented, use ERT
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Standard
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Subsubsection
-
Things that cannot be implemented
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
at least in any meaningful sort of way, so I suggest ignoring them.
They are the references environment (2.13.3), and the deluxetable environment
\end_layout
\begin_layout Subsection
-
FAQs, Tips, Tricks, and Other Ruminations
\end_layout
\begin_layout Subsubsection
-
Getting LyX and AASTeX to cooperate
\end_layout
\begin_layout Standard
-
It can be a bit tricky to get LyX to recognize a new layout and document
class.
When all else fails, do this:
\end_layout
\begin_layout Enumerate
-
Make certain that LaTeX can find AASTeX.
Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
\end_layout
\begin_layout Enumerate
-
Make certain that
\family typewriter
aastex.layout
\end_layout
\begin_layout Enumerate
-
Rerun
\family sans
\bar under
\end_layout
\begin_layout Enumerate
-
Open a regular new file, not from a template.
Does AASTeX appear in the class list in
\family sans
\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_layout
\begin_layout Subsubsection
-
LaTeX error processing a table
\end_layout
\begin_layout Standard
-
LyX, by default, attempts to center the table caption/title.
This seems to produce a bad interaction in AASTeX so you should click somewhere
in the caption/title, then select
\end_layout
\begin_layout Subsubsection
-
References
\begin_inset LatexCommand \label{cite}
\end_layout
\begin_layout Standard
-
A couple of things: 1) I have noticed some funny spacing in the reference
entries in the text.
When you enter the bibliography item data, make sure their is
\end_layout
\begin_layout Subsubsection
-
Including EPS files
\end_layout
\begin_layout Standard
-
Even though AASTeX provides its own figure commands (
\family typewriter
\end_layout
\begin_layout Subsubsection
-
Things I could have done, but didn't
\end_layout
\begin_layout Standard
-
There are a few
\begin_inset Quotes eld
\end_inset
\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
\end_layout
\begin_layout Section
-
ijmpd
\end_layout
\begin_layout Standard
-
by
\noun on
Panayotis Papasotiriou
\end_layout
\begin_layout Subsection
-
Overview
\end_layout
\begin_layout Standard
-
The ijmpd package is a set of macros that facilitates electronic manuscript
submission to the
\emph on
\end_layout
\begin_layout Subsection
-
Writing a paper
\end_layout
\begin_layout Standard
-
As usual, the easiest way to write a paper is to start with a template.
Click on
\family sans
\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.
\end_layout
\begin_layout Enumerate
-
The ijmpd package requires that the language of the document should not
be changed.
Before previewing your paper, be sure that the babel package is not used.
\end_layout
\begin_layout Enumerate
-
Two new environments, named
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
Appendices may be added to the paper.
LyX offers a special environment, called
\begin_inset Quotes eld
\end_layout
\begin_layout Enumerate
-
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.
\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
\end_layout
\begin_layout Enumerate
-
Remove the comment lines before the
\family typewriter
\end_layout
\begin_layout Enumerate
-
Remove everything between (and including) the
\family typewriter
\end_layout
\begin_layout Standard
-
The modified
\family typewriter
.tex
\end_layout
\begin_layout Subsection
-
Use of ERT
\end_layout
\begin_layout Standard
-
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
\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.
\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_layout
\begin_layout Subsection
-
Writing a paper
\end_layout
\begin_layout Standard
-
The easiest way to write a paper is to start with the Kluwer template file.
Click on
\family sans
\end_layout
\begin_layout Subsection
-
Preparing a paper for submission
\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_layout
\begin_layout Enumerate
-
Export your paper as a LaTeX file.
To do this, click on
\family sans
\end_layout
\begin_layout Enumerate
-
Edit the resulting
\family typewriter
.tex
\begin_deeper
\begin_layout Enumerate
-
remove the comment lines before the
\family typewriter
\end_layout
\begin_layout Enumerate
-
remove everything between (and including) the
\family typewriter
\end_layout
\begin_layout Standard
-
Save the resulting
\family typewriter
.tex
\family default
file.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Run the
\family typewriter
.tex
\end_layout
\begin_layout Enumerate
-
View the resulting
\family typewriter
.dvi
\end_layout
\begin_layout Subsection
-
-
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
The Kluwer package has the following
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Enumerate
-
It is possible to write multiple articles in the same LaTeX file
\begin_inset Foot
status collapsed
\begin_layout Standard
-
I can't imagine any good reason to do this.
\end_layout
\end_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
\end_layout
\begin_layout Enumerate
-
According to the user manual, the label of each bibliography item must be
written as
\family typewriter
\end_layout
\begin_layout Standard
-
The
\family typewriter
kluwer.lyx
\end_layout
\begin_layout Enumerate
-
don't delete the ERT included in the template, and
\end_layout
\begin_layout Enumerate
-
copy the example bibliography item included in the template and modify it
as necessary to enter new bibliography items.
\end_layout
\begin_layout Section
-
Koma-Script
\end_layout
\begin_layout Standard
-
by
\noun on
Bernd Rellermeyer
\end_layout
\begin_layout Subsection
-
Overview
\end_layout
\begin_layout Standard
-
The LyX document classes
\emph on
article (koma-script)
\end_layout
\begin_layout Itemize
-
Standard character size is 11pt in
\emph on
article (koma-script)
\end_layout
\begin_layout Itemize
-
Headings, labels of the description environment, and a number of elements
of the
\emph on
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.
\end_layout
\begin_layout Itemize
-
The main means in the Koma-Script document classes to design the type area
are the options
\family sans
\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
\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
status collapsed
\begin_layout Standard
-
There is an English translation
\emph on
screnggu
\end_layout
\begin_layout Subsection
-
article (koma-script), report (koma-script), and book (koma-script)
\end_layout
\begin_layout Standard
-
The document classes
\emph on
article (koma-script)
\begin_layout Itemize
-
\family sans
Addpart, Addchap
\family default
\begin_layout Itemize
-
\family sans
Addchap*
\family default
status collapsed
\begin_layout Standard
-
There is also an
\family typewriter
\begin_layout Itemize
-
\family sans
Minisec
\family default
\begin_layout Itemize
-
\family sans
Captionabove
\family default
\begin_layout Itemize
-
\family sans
Dictum
\family default
\end_layout
\begin_layout Standard
-
The following types, together with the standard types
\family sans
Title
status collapsed
\begin_layout Standard
-
The corresponding LaTeX commands must appear before the
\family typewriter
\begin_layout Itemize
-
\family sans
Subject
\family default
\begin_layout Itemize
-
\family sans
Publishers
\family default
\begin_layout Itemize
-
\family sans
Dedication
\family default
\begin_layout Itemize
-
\family sans
Titlehead
\family default
\begin_layout Itemize
-
\family sans
Uppertitleback
\family default
\begin_layout Itemize
-
\family sans
Lowertitleback
\family default
\begin_layout Itemize
-
\family sans
Extratitle
\family default
\end_layout
\begin_layout Standard
-
The layout files for the document classes
\emph on
article (koma-script)
\end_layout
\begin_layout Subsection
-
letter (koma-script)
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\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
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_layout LyX-Code
-
\backslash
firsthead{
\backslash
\end_layout
\begin_layout LyX-Code
-
{
\backslash
ignorespaces
\begin_layout LyX-Code
-
\backslash
nexthead{
\backslash
\end_layout
\begin_layout LyX-Code
-
{
\backslash
ignorespaces
\end_layout
\begin_layout Standard
-
The types
\family sans
Letter
\begin_layout Itemize
-
\family sans
Letter
\family default
\begin_layout Itemize
-
\family sans
Opening
\family default
\begin_layout Itemize
-
\family sans
Closing
\family default
\begin_layout Itemize
-
\family sans
PS
\family default
\begin_layout Itemize
-
\family sans
CC
\family default
\begin_layout Itemize
-
\family sans
Encl
\family default
\end_layout
\begin_layout Standard
-
The types
\family sans
Name
status collapsed
\begin_layout Standard
-
It could be seen as a matter of inconsequence, that the types
\family sans
Letter
\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.
\end_layout
\begin_layout Standard
-
The input types can also be used as empty paragraphs.
This makes sense e.\InsetSpace ~
g.
\end_layout
\begin_layout Standard
-
By using the input types it is possible to write a letter template, containing
filled input types with your personal dates (name, address, etc.) and empty
input types for other dates you want to enter.
\begin_layout Itemize
-
\family sans
Name
\family default
\begin_layout Itemize
-
\family sans
Signature
\family default
\begin_layout Itemize
-
\family sans
Address
\family default
\begin_layout Itemize
-
\family sans
Telephone
\family default
\begin_layout Itemize
-
\family sans
Place
\family default
\begin_layout Itemize
-
\family sans
Date
\family default
\begin_layout Itemize
-
\family sans
Backaddress
\family default
\begin_layout Itemize
-
\family sans
Specialmail
\family default
\begin_layout Itemize
-
\family sans
Location
\family default
\begin_layout Itemize
-
\family sans
Title
\family default
\begin_layout Itemize
-
\family sans
Subject
\family default
\end_layout
\begin_layout Standard
-
The types
\family sans
Yourref
\begin_layout Itemize
-
\family sans
Yourref
\family default
\begin_layout Itemize
-
\family sans
Yourmail
\family default
\begin_layout Itemize
-
\family sans
Myref
\family default
\begin_layout Itemize
-
\family sans
Customer
\family default
\begin_layout Itemize
-
\family sans
Invoice
\family default
\end_layout
\begin_layout Subsection
-
The new letter class: letter (koma-script v.2)
\end_layout
\begin_layout Standard
-
by
\noun on
Jürgen Spitzmüller
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace medskip
\end_inset
\end_layout
\begin_layout Standard
-
This class covers the same functionality as
\emph on
letter (koma-script),
\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
status collapsed
\begin_layout Standard
-
The KOMA package comes with some default
\family typewriter
*.lco
\end_layout
\begin_layout Subsection
-
Problems
\end_layout
\begin_layout Standard
-
Visualizing the Koma-Script document classes in LyX, the LyX internals cause
some problems.
\end_layout
\begin_layout Itemize
-
The chapter number of a
\family sans
Chapter
\end_layout
\begin_layout Itemize
-
The headings of the types
\family sans
Addchap
\end_layout
\begin_layout Itemize
-
The paragraphs in a
\emph on
letter
\end_layout
\begin_layout Section
-
Springer Journals (
\family sans
svjour
\end_layout
\begin_layout Standard
-
by
\noun on
Martin Vermeer
\end_layout
\begin_layout Subsection
-
Description
\end_layout
\begin_layout Standard
-
These are the layout files for some of the journal formats used by Springer
Verlag and listed on
\begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
\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
\end_layout
\begin_layout Standard
-
It is reasonably well tested only for the Journal of Geodesy.
\family typewriter
\end_layout
\begin_layout Subsection
-
New styles
\end_layout
\begin_layout Standard
-
A large number of theorem-like styles ---
\family sans
Claim, Conjecture,
\begin_layout Standard
-
\family sans
Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
\end_layout
\begin_layout Subsection
-
Supported journals
\end_layout
\begin_layout Itemize
-
\emph on
Journal of Geodesy
\emph default
\begin_layout Itemize
-
\emph on
Probability Theory and Related Fields
\emph default
\end_layout
\begin_layout Standard
-
Add your own, it isn't so hard!
\end_layout
\begin_layout Subsection
-
Credits
\end_layout
\begin_layout Standard
-
These files are partly based on the older
\family typewriter
ejour2.layout
\end_layout
\begin_layout Subsection
-
Bugs
\end_layout
\begin_layout Standard
-
Probably.
But probably less than in the old hacked-LaTeX
\family typewriter
\end_layout
\begin_layout Standard
-
Limitations e.g.: does not display the number for theorem-like layouts, just
#.
\end_layout
\begin_layout Section
-
AGU journals (
\family sans
aguplus
\end_layout
\begin_layout Standard
-
by
\shape smallcaps
Martin Vermeer
\end_layout
\begin_layout Subsection
-
Description
\end_layout
\begin_layout Standard
-
These are the layout files for some of the journals of the American Geophysical
Society.
It is assumed that you have both the AGU's own class files and AGUplus
\end_layout
\begin_layout Subsection
-
New styles
\end_layout
\begin_layout Standard
-
Redefined are
\family sans
Paragraph
\end_layout
\begin_layout Standard
-
Newly defined styles are
\family sans
Left_Header
\end_layout
\begin_layout Standard
-
I suspect this is still badly incomplete.
\end_layout
\begin_layout Subsection
-
New floats
\end_layout
\begin_layout Standard
-
\family sans
Planotable
\family default
\end_layout
\begin_layout Subsection
-
Supported journals
\end_layout
\begin_layout Itemize
-
\emph on
Journal of Geophysical Research
\emph default
\end_layout
\begin_layout Standard
-
Add your own, it isn't so hard! Look at the
\family typewriter
jgrga.layout
\end_layout
\begin_layout Subsection
-
Bugs and things to remember
\end_layout
\begin_layout Standard
-
In order to use the new layouts, you must remember to do the following for
a new document:
\end_layout
\begin_layout Enumerate
-
\emph on
Turn off babel
\emph default
\end_layout
\begin_layout Enumerate
-
Enter
\family typewriter
jgrga
\end_layout
\begin_layout Enumerate
-
Make sure you use the
\family typewriter
agu.bst
\end_layout
\begin_layout Section
-
EGS journals (
\family sans
egs
\end_layout
\begin_layout Standard
-
by
\shape smallcaps
Martin Vermeer
\end_layout
\begin_layout Subsection
-
Description
\end_layout
\begin_layout Standard
-
This is the layout file for the European Geophysical Society journals.
The needed
\family typewriter
\end_layout
\begin_layout Subsection
-
New styles
\end_layout
\begin_layout Standard
-
\family sans
Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
Accepted
\end_layout
\begin_layout Section
-
Slides [aka
\noun on
Sli
\end_layout
\begin_layout Standard
-
by
\noun on
John Weiss
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
This section describes how to use LyX to make slides for overhead projectors.
There are two document classes that can do this: the default slides class
and the
\end_layout
\begin_layout Standard
-
I'm going to say this again, nice and clear, so that there's no misunderstanding
:
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-
-
\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
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_layout
\begin_layout Standard
-
This class is the LaTeX2e improvement of the old
\noun on
Sli
\end_layout
\begin_layout Subsection
-
Getting Started
\begin_inset LatexCommand \label{sec:slidesetup}
\end_layout
\begin_layout Standard
-
Obviously, to use this document class, you need to select
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
Don't bother changing the options
\family sans
Sides and Columns
\end_layout
\begin_layout Itemize
-
The option
\family sans
\bar under
\begin_deeper
\begin_layout Description
-
\family sans
plain
\family default
\begin_layout Description
-
\family sans
headings
\family default
\begin_layout Description
-
\family sans
empty
\family default
The final output contains no page numbers, time markers, or alignment markers.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
The
\family sans
slides
\begin_deeper
\begin_layout Standard
-
Using this options allows you to add time markers to
\family sans
Note
for more details.
\end_layout
+
\end_deeper
\begin_layout Standard
-
You can also use the template file
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsection
-
Paragraph Environments
\end_layout
\begin_layout Subsubsection
-
Supported Environments
\end_layout
\begin_layout Standard
-
The first thing you'll notice when you start up a new
\family sans
slides
\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.
\begin_layout Itemize
-
\family sans
Standard
\end_layout
\begin_layout Itemize
-
\family sans
Itemize
\end_layout
\begin_layout Itemize
-
\family sans
Enumerate
\end_layout
\begin_layout Itemize
-
\family sans
Description
\end_layout
\begin_layout Itemize
-
\family sans
List
\end_layout
\begin_layout Itemize
-
\family sans
Quotation
\end_layout
\begin_layout Itemize
-
\family sans
Quote
\end_layout
\begin_layout Itemize
-
\family sans
Verse
\end_layout
\begin_layout Itemize
-
\family sans
Caption
\end_layout
\begin_layout Itemize
-
\family sans
LyX-Code
\end_layout
\begin_layout Itemize
-
\family sans
Comment
\end_layout
\begin_layout Standard
-
All of the other standard environments, including the section-heading environmen
ts, aren't used in the
\family sans
\end_layout
\begin_layout Standard
-
On the other hand, you'll notice the following new environments:
\end_layout
\begin_layout Itemize
-
\family sans
Slide
\end_layout
\begin_layout Itemize
-
\family sans
Overlay
\end_layout
\begin_layout Itemize
-
\family sans
Note
\end_layout
\begin_layout Itemize
-
\family sans
InvisibleText
\end_layout
\begin_layout Itemize
-
\family sans
VisibleText
\end_layout
\begin_layout Standard
-
These five are kind of quirky, due to a
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsubsection
-
Quirks of the New Environments
\begin_inset LatexCommand \label{sec:slideQuirk}
\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
\end_layout
\begin_layout Standard
-
You should consider
\family sans
Slide
\end_layout
\begin_layout Standard
-
A common feature of all five environments,
\family sans
Slide
\end_layout
\begin_layout Standard
-
While you don't
\emph on
have
\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
\end_layout
\begin_layout Itemize
-
Start entering the text that will
\emph on
follow
\end_layout
\begin_layout Itemize
-
Now move to the beginning of that paragraph.
\end_layout
\begin_layout Itemize
-
Next, hit
\family sans
Return
\end_layout
\begin_layout Itemize
-
Finally, change this new, empty paragraph to a
\family sans
Slide
\end_layout
\begin_layout Standard
-
Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
\end_layout
\begin_layout Subsection
-
Making a Presentation with
\family sans
Slide
\end_layout
\begin_layout Subsubsection
-
Using the
\family sans
Slide
\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
\end_layout
\begin_layout Standard
-
Choosing the
\family sans
Slide
\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
\end_layout
\begin_layout Standard
-
The
\family sans
Overlay
\end_layout
\begin_layout Standard
-
As with a
\family sans
Slide
\end_layout
\begin_layout Subsubsection
-
Using
\family sans
Overlay
\end_layout
\begin_layout Standard
-
The idea behind an
\family sans
Overlay
\end_layout
\begin_layout Standard
-
Each
\family sans
Overlay
status collapsed
\begin_layout Standard
-
Presumably, mutliple
\family sans
Overlay
\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
\end_layout
\begin_layout Standard
-
As their names imply,
\family sans
InvisibleText
\end_layout
\begin_layout Standard
-
For
\family sans
VisibleText
\end_layout
\begin_layout Standard
-
By now, it should be obvious how to create overlay transparencies using
the proper combination of
\family sans
\end_layout
\begin_layout Enumerate
-
Create a
\family sans
Slide
\end_layout
\begin_layout Enumerate
-
Before each figure or paragraph that will appear only on the
\family sans
Overlay
\end_layout
\begin_layout Enumerate
-
Start an
\family sans
Overlay
\end_layout
\begin_layout Enumerate
-
Copy the contents of this
\family sans
Slide
\end_layout
\begin_layout Enumerate
-
Within the
\family sans
Overlay
\end_layout
\begin_layout Standard
-
That's it.
You've just made an
\family sans
\end_layout
\begin_layout Standard
-
There's one problem with the way I've designed the LyX
\family sans
slides
status collapsed
\begin_layout Standard
-
The commands of interest are:
\end_layout
\begin_layout Itemize
-
\family typewriter
{
\backslash
\begin_layout Itemize
-
\family typewriter
{
\backslash
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
and need to be marked as TeX.
The text whose
\end_layout
\begin_layout Subsubsection
-
Using
\family sans
Note
\end_layout
\begin_layout Standard
-
Like an
\family sans
Overlay
\end_layout
\begin_layout Standard
-
The purpose of a
\family sans
Note
\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_layout
\begin_layout Standard
-
There's one last feature to describe.
Clearly, you'd like to print out all of your
\family sans
\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.
\end_layout
\begin_layout Standard
-
You can also provide other arguments to the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsection
-
The
\family sans
slides
\end_layout
\begin_layout Standard
-
I have also provided a template file,
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout LyX-Code
-
% Uncomment to print out only slides and overlays
\end_layout
\begin_layout LyX-Code
-
%
\end_layout
\begin_layout LyX-Code
-
%
\backslash
onlyslides{
\end_layout
\begin_layout LyX-Code
-
% Uncomment to print out only notes
\end_layout
\begin_layout LyX-Code
-
%
\end_layout
\begin_layout LyX-Code
-
%
\backslash
onlynotes{
\end_layout
\begin_layout Standard
-
One final thing: I created this class to support the LaTeX2e
\begin_inset Quotes eld
\end_inset
status collapsed
\begin_layout Standard
-
Perhaps you can take on the task\SpecialChar \ldots{}
\end_layout
\end_layout
\begin_layout Section
-
Foils [aka
\family sans
Foil
\end_layout
\begin_layout Standard
-
by
\noun on
Allan Rae
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
This section describes how to use LyX to make slides for overhead projectors.
There are two document classes that can do this: the default slides class
and the
\end_layout
\begin_layout Standard
-
I'm going to say this again, nice and clear, so that there's no misunderstanding
:
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-
-
\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_layout
\begin_layout Standard
-
The
\family sans
foils
\end_layout
\begin_layout Subsection
-
Getting Started
\end_layout
\begin_layout Standard
-
Obviously, to use this document class, you need to select
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
Don't change the options
\family sans
Sides
\end_layout
\begin_layout Itemize
-
The default font size is 20pt with the other options being 17pt, 25pt and
30pt.
\end_layout
\begin_layout Itemize
-
The default font is
\family sans
sans
\begin_layout Itemize
-
\family sans
Foil
\family default
\end_layout
\begin_layout Itemize
-
Don't bother changing the
\family sans
Float Placement
\end_layout
\begin_layout Itemize
-
The
\family sans
\bar under
\begin_layout List
\labelwidthstring MMMMMMM
-
\family sans
\series bold
empty
\begin_layout List
\labelwidthstring MMMMMMM
-
\family sans
\series bold
plain
\begin_layout List
\labelwidthstring MMMMMMM
-
\series bold
foilheadings
\series default
\begin_layout List
\labelwidthstring MMMMMMM
-
\series bold
fancy
\series default
\family default
TeX package because of some potential page layout clashes.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
Extra Options
\end_layout
\begin_layout Standard
-
The following options may be used in the extra class options in the
\family sans
\bar under
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
35mmSlide
\series default
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
headrule
\series default
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
footrule
\series default
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
dvips
\series default
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
landscape
\series default
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
leqno
\series default
\begin_layout List
\labelwidthstring MMMMMMx
-
\series bold
fleqn
\series default
\end_layout
\begin_layout Subsection
-
Supported Environments
\end_layout
\begin_layout Standard
-
Most of the environments commonly supported in other classes are also supported
by the
\family sans
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Itemize
-
\family sans
Standard
\end_layout
\begin_layout Itemize
-
\family sans
Itemize
\end_layout
\begin_layout Itemize
-
\family sans
Enumerate
\end_layout
\begin_layout Itemize
-
\family sans
Description
\end_layout
\begin_layout Itemize
-
\family sans
List
\end_layout
\begin_layout Itemize
-
\family sans
LyX-Code
\end_layout
\begin_layout Itemize
-
\family sans
Verse
\end_layout
\begin_layout Itemize
-
\family sans
Quote
\end_layout
\begin_layout Itemize
-
\family sans
Quotation
\end_layout
\begin_layout Itemize
-
\family sans
Title
\end_layout
\begin_layout Itemize
-
\family sans
Author
\end_layout
\begin_layout Itemize
-
\family sans
Date
\end_layout
\begin_layout Itemize
-
\family sans
Abstract
\end_layout
\begin_layout Itemize
-
\family sans
Bibliography
\end_layout
\begin_layout Itemize
-
\family sans
Address
\end_layout
\begin_layout Itemize
-
\family sans
RightAddress
\end_layout
\begin_layout Itemize
-
\family sans
Caption
\end_layout
\begin_layout Itemize
-
\family sans
Comment
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
That is, all the major environments apart from the sectioning environments.
Since foils are essentially self-contained sections, with a title and body,
\begin_layout Itemize
-
\family sans
Foilhead
\end_layout
\begin_layout Itemize
-
\family sans
Rotatefoilhead
\end_layout
\begin_layout Standard
-
LyX also provides slightly modified versions of these two environments called:
\end_layout
\begin_layout Itemize
-
\family sans
ShortFoilhead
\end_layout
\begin_layout Itemize
-
\family sans
ShortRotatefoilhead
\end_layout
\begin_layout Standard
-
and the differences will be explained in the next section.
\end_layout
\begin_layout Standard
-
Since foils are often used in presenting ideas or new theorems and such
\family sans
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Itemize
-
\family sans
Theorem
\end_layout
\begin_layout Itemize
-
\family sans
Lemma
\end_layout
\begin_layout Itemize
-
\family sans
Corollary
\end_layout
\begin_layout Itemize
-
\family sans
Proposition
\end_layout
\begin_layout Itemize
-
\family sans
Definition
\end_layout
\begin_layout Itemize
-
\family sans
Proof
\end_layout
\begin_layout Itemize
-
\family sans
Theorem*
\end_layout
\begin_layout Itemize
-
\family sans
Lemma*
\end_layout
\begin_layout Itemize
-
\family sans
Corollary*
\end_layout
\begin_layout Itemize
-
\family sans
Proposition*
\end_layout
\begin_layout Itemize
-
\family sans
Definition*
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
The starred versions are unnumbered while the unstarred versions are numbered.
There are also two list environments added by LyX and these are:
\end_layout
\begin_layout Itemize
-
\family sans
TickList
\end_layout
\begin_layout Itemize
-
\family sans
CrossList
\end_layout
\begin_layout Standard
-
\family sans
Foil
\family default
\end_layout
\begin_layout Standard
-
For this purpose, the following command styles are provided [
\shape smallcaps
Martin Vermeer
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Itemize
-
\family sans
My\InsetSpace ~
Logo
\begin_layout Itemize
-
\family sans
Restriction
\end_layout
\begin_layout Itemize
-
\family sans
Right\InsetSpace ~
Footer
\begin_layout Itemize
-
\family sans
Right\InsetSpace ~
Header
\begin_layout Itemize
-
\family sans
Left\InsetSpace ~
Header
\begin_deeper
\begin_layout Standard
-
\InsetSpace ~
\end_layout
+
\end_deeper
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
There are also a few commands provided by
\family sans
Foil
\end_layout
\begin_layout Subsection
-
Building a Set of Foils
\end_layout
\begin_layout Standard
-
This section will give a simple introduction to using the different environments
to build a set of foils.
If you want to see an example set of foils take a look at the
\end_layout
\begin_layout Subsubsection
-
Give It a Title Page
\end_layout
\begin_layout Standard
-
Unlike other classes that provide
\family sans
Title
\end_layout
\begin_layout Subsubsection
-
Start a New Foil
\end_layout
\begin_layout Standard
-
As I mentioned earlier, there are four ways of starting a new foil.
For portrait foils you should use
\family sans
\end_layout
\begin_layout Standard
-
Landscape foils are generated using the
\family sans
Rotatefoilhead
\end_layout
\begin_layout Standard
-
One problem with the support for landscape foils is the requirement that
you have to use the
\family typewriter
\end_layout
\begin_layout Subsubsection
-
Theorems, Lemmas, Proofs and more
\end_layout
\begin_layout Standard
-
Due to a small bug in LyX you can't have two of the same type of these environme
nts directly following each other.
They must be separated by something.
\end_layout
\begin_layout Subsubsection
-
Lists
\end_layout
\begin_layout Standard
-
You get all the commonly supported list styles found in other classes as
well as two new ones.
I'll only describe the new ones here.
\end_layout
\begin_layout Standard
-
The two new list styles,
\family sans
TickList
\end_layout
\begin_layout Subsubsection
-
Figures and Tables
\end_layout
\begin_layout Standard
-
\family sans
Foil
\family default
\end_layout
\begin_layout Subsubsection
-
Page Headers and Footers
\begin_inset LatexCommand \label{sec:foilfoot}
\begin_layout Standard
-
\family sans
My\InsetSpace ~
Logo
\end_layout
\begin_layout Standard
-
The remaining page corners can be filled by
\family sans
Right\InsetSpace ~
\end_layout
\begin_layout Subsection
-
Unsupported
\family sans
Foil
\end_layout
\begin_layout Standard
-
All the commands mentioned below need to be set in a
\family sans
LaTeX
\end_layout
\begin_layout Subsubsection
-
Lengths
\end_layout
\begin_layout Standard
-
All lengths are adjusted using the
\family typewriter
\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
\end_layout
\begin_layout Standard
-
The spacings around floats can be adjusted by setting these lengths:
\end_layout
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
There are also several title page related lengths that you may find useful
if you have a long title or several authors:
\end_layout
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\begin_layout List
\labelwidthstring MMMMMMMMMMM
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
The last length related command affects all the list environments.
If you place
\family typewriter
\end_layout
\begin_layout Subsubsection
-
Headers and Footers
\end_layout
\begin_layout Standard
-
The
\family typewriter
\end_layout
\begin_layout Standard
-
If you decide to use the
\family sans
fancy
\end_layout
\begin_layout Section
-
Latex8 (IEEE Conference Papers)
\end_layout
\begin_layout Standard
-
by
\noun on
Allan Rae
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
Since this class is specifically for writing submissions to IEEE sponsored
conferences I strongly recommend that you get a copy of their Authors Kit.
The
\end_layout
\begin_layout Subsection
-
Getting Started
\end_layout
\begin_layout Standard
-
[AR\SpecialChar \@.
more to come]
\end_layout
\begin_layout Subsection
-
Supported Environments
\end_layout
\begin_layout Itemize
-
\family sans
Standard
\end_layout
\begin_layout Itemize
-
\family sans
Title
\end_layout
\begin_layout Itemize
-
\family sans
Author
\end_layout
\begin_layout Itemize
-
\family sans
E-mail
\end_layout
\begin_layout Itemize
-
\family sans
Affiliation
\end_layout
\begin_layout Itemize
-
\family sans
Abstract
\end_layout
\begin_layout Itemize
-
\family sans
Section
\end_layout
\begin_layout Itemize
-
\family sans
SubSection
\end_layout
\begin_layout Itemize
-
\family sans
Caption
\end_layout
\begin_layout Subsection
-
Differences Between Screen and Paper
\end_layout
\begin_layout Standard
-
There are slight differences in appearance mainly with the presentation
of section counters.
On screen the trailing period of the section counter is missing but it
\end_layout
\begin_layout Section
-
Hollywood (Hollywood spec scripts)
\end_layout
\begin_layout Standard
-
by
\shape smallcaps
Garst Reese
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
Getting the format of a Hollywood script right is a
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsection
-
Special problems
\end_layout
\begin_layout Standard
-
Speakers' lines should NEVER break in mid-sentence.
If a speaker's lines continue over a page break, repeat the
\family sans
\end_layout
\begin_layout Subsection
-
Special features
\end_layout
\begin_layout Standard
-
Insert the
\family sans
Speaker
\end_layout
\begin_layout Subsection
-
Paper size and Margins
\end_layout
\begin_layout Standard
-
USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
\end_layout
\begin_layout Subsection
-
Environments
\end_layout
\begin_layout Standard
-
The following environments are available.
You can use hollywood.bind to get the bind keys shown at the right.
\end_layout
\begin_layout Itemize
-
\family sans
Standard
\newline
\begin_layout Itemize
-
\family sans
FADE_IN
\family default
\begin_layout Itemize
-
\family sans
INT:
\hfill
\begin_layout Itemize
-
\family sans
EXT:
\hfill
\begin_layout Itemize
-
\family sans
Speaker
\hfill
\begin_layout Itemize
-
\family sans
Parenthetical
\hfill
\begin_layout Itemize
-
\family sans
Dialogue
\hfill
\begin_layout Itemize
-
\family sans
Transition
\hfill
\begin_layout Itemize
-
\family sans
FADE OUT:
\hfill
\begin_layout Itemize
-
\family sans
Author
\hfill
\begin_layout Itemize
-
\family sans
Title
\hfill
\begin_layout Itemize
-
\family sans
Right_Address
\hfill
\end_layout
\begin_layout Subsection
-
Script jargon
\end_layout
\begin_layout Itemize
-
(O.S) --- off screen
\end_layout
\begin_layout Itemize
-
(V.0) --- voice over
\end_layout
\begin_layout Itemize
-
b.g.
--- background
\end_layout
\begin_layout Itemize
-
C.U.
--- close-up
\end_layout
\begin_layout Itemize
-
PAN --- camera movement
\end_layout
\begin_layout Itemize
-
INSERT --- cut to close-up of
\end_layout
\begin_layout Section
-
Broadway
\end_layout
\begin_layout Standard
-
by
\shape smallcaps
Garst Reese
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
Broadway is for writing plays.
The format is more decorative than Hollywood, and much less standardized.
This format should be suitable for workshops.
\end_layout
\begin_layout Subsection
-
Special problems
\end_layout
\begin_layout Standard
-
The same as in Hollywood.
\end_layout
\begin_layout Subsection
-
Special features
\end_layout
\begin_layout Standard
-
Insert the
\family sans
Speaker
\end_layout
\begin_layout Subsection
-
Paper size and Margins
\end_layout
\begin_layout Standard
-
USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
\end_layout
\begin_layout Subsection
-
Environments
\end_layout
\begin_layout Standard
-
The following environments are available.
You can use broadway.bind to get the bind keys shown at the right.
\end_layout
\begin_layout Itemize
-
\family sans
Standard
\newline
\begin_layout Itemize
-
\family sans
Narrative
\hfill
\begin_layout Itemize
-
\family sans
ACT
\hfill
\begin_layout Itemize
-
\family sans
ACT*
\hfill
\begin_layout Itemize
-
\family sans
SCENE
\hfill
\begin_layout Itemize
-
\family sans
AT_RISE:
\hfill
\begin_layout Itemize
-
\family sans
Speaker
\hfill
\begin_layout Itemize
-
\family sans
Parenthetical
\hfill
\begin_layout Itemize
-
\family sans
Dialogue
\hfill
\begin_layout Itemize
-
\family sans
CURTAIN
\hfill
\begin_layout Itemize
-
\family sans
Title
\hfill
\begin_layout Itemize
-
\family sans
Author
\hfill
\begin_layout Itemize
-
\family sans
Right_Address
\hfill
\end_layout
\begin_layout Standard
-
Hello there.
\end_layout
\begin_layout Section
-
RevTeX4
\end_layout
\begin_layout Standard
-
by
\noun on
Amir Karger
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-
LyX has a
\family sans
Revtex
\end_layout
\begin_layout Standard
-
These documents are supposed to be used in
\emph on
addition
\end_layout
\begin_layout Subsection
-
Installation
\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
\end_layout
\begin_layout Standard
-
Probably the easiest way to get started is either to import a RevTeX 4 document
using
\family typewriter
\end_layout
\begin_layout Subsection
-
Preamble Matter
\end_layout
\begin_layout Standard
-
Optional arguments to
\family typewriter
\end_layout
\begin_layout Standard
-
Other preamble matter, like
\family typewriter
\end_layout
\begin_layout Subsection
-
Layouts
\end_layout
\begin_layout Standard
-
The layouts basically correspond to the commands in RevTeX4.0.
For example, the Email layout corresponds to
\family typewriter
status collapsed
\begin_layout Standard
-
In case you're curious, both were included so that
\family typewriter
reLyX
\end_layout
\begin_layout Subsection
-
Important Notes
\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.
\end_layout
\begin_layout Standard
-
In RevTeX, the
\family typewriter
\end_layout
\begin_layout Standard
-
Also, the
\family sans
Author\InsetSpace ~
\end_layout
\begin_layout Subsection
-
Drawbacks
\end_layout
\begin_layout Standard
-
The main problem with this layout is that you can't use the optional arguments
to layouts like Email and Title.
(The problem is not unique to this layout; you can't use optional arguments
\begin_layout Standard
-
\emph on
Note from JMarc:
\emph default
\end_layout
\begin_layout Section
-
Article (mwart), book (mwbk) and report (mwrep)
\begin_inset OptArg
status collapsed
\begin_layout Standard
-
The
\family typewriter
mw
\end_layout
\begin_layout Standard
-
by
\noun on
Tomasz Luczak
\end_layout
\begin_layout Standard
-
The LyX document classes
\emph on
article (mwart)
\end_layout
\begin_layout Standard
-
Basic differences:
\end_layout
\begin_layout Itemize
-
Unnumbered titles (with star, eg.
\family sans
\end_layout
\begin_layout Itemize
-
Additional page styles:
\end_layout
\begin_deeper
\begin_layout Description
-
uheadings header with separated lines,
\end_layout
\begin_layout Description
-
myheadings custom header, contents headers via commands:
\family typewriter
\end_layout
\begin_layout Description
-
myuheadings custom header with separated lines,
\end_layout
\begin_layout Description
-
outer page number is placed on outer side of page
\end_layout
+
\end_deeper
\begin_layout Itemize
-
Options
\end_layout
\begin_deeper
\begin_layout Description
-
rmheadings serif titles --- default,
\end_layout
\begin_layout Description
-
sfheadings sansserif titles,
\end_layout
\begin_layout Description
-
authortitle on title page first placed is author next title --- default,
\end_layout
\begin_layout Description
-
titleauthor on title page first placed is title next author,
\end_layout
\begin_layout Description
-
withmarginpar reserve place on page for margins.
\end_layout
+
\end_deeper
\begin_layout Section
-
Elsevier Journals
\end_layout
\begin_layout Standard
-
By
\noun on
Rod Pinna
\end_layout
\begin_layout Standard
-
Elsevier Science Publishers B.V.
provides a standard LaTeX document class (
\family typewriter
\end_layout
\begin_layout Standard
-
To make use of
\family typewriter
elsart.cls
\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,
\end_layout
\begin_layout Section
-
Memoir
\end_layout
\begin_layout Standard
-
By
\noun on
Jürgen Spitzmüller
\end_layout
\begin_layout Subsection
-
Overview
\end_layout
\begin_layout Standard
-
Memoir is a very powerful and constantly evolving class.
It has been designed with regard to fictional and non-fictional literature.
Its aim is to let the user have maximum control over the typesetting of
\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.
status collapsed
\begin_layout Standard
-
You are invited to send suggestions to
\begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
status collapsed
\begin_layout Standard
-
Cf.
\begin_inset ERT
status collapsed
status collapsed
\begin_layout Standard
-
Cf.
\begin_inset ERT
status collapsed
\end_layout
\begin_layout Subsection
-
Basic features and restrictions
\end_layout
\begin_layout Standard
-
Memoir supports basically all features of the standard book classes.
There are, however, some differences, as follows:
\end_layout
\begin_layout Description
-
Font\InsetSpace ~
sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
17
\end_layout
\begin_layout Description
-
Page\InsetSpace ~
style: The fancy page style is not supported, due to a command clash
between Memoir and the fancyhdr package (they are both defining a command
\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
\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.
\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_layout
\begin_layout Description
-
Article: With the class option
\emph on
article
\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
\end_layout
\begin_layout Subsection
-
Extra features
\end_layout
\begin_layout Standard
-
We will only describe the features supported by LyX (which is not much currently
).
Please consult the Memoir manual
status collapsed
\begin_layout Standard
-
Cf.
\begin_inset ERT
status collapsed
\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.
\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.
\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.
\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.
\end_layout
\begin_layout Description
-
Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
\end_layout
\begin_layout Chapter
-
Importing and Exporting Alternate File Formats
\begin_inset OptArg
status collapsed
\begin_layout Standard
-
Importing and Exporting
\end_layout
\end_layout
\begin_layout Section
-
Considerations
\end_layout
\begin_layout Standard
-
Importing and exporting LyX documents from/to other formats has been touched
on briefly in the
\emph on
\end_layout
\begin_layout Section
-
Importing Other Formats
\end_layout
\begin_layout Subsection
-
LaTeX
\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.
\end_layout
\begin_layout Subsection
-
ASCII Text
\end_layout
\begin_layout Standard
-
When importing plain ASCII text, there are two methods of reading the file.
Importing
\begin_inset Quotes eld
\end_layout
\begin_layout Subsection
-
Noweb
\end_layout
\begin_layout Standard
-
\emph on
[Editor's note: Needs to be written, obviously - any volunteers? --- mer]
\end_layout
\begin_layout Section
-
Exporting Other Formats
\end_layout
\begin_layout Subsection
-
LaTeX
\end_layout
\begin_layout Standard
-
LyX generates two types of LaTeX files: stripped down versions for the normal
processing (
\family sans
status collapsed
\begin_layout Standard
-
The resulting file is a perfectly valid LaTeX file, though the preamble
might look a bit strange since it includes some definitions used by LyX
which wouldn't show up in most human-written files.
\end_layout
\begin_layout Subsection
-
Device Independent Files
\end_layout
\begin_layout Standard
-
Device Independent files (DVI files) are produced by running LaTeX on your
document.
There are no user settable options.
\end_layout
\begin_layout Subsection
-
PostScript®
\end_layout
\begin_layout Standard
-
The next step in the conversion chain is converting a DVI file into Postscript®.
You can either use
\family sans
\end_layout
\begin_layout Subsection
-
ASCII text
\end_layout
\begin_layout Standard
-
Exporting as ASCII attempts to preserve the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsection
-
HTML
\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
\end_layout
\begin_layout Subsection
-
PDF
\end_layout
\begin_layout Standard
-
by
\noun on
Dekel Tsur
\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
\end_layout
\begin_layout Subsubsection
-
Use pdfLaTeX
\end_layout
\begin_layout Standard
-
With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
\begin_inset LatexCommand \ref{sec:pdfeps}
\end_layout
\begin_layout Subsubsection
-
Why does the text look so bad when viewed with Acrobat Reader?
\begin_inset LatexCommand \label{sec:badfonts}
status collapsed
\begin_layout Standard
-
Bad Fonts in Acrobat Reader
\end_layout
\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
\end_layout
\begin_layout LyX-Code
-
p+ psfonts.cmz
\end_layout
\begin_layout LyX-Code
-
p+ psfonts.amz
\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
\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
\end_layout
\begin_layout Standard
-
An alternate option is to use the standard Postscript® fonts instead of
the Computer Modern fonts.
To do that, you need to select
\end_layout
\begin_layout Standard
-
To sum up, both the Computer Modern and the Postscript® fonts gives good
results (with few exceptions).
The decision of which one to use is a matter of taste.
\end_layout
\begin_layout Subsubsection
-
Why doesn't the
\backslash
boldsymbol{} command work when I use pslatex?
\begin_layout Standard
-
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-
The Postscript® fonts do not have a bold symbol font.
The solution is to use the
\family typewriter
\end_layout
\begin_layout Standard
-
It is possible to redefine the
\family typewriter
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\end_layout
\begin_layout Standard
-
in the preamble.
\end_layout
\begin_layout Subsubsection
-
Is it possible to do write latex code which is processed only when running
pdfLaTeX?
\begin_inset OptArg
status collapsed
\begin_layout Standard
-
Conditionals with pdfLaTeX
\end_layout
\end_layout
\begin_layout Standard
-
Yes.
Here is an example:
\end_layout
\begin_layout LyX-Code
-
\backslash
newif
\backslash
\end_layout
\begin_layout LyX-Code
-
\backslash
ifx
\end_layout
\begin_layout LyX-Code
-
\backslash
pdffalse
\end_layout
\begin_layout LyX-Code
-
\backslash
else
\end_layout
\begin_layout LyX-Code
-
\backslash
pdftrue
\begin_layout LyX-Code
-
\backslash
fi
\end_layout
\begin_layout LyX-Code
-
\backslash
ifpdf
\end_layout
\begin_layout LyX-Code
-
\backslash
pdfinfo { /Author (your name and e-mail address)
\end_layout
\begin_layout LyX-Code
-
/Title (official title -- i.e., title element)
\end_layout
\begin_layout LyX-Code
-
/Subject (one line description of the document)
\end_layout
\begin_layout LyX-Code
-
}
\end_layout
\begin_layout LyX-Code
-
\backslash
pdfcatalog { /PageMode (/UseNone)
\end_layout
\begin_layout LyX-Code
-
% /OpenAction (fitbh)
\end_layout
\begin_layout LyX-Code
-
}
\end_layout
\begin_layout LyX-Code
-
\backslash
usepackage[pdftex]{hyperref}
\begin_layout LyX-Code
-
\backslash
else
\end_layout
\begin_layout LyX-Code
-
\backslash
usepackage[ps2pdf]{hyperref}
\begin_layout LyX-Code
-
\backslash
fi
\end_layout
\begin_layout Subsubsection
-
How can I make URLs clickable ?
\end_layout
\begin_layout Standard
-
See the references here :
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
\end_inset
\end_layout
\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
\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
\end_layout
\begin_layout Standard
-
While it is not possible to save this command using the
\family sans
Preferences
\begin_layout LyX-Code
-
\backslash
custom_export_command "mycommand $$FName"
\end_layout
\begin_layout Section
-
The Complete reLyX Description
\begin_inset LatexCommand \label{sec:reLyX}
\end_layout
\begin_layout Subsection
-
Synopsis
\end_layout
\begin_layout Standard
-
The simplest way to use reLyX is via the
\family sans
\bar under
\begin_layout Standard
-
\series bold
reLyX
\series default
\begin_layout Standard
-
\series bold
reLyX
\series default
\begin_layout Standard
-
\series bold
reLyX
\series default
\end_layout
\begin_layout Subsection
-
Options
\end_layout
\begin_layout Description
-
\series bold
-c
\series default
\begin_layout Description
-
\series bold
-d
\series default
\begin_layout Description
-
\series bold
-f
\series default
\begin_layout Description
-
\series bold
-h
\series default
\begin_layout Description
-
\series bold
-o
\series default
\begin_layout Description
-
\series bold
-p
\series default
\begin_layout Description
-
\series bold
-r
\series default
\begin_layout Description
-
\series bold
-s
\series default
\end_layout
\begin_layout Subsection
-
Description
\end_layout
\begin_layout Subsubsection
-
Introduction
\end_layout
\begin_layout Standard
-
reLyX will create a LyX file
\emph on
dir/foo.lyx
\end_layout
\begin_layout Standard
-
Suffixes
\family typewriter
.tex
\end_layout
\begin_layout Standard
-
The purpose of reLyX is to translate
\shape italic
well-behaved
\end_layout
\begin_layout Standard
-
reLyX has some bugs and lacks a few features.
However, its main goals are:
\end_layout
\begin_layout Itemize
-
Get through a well-behaved LaTeX2e file without crashing
\end_layout
\begin_layout Itemize
-
Translate a lot of that file.
\end_layout
\begin_layout Itemize
-
Localize the parts that can't be translated and copy them in TeX mode
\end_layout
\begin_layout Standard
-
It achieves these main goals pretty well on most files.
\end_layout
\begin_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.
\end_layout
\begin_layout Subsubsection
-
Usage
\end_layout
\begin_layout Standard
-
Here's a more lengthy description of what you should do to translate a LaTeX
document into LyX.
\end_layout
\begin_layout Itemize
-
Run reLyX.
\end_layout
\begin_deeper
\begin_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_layout
+
\end_deeper
\begin_layout Itemize
-
Run LyX on the resulting .lyx file.
\end_layout
\begin_deeper
\begin_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
\family default
file.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
Change things that are in ERT boxes (TeX code) by hand in LyX.
\end_layout
\begin_deeper
\begin_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
\end_layout
\begin_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
and less WYSIWYM.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
PROOFREAD THE DOCUMENT!!
\end_layout
\begin_deeper
\begin_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
For example, you may see extra spaces or deleted spaces.
Space handling has improved, but it's not perfect.
\end_layout
+
\end_deeper
\begin_layout Subsubsection
-
What reLyX Can Handle
\end_layout
\begin_layout Standard
-
reLyX understands many LaTeX commands.
It will translate:
\end_layout
\begin_layout Itemize
-
regular text, including mini-commands like ~, '',
\family typewriter
\end_layout
\begin_layout Itemize
-
title commands like
\family typewriter
\end_layout
\begin_layout Itemize
-
heading commands like
\family typewriter
\end_layout
\begin_layout Itemize
-
Environments:
\family typewriter
quote
\begin_layout Itemize
-
\family typewriter
itemize
\family default
\end_layout
\begin_layout Itemize
-
cross-referencing commands:
\family typewriter
\begin_layout Itemize
-
\family typewriter
\backslash
\end_layout
\begin_layout Itemize
-
font-changing commands including
\family typewriter
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
tabular
\family default
\end_layout
\begin_layout Itemize
-
float environments
\family typewriter
table
\begin_layout Itemize
-
\family typewriter
thebibliography
\family default
\end_layout
\begin_layout Itemize
-
miscellaneous commands:
\family typewriter
\end_layout
\begin_layout Itemize
-
documentclass-specific environments (and some commands) which can be translated
to LyX layouts
\end_layout
\begin_layout Itemize
-
arguments to certain untranslatable commands (e.g.
\family typewriter
\end_layout
\begin_layout Standard
-
Some of this support may not be 100% yet.
See below for details
\end_layout
\begin_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.
\end_layout
\begin_layout Standard
-
reLyX will also copy any preamble commands (i.e., anything before
\family typewriter
\end_layout
\begin_layout Subsubsection
-
What reLyX Can't Handle --- But it's OK
\end_layout
\begin_layout Itemize
-
figures and
\family typewriter
tabular*
\end_layout
\begin_layout Itemize
-
minipages
\end_layout
\begin_layout Itemize
-
spacing commands (
\family typewriter
\begin_layout Itemize
-
\family typewriter
\backslash
\begin_layout Itemize
-
\family typewriter
\backslash
\end_layout
\begin_layout Itemize
-
some unknown (e.g., user-defined) environments and commands
\end_layout
\begin_layout Standard
-
reLyX copies unknown commands, along with their arguments, verbatim into
the LyX file.
Also, if it sees a
\end_layout
\begin_layout Subsubsection
-
What reLyX Handles Badly --- a.\InsetSpace ~
k.\InsetSpace ~
a.
\end_layout
\begin_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
\end_layout
\begin_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
\end_layout
\begin_layout Itemize
-
-
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Itemize
-
reLyX translates only a few options to the
\family typewriter
\begin_deeper
\begin_layout Standard
-
More importantly, reLyX doesn't translate
\family typewriter
\family default
, etc.
\end_layout
+
\end_deeper
\begin_layout Itemize
-
The foil class has a couple bugs.
reLyX may do weird things with optional arguments to
\family typewriter
\end_layout
\begin_layout Standard
-
reLyX is hopefully rather robust.
As mentioned above, it may not translate your file perfectly, but it shouldn't
crash.
\end_layout
\begin_layout Subsubsection
-
What LyX Can't Handle
\end_layout
\begin_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
\end_layout
\begin_layout Itemize
-
For a number of commands, LyX does not support the optional argument.
Examples include
\family typewriter
\end_layout
\begin_layout Itemize
-
Centering (or right or left justifying) works on full paragraphs.
\end_layout
\begin_layout Itemize
-
LyX support for tables isn't perfect.
For complicated tables, use a
\begin_inset Quotes eld
\end_layout
\begin_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.
\end_layout
\begin_layout Subsection
-
Examples
\end_layout
\begin_layout Standard
-
\family typewriter
reLyX -df -o
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
When it finds a
\family typewriter
\end_layout
\begin_layout Subsection
-
Notes
\end_layout
\begin_layout Subsubsection
-
Bug Reports
\begin_inset LatexCommand \label{sub:relyx-bug-reports}
\end_layout
\begin_layout Standard
-
If reLyX is crashing or otherwise acting strangely---in ways other than
those described in Section\InsetSpace ~
\end_layout
\begin_layout Standard
-
Bug reports should be sent to the LyX developers' mailing list.
Its address is currently
\family typewriter
\end_layout
\begin_layout Subsubsection
-
Implementation Details:
\end_layout
\begin_layout Standard
-
reLyX makes several
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Description
-
Pass\InsetSpace ~
0 \InsetSpace ~
\end_layout
\begin_layout Description
-
Pass\InsetSpace ~
1a \InsetSpace ~
\end_layout
\begin_layout Description
-
Pass\InsetSpace ~
1b \InsetSpace ~
\begin_deeper
\begin_layout Standard
-
Once you know what class the document is, read the LyX layout file for that
class.
\end_layout
+
\end_deeper
\begin_layout Description
-
Pass\InsetSpace ~
2 \InsetSpace ~
\begin_deeper
\begin_layout Itemize
-
Change, e.g.,
\family typewriter
x^2
\end_layout
\begin_layout Itemize
-
Removing optional arguments that LyX can't handle (e.g., from
\family typewriter
\end_layout
\begin_layout Itemize
-
Changing
\family typewriter
{
This is necessary because LyX always writes out the non-local forms anyway.
This should very rarely make a difference.
\end_layout
+
\end_deeper
\begin_layout Description
-
Pass\InsetSpace ~
3 \InsetSpace ~
\end_layout
\begin_layout Description
-
Pass\InsetSpace ~
4 \InsetSpace ~
\end_layout
\begin_layout Standard
-
If there are any
\family typewriter
\end_layout
\begin_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.
\end_layout
\begin_layout Subsubsection
-
Layout Files
\end_layout
\begin_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
\end_layout
\begin_layout Subsubsection
-
Syntax Files
\begin_inset LatexCommand \label{sub:relyx-syntax}
\end_layout
\begin_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.
\end_layout
\begin_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
\end_layout
\begin_layout Standard
-
Some commands that cannot be translated to LyX, like
\family typewriter
\end_layout
\begin_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.
\end_layout
\begin_layout Standard
-
Second, the syntax file describes any
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
Third, the syntax file describes a math translation table.
The LyX math editor doesn't support a few commands.
For example,
\end_layout
\begin_layout Subsubsection
-
Miscellaneous
\end_layout
\begin_layout Standard
-
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/}
\end_layout
\begin_layout Subsection
-
Diagnostics
\end_layout
\begin_layout Standard
-
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.
\end_layout
\begin_layout Standard
-
When it's finished, reLyX will tell you if it finished successfully or died
due to some error.
\end_layout
\begin_layout Subsection
-
Warnings
\end_layout
\begin_layout Standard
-
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
\end_layout
\begin_layout Standard
-
If you import
\family typewriter
foo.tex
\end_layout
\begin_layout Standard
-
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)
\end_layout
\begin_layout Subsection
-
Files
\end_layout
\begin_layout Description
-
\family typewriter
\series medium
MY_LYXDIR/layouts/*.layout
\begin_layout Description
-
\family typewriter
\series medium
MY_LYXDIR/reLyX/syntax.default
\begin_layout Description
-
\family typewriter
\series medium
LIBDIR/layouts/*.layout
\begin_layout Description
-
\family typewriter
\series medium
LIBDIR/reLyX/syntax.default
\begin_layout Standard
-
\family typewriter
LIBDIR
\family default
\end_layout
\begin_layout Subsection
-
See also
\end_layout
\begin_layout Standard
-
\shape italic
lyx
\shape default
\end_layout
\begin_layout Subsection
-
Authors
\end_layout
\begin_layout Standard
-
Copyright (c) 1998--9
\noun on
Amir Karger
\end_layout
\begin_layout Standard
-
Code contributors:
\end_layout
\begin_layout Itemize
-
\noun on
John Weiss
\noun default
\begin_layout Itemize
-
\noun on
Etienne Grossmann
\end_layout
\begin_layout Itemize
-
\noun on
Jos\i \'{e}
Ab\i \'{\i}
\begin_layout Itemize
-
\noun on
David Suarez de Lis
\end_layout
\begin_layout Standard
-
Other contributors:
\end_layout
\begin_layout Itemize
-
\noun on
Jean-Marc Lasgouttes
\noun default
\begin_layout Itemize
-
\noun on
Asger K.
Alstrup Nielsen
\end_layout
\begin_layout Itemize
-
Various members of the LyX developers' and users' lists provided bug reports
and feature suggestions.
\end_layout
\begin_layout Standard
-
reLyX uses a modified version the Perl TeX parser
\family typewriter
Text::TeX
\end_layout
\begin_layout Chapter
-
LyX Features needing Extra Software
\end_layout
\begin_layout Section
-
Using LyX with SGML-Tools (aka LinuxDoc)
\end_layout
\begin_layout Standard
-
by
\noun on
Paul Evans
\end_layout
\begin_layout Subsection
-
Overview
\end_layout
\begin_layout Standard
-
LinuxDoc is a document class available in LyX if you have the
\family typewriter
sgml-tools
\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
\end_layout
\begin_layout Itemize
-
how to setup and use a document in LinuxDoc
\end_layout
\begin_layout Itemize
-
how to use the tags in LinuxDoc to layout your document
\end_layout
\begin_layout Itemize
-
how to use the SGML packages to produce the various formats
\end_layout
\begin_layout Itemize
-
how to sort out some problems.
\end_layout
\begin_layout Subsection
-
Preparing and using a LinuxDoc document
\end_layout
\begin_layout Subsubsection
-
Getting started
\end_layout
\begin_layout Standard
-
You start by selecting the LinuxDoc class using the
\family sans
\bar under
\end_layout
\begin_layout Standard
-
You
\emph on
must
\end_layout
\begin_layout Standard
-
After that you can prepare a document as usual using the available range
of paragraph environments.
See section\InsetSpace ~
\end_layout
\begin_layout Subsubsection
-
Output from LinuxDoc
\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
\end_layout
\begin_layout Subsection
-
Using the paragraph environments in LinuxDoc
\end_layout
\begin_layout Subsubsection
-
The Structure of a LinuxDoc Document
\end_layout
\begin_layout Standard
-
There is a formal structure for LinuxDoc which limits how you can place
tags.
There are two parts to all documents:
\end_layout
\begin_layout Description
-
Header: this is everything up to the first time you insert a Section layout
marker.
It can include title, author, date, abstract and ToC.
\end_layout
\begin_layout Description
-
Body: from the beginning of the first section onwards.
All other tags are allowed.
\end_layout
\begin_layout Subsubsection
-
The LinuxDoc Paragraph Environments
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:sgmlparas}
\end_inset
\begin_layout Itemize
-
\family sans
Standard:
\family roman
\begin_layout Itemize
-
\family sans
Title
\family default
\begin_layout Itemize
-
\family sans
Section, Subsection, Subsubsection, Paragraph and Subparagraph:
\family default
\begin_layout Itemize
-
\family sans
Enumerate:
\family default
\begin_layout Itemize
-
\family sans
Itemize:
\family roman
\begin_layout Itemize
-
\family sans
Description
\family default
\begin_layout Itemize
-
\family sans
Verbatim:
\family default
\begin_layout Itemize
-
\family sans
Code: similar to the Lyx-Code
\family roman
\begin_layout Itemize
-
\family sans
Author
\family default
\begin_layout Itemize
-
\family sans
Date:
\family default
\begin_layout Itemize
-
\family sans
Abstract
\family default
\begin_layout Standard
-
\emph on
Author's note.
\begin_layout Itemize
-
\family sans
Displaymath
\family default
\begin_layout Standard
-
\emph on
Author's note:
\emph default
\end_layout
\begin_layout Subsubsection
-
Other document features
\end_layout
\begin_layout Standard
-
You can also use the
\family sans
Layout
\begin_layout Standard
-
\emph on
Author's note:
\emph default
\end_layout
\begin_layout Subsubsection
-
Cross references and HTML
\end_layout
\begin_layout Standard
-
On the
\family sans
Insert
\begin_layout Quote
-
\family typewriter
\backslash
\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_layout Itemize
-
\family sans
URL:
\family roman
\begin_layout Itemize
-
\family sans
HTML\InsetSpace ~
URL:
\end_layout
\begin_layout Subsection
-
Using the LinuxDoc Sgml scripts
\begin_inset Note Note
status collapsed
\begin_layout Standard
-
This section is completely outdated.
\end_layout
\end_layout
\begin_layout Standard
-
-
\begin_inset LatexCommand \label{sec:sgmloperate}
\end_inset
\begin_layout LyX-Code
-
\family roman
-
\begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
\end_inset
\end_layout
\begin_layout Standard
-
Alternatively, you can go to the
\family typewriter
sunsite
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
\begin_layout LyX-Code
-
\family roman
-
\begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
\end_inset
\begin_layout Standard
-
\family roman
The
\family default
\end_layout
\begin_layout Standard
-
This package was renamed from
\family typewriter
linuxdoc-sgml-1.5.tar.gz
\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
\end_layout
\begin_layout Subsection
-
Troubleshooting LinuxDoc
\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
\end_layout
\begin_layout Section
-
Checking TeX
\end_layout
\begin_layout Standard
-
by
\noun on
Asger Alstrup
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
Under the
\family sans
\bar under
\end_layout
\begin_layout Standard
-
The
\family sans
ChkTeX
\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
\end_layout
\begin_layout Itemize
-
Ellipsis detection:
\newline
Use \SpecialChar \ldots{}
\end_layout
\begin_layout Itemize
-
No space in front of/after parenthesis:
\newline
( wrong spacing )
\end_layout
\begin_layout Itemize
-
Enforcement of normal space after common abbreviations:
\newline
e.
\end_layout
\begin_layout Itemize
-
Enforcement of end-of-sentence space when the last sentence ends with a
capital letter:
\newline
\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.
+The label should stick right
+ up to the text to avoid falling to a wrong page.
\begin_inset LatexCommand \label{sec:chktex}
status collapsed
\begin_layout Standard
-
This footnote is in danger of falling off to a wrong page
\end_layout
\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.
+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}
\end_layout
\begin_layout Itemize
-
Use of
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
and more \SpecialChar \ldots{}
It is an invaluable tool when you are
\begin_inset Quotes eld
\end_layout
\begin_layout Subsection
-
How to use it
\end_layout
\begin_layout Standard
-
If you have the program installed, usage is as simple as choosing
\family sans
\bar under
\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
\end_layout
\begin_layout Subsection
-
How to fine tune it
\end_layout
\begin_layout Standard
-
Sometimes, you'll find that
\family sans
ChkTeX
\end_layout
\begin_layout Standard
-
Although
\family sans
ChkTeX
status collapsed
\begin_layout Standard
-
You can inspect the specific output from
\family sans
chktex
\end_layout
\begin_layout Itemize
-
Fine tune the
\family sans
ChkTeX
\end_layout
\begin_layout Itemize
-
Export your document as a raw LaTeX file using
\family sans
\bar under
\end_layout
\begin_layout Standard
-
Here follows the warning messages that can be enabled and disabled in
\family sans
Preferences
\end_layout
\begin_layout Standard
-
Notice that you should only use the options that enable and disable warnings,
because LyX relies on some of the other command line parameters to be set
in a specific way to have a chance to communicate with
\begin_layout Enumerate
-
\size small
\emph on
Command terminated with space.
\begin_layout Enumerate
-
\size small
Non-breaking space (
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
\emph on
You should enclose the previous parenthesis with
\begin_layout Enumerate
-
\size small
Italic correction (
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
Italic correction (
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
\emph on
No italic correction (
\begin_layout Enumerate
-
\size small
Accent command
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
Wrong length of dash may have been used.
\end_layout
\begin_layout Enumerate
-
\size small
\emph on
-
\begin_inset Quotes eld
\end_inset
\begin_layout Enumerate
-
\size small
Solo
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
You should use
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
Inter-word spacing (
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
Inter-sentence spacing (
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
Could not find argument for command.
\end_layout
\begin_layout Enumerate
-
\size small
No match found for
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
Math mode still on at end of LaTeX file.
\end_layout
\begin_layout Enumerate
-
\size small
Number of
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
You should use either
\family typewriter
\begin_layout Enumerate
-
\size small
You should use "
\family typewriter
\begin_layout Enumerate
-
\size small
User-specified pattern found.
\end_layout
\begin_layout Enumerate
-
\size small
This command might not be intended.
\end_layout
\begin_layout Enumerate
-
\size small
\emph on
Comment displayed.
\begin_layout Enumerate
-
\size small
Either
\family typewriter
\begin_layout Enumerate
-
\size small
Delete this space to maintain correct page references.
\end_layout
\begin_layout Enumerate
-
\size small
\emph on
You might wish to put this between a pair of
\begin_layout Enumerate
-
\size small
You ought to remove spaces in front of punctuation.
\end_layout
\begin_layout Enumerate
-
\size small
Could not execute LaTeX command.
\end_layout
\begin_layout Enumerate
-
\size small
Don't use
\family typewriter
\begin_layout Enumerate
-
\family typewriter
\size small
$
\begin_layout Enumerate
-
\size small
\emph on
Multiple spaces detected in output.
\begin_layout Enumerate
-
\size small
This text may be ignored.
\end_layout
\begin_layout Enumerate
-
\size small
Use
\family typewriter
\begin_layout Enumerate
-
\size small
Use
\family typewriter
\begin_layout Enumerate
-
\size small
Don't mix quotes.
\end_layout
\begin_layout Enumerate
-
\size small
You should perhaps use
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
You should put a space in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
-
\size small
You should avoid spaces in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
-
\size small
\emph on
You should not use punctuation in front of/after quotes.
\begin_layout Enumerate
-
\size small
Double space found.
\end_layout
\begin_layout Enumerate
-
\size small
You should put punctuation outside inner/inside display math mode.
\end_layout
\begin_layout Enumerate
-
\size small
You ought to not use primitive TeX in LaTeX code.
\end_layout
\begin_layout Enumerate
-
\size small
You should remove spaces in front of
\begin_inset Quotes eld
\begin_layout Enumerate
-
\size small
-
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
In later versions of LyX, we hope to provide a more complete interface to
this tool (and it's smaller cousin
\family typewriter
\end_layout
\begin_layout Section
-
Version Control in LyX
\end_layout
\begin_layout Standard
-
by
\noun on
Lars Gullik Bjønnes
\end_layout
\begin_layout Subsection
-
Introduction
\end_layout
\begin_layout Standard
-
A friend of mine wanted to try LyX for a group project.
When he didn't find support for version control or file locking, he dropped
it.
\end_layout
\begin_layout Standard
-
Before you begin to use the version control features in LyX, you should
read
\begin_inset Quotes eld
\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.
\end_layout
\begin_layout Subsection
-
RCS commands in LyX
\end_layout
\begin_layout Standard
-
The following sections describe the RCS commands supported by LyX.
You can find them in the
\family sans
\begin_layout Subsubsection
-
\family sans
Register
\end_layout
\begin_layout Standard
-
If your document is not under revision control, this is the only item shown
in the menu.
And if it is under revision control, the
\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.
\end_layout
\begin_layout Standard
-
RCS command that is run:
\family typewriter
ci -q -u -i -t-"<initial description>" <file-name>
\end_layout
\begin_layout Standard
-
Read
\family typewriter
man ci
\begin_layout Subsubsection
-
\family sans
Check In Changes
\end_layout
\begin_layout Standard
-
When you are finished editing a file, you check in your changes.
When you do this, you are asked for a description of the changes.
This is stored in the history log.
\end_layout
\begin_layout Standard
-
RCS command:
\family typewriter
ci -q -u -m"<description>" <file-name>
\begin_layout Subsubsection
-
\family sans
Check Out For Edit
\end_layout
\begin_layout Standard
-
By doing this you lock the document so that only you can edit it.
This will also make the document Read-Write only for you.
You will usually continue editing for a while and when you are finished
\end_layout
\begin_layout Standard
-
RCS command:
\family typewriter
co -q -l <file-name>
\begin_layout Subsubsection
-
\family sans
Revert To Last Version
\end_layout
\begin_layout Standard
-
This will discard all changes made to the document since the last check
in.
You get a warning before changes are discarded.
\end_layout
\begin_layout Standard
-
RCS command:
\family typewriter
co -f -u<version> <file-name>
\begin_layout Subsubsection
-
\family sans
Undo Last Checkin
\end_layout
\begin_layout Standard
-
This makes as if the last check in never happened.
No changes are made to the document loaded into LyX, but the last version
is removed from the master RCS file.
\end_layout
\begin_layout Standard
-
RCS command:
\family typewriter
rcs -o<version> <file-name>
\begin_layout Subsubsection
-
\family sans
Show History
\end_layout
\begin_layout Standard
-
This show the complete history of the RCS document.
The output of
\family typewriter
\end_layout
\begin_layout Section
-
Literate Programming
\end_layout
\begin_layout Standard
-
Updated by
\noun on
Kayvan Sylvan
\end_layout
\begin_layout Subsection
-
Introduction
\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,
\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
\end_layout
\begin_layout Subsection
-
Literate Programming
\end_layout
\begin_layout Standard
-
From the Literate Programming FAQ:
\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!
\end_layout
\begin_layout Standard
-
Another excerpt says:
\end_layout
\begin_layout Quotation
-
\emph on
How is literate programming different from verbose commenting?
\end_layout
\begin_layout Quotation
-
There are three distinguishing characteristics.
In order of importance, they are:
\end_layout
\begin_deeper
\begin_layout Itemize
-
flexible order of elaboration
\end_layout
\begin_layout Itemize
-
automatic support for browsing
\end_layout
\begin_layout Itemize
-
typeset documentation, especially diagrams and mathematics
\end_layout
+
\end_deeper
\begin_layout Standard
-
Now that I sparked your curiosity, take a look in the references.
\end_layout
\begin_layout Subsubsection
-
References
\end_layout
\begin_layout Standard
-
The complete Literate Programming FAQ can be found at:
\end_layout
\begin_layout Quote
-
-
\begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
\end_inset
\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_layout
\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.
\end_layout
\begin_layout Itemize
-
There is a good selection of filters available already (the html is one
of them).
\end_layout
\begin_layout Itemize
-
It is free.
\end_layout
\begin_layout Standard
-
The Noweb web page can be found at:
\end_layout
\begin_layout Quote
-
-
\begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
\end_inset
\end_layout
\begin_layout Standard
-
Starting from there you can reach many other interesting links and even
some literate program examples.
\end_layout
\begin_layout Subsection
-
LyX and Literate Programming
\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
\end_layout
\begin_layout Subsubsection
-
Generating documents and code (weaving and tangling)
\end_layout
\begin_layout Paragraph
-
Selecting the document class
\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:
\end_layout
\begin_layout Itemize
-
Article (Noweb)
\end_layout
\begin_layout Itemize
-
Book (Noweb)
\end_layout
\begin_layout Itemize
-
Report (Noweb)
\end_layout
\begin_layout Standard
-
You must select one of them to create your literate documents from.
\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).
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_layout
\end_layout
\begin_layout Paragraph
-
Typing code in
\end_layout
\begin_layout Standard
-
LyX enables you to write code with a layout named
\noun on
Scrap
status collapsed
\begin_layout Standard
-
The equivalent Noweb term is
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout LyX-Code
-
<<My scrap>>=
\end_layout
\begin_layout LyX-Code
-
code
\end_layout
\begin_layout LyX-Code
-
more code
\end_layout
\begin_layout LyX-Code
-
even more code
\end_layout
\begin_layout LyX-Code
-
@
\end_layout
\begin_layout Standard
-
The problem is that whatever is written in between the << and the
\family typewriter
@
\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.
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_layout
\end_layout
\begin_layout LyX-Code
-
<<My scrap>>=
\newline
code
\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.
status collapsed
\begin_layout Standard
-
It is in my list of
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
As a special note, you can also use the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout LyX-Code
-
<<My scrap>>=
\newline
def some_function(args):
\newline
- "This is the doc string for this function."
+ "This is the doc string for this
+ function."
\newline
print "My args: ", args
\end_layout
\begin_layout LyX-Code
-
@ %def some_function
\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
\end_layout
\begin_layout Paragraph
-
Generating the documentation
\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
\end_layout
\begin_layout Standard
-
To help orientate you, I will now explain what happens inside LyX:
\end_layout
\begin_layout Enumerate
-
When the
\family sans
\bar under
\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
\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,
\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
status open
\begin_layout Standard
-
The converters are defined in the
\family sans
\bar under
\begin_deeper
\begin_layout Standard
-
Otherwise it will just skip this step.
\end_layout
+
\end_deeper
\begin_layout Enumerate
-
Finally, LaTeX is invoked and the regular post processing continues as in
a plain document.
\end_layout
\begin_layout Standard
-
Independence from a particular
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Paragraph
-
Generating the code
\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
\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).
\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.
\end_layout
\begin_layout Standard
-
The first part, the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
This is an implementation of
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout LyX-Code
-
#!/bin/sh
\end_layout
\begin_layout LyX-Code
-
#
\end_layout
\begin_layout LyX-Code
-
notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
\end_layout
\begin_layout Standard
-
The next part of the converter setting is the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
The converter code looks in
\emph on
MYLYXDIR/scripts
\end_layout
\begin_layout Paragraph
-
Build instructions in the document
\end_layout
\begin_layout Standard
-
The last piece of the integration between LyX and noweb is the
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Standard
-
Typically, such a scrap would look something like this:
\end_layout
\begin_layout LyX-Code
-
<<build-script>>=
\newline
#!/bin/sh
\newline
NOWEB_SOURCE=myfile.nw
\newline
+
fi
\newline
[...
\end_layout
\begin_layout Standard
-
Look in
\emph on
LIBDIR/examples/listerrors.lyx
\end_layout
\begin_layout Subsubsection
-
Configuring LyX
\end_layout
\begin_layout Standard
-
All the Literate Programming support is configured by the
\family sans
\bar under
\end_layout
\begin_layout Description
-
the\InsetSpace ~
\begin_inset Quotes eld
\end_layout
\begin_layout Description
-
the\InsetSpace ~
\family sans
\begin_layout Description
-
\family sans
NoWeb
\family default
\begin_layout Description
-
\family sans
NoWeb
\family default
\end_layout
\begin_layout Subsubsection
-
Debug extensions
\end_layout
\begin_layout Standard
-
There is also a new function implemented in the LyX server, the
\begin_inset Quotes eld
\end_inset
\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.
\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_layout
\begin_layout LyX-Code
-
echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
\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
\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
\end_layout
\begin_layout Standard
-
Read the LyX server documentation in the
\emph on
Customization Manual
\end_layout
\begin_layout Subsubsection
-
Toolbar extensions
\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
\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
\end_layout
\begin_layout LyX-Code
-
Toolbar
\end_layout
\begin_layout LyX-Code
-
Layouts
\end_layout
\begin_layout LyX-Code
-
Icon "layout Standard"
\end_layout
\begin_layout LyX-Code
-
Icon "layout Section"
\end_layout
\begin_layout LyX-Code
-
Icon "layout LaTeX"
\end_layout
\begin_layout LyX-Code
-
Icon "layout LyX-Code"
\end_layout
\begin_layout LyX-Code
-
Icon "layout Scrap"
\end_layout
\begin_layout LyX-Code
-
Separator
\end_layout
\begin_layout LyX-Code
-
Icon "buffer-view"
\end_layout
\begin_layout LyX-Code
-
Icon "buffer-typeset"
\end_layout
\begin_layout LyX-Code
-
Icon "build-program"
\end_layout
\begin_layout LyX-Code
-
Separator
\end_layout
\begin_layout LyX-Code
-
.
\end_layout
\begin_layout LyX-Code
-
.
\end_layout
\begin_layout LyX-Code
-
.
\end_layout
\begin_layout LyX-Code
-
End
\end_layout
\begin_layout Subsubsection
-
Colors customization
\end_layout
\begin_layout Standard
-
There are a number of colors in LyX that can be customized in
\family sans
Preferences
\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.
\end_layout
\begin_layout Chapter
-
Secrets of the LaTeX Masters
\begin_inset LatexCommand \label{cha:secrets}
\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,
\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.
\end_layout
\begin_layout Section
-
Tricks for Footnotes and Margin Notes
\end_layout
\begin_layout Standard
-
suggested by
\noun on
Robin Socha
\end_layout
\begin_layout Subsection
-
Footnotes
\end_layout
\begin_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_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
status collapsed
\begin_layout Standard
-
The counter has been set back to 1.
\end_layout
\end_layout
\begin_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 collapsed
\begin_layout Standard
-
This is an example for a footnote with alphabetic numbering.
\newline
Use
\end_layout
\begin_layout Standard
-
The next command sets the counter style back to default, i.e.
\family typewriter
status collapsed
\begin_layout Standard
-
Use
\family typewriter
\end_layout
\begin_layout Standard
-
You can use
\family typewriter
\end_layout
\begin_layout Subsection
-
Margin Notes
\end_layout
\begin_layout Standard
-
Here are two examples of neat things you can do to margin notes using LaTeX
commands.
\end_layout
\begin_layout Standard
-
The following command will make a vertical line appear alongside your text---gre
at for
\begin_inset Quotes eld
\end_layout
\begin_layout Standard
-
Check your dvi- or ghostview-output to see what the
\family typewriter
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
status collapsed
\begin_layout Standard
-
This is a
\newline
margin note.
\end_layout
\begin_layout Section
-
Multiple Columns
\end_layout
\begin_layout Standard
-
by
\noun on
Lars Gullik Bjønnes
\end_layout
\begin_layout Subsection
-
Purpose
\end_layout
\begin_layout Standard
-
The aim for this chapter
\begin_inset Foot
status collapsed
\begin_layout Standard
-
Editor's note: Lars' original chapter was a masterful description of how
to use the
\family typewriter
\end_layout
\begin_layout Subsection
-
Limitations
\end_layout
\begin_layout Standard
-
The
\family typewriter
multicol
\end_layout
\begin_layout Subsection
-
Examples
\end_layout
\begin_layout Subsubsection
-
Two columns
\end_layout
\begin_layout Standard
-
If you want to have two columns in your text, you have use LaTeX mode to
insert
\family typewriter
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Standard
-
\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
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Subsubsection
-
Multiple columns
\end_layout
\begin_layout Standard
-
The same pattern is used when you want more than two columns:
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Standard
-
\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
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
You can have 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
\end_layout
\begin_layout Standard
-
You can even have columns inside columns:
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Standard
-
\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.
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Standard
-
\size footnotesize
The youth moved in the best society--had, so far as was known, no enemies
and no particular vices.
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\begin_layout Standard
-
\size footnotesize
Ronald Adair was fond of cards--playing continually, but never for such
stakes as would hurt him.
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
Please do read the file
\family typewriter
examples/multicol.lyx
\end_layout
\begin_layout Section
-
Numbering in the
\family sans
Enumerate
status collapsed
\begin_layout Standard
-
Numbering in Enumerate
\end_layout
\end_layout
\begin_layout Standard
-
by
\noun on
John Weiss
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
\noindent
The default numbering for the
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\end_layout
\begin_layout Standard
-
\SpecialChar \ldots{}
which changes the numbering scheme to uppercase Roman numerals, uppercase
letters, Arabic numbers, and lowercase letter.
\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:
\end_layout
\begin_layout Standard
-
As you can see in the example, there is a label command for each nesting
level,
\family typewriter
\end_layout
\begin_layout Standard
-
You can get really fancy with these.
For example:
\end_layout
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\begin_layout LyX-Code
-
\backslash
renewcommand{
\backslash
\end_layout
\begin_layout Standard
-
produces the somewhat out of hand numbering scheme: <
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Section
-
Extra Space Between Table Rows
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
\noindent
LaTeX allows you to put a bit of extra space between rows in a table by
\end_layout
\begin_layout Standard
-
The first is the more formal, but longwinded way to do it.
In the LaTeX preamble, add the following command definition:
\end_layout
\begin_layout Standard
-
\family typewriter
\backslash
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="4" columns="3">
<features>
<column alignment="center" valignment="top" width="0pt">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\bar no
\noun off
\color none
-
\begin_inset ERT
status collapsed
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\end_layout
\begin_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.
\begin_layout Standard
\align center
-
-\begin_inset Tabular
+\begin_inset Tabular
<lyxtabular version="3" rows="4" columns="3">
<features>
<column alignment="center" valignment="top" width="0pt">
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\bar no
\noun off
\color none
-
\begin_inset ERT
status collapsed
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\begin_layout Standard
-
\family roman
\series medium
\shape up
\end_layout
\begin_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!
\end_layout
\begin_layout Section
-
Dropped Capitals
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
\noindent
-
\begin_inset ERT
status collapsed
\begin_layout Standard
\noindent
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Section
-
Non-standard Paragraph Shapes
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status collapsed
\begin_layout Standard
\noindent
-
\begin_inset ERT
status collapsed
which will benefit from such handcrafting.
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-
The syntax is
\family typewriter
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status inlined
\end_layout
\begin_layout Section
-
Summary
\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