-#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 370
+#LyX 2.1 created this file. For more info see http://www.lyx.org/
+\lyxformat 426
\begin_document
\begin_header
\textclass scrbook
\cleardoublepage
\pagenumbering{arabic}}
-% redefine the \LyX macro for PDF bookmarks
-\def\LyX{\texorpdfstring{%
- L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
- {LyX}}
-
% used for multi-column text
\usepackage{multicol}
% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
\end_preamble
-\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
+\options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
\use_default_options false
\begin_modules
logicalmkup
theorems-ams
theorems-ams-extended
+multicol
\end_modules
+\maintain_unincluded_children false
\begin_local_layout
Format 7
InsetLayout CharStyle:MenuItem
End
\end_local_layout
\language english
-\inputencoding latin1
+\language_package default
+\inputencoding auto
+\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\font_default_family default
-\use_xetex false
+\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\graphics default
\default_output_format default
+\output_sync 1
\bibtex_command default
\index_command default
\paperfontsize 12
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle false
-\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
\papersize default
\use_geometry false
-\use_amsmath 0
-\use_esint 0
+\use_package amsmath 1
+\use_package esint 0
+\use_package mathdots 1
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type numerical
+\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\justification true
+\use_refstyle 0
+\notefontcolor #0000ff
\index Index
\shortcut idx
\color #008000
\paperpagestyle headings
\tracking_changes false
\output_changes false
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict true
\end_header
\begin_body
Additional LyX Features
\end_layout
+\begin_layout Subtitle
+Version 2.0.x
+\end_layout
+
\begin_layout Author
by the LyX Team
\begin_inset Foot
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-
+
\end_layout
\begin_layout Standard
User's Guide\SpecialChar \@.
\emph default
- The reason for separating this document out is simple: the
+ The reason for separating the two documents is simple: the
\emph on
User's Guide
\emph default
is already quite lengthy, and it contains information on all of the basic
features one needs to know in order to prepare most documents.
- However, the LyX Team has worked to LyX extensible through various configuratio
-n files and external packages.
+ However, the LyX Team has worked to make LyX extensible through various
+ configuration files and external packages.
That means that if you want to support the Fizzwizzle LaTeX package, you
can create a layout file (or module) for it without having to alter LyX
itself.
- We've already had contributions of several new features this way.
- This is the place where all of those get documented.
+ We've already had contributions of several new features this way, and some
+ of them are documented here.
+ There are also some more `advanced' features, such as how to control the
+ presentation of bibliographies and how to work with multi-part documents,
+ that are not covered in the
+\emph on
+User's Guide
+\emph default
+ and are discussed here.
\end_layout
\begin_layout Standard
This manual also documents some special features, like fax support, version
control, and SGML support, which require additional software to work properly.
- Lastly, there's a chapter of LaTeX tools and tips, things you can use to
- spruce up your documents by directly using the powerful features of LaTeX.
+ There is also a chapter on LyX's support for HTML.
+ And lastly, there's a chapter of LaTeX tools and tips, things you can use
+ to spruce up your documents by directly using the powerful features of
+ LaTeX.
After all, LyX
\emph on
is
\end_layout
\begin_layout Standard
-Since all the topics in this manual depend heavily on LyX's interaction
+Since many of the topics in this manual depend heavily on LyX's interaction
with LaTeX, this first chapter covers the inner workings of LyX and how
to direct LyX to generate exactly the LaTeX code you want.
It is obviously for more seasoned LyX users.
For one thing, you don't need to know LaTeX to use LyX effectively.
And LyX has added its own extensions to LaTeX.
Try the following sometime: select
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
from the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu (or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
), then look at the preamble of the resulting
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Format
+View
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
View\SpecialChar \menuseparator
-Update\SpecialChar \menuseparator
-Format
+Update
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Convert the document to LaTeX and save to a file with the extension
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in place of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Run LaTeX on the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file (maybe several times), and run any other commands (such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-If you've run LaTeX using
-\begin_inset Flex CharStyle:MenuItem
+If you have run LaTeX using
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
, LyX then runs a DVI viewer to display the DVI-file.
- If you've used
-\begin_inset Flex CharStyle:MenuItem
+ If you have used
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run a PostScript viewer, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can import a LaTeX file into LyX by using the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
command in LyX.
This will call a program named
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
which will create a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
from the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
will translate most legal LaTeX, but not everything.
It will put things it doesn't understand into TeX code, so after translating
a file with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LyX cannot, and will never be able to, display every possible LaTeX construct.
If ever you need to insert LaTeX commands into your LyX document, you can
use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
box, which you can insert into your document with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
TeX Code
\end_layout
+\end_inset
+
+ or the keyboard shortcut
+\begin_inset Info
+type "shortcut"
+arg "ert-insert"
\end_inset
.
\begin_inset Newline newline
\end_inset
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You
\begin_inset Newline newline
\end_inset
\begin_layout Standard
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
box containing this text is directly after this paragraph.
Those of you reading the manual in LyX will only see the TeX code inset.
Those reading a printed version of the manuals will see the actual results:
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
\begin_inset ERT
-status collapsed
+status open
\begin_layout Plain Layout
\begin_layout Plain Layout
-This is an example for a minipage environment.
+This is an example of a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\end_layout
\end_inset
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
In addition to using TeX code, you can also create a separate file containing
some complex LaTeX structure and then use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to include your file (you should select the type
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
).
We recommend that you only do this if you have a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-Beware reinventing the wheel.
+Beware of reinventing the wheel.
\end_layout
\begin_layout Standard
\end_inset
- for details, and see chapter
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
+ for details.
\end_layout
\begin_layout Standard
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
+ In addition to providing special commands, the inclusion of a package can
+ change the document.
For example, the package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset Newline newline
\end_inset
-There are several LaTeX counters and variables which
+There are several LaTeX counters and variables that
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- (There are variables which you can set and reset inside the document, too.)
- Margins are a good example of something which must be set in the preamble.
+ (There are variables that you can set and reset inside the document, too.)
+ Margins are a good example of something that must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\begin_layout Itemize
Declare user defined commands (with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX adds its own set of definitions to the preamble of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
The commands which LyX adds to the preamble of a LaTeX file are fixed; you
can't change them without patching LyX itself.
You can, however, add your own stuff to the preamble by selecting
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
dialog.
LyX adds anything in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
There are two variables under LaTeX that control page position:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Sometimes, the size of a print medium and the area of the medium that you
can actually print on aren't the same.
This is where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The default values for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
your sysadmin is a doofus,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
can save the day.
- Suppose you're left and top margins are always 0.5
+ Suppose your left and top margins are always 0.5
\begin_inset space \thinspace{}
\end_inset
Speaking of labels, suppose you wanted to print out a bunch of address labels.
There's a rather nice package, available at your nearest CTAN archive,
for printing sheets of labels:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First, make sure you're using the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
This sets things up for Avery label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
around each label text.
This and other special features of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
- Also, there are more examples and an assortment of LaTeX
-\begin_inset Quotes eld
-\end_inset
-
-dirty tricks
-\begin_inset Quotes erd
-\end_inset
-
- given in Chapter
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "cha:secrets"
-
-\end_inset
-
-.
-
\end_layout
\begin_layout Section
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
It then uses the logfile from the LaTeX run to do a post-mortem.
- After analyzing the logfile,LyX displays a dialog listing the errors.
+ After analyzing the logfile, LyX displays a dialog listing the errors.
Clicking on any one of them will take you to the position in your LyX file
where the error occurred.
\begin_inset Foot
\begin_layout Standard
Some folks also like to look at the log file directly: It is available from
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
You can also enable the `draft' option in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
- LaTeX Error: File
+LaTeX Error: File
\begin_inset Quotes els
\end_inset
isn't installed on this system.
This usually appears because some package your document needs isn't installed.
If you didn't touch the preamble or didn't use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
command, then one of the packages LyX tried to load is missing.
Use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
to get a list of packages that LyX knows about.
This file is updated whenever you reconfigure LyX (using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
If you did use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
misuse
\emph default
any of them, like trying to manually insert lots of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
spacing it will add in order to break a line.
Preferably, you should rework the paragraph to avoid the problem.
If this isn't an option, you can wrap your text in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-The basics how to use BibTeX are explained in section
+The most basic information about how to use BibTeX with LyX is contained
+ in the section
\emph on
Bibliography databases (BibTeX)
\emph default
).
LyX supports two packages that provide this style,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Both packages have their pros and cons, which cannot be listed in detail.
If you only want to have simple author-year (or author-numerical) style,
or if you want to use one of the countless style files for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-, than the established
-\begin_inset Flex CharStyle:Code
+, then the established
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package is probably your choice.
If you need special features like short title references, ibidem etc., you
might consider the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The handling of both packages in LyX is basically the same.
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and select under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and check under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Now you can insert multiple BibTeX bibliographies, one for each section
of your bibliography.
Returning to our example: Insert the BibTeX bibliography
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and a second one for the database
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
You are free to use the same or different styles for each section.
- Additionally, you can chose if the bibliography section should contain
+ Additionally, you can choose if the bibliography section should contain
\begin_inset Quotes eld
\end_inset
.
The titles for the sections can be added as ordinary sections or subsections.
Since
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- removes the bibliography title, you have manually re-add that, too (as
+ removes the bibliography title, you have to manually re-add that, too (as
a chapter* or section*, for instance).
\end_layout
a bibliography for each section or chapter of the document, are not supported
by BibTeX itself.
But the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package, which is used for the creation of sectioned bibliographies in
LyX (see the previous section), provides an easy way to solve this task,
if you are willing to use some
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
An alternative approach is to use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
check
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
In the document, you have to enclose the sections, which shall contain
their own bibliography (including the BibTeX bibliography itself), between
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
(those commands have to be inserted as TeX code).
- The bibliography will contain all references which have been cited in the
+ The bibliography will contain all references that have been cited in the
current
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\series default
If you are using this approach, then every citation reference has to be
inside some
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Also, the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
everything up to and including the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
line as well as the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX allows you to include files quite easily with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
+ that files that are
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- are typeset beginning on a new page, while files which are
+ are typeset beginning on a new page, while files that are
\begin_inset Quotes eld
\end_inset
\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
+g, while the included files are converted to LaTeX files that do not have
all the preamble information.
\end_layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Normally, spaces in this file are invisible, though two consecutive spaces
are conserved, unlike LyX's normal treatment of spaces.
However, setting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
First, open all the files in question: let's call them A and B in a two
file example, where B is included in A.
Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
+ Open the cross-reference dialog whilst in document B, and you can select
the
\begin_inset Quotes eld
\end_inset
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
Copy the bibliography list with all entries to all subdocuments and transform
them to a comment.
This way LyX will find the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
As the bibliography list is in a comment, LaTeX won't use use it and the
references will look like this: [?], instead of like this: [1].
One solution is to use the LaTeX-package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
\end_layout
+\begin_layout Section
+LyX Archives
+\end_layout
+
+\begin_layout Standard
+Users sometimes need to be able to
+\begin_inset Quotes eld
+\end_inset
+
+bundle
+\begin_inset Quotes erd
+\end_inset
+
+ a LyX file together with all the images (and other files) on which it depends,
+ either for sending to a publisher or for sharing with a co-author.
+ LyX 2.0 includes a Python script (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxpak.py
+\end_layout
+
+\end_inset
+
+) that automates this process.
+ To use it, you must have either the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zipfile
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tarfile
+\end_layout
+
+\end_inset
+
+ python modules installed on your system.
+ By default, the script prefers the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+gzip
+\end_layout
+
+\end_inset
+
+-compressed
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tar
+\end_layout
+
+\end_inset
+
+ format on Unix-like systems and the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zip
+\end_layout
+
+\end_inset
+
+ format on Windows.
+\end_layout
+
+\begin_layout Standard
+LyX's configuration process will set the script up to export a `LyX Archive',
+ and this format will then be available under
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Export
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+Independently of the platform, the generation of a particular archive format
+ can be forced by adding either the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-t
+\end_layout
+
+\end_inset
+
+ (for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+tar
+\end_layout
+
+\end_inset
+
+ format) or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-z
+\end_layout
+
+\end_inset
+
+ (for the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+zip
+\end_layout
+
+\end_inset
+
+ format) switch to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+LyX\SpecialChar \menuseparator
+LyX Archive
+\end_layout
+
+\end_inset
+
+ converter in
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
+\end_layout
+
+\end_inset
+
+.
+ (Make sure you add the switch after the script name, not before it.)
+\end_layout
+
\begin_layout Section
Fancy Headers and Footers
\end_layout
\begin_layout Standard
The default page layout is rather plain; for an
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For more information on fancy headers, see the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
package documentation.
- This can be found in the file
-\begin_inset Flex CharStyle:Code
+ (
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-fancyhdr.dvi
-\end_layout
-\end_inset
-
-, which should have been installed with your LaTeX distribution, or
-\begin_inset CommandInset href
-LatexCommand href
-name "online"
-target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
+http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
+\end_layout
\end_inset
-.
+)
\end_layout
\begin_layout Standard
.
The footer is also divided into these three fields.
The LaTeX commands to set these fields in the simplest manner are
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
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
+ the page number appears in the central footer) simply include a command
with a blank argument, e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Standard
The commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
access LaTeX's section and page counters, and so print out the current
section and page numbers.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can switch the header/footer settings on and off for individual pages
using commands like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
\noindent
(you may need to preface this with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Open the dialog by selecting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu item and then select the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+ The following table shows the mappings from button name to LaTeX package.
\end_layout
\begin_layout Standard
\begin_layout Itemize
Use the LaTeX command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Specify each individual entry by starting each item with the bullet shape
enclosed in square brackets and set as
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
For example, this item was started with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Chapter
-The LyX Server
+LyX and the World Wide Web
\end_layout
-\begin_layout Section
-Introduction
+\begin_layout Standard
+LyX has long supported the export of documents to various web-friendly formats,
+ such as HTML.
+ Before verson 2.0, however, HTML export was always accomplished by the use
+ of external converters.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For details on the use of external converters with LyX, see the
+\emph on
+Converters
+\emph default
+ section of the Customization manual.
\end_layout
-\begin_layout Standard
-The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
- and retrieve information about the LyX internal state.
- This is only intended for advanced users, but they should find it useful.
- It is by writing to the LyX server, for example, that bibliography managers,
- such as JabRef, are able to
-\begin_inset Quotes eld
\end_inset
-push
-\begin_inset Quotes erd
-\end_inset
+ These fall into two large groups: there are converters that use LaTeX as
+ an intermediate format, such as
+\begin_inset Flex Code
+status collapsed
- citations to LyX.
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Section
-Starting the LyX Server
-\end_layout
+\end_inset
-\begin_layout Standard
-The LyX server works through the use of a pair of named pipes.
- These are usually located in
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir
+html2latex
\end_layout
\end_inset
-
-\begin_inset Foot
+, and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-On Windows,
-\emph on
-local
-\emph default
- named pipes are special objects located in
-\begin_inset Flex CharStyle:Code
-status collapsed
+plastex
+\end_layout
-\begin_layout Plain Layout
+\end_inset
-\backslash
+, relying upon LyX to produce the LaTeX; and there is a converter that works
+ directly on LyX files,
+\begin_inset Flex Code
+status collapsed
-\backslash
-.
-\backslash
-pipe
+\begin_layout Plain Layout
+eLyXer
\end_layout
\end_inset
.
+ All of these have different advantages and disadvantages.
+
\end_layout
-\end_inset
+\begin_layout Standard
+The LaTeX-based converters have the advantage that, in principle, they know
+ everything about the exported document that LaTeX does.
+ Such converters do not care, for example, if a certain block of code was
+ produced by LyX or was Evil Red Text.
+ These converters know about
+\begin_inset Flex Code
+status collapsed
- and have the names
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+aux
+\end_layout
+\end_inset
-\begin_inset Flex CharStyle:Code
+ files, counters, and references, and can often make use of the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+bbl
\end_layout
\end_inset
+ files generated by BibTeX.
+ On the other hand, LaTeX is a very hard language to parse---it is sometimes
+ said that only TeX itself understands TeX---and LaTeX-based converters
+ will often choke on what seem to be quite simple constructs; complex ones
+ can throw them completely, and as of this writing, for example, the
+\emph on
+Embedded Objects
+\emph default
+ manual will not export with
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+htlatex
+\end_layout
- and
-\begin_inset Quotes eld
\end_inset
+, though the others will.
+ The other issue concerns how math is handled.
+ These converters typically convert the formulae into little pictures that
+ are then linked from the HTML document.
+ Since these are actually generated by LaTeX, they are accurate.
+ But they do not scale well, and just getting them to look as if they are
+ actually meant to be in your document---so that the font sizes seem to
+ be roughly the same---can be a challenge.
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Alex Fernandez's
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+eLyXer
\end_layout
\end_inset
+ (
+\begin_inset CommandInset href
+LatexCommand href
+name "http://elyxer.nongnu.org/"
+target "http://elyxer.nongnu.org/"
-\begin_inset Quotes erd
\end_inset
-.
- External programs write into
-\begin_inset Flex CharStyle:Code
+) solves some of these problems.
+ In particular, the formulae it produces scale perfectly, since it renders
+ math using a combination of HTML and CSS rather than converting the formulae
+ to images.
+ But even moderately complex formula are rendered less well than with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+htlatex
\end_layout
\end_inset
- and read back data from
-\begin_inset Flex CharStyle:Code
+; this reflects the limitations of HTML.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+That said,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+eLyXer
\end_layout
\end_inset
-.
- The stem of the pipe names can be defined in the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences
+ can also use jsMath and MathJax for equations, but this setting is only
+ available globally and requires one to have access to a server that runs
+ the backend.
\end_layout
\end_inset
- dialog, for example
-\begin_inset Flex CharStyle:Code
+ More importantly (as of version 1.1.1, at least),
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"/home/myhome/lyxpipe"
+eLyXer
\end_layout
\end_inset
-, or
-\begin_inset Flex CharStyle:Code
+ has limited support for math macros and no support for user-defined paragraph
+ or character styles.
+ These limitations make
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe"
+eLyXer
\end_layout
\end_inset
- on Windows.
- You
-\emph on
-must
-\emph default
- configure this manually in order for the server to start.
+ unsuitable for many of the documents LyX users produce.
+ In principle, of course, these problems could be solved, but the LyX developers
+ have decided to follow a different path and have made LyX itself capable
+ of writing XHTML, just as it is capable of writing LaTeX, DocBook, and
+ plaintext.
\end_layout
\begin_layout Standard
-LyX will add the '
-\begin_inset Flex CharStyle:Code
+As of this writing, XHTML output remains under development and should probably
+ be regarded as
+\begin_inset Quotes eld
+\end_inset
+
+experimental
+\begin_inset Quotes erd
+\end_inset
+
+.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-.in
+The file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+development/HTML.notes
\end_layout
\end_inset
-' and '
-\begin_inset Flex CharStyle:Code
+, which can be found in the LyX source tree or
+\begin_inset CommandInset href
+LatexCommand href
+name "accessed online"
+target "http://www.lyx.org/trac/browser/lyx-devel/trunk/development/HTML/HTML.notes"
+
+\end_inset
+
+, usually contains up-to-date information about the state of XHTML output.
+ See also the list of XHTML bugs on
+\begin_inset CommandInset href
+LatexCommand href
+name "the bug tracker"
+target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+ Still, the developers have chosen this approach because it has several
+ potential advantages over the other two.
+\end_layout
+
+\begin_layout Standard
+These advantages are primarily due to the fact that the XHTML output routines,
+ since they are part of LyX, know everything LyX knows about the document
+ being exported.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-.out
+Another advantage is that, since these routines are internal to LyX, they
+ are immune to changes in LyX's file format, or to changes in the semantics
+ of existing insets.
\end_layout
\end_inset
-' to create the pipes.
- If one of the pipes already exists, LyX will assume that another LyX process
- is already running and will not start the server.
- On POSIX (Unix like) systems, if for some other reason, an unused
+ So they know about the table of contents (as displayed in the outline),
+ about the counters associated with different paragraph styles, and about
+ user-defined styles.
+ The XHTML output routines know what LyX knows about internationalization,
+ too, so they will output
\begin_inset Quotes eld
\end_inset
-stale
+Chapter 1
\begin_inset Quotes erd
\end_inset
- pipe is left in existence when LyX closes, then LyX will try to delete
- it.
- If this fails for some reason, you will need to delete the pipes manually
- and then restart LyX.
- On Windows, pipes are deleted by the OS on program termination or crash,
- so
+ or
\begin_inset Quotes eld
\end_inset
-stale
+
+\lang ngerman
+Kapitel
+\lang english
+ 1
\begin_inset Quotes erd
\end_inset
- pipes should not be possible.
+, depending upon the language in effect at the time.
+
\end_layout
\begin_layout Standard
-To have several LyX processes with servers at the same time, you have to
- use different configurations, perhaps by using separate user directories,
- each with its own
-\begin_inset Flex CharStyle:Code
+Quite generally, the output routines know what LyX knows about document
+ layout, that is, about how the document is to be rendered on screen.
+ We use this information when we output the document as XHTML.
+ In particular, LyX
+\emph on
+automatically
+\emph default
+ generates CSS style information corresponding to the layout information
+ it uses to render the document on screen: if section headings are supposed
+ to be sans-serif and bold as seen in LyX, then (by default) they will be
+ sans-serif and bold when viewed in a web browser, too.
+ And this is true not just for pre-defined styles, like Section, but for
+ any style, including user-defined styles.
+ Indeed, the XHTML output routines make no distinction between user-defined
+ paragraph and character styles and LyX's own pre-defined styles: in each
+ case, everything LyX knows about the styles is contained in the layout
+ files.
+ And much the same is true as regards pre-defined textual insets, such as
+ footnotes, and various custom insets.
+
+\end_layout
+
+\begin_layout Standard
+The result is that XHTML output can be customized and extended in exactly
+ the same way LaTeX output can be customized and extended: through layout
+ files and modules.
+ See chapter five of the
+\emph on
+Customization
+\emph default
+manual for the details.
+\end_layout
+
+\begin_layout Standard
+The remainder of this chapter contains more detailed information on XHTML
+ output, its limitations, and ways to work around those limitations.
+\end_layout
+
+\begin_layout Section
+Math Output in XHTML
+\end_layout
+
+\begin_layout Standard
+LyX offers four choices for how math is rendered.
+ These have various advantages and disadvantages:
+\end_layout
+
+\begin_layout Itemize
+MathML
+\begin_inset Newline newline
+\end_inset
+
+MathML is a dialect of XML designed specifically for mathematics on the
+ web, and it typically renders very well in browsers that support it.
+ The disadvantage is that not all browsers support MathML, and support is
+ not complete even in the Gecko-based browsers, such as Firefox.
+\begin_inset Newline newline
+\end_inset
+
+If LyX is unable to render a formula as MathML---for example, if the formula
+ uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-preferences
+xymatrix
\end_layout
\end_inset
- file, for each process.
+ package or ERT---then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Standard
-If you are developing a client program, you might find it useful to enable
- debugging information from the LyX server.
- Do this by starting LyX as
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+HTML
+\begin_inset Newline newline
+\end_inset
+
+As mentioned above,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyx -dbg lyxserver
+elyxer
\end_layout
\end_inset
-.
-\end_layout
+ outputs math as HTML, styled by CSS.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
-You can find a complete example client written in C in the source distribution
- as
-\begin_inset Flex CharStyle:Code
+\begin_layout Plain Layout
+LyX has borrowed some of the CSS for its HTML output from
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-development/lyxserver/server_monitor.c
+elyxer
\end_layout
\end_inset
.
\end_layout
-\begin_layout Standard
-Another useful tool is command-line based client you will find in
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ For simple formulae, this can work quite well, though with more complicated
+ formulae it tends to break down.
+ Still, this method has the advantage that it is very widely supported and
+ so it may be appropriate for documents that contain only a little, fairly
+ simple math.
+\begin_inset Newline newline
+\end_inset
+
+If Lyx is unable to render a formula as HTML---for example, if the formula
+ uses the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-src/client/lyxclient
+xymatrix
\end_layout
\end_inset
-.
+ package or ERT---then it will instead output the formula as an image.
+
\end_layout
-\begin_layout Section
-Normal communication
-\end_layout
+\begin_layout Itemize
+Images
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-To issue a LyX call, the client writes a line of ASCII text into the input
- pipe.
- This line has the following format:
+Like
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Quote
-LYXCMD:
-\emph on
-clientname
-\emph default
-:
+\end_inset
+
+, LyX will output formulae as images, the very same images, in fact, that
+ are used for instant preview.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Instant preview does
\emph on
-function
+not
\emph default
-:
-\emph on
-argument
+have to be on for images to be output, however.
\end_layout
-\begin_layout Description
-clientname is a name that the client can choose arbitrarily.
- Its only use is that LyX will echo it if it sends an answer—so a client
- can dispatch results from different requesters.
-\end_layout
+\end_inset
-\begin_layout Description
-function is the function you want LyX to perform.
- It is the same as the commands you'd use in the minibuffer.
-\end_layout
+ The advantage to this method is that the images are simply generated by
+ LaTeX, so they are very accurate.
+ The disadvantage, as mentioned earlier, is that these are bitmapped images,
+ so they do not scale terribly well, and one cannot copy them, etc.
+ (As of this writing, there are also problems about equation numbering.
+ See
+\begin_inset CommandInset href
+LatexCommand href
+name "bug 6894"
+target "http://www.lyx.org/trac/ticket/6894"
-\begin_layout Description
-argument is an optional argument which is meaningful only to some functions
- (for instance, the
+\end_inset
+
+.)
+\begin_inset Newline newline
+\end_inset
+
+The size of the images can be controlled by setting the
\begin_inset Quotes eld
\end_inset
-self-insert
+Math Images Scaling
\begin_inset Quotes erd
\end_inset
- LFUN will insert the argument as text at the cursor position).
-\end_layout
+ parameter under
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-The answer from LyX will arrive in the output pipe and be of the form
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
\end_layout
-\begin_layout Quote
-INFO:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-data
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For those who want to know, this controls the resolution of the image in
+ dots per inch and is based upon a default of 75 dpi.
\end_layout
-\begin_layout Standard
-where
-\emph on
-clientname
-\emph default
- and
-\emph on
-function
-\emph default
- are just echoed from the command request, while
-\emph on
-data
-\emph default
- is more or less useful information filled according to how the command
- execution worked out.
- Some commands, such as
-\begin_inset Quotes eld
\end_inset
-font-state
-\begin_inset Quotes erd
-\end_inset
-, will return information about the internal state of LyX, while other will
- return an empty data-response.
- This means that the command execution went fine.
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-In case of errors, the response from LyX will have this form
+If LyX for some reason fails to create an image for a formula (e.g., if a
+ required LaTeX package is not installed), then it will fall back to outputing
+ the raw LaTeX.
\end_layout
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-error message
-\end_layout
+\begin_layout Itemize
+LaTeX
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
-\end_layout
+Finally, LyX will happily output math as LaTeX.
+ As well as being the output of last resort, this method can be used with
+ such tools as
+\begin_inset CommandInset href
+LatexCommand href
+name "jsMath"
+target "http://www.math.union.edu/~dpvc/jsMath/"
-\begin_layout Standard
-Examples:
+\end_inset
+
+, which uses JavaScript to render LaTeX embedded in HTML documents.
+ LyX wraps the LaTeX in either a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+span
\end_layout
-\begin_layout LyX-Code
-echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
-\begin_inset Newline newline
\end_inset
-echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
-\begin_inset Newline newline
-\end_inset
+ (for inline formulas) or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+div
+\end_layout
-read a <~/.lyxpipe.out
-\begin_inset Newline newline
\end_inset
-echo $a
+ (for displayed formulas) with
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+class='math'
\end_layout
-\begin_layout Section
-Notification
+\end_inset
+
+, as is required for jsMath.
\end_layout
\begin_layout Standard
-LyX can notify clients of events going on asynchronously.
- Currently it will only do this if the user binds a key sequence with the
- function
-\begin_inset Quotes eld
-\end_inset
+One of these output methods must be selected under
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
+\end_layout
-notify
-\begin_inset Quotes erd
\end_inset
.
- The format of the string LyX sends is as follows:
+ By default, LyX outputs MathML.
+ This is a document-wide setting, therefore.
\end_layout
-\begin_layout Quote
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Eventually, LyX will offer the user the option to select an alternate output
+ method for a particular inset, say, one that isn't being rendered very
+ well by MathML.
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-NOTIFY:
+That said, since LyX falls back to images if the inset contains ERT, then
+ one can force output as an image by putting some harmless ERT into the
+ math, for example:
+\begin_inset Formula $a=b\relax$
+\end_inset
+
+.
\end_layout
\end_inset
-\emph on
-key-sequence
+\end_layout
+
+\begin_layout Section
+Bibliography and Citations
\end_layout
\begin_layout Standard
-where
+XHTML output fully supports bibliographies and citations.
+
+\end_layout
+
+\begin_layout Standard
+Citation labels are generated by the same machinery that generates LyX's
+ on-screen labels, so the labels will look in the output much as they do
+ in LyX, though better.
+ If you are using numerical citations, then LyX will output numerical labels,
+ such as [1] or [17], rather than simply showing the citation key in square
+ brackets, as it does on-screen.
+ If you are using author-year citations, then LyX will add lowercase letters
+ to the years, just as BibTeX does, if it finds more than one citation for
+ a given author-year combination.
+ The labels will be printed with the bibliography entries.
+ Note that there is, at present, no way to customize the appearance of the
+ labels, for example, to choose between square brackets and parentheses.
+\end_layout
+
+\begin_layout Standard
+Bibliography output is handled by the same machinery that handles the presentati
+on of reference information in the citation dialog, so you will see in the
+ XHTML output pretty much what you would see if you were to look at a given
+ entry in the citation dialog.
+ The formatting can be customized in your layout file or, preferably, in
+ a module.
+ See the
\emph on
-key-sequence
+Customization
\emph default
- is the printed representation of the key sequence that was actually typed
- by the user.
+ manual for the details.
\end_layout
\begin_layout Standard
-This mechanism can be used to extend LyX's command set and implement macros.
- Bind some key sequence to
+The main defect at present is that cross-referenced information is printed
+ with every entry with which it is associated.
+ So you can see things like this:
+\end_layout
+
+\begin_layout Quote
+Jason Stanley,
\begin_inset Quotes eld
\end_inset
-notify
+Context and Logical Form
\begin_inset Quotes erd
\end_inset
-.
- Then start a client that listens on the output pipe, dispatches the command
- according to the sequence, and starts a function that may use LyX calls
- and LyX requests to issue a command or a series of commands to LyX.
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 30--68.
\end_layout
-\begin_layout Section
-The simple LyX Server Protocol
+\begin_layout Quote
+Jason Stanley,
+\begin_inset Quotes eld
+\end_inset
+
+Semantics in Context
+\begin_inset Quotes erd
+\end_inset
+
+, in
+\emph on
+Language in Context: Selected Essays
+\emph default
+ (Oxford: Oxford University Press, 2007), pp.
+ 201--30.
\end_layout
\begin_layout Standard
-LyX implements a simple protocol that can be used for session management.
- All messages are of the form
+This should be fixed before long.
\end_layout
-\begin_layout Quote
-LYXSRV:
-\emph on
-clientname
-\emph default
-:
-\emph on
-protocol message
+\begin_layout Standard
+There is no support at present for sectioned bibliographies.
+ If you have multiple bibliographies, then LyX will print the same bibliography
+ over and over.
+\end_layout
+
+\begin_layout Section
+Indexes
\end_layout
\begin_layout Standard
-where
+LyX will happily export indexes as XHTML, but with certain limitations at
+ the moment.
+\end_layout
+
+\begin_layout Standard
+Index export will be most reliable when you do not attempt to use the fancy
+ constructs that are described in the section on indexes in the
\emph on
-protocol message
+User's Guide
\emph default
- can be
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+The main issue here is that LyX itself does not really handle these.
+ It just lets you enter what you would have to enter in raw LaTeX.
+\end_layout
+
+\end_inset
+
+ We'll describe how they are handled using the subsection headings from
+ that section.
+\end_layout
+
+\begin_layout Itemize
+Grouping Index Entries (aka, sub-entries): LyX makes an effort to support
+ these, but the entries must be separated by
\begin_inset Quotes eld
\end_inset
-hello
+ !
\begin_inset Quotes erd
\end_inset
- or
+, that is, there must be spaces around the exclamation point.
+ This is because it is otherwise too difficult to check for escaped exclamation
+ points, ones in math, and so forth.
+\end_layout
+
+\begin_layout Itemize
+Page Ranges: There is no support at all for page ranges, since these make
+ no sense with XHMTL.
+ Instead, you will just get two index entries, one at either end.
+\end_layout
+
+\begin_layout Itemize
+Cross-referencing: There is no support for cross-referencing.
+ If LyX finds an entry containing the
\begin_inset Quotes eld
\end_inset
-bye
+|see\SpecialChar \ldots{}
+
\begin_inset Quotes erd
\end_inset
-.
- If
+ construct, it is just dropped, and the rest is treated as an ordinary index
+ entry.
+\end_layout
+
+\begin_layout Itemize
+Index Entry Order: LyX does support attempts to fix the sorting order.
+ It will take what is before the first `@' it finds and use that for sorting,
+ taking what follows the first `@' to be the actual entry.
+ At present, LyX does not check for escaped `@', so do not try to index
+ email addresses.
+\end_layout
+
+\begin_layout Itemize
+Index Entry Layout: You can format entries by using the text style dialog,
+ or by using any other method available within LyX itself.
+ There is no support for constructs like:
\begin_inset Quotes eld
\end_inset
-hello
+entry|textbf
\begin_inset Quotes erd
\end_inset
- is received from a client, LyX will report back to inform the client that
- it's listening to it's messages, while
+.
+ Indeed, if LyX finds a pipe symbol, `|', in an entry, it will delete it
+ and everything that follows it.
+\end_layout
+
+\begin_layout Itemize
+Multiple Indexes: There is no support for multiple indexes.
+ Rather, all index entries will be printed as one large index.
+ To avoid our printing several versions of the index, we print only the
+ main index, so make sure you have one.
+\end_layout
+
+\begin_layout Section
+Nomenclature and Glossary
+\end_layout
+
+\begin_layout Standard
+There is at present no support for glossaries.
+ Adding it would be fairly trivial, and welcome.
+\end_layout
+
+\begin_layout Chapter
+The LyX Server
+\end_layout
+
+\begin_layout Section
+Introduction
+\end_layout
+
+\begin_layout Standard
+The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
+ and retrieve information about the LyX internal state.
+ This is only intended for advanced users, but they should find it useful.
+ It is by writing to the LyX server, for example, that bibliography managers,
+ such as JabRef, are able to
\begin_inset Quotes eld
\end_inset
-bye
+push
\begin_inset Quotes erd
\end_inset
- sent from LyX will inform clients that LyX is closing.
+ citations to LyX.
\end_layout
\begin_layout Section
-Reverse DVI/PDF search
+Starting the LyX Server
\end_layout
\begin_layout Standard
-Some DVI/PDF viewers
-\begin_inset Foot
+The LyX server works through the use of a pair of named pipes.
+ These are usually located in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Skim on Mac OSX and SumatraPDF on Windows.
+UserDir
\end_layout
\end_inset
- provide
-\emph on
-reverse search
-\emph default
- facility (also called
-\emph on
-inverse search
-\emph default
-).
- This means that you can tell LyX to put the cursor to a specific line in
- the document by clicking at the respective position in the DVI/PDF output.
- To achieve this, the viewer must be able to communicate with LyX.
- This is done via the LyX server either by using the named pipe (
-\emph on
-lyxpipe
-\emph default
-), or the UNIX domain socket (
+, (except on Windows, where
\emph on
-lyxsocket
+local
\emph default
-) that LyX creates in its temporary directory (this is the way the
-\begin_inset Flex CharStyle:Code
+ named pipes are special objects located in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient
+
+\backslash
+
+\backslash
+.
+\backslash
+pipe
\end_layout
\end_inset
- program communicates with LyX).
- In some cases, you need a helper script that mediates between the viewer
- and LyX, in others, the viewer can communicate with LyX directly.
- This depends on the selected viewer and on your operating system.
- The same applies to the way viewers need to be configured and the way the
- reverse search is actually performed.
- In what follows, we will thus describe how to setup reverse search for
- specific viewers.
- Before we turn to this, though, we will explain what needs to be done generally
- to enable reverse search in the DVI/PDF output.
-\end_layout
+) and have the names
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Enabling reverse search
-\end_layout
-\begin_layout Standard
-LaTeX provides several different methods for reverse search.
- Some are built-in in the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex/pdflatex
+lyxpipe.in
\end_layout
\end_inset
- program, some are provided by external packages.
- Your choice depends on whether your LaTeX distribution already provides
- a given method (the built-in methods are rather new) and whether your viewer
- can cope with it.
- The available methods are described in the following.
-\end_layout
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-This method provides the DVI file with the necessary information for reverse
- search.
- It is available in LaTeX since quite some time (any somewhat recent LaTeX
- distribution should include it), and it works reliably.
- To enable it, change the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+lyxpipe.out
\end_layout
\end_inset
-eX (plain)->DVI
-\end_layout
+\begin_inset Quotes erd
\end_inset
- or
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+.
+ External programs write into
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
-\end_layout
-
-\end_inset
-
-eX (plain)->DraftDVI
+lyxpipe.in
\end_layout
\end_inset
- converter in
-\begin_inset Flex CharStyle:MenuItem
+ and read back data from
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+lyxpipe.out
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+.
+ The stem of the pipe names can be defined in the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-latex -src-specials $$i
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
\end_inset
-.
- If this doesn't work, check if your TeX engine needs different options
- (the syntax might differ in some distributions).
-\end_layout
+ dialog, for example
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
+\begin_layout Plain Layout
+"/home/myhome/lyxpipe"
\end_layout
-\begin_layout Standard
-The packages
-\emph on
-pdfsync
-\emph default
- and
-\emph on
-scrltx
-\emph default
- provide reverse search facility for PDF output (via pdflatex) and DVI output,
- respectively.
- In order to enable it, load the packages in the LyX preamble:
-\end_layout
+\end_inset
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+, or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+"
+\backslash
\backslash
-usepackage{pdfsync}
+.
+\backslash
+pipe
+\backslash
+lyxpipe"
\end_layout
\end_inset
- for reverse PDF search,
+ on Windows (but any working path can be used).
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
-\begin_layout Itemize
-
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+LyX will add the '
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-usepackage[active]{srcltx}
+.in
\end_layout
\end_inset
- for reverse DVI search.
-\end_layout
+' and '
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-If you want to be able to perform both DVI and PDF reverse searches, you
- can also insert in the preamble the following lines
+\begin_layout Plain Layout
+.out
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-usepackage{ifpdf}
-\begin_inset Newline newline
\end_inset
-
-\backslash
-ifpdf
-\begin_inset Newline newline
+' to create the pipes.
+ If one of the pipes already exists, LyX will assume that another LyX process
+ is already running and will not start the server.
+ On POSIX (Unix like) systems, if for some other reason, an unused
+\begin_inset Quotes eld
\end_inset
-
-\backslash
-usepackage{pdfsync}
-\begin_inset Newline newline
+stale
+\begin_inset Quotes erd
\end_inset
-
-\backslash
-else
-\begin_inset Newline newline
+ pipe is left in existence when LyX closes, then LyX will try to delete
+ it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart LyX.
+ On Windows, pipes are deleted by the OS on program termination or crash,
+ so
+\begin_inset Quotes eld
\end_inset
-
-\backslash
-usepackage[active]{srcltx}
-\begin_inset Newline newline
+stale
+\begin_inset Quotes erd
\end_inset
-
-\backslash
-fi
-\end_layout
-
-\begin_layout Standard
-This way, you can preview the file as either DVI or PDF (pdflatex) and the
- right package will be used.
-\end_layout
-
-\begin_layout Standard
-Note that PDFSync might affect the output layout of your document.
- It is therefore advised to disable PDFsync for final documents.
-\end_layout
-
-\begin_layout Subsubsection*
-Built-in reverse search via SyncTeX (DVI and PDF)
+ pipes should not be possible.
\end_layout
\begin_layout Standard
-Recent versions of
-\begin_inset Flex CharStyle:Code
+To have several LyX processes with servers at the same time, you have to
+ use different configurations, perhaps by using separate user directories,
+ each with its own
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-(pdf)latex
+preferences
\end_layout
\end_inset
- have built-in support for both PDF and DVI reverse search.
- This so-called
-\emph on
-SyncTeX
-\emph default
- facility is basically the result of the integration of the PDFSync package
- to the pdftex program and its merge with the
-\emph on
-scr-specials
-\emph default
- approach.
- You need at least TeXLive 2008 or a recent MikTeX distribution in order
- to use it.
- Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
- already provide SyncTeX support.
+ file, for each process.
\end_layout
\begin_layout Standard
-To enable SyncTeX for DVI output, change the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+If you are developing a client program, you might find it useful to enable
+ debugging information from the LyX server.
+ Do this by starting LyX as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+lyx -dbg lyxserver
\end_layout
\end_inset
-eX (plain) -> DVI
+.
\end_layout
-\end_inset
-
- or
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_layout Standard
+You can find a complete example client written in C in the source distribution
+ as
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+development/lyxserver/server_monitor.c
\end_layout
\end_inset
-eX (plain) -> DraftDVI
+.
\end_layout
-\end_inset
-
- converter in
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Standard
+Another useful tool is the command-line based clientfound in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+src/client/lyxclient
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-latex -synctex=1 $$i
+.
\end_layout
-\end_inset
-
-, and for PDF output, change the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
-status collapsed
-
-\begin_layout Plain Layout
+\begin_layout Section
+Normal communication
+\end_layout
-{}
+\begin_layout Standard
+To issue a LyX call, the client writes a line of ASCII text into the input
+ pipe.
+ This line has the following format:
\end_layout
-\end_inset
-
-eX (pdflatex) -> PDF (pdflatex)
+\begin_layout Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
\end_layout
-\end_inset
-
- or converter to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-pdflatex -synctex=1 $$i
+\begin_layout Description
+clientname is a name that the client can choose arbitrarily.
+ Its only use is that LyX will echo it if it sends an answer—so a client
+ can dispatch results from different requesters.
\end_layout
-\end_inset
-
-.
- Check the documentation of your viewer whether the viewer needs to be configure
-d for the use with SyncTeX.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
--synctex=1
+\begin_layout Description
+function is the function you want LyX to perform.
+ It is the same as the commands you'd use in the minibuffer.
\end_layout
+\begin_layout Description
+argument is an optional argument which is meaningful only to some functions
+ (for instance, the
+\begin_inset Quotes eld
\end_inset
- option enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex CharStyle:Code
-status collapsed
+self-insert
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
--synctex=-1
+ LFUN will insert the argument as text at the cursor position).
\end_layout
-\end_inset
+\begin_layout Standard
+The answer from LyX will arrive in the output pipe and be of the form
+\end_layout
-.
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
\end_layout
+\begin_layout Standard
+where
+\emph on
+clientname
+\emph default
+ and
+\emph on
+function
+\emph default
+ are just echoed from the command request, while
+\emph on
+data
+\emph default
+ is more or less useful information filled according to how the command
+ execution worked out.
+ Some commands, such as
+\begin_inset Quotes eld
\end_inset
+font-state
+\begin_inset Quotes erd
+\end_inset
+, will return information about the internal state of LyX, while other will
+ return an empty data-response.
+ This means that the command execution went fine.
\end_layout
-\begin_layout Subsection
-Configuring and using specific viewers
+\begin_layout Standard
+In case of errors, the response from LyX will have this form
\end_layout
-\begin_layout Subsubsection*
-Xdvi (all platforms)
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
\end_layout
\begin_layout Standard
-If you use
-\begin_inset Flex CharStyle:Code
-status collapsed
+where the
+\emph on
+error message
+\emph default
+ should contain an explanation of why the command failed.
+\end_layout
-\begin_layout Plain Layout
-xdvi
+\begin_layout Standard
+Examples:
\end_layout
+\begin_layout LyX-Code
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
+\begin_inset Newline newline
+\end_inset
+
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+\begin_inset Newline newline
\end_inset
-, you don't need to do anything else for performing a reverse DVI search,
- as LyX already provides the necessary hooks for automatically using the
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
+\end_inset
-\begin_layout Plain Layout
-lyxclient
+echo $a
\end_layout
-\end_inset
-
- program.
- Just setup your document as described above (reverse search is triggered
- by Ctrl-click or Alt-click on Mac OSX, respectively).
+\begin_layout Section
+Notification
\end_layout
\begin_layout Standard
-However, if for whatever reason you want to use the named pipe instead of
- the socket for communicating with LyX, simply change the DVI viewer in
-
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats
-\end_layout
+LyX can notify clients of events going on asynchronously.
+ Currently it will only do this if the user binds a key sequence with the
+ function
+\begin_inset Quotes eld
+\end_inset
+notify
+\begin_inset Quotes erd
\end_inset
- to
-\begin_inset Foot
-status collapsed
+.
+ The format of the string LyX sends is as follows:
+\end_layout
-\begin_layout Plain Layout
-On Mac OSX you have to use
-\begin_inset Flex CharStyle:Code
+\begin_layout Quote
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
+NOTIFY:
\end_layout
\end_inset
+\emph on
+key-sequence
+\end_layout
+
+\begin_layout Standard
+where
+\emph on
+key-sequence
+\emph default
+ is the printed representation of the key sequence that was actually typed
+ by the user.
\end_layout
+\begin_layout Standard
+This mechanism can be used to extend LyX's command set and implement macros.
+ Bind some key sequence to
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+notify
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-xdvi -editor 'lyxeditor.sh %f %l'
+.
+ Then start a client that listens on the output pipe, dispatches the command
+ according to the sequence, and starts a function that may use LyX calls
+ and LyX requests to issue a command or a series of commands to LyX.
\end_layout
-\end_inset
+\begin_layout Section
+The simple LyX Server Protocol
+\end_layout
-, where
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Standard
+LyX implements a simple protocol that can be used for session management.
+ All messages are of the form
+\end_layout
-\begin_layout Plain Layout
-lyxeditor.sh
+\begin_layout Quote
+LYXSRV:
+\emph on
+clientname
+\emph default
+:
+\emph on
+protocol message
\end_layout
+\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
+\begin_inset Quotes eld
\end_inset
- is a suitable script.
- For example, a minimal shell script is the following one:
-\end_layout
+hello
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-#!/bin/sh
-\begin_inset Newline newline
+ or
+\begin_inset Quotes eld
\end_inset
-LYXPIPE="/path/to/lyxpipe"
-\begin_inset Newline newline
+bye
+\begin_inset Quotes erd
\end_inset
-COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
-\begin_inset Newline newline
+.
+ If
+\begin_inset Quotes eld
\end_inset
-echo "$COMMAND" > "${LYXPIPE}".in || exit
-\begin_inset Newline newline
+hello
+\begin_inset Quotes erd
\end_inset
-read < "${LYXPIPE}".out || exit
-\end_layout
+ is received from a client, LyX will report back to inform the client that
+ it's listening to it's messages, while
+\begin_inset Quotes eld
+\end_inset
+
+bye
+\begin_inset Quotes erd
+\end_inset
+
+ sent from LyX will inform clients that LyX is closing.
+\end_layout
+
+\begin_layout Section
+Reverse DVI/PDF search
+\end_layout
\begin_layout Standard
-where
-\begin_inset Flex CharStyle:Code
+Some DVI/PDF viewers
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-/path/to/lyxpipe
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
+ Skim on Mac OSX and SumatraPDF on Windows.
\end_layout
\end_inset
- is the Ly
-\begin_inset ERT
+ provide
+\emph on
+reverse search
+\emph default
+ facility (also called
+\emph on
+inverse search
+\emph default
+).
+ This means that you can tell LyX to put the cursor to a specific line in
+ the document by clicking at the respective position in the DVI/PDF output.
+ To achieve this, the viewer must be able to communicate with LyX.
+ This is done via the LyX server either by using the named pipe (
+\emph on
+lyxpipe
+\emph default
+), or the UNIX domain socket (
+\emph on
+lyxsocket
+\emph default
+) that LyX creates in its temporary directory (this is the way the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+lyxclient
\end_layout
\end_inset
-XServer pipe path specified in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-Paths
+ program communicates with LyX).
+ In some cases, you need a helper script that mediates between the viewer
+ and LyX, in others, the viewer can communicate with LyX directly.
+ This depends on the selected viewer and on your operating system.
+ The same applies to the way viewers need to be configured and the way the
+ reverse search is actually performed.
+ In what follows, we will thus describe how to setup reverse search for
+ specific viewers.
+ Before we turn to this, though, we will explain what needs to be done generally
+ to enable reverse search in the DVI/PDF output.
\end_layout
+\begin_layout Subsection
+Automatic setup
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:rev-search"
+
\end_inset
-.
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-In the
-\begin_inset Flex CharStyle:Code
+\end_layout
+
+\begin_layout Standard
+In most cases LyX will do the work for you by enabling the option
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-development/tools
+Synchronize with Output
\end_layout
\end_inset
- folder of a source distribution you can find a
-\begin_inset Flex CharStyle:Code
+ in the menu
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxeditor
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output
\end_layout
\end_inset
- script which is able to locate the
-\emph on
-lyxpipe
-\emph default
- based on your preferences.
+.
+ In such a case LyX will automatically insert the necessary SyncTeX macro
+ (for PDF) or load the srcltx package (for DVI) respectively.
+ This option can be easily reached also on
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+View/Update
\end_layout
\end_inset
-
-\end_layout
-
-\begin_layout Subsubsection*
-MacDviX (Mac OSX)
+ Toolbar.
\end_layout
\begin_layout Standard
-At the end of
-\begin_inset Flex CharStyle:Code
+If you need a different setting, you can select or input a custom macro
+ from the drop down box just below
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-/Applications/MacDviX_Folder/calleditor.script
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Synchronize with Output
\end_layout
\end_inset
-, add the following lines:
+.
\end_layout
-\begin_layout LyX-Code
-/Applications/Ly
-\begin_inset ERT
+\begin_layout Standard
+Note that the method
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-{}
+\backslash
+synctex=1
\end_layout
\end_inset
-X.app/Contents/MacOS/lyxeditor "$2" $1
-\begin_inset Newline newline
-\end_inset
+ enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
+status collapsed
-exit 1
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
-Modify the lines accordingly if you install LyX somewhere else than in the
- Applications folder.
+\backslash
+synctex=-1
\end_layout
-\begin_layout Standard
-Reverse search is triggered by Alt-click (OPTION-click).
-\end_layout
+\end_inset
-\begin_layout Subsubsection*
-Skim (Mac OSX)
+.
\end_layout
\begin_layout Standard
-Enter
-\begin_inset Flex CharStyle:Code
+Please aöso note that including the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-open -a Skim.app $$i
+srcltx
\end_layout
\end_inset
- to the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+ package or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+src-specials
\end_layout
\end_inset
-, and then in
-\begin_inset Flex CharStyle:MenuItem
+ sometimes has an undesired impact on the typesetting.
+ Thus, you should switch output synchronization off for the final typesetting
+ if you use the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Skim\SpecialChar \menuseparator
-Preferences\SpecialChar \menuseparator
-Sync
+srcltx
\end_layout
\end_inset
- select Ly
-\begin_inset ERT
+ package or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+src-specials
\end_layout
\end_inset
-X.
+.
+
\end_layout
\begin_layout Standard
-Reverse search is triggered by COMMAND-SHIFT-click
-\end_layout
-
-\begin_layout Subsubsection*
-Okular (KDE)
-\end_layout
+In case you need some more special settings that are not covered by the
+ automatic settings, read the next section about how to set up output synchroniz
+ation manually.
+ If the automatic setup suits your needs, you can readily jump to section
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-Go to
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-\begin_layout Plain Layout
-Settings\SpecialChar \menuseparator
-Configure Okular\SpecialChar \ldots{}
-\SpecialChar \menuseparator
-Editor
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:configuring-viewers"
\end_inset
-, select
-\begin_inset Quotes eld
-\end_inset
+, where the necessary configuration steps in your viewer -- needed both
+ with the automatic and the manual setup -- are described.
+\end_layout
-Custom Text Editor
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Manual setup
+\end_layout
- and add the command
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient -g %f %l
+latex/pdflatex
\end_layout
\end_inset
-.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by SHIFT-click.
+ program, some are provided by external packages.
+ Your choice depends on whether your LaTeX distribution already provides
+ a given method (the built-in methods are rather new) and whether your viewer
+ can cope with it.
+ The available methods are described in the following.
\end_layout
\begin_layout Subsubsection*
-YAP (Windows)
+Built-in DVI-search via src-specials (DVI only)
\end_layout
\begin_layout Standard
-Launch yap, choose its
-\begin_inset Flex CharStyle:MenuItem
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in LaTeX since quite some time (any somewhat recent LaTeX
+ distribution should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Options
-\end_layout
-
-\end_inset
+LaT
+\begin_inset ERT
+status collapsed
- menu and select the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
+{}
+\end_layout
- tab.
- Click on the
-\begin_inset Quotes eld
\end_inset
-New\SpecialChar \ldots{}
+eX (plain)->DVI
+\end_layout
-\begin_inset Quotes erd
\end_inset
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
+ or
+\begin_inset Flex MenuItem
+status collapsed
-LyX Editor
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-Name:
-\begin_inset Quotes erd
-\end_inset
+{}
+\end_layout
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
\end_inset
-\SpecialChar \ldots{}
+eX (plain)->DraftDVI
+\end_layout
-\begin_inset Quotes erd
\end_inset
- to open a file dialog and navigate to the directory containing the batch
- file
-\begin_inset Flex CharStyle:Code
+ converter in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
\end_inset
- (see below).
- Select
-\begin_inset Flex CharStyle:Code
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+latex -src-specials $$i
\end_layout
\end_inset
- and then specify the program arguments as
-\begin_inset Flex CharStyle:Code
-status collapsed
+.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
+\end_layout
-\begin_layout Plain Layout
-%f %l
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
\end_layout
-\end_inset
+\begin_layout Standard
+The packages
+\emph on
+pdfsync
+\emph default
+ and
+\emph on
+scrltx
+\emph default
+ provide reverse search facility for PDF output (via pdflatex) and DVI output,
+ respectively.
+ In order to enable it, load the packages in the LyX preamble:
+\end_layout
-.
- The
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+
+\backslash
+usepackage{pdfsync}
\end_layout
\end_inset
- wrapper is used for communicating with LyX through the
-\emph on
-lyxpipe
-\emph default
- and is as follows:
+ for reverse PDF search,
\end_layout
-\begin_layout LyX-Code
-@echo off
-\begin_inset Newline newline
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex Code
+status collapsed
-echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
-\backslash
+\begin_layout Plain Layout
\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.in
-\begin_inset Newline newline
-\end_inset
+usepackage[active]{srcltx}
+\end_layout
-type
-\backslash
+\end_inset
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.out
+ for reverse DVI search.
\end_layout
\begin_layout Standard
-Make sure that the LyXServer pipe path you specified in LyX is
-\begin_inset Flex CharStyle:Code
-status collapsed
+If you want to be able to perform both DVI and PDF reverse searches, you
+ can also insert in the preamble the following lines
+\end_layout
-\begin_layout Plain Layout
+\begin_layout LyX-Code
\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
+\end_inset
+
\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe
-\end_layout
+ifpdf
+\begin_inset Newline newline
+\end_inset
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
\end_inset
-, otherwise change the
-\begin_inset Flex CharStyle:Code
-status collapsed
-\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
+\backslash
+else
+\begin_inset Newline newline
+\end_inset
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
\end_inset
- wrapper accordingly.
- You are advised to select in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-Paths
+\backslash
+fi
\end_layout
-\end_inset
-
- a temporary directory whose name does not contain spaces, otherwise inverse
- search will fail.
+\begin_layout Standard
+This way, you can preview the file as either DVI or PDF (pdflatex) and the
+ right package will be used.
\end_layout
\begin_layout Standard
-In yap, reverse search is triggered by double-click.
+Note that PDFSync might affect the output layout of your document.
+ It is therefore advised to disable PDFsync for final documents.
\end_layout
\begin_layout Subsubsection*
-SumatraPDF (Windows)
+Built-in reverse search via SyncTeX (DVI and PDF)
\end_layout
\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+Recent versions of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SumatraPDF -inverse-search "lyxeditor.bat %f %l"
+(pdf)latex
\end_layout
\end_inset
- in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+SyncTeX
+\emph default
+ facility is basically the result of the integration of the PDFSync package
+ to the pdftex program and its merge with the
+\emph on
+scr-specials
+\emph default
+ approach.
+ You need at least TeXLive 2008 or a recent MikTeX distribution in order
+ to use it.
+ Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
+ already provide SyncTeX support.
\end_layout
-\end_inset
+\begin_layout Standard
+To enable SyncTeX for DVI output, change the
+\begin_inset Flex MenuItem
+status collapsed
-, where
-\begin_inset Flex CharStyle:Code
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+
+{}
\end_layout
\end_inset
- is the previous wrapper.
- If SumatraPDF.exe is not in your command PATH, use its full file name.
- Again, make sure that the LyX temporary directory name does not contain
- spaces, otherwise inverse search will fail.
+eX (plain) -> DVI
\end_layout
-\begin_layout Standard
-Reverse search is triggered by double-click.
-\end_layout
+\end_inset
-\begin_layout Subsubsection*
-YAP (Cygwin)
-\end_layout
+ or
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-First of all, make sure that yap is your default DVI viewer in the Windows
- environment, then launch it, choose its
-\begin_inset Flex CharStyle:MenuItem
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Options
+
+{}
\end_layout
\end_inset
- menu and select the
-\begin_inset Quotes eld
-\end_inset
+eX (plain) -> DraftDVI
+\end_layout
-Inverse DVI Search
-\begin_inset Quotes erd
\end_inset
- tab.
- Click on the
-\begin_inset Quotes eld
-\end_inset
+ converter in
+\begin_inset Flex MenuItem
+status collapsed
-New\SpecialChar \ldots{}
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
+\end_layout
-\begin_inset Quotes erd
\end_inset
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
+ to
+\begin_inset Flex Code
+status collapsed
-LyX Editor
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+latex -synctex=1 $$i
+\end_layout
- (or any other name you like) in the
-\begin_inset Quotes eld
\end_inset
-Name:
-\begin_inset Quotes erd
-\end_inset
+, and for PDF output, change the
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
+\end_layout
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
\end_inset
-\SpecialChar \ldots{}
+eX (pdflatex) -> PDF (pdflatex)
+\end_layout
-\begin_inset Quotes erd
\end_inset
- to open a file dialog and navigate to the directory containing the
-\begin_inset Flex CharStyle:Code
+ or converter to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+pdflatex -synctex=1 $$i
\end_layout
\end_inset
- program.
- Select
-\begin_inset Flex CharStyle:Code
+.
+ Check the documentation of your viewer whether the viewer needs to be configure
+d for the use with SyncTeX.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that the option
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+-synctex=1
\end_layout
\end_inset
- and then specify the program arguments as as
-\begin_inset Flex CharStyle:Code
+ option enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--g %f %l
+-synctex=-1
\end_layout
\end_inset
.
- In this way, you will be using the
-\emph on
-lyxsocket
-\emph default
- for communicating with LyX.
- If, for whatever reason, you want to use the
-\emph on
-lyxpipe
-\emph default
-, select
-\begin_inset Flex CharStyle:Code
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Configuring and using specific viewers
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:configuring-viewers"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection*
+Xdvi (all platforms)
+\end_layout
+
+\begin_layout Standard
+If you use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-bash.exe
+xdvi
\end_layout
\end_inset
- instead of
-\begin_inset Flex CharStyle:Code
+, you don't need to do anything else for performing a reverse DVI search,
+ as LyX already provides the necessary hooks for automatically using the
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+lyxclient
\end_layout
\end_inset
- and specify
-\begin_inset Flex CharStyle:Code
+ program.
+ Just setup your document as described above (reverse search is triggered
+ by Ctrl-click or Alt-click on Mac OSX, respectively).
+\end_layout
+
+\begin_layout Standard
+However, if for whatever reason you want to use the named pipe instead of
+ the socket for communicating with LyX, simply change the DVI viewer in
+
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
--c 'lyxeditor.sh "%f" %l'
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats
\end_layout
\end_inset
- as program arguments (here, don't forget the double quotes around
-\begin_inset Flex CharStyle:Code
+ to
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+On Mac OSX you have to use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%f
+DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
\end_inset
- as they are essential), where
-\begin_inset Flex CharStyle:Code
+
+\end_layout
+
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.sh
+xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
\end_inset
- is the previously introduced shell script (make sure that
-\begin_inset Flex CharStyle:Code
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- is in the bash command PATH, otherwise use its full posix name).
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
-\begin_layout Standard
-In yap, reverse search is triggered by double-click.
-\end_layout
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsubsection*
-SumatraPDF (Cygwin)
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
+\end_inset
+
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
+\end_inset
+
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
+\end_inset
+
+read < "${LYXPIPE}".out || exit
\end_layout
\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+/path/to/lyxpipe
\end_layout
\end_inset
- in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+ is the Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+
+{}
\end_layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+XServer pipe path specified in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
\end_inset
- is the following script (to be placed in your command PATH,
-\begin_inset Flex CharStyle:Code
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/usr/local/bin
+development/tools
\end_layout
\end_inset
- being the best choice):
+ folder of a source distribution you can find a
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor
\end_layout
-\begin_layout LyX-Code
-#!/bin/bash
-\begin_inset Newline newline
\end_inset
-cd $(dirname $1)
-\begin_inset Newline newline
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
+\end_layout
+
\end_inset
-SumatraPDF -inverse-search "lyxclient -g %f %l" $(basename $1)
+
+\end_layout
+
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
\end_layout
\begin_layout Standard
-This is needed because SumatraPDF is a native Windows application and does
- not understand the posix paths used by the Cygwin version of LyX.
- If SumatraPDF is not in your command PATH, use its full posix path in the
- script above.
- Again, if you want to use the
-\emph on
-lyxpipe
-\emph default
- instead of the
-\emph on
-lyxsocket
-\emph default
-, replace
-\begin_inset Flex CharStyle:Code
+At the end of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-"lyxclient -g %f %l"
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
\end_inset
- with
-\begin_inset Flex CharStyle:Code
+, add the following lines:
+\end_layout
+
+\begin_layout LyX-Code
+/Applications/Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-"bash -c 'lyxeditor.sh
-\backslash
-"%f
-\backslash
-" %l'"
+
+{}
\end_layout
\end_inset
-.
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
+
+exit 1
\end_layout
\begin_layout Standard
-Reverse search is triggered by double-click.
+Modify the lines accordingly if you install LyX somewhere else than in the
+ Applications folder.
\end_layout
-\begin_layout Chapter
-Special Document Classes
+\begin_layout Standard
+Reverse search is triggered by Alt-click (OPTION-click).
\end_layout
-\begin_layout Section
-A&A Paper
+\begin_layout Subsubsection*
+Skim (Mac OSX)
\end_layout
\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
+Enter
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Introduction
+\begin_layout Plain Layout
+open -a Skim.app $$i
\end_layout
-\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (www.edpsciences.fr/aa/
-\begin_inset Flex URL
+\end_inset
+
+ to the viewer setting in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
+\end_layout
-http://www.edpsciences.fr/aa/
+\end_inset
+
+, and then in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Skim\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Sync
\end_layout
\end_inset
-) using Version 5.01 of the document class
-\family typewriter
-aa.cls
-\family default
-.
- This package can be downloaded from the ftp site
+ select Ly
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+X.
+\end_layout
+
+\begin_layout Standard
+Reverse search is triggered by COMMAND-SHIFT-click
+\end_layout
+\begin_layout Subsubsection*
+Okular (KDE)
\end_layout
\begin_layout Standard
-\align center
-\begin_inset Flex URL
+Go to
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-ftp://ftp.edpsciences.org/pub/aa/readme.html
+Settings\SpecialChar \menuseparator
+Configure Okular\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Editor
\end_layout
\end_inset
+, select
+\begin_inset Quotes eld
+\end_inset
+
+Custom Text Editor
+\begin_inset Quotes erd
+\end_inset
+
+ and add the command
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxclient -g %f %l
\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.
-
+Reverse search is triggered by SHIFT-click.
\end_layout
-\begin_layout Standard
-Please note that the publisher of the journal was changed from Springer
- to EDP Sciences starting January 1, 2001.
- That change implicated also some slight changes of the style files, namely
- the removal of the thesaurus command.
- The LyX class aa supports the newest version of these style files, V 5.01.
- If you have an older version installed, please upgrade.
- For compatibility, the old (version 4) layout has been kept as
-\family sans
-article (A&A V4)
-\family default
-.
- Please refer to the comments in
-\family typewriter
-LyXDir/layouts/aapaper.layout
-\family default
-.
-\end_layout
-
-\begin_layout Subsection
-Getting started
+\begin_layout Subsubsection*
+YAP (Windows)
\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
+Launch yap, choose its
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog (OK, that one was obvious).
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
\end_layout
-\begin_layout Itemize
-Don't change the option
-\family sans
-Page
-\begin_inset space ~
\end_inset
-style
-\family default
-: Leave it set to
-\family sans
-default
-\family default
-.
- The whole layout is done by the macros, you shouldn't change anything.
-\end_layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-The header block
-\end_layout
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
-\end_layout
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+New\SpecialChar \ldots{}
-\family sans
-Title
-\family default
-: [required]
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Subtitle
-\family default
-: [optional]
-\end_layout
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Author
-\family default
-: [required]
-\end_layout
+Name:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Address
-\family default
-: [required]
-\end_layout
+\SpecialChar \ldots{}
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
+ (see below).
+ Select
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+%f %l
\end_layout
-\begin_layout Standard
-There is no need to issue the
-\family typewriter
+\end_inset
-\backslash
-maketitle
-\family default
- command, this is done automatically by LyX when the header is finished.
- Although the order of the single header entries doesn't matter it is advised
- to keep the above sequence, just to get the best optics and meets the layout
- of the real document.
+.
+ The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-If you want to place footnotes in the header block, e.
-\begin_inset space \thinspace{}
\end_inset
-g.
-\begin_inset space \space{}
+ wrapper is used for communicating with LyX through the
+\emph on
+lyxpipe
+\emph default
+ and is as follows:
+\end_layout
+
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
\end_inset
-to state your present address, just use the standard footnote via the menu
-
-\family sans
-Insert\SpecialChar \menuseparator
-Footnote.
+echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
+\backslash
-\family default
- LyX will automagically use the term
-\family typewriter
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.in
+\begin_inset Newline newline
+\end_inset
+type
\backslash
-thanks{}
-\family default
- in that case.
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.out
\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
+Make sure that the LyXServer pipe path you specified in LyX is
+\begin_inset Flex Code
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
-\family typewriter
+\backslash
\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+.
+\backslash
+pipe
+\backslash
+lyxpipe
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+, otherwise change the
+\begin_inset Flex Code
+status collapsed
-\backslash
-inst{<nr>}
-\family default
-to mark corresponding author/institute pairs.
- The institutes are numbered sequentially as they appear in the
-\family sans
-Address
-\family default
- field, so you have to put a marker to each author.
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
-
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
-\end_layout
+ wrapper accordingly.
+\end_layout
\begin_layout Standard
-In all cases, the appropriate command has to be entered in LyX and marked
- as LaTeX code.
- See the examples.
-
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Subsection
-The abstract
+\begin_layout Subsubsection*
+SumatraPDF (Windows)
\end_layout
\begin_layout Standard
-The abstract should immediately follow the header block.
- With version 5 the abstract environment was changed to a command, and there
- is now a resctriction to only one paragraph.
- In addition, it should contain an entry with the keywords.
- This is not yet implemented for LyX, therefore you have to enter the LaTeX
- command
-\family typewriter
-
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
-\end_layout
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Supported environments
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat %f %l"
\end_layout
-\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
-\end_layout
+\end_inset
-\begin_layout Itemize
+ in the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
-\family sans
-Standard
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Section
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsection
+ is the previous wrapper.
+ If SumatraPDF.exe is not in your command PATH, use its full file name.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
-\family sans
-Subsubsection
+\begin_layout Subsubsection*
+YAP (Cygwin)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+First of all, make sure that yap is your default DVI viewer in the Windows
+ environment, then launch it, choose its
+\begin_inset Flex MenuItem
+status collapsed
-\family sans
-Itemize
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Enumerate
-\end_layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Description
-\end_layout
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+New\SpecialChar \ldots{}
-\family sans
-Caption
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Abstract
-\end_layout
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Acknowledgment
-\end_layout
+Name:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Bibliography
-\end_layout
+\SpecialChar \ldots{}
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-LaTeX
-\end_layout
+ to open a file dialog and navigate to the directory containing the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Commands not supported by LyX
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Standard
-Some commands are not yet supported by the
-\family sans
-paper (A&A)
-\family default
- layout for LyX.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
+\end_inset
+
+ program (which is installed by default on Cygwin along with the LyX executable).
+ Select
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.exe
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-\backslash
-and
+\begin_layout Plain Layout
+-g %f %l
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+.
+ In this way, you will be using the
+\emph on
+lyxsocket
+\emph default
+ for communicating with LyX.
+ If, for whatever reason, you want to use the
+\emph on
+lyxpipe
+\emph default
+, omit the
+\begin_inset Flex Code
+status collapsed
-\backslash
-email
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ option and be sure to specify the LyXServer pipe path in the LyX preferences.
+\end_layout
-\backslash
-appendix
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
-\family typewriter
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\backslash
-authorrunning
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor -g %f %l"
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ in the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
-\backslash
-inst{}
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path.
+ The
+\begin_inset Flex Code
+status collapsed
-\backslash
-keywords{}
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+ enables communication via the
+\emph on
+lyxsocket
+\emph default
+.
+ Again, omit the
+\begin_inset Flex Code
+status collapsed
-\backslash
-object{}
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-titlerunning{}
+ option if you want to use the
+\emph on
+lyxpipe
+\emph default
+, and be sure to specify the LyXServer pipe path in the LyX preferences.
\end_layout
\begin_layout Standard
-If you want to use any of these commands, you have to enter them yourself.
-
-\series bold
-Do not forget to mark them as LaTeX code!
+Reverse search is triggered by double-click.
\end_layout
-\begin_layout Subsection
-Figure and Table Floats
+\begin_layout Section
+Forward search
\end_layout
\begin_layout Standard
-LyX provides support for the necessary float environments
-\family sans
-figure, figure*, table
-\family default
- and
-\family sans
-table*
-\family default
-, therefore we won't tell much about it here.
- Refer to the
-\emph on
-User's
-\begin_inset space ~
+Forward search is, as the name implies, in a sense the
+\begin_inset Quotes eld
\end_inset
-Guide
-\emph default
-.
- Just remember that tables should be left-aligned.
- For that, select the table and change the alignment in
-\family sans
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
+opposite
+\begin_inset Quotes erd
\end_inset
-Settings.
+ of reverse search.
+ It allows you to let the viewer jump to a given position from within LyX.
+ If forward search is set up (as described in what follows), you can put
+ the cursor anywhere in your LyX document, and hit
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Navigate\SpecialChar \menuseparator
+Forward search
\end_layout
-\begin_layout Standard
-There is only one special thing: the figures with caption besides the figure.
- To create such a figure, you have to do the following:
+\end_inset
+
+ (or select
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Forward search
\end_layout
-\begin_layout Enumerate
-Create a wide figure float:
-\family sans
-Insert\SpecialChar \menuseparator
-Float\SpecialChar \menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
-\bar under
-S
-\bar default
-pan
-\begin_inset space ~
\end_inset
-columns
-\family default
+ in the context menu via right mouse click), and then the viewer will jump
+ to that position as well.
+ This implies, of course, that your viewer supports this function.
+\end_layout
+
+\begin_layout Standard
+To make forward search possible, you first need to provide the generated
+ output PDF/DVI file with additional information about the TeX sources.
+ This can be done via the methods described in the section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:rev-search"
+
+\end_inset
+
.
\end_layout
-\begin_layout Enumerate
-Enter your caption text.
+\begin_layout Standard
+Additionally, you need to configure LyX for using your viewers in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+General
\end_layout
-\begin_layout Enumerate
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
+\end_inset
+
+.
+ We provide a range of tested configurations for some viewers, which you
+ can select from the drop down list.
+ If none of these configurations suits you, you have to find out and enter
+ a suitable configuration yourself.
+ The definition syntax uses the following placeholders:
\end_layout
-\begin_layout Enumerate
-Insert your figure
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$n
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-Insert\SpecialChar \menuseparator
-Special
-\begin_inset space ~
\end_inset
-Character\SpecialChar \menuseparator
-Horizontal
-\begin_inset space ~
-\end_inset
+: row number
+\end_layout
-Fill
-\family default
-.
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$$t
\end_layout
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c
-\begin_inset space ~
\end_inset
-t
-\family default
-.
+: name of the (temporary) exported .tex file
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
+\begin_layout Itemize
+\noindent
+\begin_inset Flex Code
+status collapsed
-\backslash
-parbox[b]{55mm}{
-\family default
-.
-
-\series bold
-Do not close the brace!
+\begin_layout Plain Layout
+$$o
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the caption text, switch to LaTeX mode and insert
- the closing brace:
-\family sans
-M-c
-\begin_inset space ~
\end_inset
-t
-\family default
-
-\family typewriter
-}
-\family default
-.
+: name of the exported output file (either dvi or pdf, depending on which
+ one exists in the temporary directory)
\end_layout
\begin_layout Standard
-Also, refer to the figures in the example paper.
+Note that only some of the viewers provide full forward search functionality,
+ among them yap, xdvi, okular and Sumatra PDF.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For Sumatra CMCDDE is needed --- downloadable from
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.istri.fr/zip/CMCDDE.zip"
+
+\end_inset
+
+
\end_layout
-\begin_layout Subsection
-Referee layout
+\end_inset
+
+ While many of the widespread PDF viewers (most notably Adobe Reader) do
+ not support forward search at all, some other viewers -- e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+ evince and xpdf -- allow at least to reload the document and jump to a
+ specific page of the file, so you can at least navigate
+\begin_inset Quotes eld
+\end_inset
+
+near
+\begin_inset Quotes erd
+\end_inset
+
+.
+ This latter functionality is provided by an external call of synctex (see
+ the predefined example configurations).
+
\end_layout
\begin_layout Standard
-For submission, the paper has to be formated in a special double-spacing
- layout.
- For this purpose, you have to give the option
-\family typewriter
-referee
-\family default
- to the documentclass.
- This must be done using the extra class options field in the
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
-\end_layout
+Forward search works both with DVI and PDF output.
+ LyX simply checks which preview format you have used before (i.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
-The example paper
+e., which format is already there in the temporary directory) and chooses
+ the appropriate configuration for the respective format.
\end_layout
-\begin_layout Standard
-The
-\family sans
-Examples
-\family default
- directory contains an example paper written with LyX.
- It is the example paper from the original macro package, translated to
- LyX.
- Use it for inspiration, and compare the original LaTeX code with LyX way
- of writing.
+\begin_layout Chapter
+Special Document Classes
\end_layout
\begin_layout Section
-AASTeX
+A&A Paper
\end_layout
\begin_layout Standard
by
\noun on
-Mike Ressler
+Peter Sütterlin
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-AASTeX is a set of macros produced by the American Astronomical Society
- to facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- LyX has proven to be an excellent tool for generating these documents,
- especially given its equation, citation, and figure handling capabilities.
- LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
- incompatible with LyX.
- The AASTeX package may be downloaded from the AASTeX Web site
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.edpsciences.fr/aa/
+\end_layout
+
+\end_inset
+
+) using Version 5.01 of the document class
+\family typewriter
+aa.cls
+\family default
+.
+ This package can be downloaded from the ftp site
\end_layout
\begin_layout Standard
\begin_layout Plain Layout
-http://www.journals.uchicago.edu/AAS/AASTeX
+ftp://ftp.edpsciences.org/pub/aa/readme.html
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-A complete user guide is contained in that package and you should familiarize
- yourself with it thoroughly before embarking on writing a paper in LyX.
- LyX will not reduce the need to figure out all the AASTeX commands, it
- will only reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported LaTeX document
- conforms completely to the requirements of the journal to which you are
- submitting your paper.
-\end_layout
-
-\begin_layout Subsection
-Starting a New Paper
+A manual comes together with that package, and this text is not meant to
+ replace the original manual but is merely a short guide in how to realize
+ the correct form of your paper.
+
\end_layout
\begin_layout Standard
-I strongly suggest that you start with the AASTeX template file.
- Click on
-\family sans
-File\SpecialChar \menuseparator
-New from
-\family default
-
+Please note that the publisher of the journal was changed from Springer
+ to EDP Sciences starting January 1, 2001.
+ That change involved also some slight changes to the style files, namely
+ the removal of the thesaurus command.
+ The LyX class aa supports the newest version of these style files, V 5.01.
+ If you have an older version installed, please upgrade.
+ For compatibility, the old (version 4) layout has been kept as
\family sans
-Template
-\family default
-, enter the new file name, then choose the
-\family typewriter
-aastex.lyx
-\family default
- template.
- This will show the most common fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
-\family typewriter
-<>
-\family default
-) with the correct information.
- Many of the AASTeX commands and environments can be implemented directly
- in LyX, but some cannot: most noticeably
-\family typewriter
-
-\backslash
-altaffilmark
+article (A&A V4)
\family default
- and
+.
+ Please refer to the comments in
\family typewriter
-
-\backslash
-altaffiltext
+LyXDir/layouts/aapaper.layout
\family default
-, which should stick out like a sore thumb if you actually just opened the
- template file.
- For commands such as these, the LaTeX code must be entered directly and
- marked as such.
- Such commands are referred to as TeX code, or Evil Red Text.
- I tried to minimize the amount of TeX code needed in an AASTeX document,
- but there is still a bit more required than any of us would like.
+.
\end_layout
\begin_layout Subsection
-Finishing Your Paper
+Getting started
\end_layout
\begin_layout Standard
-When the paper is finished to your satisfaction and previews/prints correctly,
- there are a few
-\begin_inset Quotes eld
-\end_inset
-
-postprocessing
-\begin_inset Quotes erd
-\end_inset
-
- actions which need to be done before you submit it to the journals.
-
+It is recommended you start from the example template distributed with LyX.
+ If you are not using a template, note the following settings:
\end_layout
-\begin_layout Enumerate
-Export your paper as a LaTeX file (
+\begin_layout Itemize
+Select
\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
+article (A&A)
\family default
-).
-
+ in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog (OK, that one was obvious).
\end_layout
-\begin_layout Enumerate
-Edit the resulting
-\family typewriter
-.tex
+\begin_layout Itemize
+Don't change the option
+\family sans
+Page
+\begin_inset space ~
+\end_inset
+
+style
\family default
- file with your favorite text editor
+: Leave it set to
+\family sans
+default
+\family default
+.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
-\family typewriter
+\begin_layout Subsection
+The header block
+\end_layout
-\backslash
-documentclass
-\family default
- command
+\begin_layout Standard
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
\end_layout
-\begin_layout Enumerate
-remove the
-\family typewriter
+\begin_layout Itemize
-\backslash
-usepackage...{fontenc}
+\family sans
+Title
\family default
- line if it appears (usually just after
-\family typewriter
+: [required]
+\end_layout
-\backslash
-documentclass
-\family default
-}; also remove the
-\family typewriter
+\begin_layout Itemize
-\backslash
-secnumdepth
+\family sans
+Subtitle
\family default
- line if it appears.
+: [optional]
\end_layout
-\begin_layout Enumerate
-remove everything between (and including) the
-\family typewriter
+\begin_layout Itemize
-\backslash
-makeatletter
+\family sans
+Author
\family default
- and
-\family typewriter
+: [required]
+\end_layout
-\backslash
-makeatother
+\begin_layout Itemize
+
+\family sans
+Address
\family default
- commands, except for any commands you specifically put into the LaTeX preamble
- (which should appear immediately after the
-\begin_inset Quotes eld
-\end_inset
+: [required]
+\end_layout
-User specified LaTeX commands
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- comment in the
-\family typewriter
-.tex
+\family sans
+Offprints
\family default
- file).
+: [optional] if more than one author: whom to contact for offprint requests.
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
-\end_layout
+\begin_layout Itemize
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+\family sans
+Mail
+\family default
+: [optional] mail address for contacts.
\end_layout
-\begin_layout Enumerate
-Submit it.
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsection
-Comments On Specific Commands
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
\end_layout
\begin_layout Standard
-I will not describe the detailed usage of the individual AASTeX commands:
- the AASTeX User Guide (
+There is no need to issue the
\family typewriter
-aasguide.tex
-\family default
-) gives a good description of each.
- Thus it's probably easiest for me to go down the list as found in the guide
- and offer comments where necessary.
- So let's begin \SpecialChar \ldots{}
-\end_layout
-
-\begin_layout Subsubsection
-Things that work as expected
+\backslash
+maketitle
+\family default
+ command, this is done automatically by LyX when the header is finished.
+ Although the order of the single header entries doesn't matter it is advised
+ to keep the above sequence, just to get the best optics and meets the layout
+ of the real document.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Plain Layout
+g.
+\begin_inset space \space{}
+\end_inset
+to state your present address, just use the standard footnote via the menu
+
+\family sans
+Insert\SpecialChar \menuseparator
+Footnote.
+
+\family default
+ LyX will automagically use the term
+\family typewriter
\backslash
-begin{sloppypar}
+thanks{}
+\family default
+ in that case.
\end_layout
-\end_inset
-
-
+\begin_layout Standard
+In addition to these topics, the macros use three additional LaTeX commands
+ that have no counterpart in LyX:
\end_layout
-\begin_layout Standard
-Because they work as you might expect, I simply list them and the section
- they are found in:
-\family typewriter
+\begin_layout Itemize
-\backslash
-documentclass
-\family default
- (2.1.1),
\family typewriter
\backslash
-begin{document}
+and
\family default
- (2.2),
-\family typewriter
+ to separate different names for more than one author and institute, respectivel
+y.
+\end_layout
-\backslash
-title
-\family default
- (2.3),
-\family typewriter
+\begin_layout Itemize
-\backslash
-author
-\family default
- (2.3),
\family typewriter
\backslash
-affil
+inst{<nr>}
\family default
- (2.3),
-\family typewriter
-
-\backslash
-abstract
+to mark corresponding author/institute pairs.
+ The institutes are numbered sequentially as they appear in the
+\family sans
+Address
\family default
- (2.4),
-\family typewriter
+ field, so you have to put a marker to each author.
+\end_layout
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
+\begin_layout Itemize
-\backslash
-section
-\family default
- (2.7),
\family typewriter
\backslash
-subsection
+email{address}
\family default
- (2.7),
-\family typewriter
+ to supply an email address for fast contact.
+\end_layout
-\backslash
-subsubsection
-\family default
- (2.7),
-\family typewriter
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
+
+\end_layout
-\backslash
-paragraph
-\family default
- (2.7),
-\family typewriter
+\begin_layout Subsection
+The abstract
+\end_layout
-\backslash
-facility
-\family default
- (2.10),
+\begin_layout Standard
+The abstract should immediately follow the header block.
+ With version 5 the abstract environment was changed to a command, and there
+ is now a resctriction to only one paragraph.
+ In addition, it should contain an entry with the keywords.
+ This is not yet implemented for LyX, therefore you have to enter the LaTeX
+ command
\family typewriter
\backslash
-begin{displaymath}
+keywords{}
\family default
- (2.12),
-\family typewriter
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
+\end_layout
-\backslash
-begin{equation}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Subsection
+Supported environments
+\end_layout
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Standard
+The A&A paper layout supports the following environments for structuring
+ your text:
+\end_layout
-\backslash
-begin{mathletters}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{thebibliography}
-\family default
- (2.13.1),
-\family typewriter
+\family sans
+Standard
+\end_layout
-\backslash
-bibitem
-\family default
- (2.13.2), all the cite commands and their variations (2.13.2), the generic
- graphicx figure commands (2.14.1),
-\family typewriter
+\begin_layout Itemize
-\backslash
-begin{table}
-\family default
- (2.15.4),
-\family typewriter
+\family sans
+Section
+\end_layout
-\backslash
-begin{tabular}
-\family default
- (2.15.4),
-\family typewriter
+\begin_layout Itemize
-\backslash
-caption
-\family default
- (2.15.4),
-\family typewriter
+\family sans
+Subsection
+\end_layout
-\backslash
-label
-\family default
- (2.15.4, amongst other places),
-\family typewriter
+\begin_layout Itemize
-\backslash
-tablerefs
-\family default
- (2.15.5),
-\family typewriter
+\family sans
+Subsubsection
+\end_layout
-\backslash
-tablecomments
-\family default
- (2.15.5),
-\family typewriter
+\begin_layout Itemize
-\backslash
-url
-\family default
- (2.17.4),
-\family typewriter
+\family sans
+Itemize
+\end_layout
-\backslash
-end{document}
-\family default
- (2.18).
+\begin_layout Itemize
+
+\family sans
+Enumerate
\end_layout
-\begin_layout Standard
-The following style options also work correctly:
-\family typewriter
-longabstract
-\family default
- (2.4),
-\family typewriter
-preprint
-\family default
- (3.2.1),
-\family typewriter
-preprint2
-\family default
- (3.2.2),
-\family typewriter
-eqsecnum
-\family default
- (3.3),
-\family typewriter
-flushrt
-\family default
- (3.4).
- Simply put them in the
+\begin_layout Itemize
+
\family sans
-Options
-\family default
- box in
+Description
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Layout\SpecialChar \menuseparator
-Document
-\family default
-.
+Caption
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
+\begin_layout Itemize
-\begin_layout Plain Layout
+\family sans
+Abstract
+\end_layout
+\begin_layout Itemize
-\backslash
-end{sloppypar}
+\family sans
+Acknowledgment
\end_layout
-\end_inset
+\begin_layout Itemize
+
+\family sans
+Bibliography
+\end_layout
+\begin_layout Itemize
+\family sans
+LaTeX
\end_layout
-\begin_layout Subsubsection
-Things that work, but require more comment
+\begin_layout Subsection
+Commands not supported by LyX
\end_layout
\begin_layout Standard
-The following items work, but require a little more discussion:
+Some commands are not yet supported by the
+\family sans
+paper (A&A)
+\family default
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
\end_layout
\begin_layout Itemize
-These items are reserved for use by the journal editors, but you can put
- them into the LaTeX preamble if you feel compelled to do so:
-\family typewriter
-\backslash
-received
-\family default
-,
\family typewriter
\backslash
-revised
-\family default
-,
-\family typewriter
+and
+\end_layout
-\backslash
-accepted
-\family default
-,
-\family typewriter
+\begin_layout Itemize
-\backslash
-ccc
-\family default
-,
\family typewriter
\backslash
-cpright
-\family default
- (all from 2.1.3)
+email
\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
-
-\backslash
-slugcomment
-\family default
- (2.1.4),
-\family typewriter
-\backslash
-shorttitle
-\family default
- (2.1.5),
\family typewriter
\backslash
-shortauthors
-\family default
- (2.1.5)
+appendix
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
-email
-\family default
- (2.3) – can only be used
-\begin_inset Quotes eld
-\end_inset
-
-standalone
-\begin_inset Quotes erd
-\end_inset
-
-, not in the middle of a paragraph.
- Use TeX code if you need to embed it.
+authorrunning
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
-and
-\family default
- (2.3) – will have extra {} after it.
- This should not cause an error.
+inst{}
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
-notetoeditor
-\family default
- (2.6) – can only be used
-\begin_inset Quotes eld
-\end_inset
-
-standalone
-\begin_inset Quotes erd
-\end_inset
-
-, not in the middle of a paragraph.
- Use TeX code if you need to embed it.
+keywords{}
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
-placetable
-\family default
- (2.8) – can't insert a cross-reference tag, you must type the tag name by
- hand
+object{}
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
-placefigure
-\family default
- (2.8) – same as for
-\family typewriter
-
-\backslash
-placetable
+titlerunning{}
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+If you want to use any of these commands, you have to enter them yourself.
+
+\series bold
+Do not forget to mark them as LaTeX code!
+\end_layout
-\family typewriter
+\begin_layout Subsection
+Figure and Table Floats
+\end_layout
-\backslash
-acknowledgements
+\begin_layout Standard
+LyX provides support for the necessary float environments
+\family sans
+figure, figure*, table
\family default
- (2.9) – will have extra {} after it.
- This should not cause an error.
+ and
+\family sans
+table*
+\family default
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's
+\begin_inset space ~
+\end_inset
+
+Guide
+\emph default
+.
+ Just remember that tables should be left-aligned.
+ For that, select the table and change the alignment in
+\family sans
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
+
+Settings.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+There is only one special thing: the figures with caption besides the figure.
+ To create such a figure, you have to do the following:
+\end_layout
-\family typewriter
+\begin_layout Enumerate
+Create a wide figure float:
+\family sans
+Insert\SpecialChar \menuseparator
+Float\SpecialChar \menuseparator
+Figure
+\family default
+, then right click in the figure and select
+\family sans
+\bar under
+S
+\bar default
+pan
+\begin_inset space ~
+\end_inset
-\backslash
-appendix
+columns
\family default
- (2.11) – will have extra {} after it.
- This should not cause an error.
+.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
+Enter your caption text.
+\end_layout
-\backslash
-figcaption
+\begin_layout Enumerate
+Press
+\family sans
+Return
\family default
- (2.14.2) – you can insert an optional filename argument by placing the cursor
- at the beginning of the text and selecting
+ to move the cursor above the caption.
+\end_layout
+
+\begin_layout Enumerate
+Insert your figure
+\end_layout
+
+\begin_layout Enumerate
+Position the cursor behind the figure and insert a horizontal fill:
\family sans
Insert\SpecialChar \menuseparator
-Short Title
-\family default
-.
-
-\begin_inset Quotes eld
+Special
+\begin_inset space ~
\end_inset
-Short Title
-\begin_inset Quotes erd
+Character\SpecialChar \menuseparator
+Horizontal
+\begin_inset space ~
\end_inset
- inserts an optional argument of the type needed by
-\family typewriter
-
-\backslash
-figcaption
+Fill
\family default
.
- Hopefully it will be renamed someday.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
+Switch to LaTeX mode:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-objectname
+t
\family default
- (2.17.1) – same as
+.
+\end_layout
+
+\begin_layout Enumerate
+Enter
\family typewriter
\backslash
-figcaption
+parbox[b]{55mm}{
\family default
- for the catalog ID optional parameter
+.
+
+\series bold
+Do not close the brace!
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
+Position the cursor behind the caption text, switch to LaTeX mode and insert
+ the closing brace:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-dataset
+t
\family default
- (2.17.1) – same as
+
\family typewriter
-
-\backslash
-figcaption
+}
\family default
- for the catalog ID optional parameter
-\end_layout
-
-\begin_layout Subsubsection
-Things not implemented, use TeX code
+.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{sloppypar}
+Also, refer to the figures in the example paper.
\end_layout
-\end_inset
-
-
+\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
\family typewriter
-
-\backslash
-altaffilmark
+referee
\family default
- (2.3),
-\family typewriter
-
-\backslash
-altaffiltext
+ to the documentclass.
+ This must be done using the extra class options field in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
\family default
- (2.3),
+ dialog.
+ Just enter the string
\family typewriter
-
-\backslash
-eqnum
+referee
\family default
- (2.12),
-\family typewriter
+ there.
+\end_layout
-\backslash
-setcounter{equation}
-\family default
- (2.12), Journal name abbreviations (2.13.4),
-\family typewriter
+\begin_layout Subsection
+The example paper
+\end_layout
-\backslash
-figurenum
+\begin_layout Standard
+The
+\family sans
+Examples
\family default
- (2.14.1),
-\family typewriter
+ directory contains an example paper written with LyX.
+ It is the example paper from the original macro package, translated to
+ LyX.
+ Use it for inspiration, and compare the original LaTeX code with LyX way
+ of writing.
+\end_layout
-\backslash
-epsscale
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Section
+AASTeX
+\end_layout
-\backslash
-plotone
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
+\end_layout
-\backslash
-plottwo
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+AASTeX is a set of macros produced by the American Astronomical Society
+ to facilitate electronic manuscript submission to the three journals they
+ publish: the Astrophysical Journal (including the Letters and Supplement),
+ the Astronomical Journal, and the Publications of the Astronomical Society
+ of the Pacific.
+ LyX has proven to be an excellent tool for generating these documents,
+ especially given its equation, citation, and figure handling capabilities.
+ LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
+ is the version described here, or higher.
+ Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
+ incompatible with LyX.
+ The AASTeX package may be downloaded from the AASTeX Web site
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.journals.uchicago.edu/AAS/AASTeX
+\end_layout
+
+\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
+ will only reduce the drudgery of typing everything in.
+ It is your responsibility to ensure that the final exported LaTeX document
+ conforms completely to the requirements of the journal to which you are
+ submitting your paper.
+\end_layout
+
+\begin_layout Subsection
+Starting a New Paper
+\end_layout
+
+\begin_layout Standard
+I strongly suggest that you start with the AASTeX template file.
+ Click on
+\family sans
+File\SpecialChar \menuseparator
+New from
\family default
- (2.14.1),
+
+\family sans
+Template
+\family default
+, enter the new file name, then choose the
\family typewriter
-
-\backslash
-tablenum
+aastex.lyx
\family default
- (2.15.4),
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
\family typewriter
-
-\backslash
-tableline
+<>
\family default
- (2.15.4, insert it as the first element in the lefthand cell after where
- you want it.
- Don't use any of LyX's rules in the table),
+) with the correct information.
+ Many of the AASTeX commands and environments can be implemented directly
+ in LyX, but some cannot: most noticeably
\family typewriter
\backslash
-tablenotemark
+altaffilmark
\family default
- (2.15.5),
+ and
\family typewriter
\backslash
-tablenotetext
+altaffiltext
\family default
- (2.15.5), much of Misc (2.17, except
-\family typewriter
+, which should stick out like a sore thumb if you actually just opened the
+ template file.
+ For commands such as these, the LaTeX code must be entered directly and
+ marked as such.
+ Such commands are referred to as TeX code, or Evil Red Text.
+ I tried to minimize the amount of TeX code needed in an AASTeX document,
+ but there is still a bit more required than any of us would like.
+\end_layout
-\backslash
-objectname
+\begin_layout Subsection
+Finishing Your Paper
+\end_layout
+
+\begin_layout Standard
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
+\begin_inset Quotes eld
+\end_inset
+
+postprocessing
+\begin_inset Quotes erd
+\end_inset
+
+ actions which need to be done before you submit it to the journals.
+
+\end_layout
+
+\begin_layout Enumerate
+Export your paper as a LaTeX file (
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
-,
-\family typewriter
+).
+
+\end_layout
-\backslash
-dataset
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
\family default
-,
+ file with your favorite text editor
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
\family typewriter
\backslash
-url
+documentclass
\family default
-, and
+ command
+\end_layout
+
+\begin_layout Enumerate
+remove the
\family typewriter
\backslash
-email
+usepackage...{fontenc}
\family default
-; see above),
+ line if it appears (usually just after
\family typewriter
\backslash
-singlespace
+documentclass
\family default
- (3.1),
+}; also remove the
\family typewriter
\backslash
-doublespace
+secnumdepth
\family default
- (3.1),
+ line if it appears.
+\end_layout
+
+\begin_layout Enumerate
+remove everything between (and including) the
\family typewriter
\backslash
-onecolumn
+makeatletter
\family default
- (3.2),
+ and
\family typewriter
\backslash
-twocolumn
+makeatother
\family default
- (3.2)
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
+ commands, except for any commands you specifically put into the LaTeX preamble
+ (which should appear immediately after the
+\begin_inset Quotes eld
\end_inset
-
-\end_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
- (2.15).
- If you really, really need to use deluxetable, I suggest editing it in
- a separate file with a text editor, then using
-\family sans
-Insert\SpecialChar \menuseparator
-Child
-\begin_inset space ~
+User specified LaTeX commands
+\begin_inset Quotes erd
\end_inset
-Document
-\family default
- to include it in your LyX document.
- See the
+ comment in the
\family typewriter
-aas_sample.lyx
+.tex
\family default
- file to see an example of this.
-\end_layout
-
-\begin_layout Subsection
-FAQs, Tips, Tricks, and Other Ruminations
-\end_layout
-
-\begin_layout Subsubsection
-Getting LyX and AASTeX to cooperate
-\end_layout
-
-\begin_layout Standard
-It can be a bit tricky to get LyX to recognize a new layout and document
- class.
- When all else fails, do this:
+ file).
\end_layout
+\end_deeper
\begin_layout Enumerate
-Make certain that LaTeX can find AASTeX.
- Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
- a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
-\family typewriter
-sample.tex
-\family default
-.
+Run the resulting file through LaTeX to make sure it still processes correctly.
\end_layout
\begin_layout Enumerate
-Make certain that
-\family typewriter
-aastex.layout
-\family default
- appears in LyX's
-\family typewriter
-layouts
-\family default
- folder
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
\end_layout
\begin_layout Enumerate
-Rerun
-\family sans
-Tools\SpecialChar \menuseparator
-Reconfigure
-\family default
- in LyX, then restart LyX.
+Submit it.
\end_layout
-\begin_layout Enumerate
-Open a regular new file, not from a template.
- Does AASTeX appear in the class list in
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
-?
+\begin_layout Subsection
+Comments On Specific Commands
\end_layout
\begin_layout Standard
-If you get a warning from an existing AASTeX document about not being able
- to find the AASTeX layout or a message about
-\begin_inset Quotes eld
-\end_inset
-
-You should not mix title layouts with normal ones
-\begin_inset Quotes erd
-\end_inset
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
+\family typewriter
+aasguide.tex
+\family default
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar \ldots{}
-, things haven't been installed correctly.
\end_layout
\begin_layout Subsubsection
-LaTeX error processing a table
+Things that work as expected
\end_layout
\begin_layout Standard
-LyX, by default, attempts to center the table caption/title.
- This seems to produce a bad interaction in AASTeX so you should click somewhere
- in the caption/title, then select
-\family sans
-Edit\SpecialChar \menuseparator
-Paragraph
-\begin_inset space ~
-\end_inset
+Because they work as you might expect, I simply list them and the section
+ they are found in:
+\family typewriter
-Settings
-\family default
-, then set the
-\family sans
-Alignment
+\backslash
+documentclass
\family default
- to
-\family sans
-Block
+ (2.1.1),
+\family typewriter
+
+\backslash
+begin{document}
\family default
-.
- This took care of it for me.
-\end_layout
+ (2.2),
+\family typewriter
-\begin_layout Subsubsection
-References
-\end_layout
+\backslash
+title
+\family default
+ (2.3),
+\family typewriter
-\begin_layout Standard
-A couple of things: 1) I have noticed some funny spacing in the reference
- entries in the text.
- When you enter the bibliography item data, make sure their is
-\emph on
-no
-\emph default
- space between the last author and the parenthesis setting off the year;
-
-\emph on
-e.
-\begin_inset space \thinspace{}
-\end_inset
+\backslash
+author
+\family default
+ (2.3),
+\family typewriter
-g.
-\begin_inset space \space{}
-\end_inset
+\backslash
+affil
+\family default
+ (2.3),
+\family typewriter
+\backslash
+abstract
+\family default
+ (2.4),
+\family typewriter
-\emph default
-type
+\backslash
+keywords
+\family default
+ (2.5),
\family typewriter
-Ressler(1992)
+
+\backslash
+section
\family default
-, not
+ (2.7),
\family typewriter
-Ressler (1992)
+
+\backslash
+subsection
\family default
-.
- 2) Entering the references at all is not obvious.
- The easiest thing is to start typing your first reference at the end of
- the document, then mark it as type
-\family sans
-References
+ (2.7),
+\family typewriter
+
+\backslash
+subsubsection
\family default
-.
- That will put a small gray box in front of what you just typed.
- Click on the box to fill in the rest of the information.
- For new references, go to the end of an existing reference and press return.
- That will create a new line with its own box, etc.
-\end_layout
+ (2.7),
+\family typewriter
-\begin_layout Subsubsection
-Including EPS files
-\end_layout
+\backslash
+paragraph
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Standard
-Even though AASTeX provides its own figure commands (
+\backslash
+facility
+\family default
+ (2.10),
\family typewriter
\backslash
-plotone
+begin{displaymath}
\family default
-, for example), I much prefer LaTeX's standard figure commands (with the
- default graphicx).
- You can insert the
+ (2.12),
\family typewriter
\backslash
-plotone
+begin{equation}
\family default
-, etc.
-\begin_inset space ~
-\end_inset
+ (2.12),
+\family typewriter
-commands as TeX code into a Figure Float box if you desire, but I never
- have much luck getting the layout right.
- With the standard graphics, LyX will insert a
+\backslash
+begin{eqnarray}
+\family default
+ (2.12),
\family typewriter
\backslash
-usepackage{graphicx}
+begin{mathletters}
\family default
- command into the LaTeX preamble and handle the figures in the standard
- LaTeX2e way, interspersing the figures in the text.
- I believe ApJ accepts figures exactly this way now; AJ might still use
- the
-\begin_inset Quotes eld
-\end_inset
+ (2.12),
+\family typewriter
-stack everything at the end
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{thebibliography}
+\family default
+ (2.13.1),
+\family typewriter
- technique.
-\end_layout
+\backslash
+bibitem
+\family default
+ (2.13.2), all the cite commands and their variations (2.13.2), the generic
+ graphicx figure commands (2.14.1),
+\family typewriter
-\begin_layout Subsubsection
-Things I could have done, but didn't
-\end_layout
+\backslash
+begin{table}
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Standard
-There are a few
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{tabular}
+\family default
+ (2.15.4),
+\family typewriter
-pretty
-\begin_inset Quotes erd
-\end_inset
+\backslash
+caption
+\family default
+ (2.15.4),
+\family typewriter
- things I could have implemented, but chose not to.
- For instance, I saw no point in double-spacing the text in the LyX window,
- even though it is double-spaced in the paper manuscript.
- Also, I chose not to make separate layouts for the preprint and preprint2
- styles.
- Since I assume you will spend most of your time in the plain manuscript
- mode anyway, I decided not to chew up more disk space with this.
-
-\end_layout
+\backslash
+label
+\family default
+ (2.15.4, amongst other places),
+\family typewriter
-\begin_layout Subsection
-Final Caveat
+\backslash
+tablerefs
+\family default
+ (2.15.5),
+\family typewriter
+
+\backslash
+tablecomments
+\family default
+ (2.15.5),
+\family typewriter
+
+\backslash
+url
+\family default
+ (2.17.4),
+\family typewriter
+
+\backslash
+end{document}
+\family default
+ (2.18).
\end_layout
\begin_layout Standard
-Your mileage may vary.
- I've now had papers published by both ApJ and AJ that have had 98% of the
- effort done in LyX; the last 2% was the LaTeX post-processing and a few
- cleanups.
- I have had no trouble with the submission process, and I'm sure the journals
- were never aware that there might be a difference.
- So, go forth and publish!
+The following style options also work correctly:
+\family typewriter
+longabstract
+\family default
+ (2.4),
+\family typewriter
+preprint
+\family default
+ (3.2.1),
+\family typewriter
+preprint2
+\family default
+ (3.2.2),
+\family typewriter
+eqsecnum
+\family default
+ (3.3),
+\family typewriter
+flushrt
+\family default
+ (3.4).
+ Simply put them in the
+\family sans
+Options
+\family default
+ box in
+\family sans
+Layout\SpecialChar \menuseparator
+Document
+\family default
+.
\end_layout
-\begin_layout Section
-AMS LaTeX
+\begin_layout Subsubsection
+Things that work, but require more comment
\end_layout
\begin_layout Standard
-by
-\noun on
-David Johnson; updated by Richard Heck
+The following items work, but require a little more discussion:
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
+\begin_layout Itemize
+These items are reserved for use by the journal editors, but you can put
+ them into the LaTeX preamble if you feel compelled to do so:
+\family typewriter
+\backslash
+received
+\family default
+,
+\family typewriter
-\end_layout
+\backslash
+revised
+\family default
+,
+\family typewriter
-\begin_layout Standard
-\noindent
-The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
- papers to be submitted to American Mathematical Society publications.
- The layouts are not tailored to a specific journal, but easily can be.
- You should refer to the AMS documentation for specific instructions for
- each journal (usually it will entail only changing a single line in the
- TeX output).
- That documentation is available on the Web at
-\begin_inset Flex URL
-status open
+\backslash
+accepted
+\family default
+,
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+ccc
+\family default
+,
+\family typewriter
-http://www.ams.org
+\backslash
+cpright
+\family default
+ (all from 2.1.3)
\end_layout
-\end_inset
+\begin_layout Itemize
+These items may be placed in the LaTeX preamble, and are included as blanks
+ in the template file:
+\family typewriter
- or by ftp at
-\begin_inset Flex URL
-status open
+\backslash
+slugcomment
+\family default
+ (2.1.4),
+\family typewriter
-\begin_layout Plain Layout
+\backslash
+shorttitle
+\family default
+ (2.1.5),
+\family typewriter
-ftp://ftp.ams.org/pub/tex/amslatex/
+\backslash
+shortauthors
+\family default
+ (2.1.5)
\end_layout
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+email
+\family default
+ (2.3) – can only be used
+\begin_inset Quotes eld
\end_inset
-.
- These layouts are appropriate, and useful, for any mathematical writing.
-
-\end_layout
+standalone
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-There are two basic AMS LaTeX layouts:
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
\begin_layout Itemize
-amsart: The standard AMS article format.
+
+\family typewriter
+
+\backslash
+and
+\family default
+ (2.3) – will have extra {} after it.
+ This should not cause an error.
\end_layout
\begin_layout Itemize
-amsbook: the standard AMS book (really, monograph) format.
-
-\end_layout
-\begin_layout Standard
-The layouts themselves contain only the minimum necessary to use the AMS
- classes.
- They do not, in particular, contain any of the `theorem' environments used
- for setting theorems, lemmas, and the like.
- These are contained, instead, in the
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS)
-\end_layout
+\backslash
+notetoeditor
+\family default
+ (2.6) – can only be used
+\begin_inset Quotes eld
+\end_inset
+standalone
+\begin_inset Quotes erd
\end_inset
- module, which is loaded by default when when you select one of the AMS
- classes.
- (It can also be used with other classes and can be removed, if you would
- rather use something else.) Less commonly used environments are in the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Theorems (AMS-Extended)
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
-\end_inset
-
- module, which must be loaded manually.
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-By default, theorems and the like are numbered consecutively throughout
- the document, but this may be modified by loading the module
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Order by Section)
+\backslash
+placetable
+\family default
+ (2.8) – can't insert a cross-reference tag, you must type the tag name by
+ hand
\end_layout
-\end_inset
+\begin_layout Itemize
- or, if you are using
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-book (AMS)
+\backslash
+placefigure
+\family default
+ (2.8) – same as for
+\family typewriter
+
+\backslash
+placetable
\end_layout
-\end_inset
+\begin_layout Itemize
-, the module
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Order by Chapter)
+\backslash
+acknowledgements
+\family default
+ (2.9) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
-
-.
- These will number the results as
-\begin_inset Formula $n.m$
-\end_inset
+\begin_layout Itemize
-, where the first number refers to the section (or chapter) and the second
- refers to the total number of results so far in that section (or chapter).
- Many environments are also available unnumbered.
- These are indicated by an asterisk at the end.
- If you happen to want
-\emph on
-only
-\emph default
- unnumbered results, the the module
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (Starred)
+\backslash
+appendix
+\family default
+ (2.11) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\end_inset
-
- provides that option.
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Note that these modules do not
-\emph on
-have
-\emph default
- to be used with the AMS classes.
- It is perfectly possible to use the
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-Theorems (AMS)
-\end_layout
+\backslash
+figcaption
+\family default
+ (2.14.2) – you can insert an optional filename argument by placing the cursor
+ at the beginning of the text and selecting
+\family sans
+Insert\SpecialChar \menuseparator
+Short Title
+\family default
+.
+
+\begin_inset Quotes eld
+\end_inset
+Short Title
+\begin_inset Quotes erd
\end_inset
- module, and the others mentioned, with other classes, such as
-\begin_inset Flex CharStyle:Code
-status collapsed
+ inserts an optional argument of the type needed by
+\family typewriter
-\begin_layout Plain Layout
-article
+\backslash
+figcaption
+\family default
+.
+ Hopefully it will be renamed someday.
\end_layout
-\end_inset
+\begin_layout Itemize
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-report
-\end_layout
+\backslash
+objectname
+\family default
+ (2.17.1) – same as
+\family typewriter
-\end_inset
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
+\end_layout
-,
-\begin_inset Flex CharStyle:Code
-status collapsed
+\begin_layout Itemize
-\begin_layout Plain Layout
-book (KOMA-script)
-\end_layout
+\family typewriter
-\end_inset
+\backslash
+dataset
+\family default
+ (2.17.1) – same as
+\family typewriter
-, and so forth.
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Subsection
-What these layouts provide
+\begin_layout Subsubsection
+Things not implemented, use TeX code
\end_layout
\begin_layout Standard
-There is a long list of included environments provided by these layouts.
- In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
- variety of `theorem' environments.
- However, the AMS recommends the environments that are available in LyX.
-
-\end_layout
-\begin_layout Standard
-The following environments—as well as the standard environments, such as
-
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\family typewriter
-\begin_layout Plain Layout
-section
-\end_layout
+\backslash
+altaffilmark
+\family default
+ (2.3),
+\family typewriter
-\end_inset
+\backslash
+altaffiltext
+\family default
+ (2.3),
+\family typewriter
-,
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\backslash
+eqnum
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Plain Layout
-bibliography
-\end_layout
+\backslash
+setcounter{equation}
+\family default
+ (2.12), Journal name abbreviations (2.13.4),
+\family typewriter
-\end_inset
+\backslash
+figurenum
+\family default
+ (2.14.1),
+\family typewriter
-,
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\backslash
+epsscale
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Plain Layout
-title
-\end_layout
+\backslash
+plotone
+\family default
+ (2.14.1),
+\family typewriter
-\end_inset
+\backslash
+plottwo
+\family default
+ (2.14.1),
+\family typewriter
-,
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\backslash
+tablenum
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Plain Layout
-author
-\end_layout
+\backslash
+tableline
+\family default
+ (2.15.4, insert it as the first element in the lefthand cell after where
+ you want it.
+ Don't use any of LyX's rules in the table),
+\family typewriter
-\end_inset
+\backslash
+tablenotemark
+\family default
+ (2.15.5),
+\family typewriter
-, and
-\begin_inset Flex CharStyle:Noun
-status collapsed
+\backslash
+tablenotetext
+\family default
+ (2.15.5), much of Misc (2.17, except
+\family typewriter
-\begin_layout Plain Layout
-date
-\end_layout
-
-\end_inset
+\backslash
+objectname
+\family default
+,
+\family typewriter
-—are provided by
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+dataset
+\family default
+,
+\family typewriter
-\begin_layout Plain Layout
-article (AMS)
-\end_layout
+\backslash
+url
+\family default
+, and
+\family typewriter
-\end_inset
+\backslash
+email
+\family default
+; see above),
+\family typewriter
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
+\backslash
+singlespace
+\family default
+ (3.1),
+\family typewriter
-\begin_layout Plain Layout
-book (AMS)
-\end_layout
+\backslash
+doublespace
+\family default
+ (3.1),
+\family typewriter
-\end_inset
+\backslash
+onecolumn
+\family default
+ (3.2),
+\family typewriter
-:
+\backslash
+twocolumn
+\family default
+ (3.2)
\end_layout
-\begin_layout Description
-Address This should be the author's permanent address.
+\begin_layout Subsubsection
+Things that cannot be implemented
\end_layout
-\begin_layout Description
-Current
+\begin_layout Standard
+\SpecialChar \ldots{}
+ at least in any meaningful sort of way, so I suggest ignoring them.
+ They are the references environment (2.13.3), and the deluxetable environment
+ (2.15).
+ If you really, really need to use deluxetable, I suggest editing it in
+ a separate file with a text editor, then using
+\family sans
+Insert\SpecialChar \menuseparator
+Child
\begin_inset space ~
\end_inset
-Address This should be the author's temporary address at the time of submission,
- if different from the Address.
+Document
+\family default
+ to include it in your LyX document.
+ See the
+\family typewriter
+aas_sample.lyx
+\family default
+ file to see an example of this.
\end_layout
-\begin_layout Description
-Email Author's e-mail address
+\begin_layout Subsection
+FAQs, Tips, Tricks, and Other Ruminations
\end_layout
-\begin_layout Description
-URL Author's Web address, if desired.
+\begin_layout Subsubsection
+Getting LyX and AASTeX to cooperate
\end_layout
-\begin_layout Description
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
+\begin_layout Standard
+It can be a bit tricky to get LyX to recognize a new layout and document
+ class.
+ When all else fails, do this:
\end_layout
-\begin_layout Description
-Subjectclass These refer to the AMS Subject Classifications, published and
- described in
-\emph on
-Mathematical Reviews
-\emph default
+\begin_layout Enumerate
+Make certain that LaTeX can find AASTeX.
+ Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
+ a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
+\family typewriter
+sample.tex
+\family default
.
- These are also available online at the AMS cites listed above.
\end_layout
-\begin_layout Description
-Thanks
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
+\family default
+ appears in LyX's
+\family typewriter
+layouts
+\family default
+ folder
\end_layout
-\begin_layout Description
-Dedicatory
+\begin_layout Enumerate
+Rerun
+\family sans
+Tools\SpecialChar \menuseparator
+Reconfigure
+\family default
+ in LyX, then restart LyX.
\end_layout
-\begin_layout Description
-Translator
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AASTeX appear in the class list in
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+?
\end_layout
\begin_layout Standard
-The following environments are provided by both the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Theorems
-\end_layout
-
+If you get a warning from an existing AASTeX document about not being able
+ to find the AASTeX layout or a message about
+\begin_inset Quotes eld
\end_inset
- and
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-Theorems (AMS)
-\end_layout
-
+You should not mix title layouts with normal ones
+\begin_inset Quotes erd
\end_inset
- modules, in the latter case in both starred (unnumbered) and unstarred
- (numbered) versions.
- These same environments are provided only in the starred versions by the
-
-\begin_inset Flex CharStyle:Code
-status collapsed
+, things haven't been installed correctly.
+\end_layout
-\begin_layout Plain Layout
-Theorems (Starred)
+\begin_layout Subsubsection
+LaTeX error processing a table
\end_layout
+\begin_layout Standard
+LyX, by default, attempts to center the table caption/title.
+ This seems to produce a bad interaction in AASTeX so you should click somewhere
+ in the caption/title, then select
+\family sans
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
- module:
+Settings
+\family default
+, then set the
+\family sans
+Alignment
+\family default
+ to
+\family sans
+Block
+\family default
+.
+ This took care of it for me.
\end_layout
-\begin_layout Theorem
-This is typically used for the statements of major results.
-
+\begin_layout Subsubsection
+References
\end_layout
-\begin_layout Corollary*
-This is used for statements which follow fairly directly from previous statement
-s.
- Again, these can be major results.
+\begin_layout Standard
+A couple of things: 1) I have noticed some funny spacing in the reference
+ entries in the text.
+ When you enter the bibliography item data, make sure their is
+\emph on
+no
+\emph default
+ space between the last author and the parenthesis setting off the year;
-\end_layout
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Lemma
-These are smaller results needed to prove other statements.
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Proposition
-These are less major results which (hopefully) add to the general theory
- being discussed.
-\end_layout
-\begin_layout Conjecture
-These are statements provided without justification, which the author does
- not know how to prove, but which seem to be true (to the author, at least).
+\emph default
+type
+\family typewriter
+Ressler(1992)
+\family default
+, not
+\family typewriter
+Ressler (1992)
+\family default
+.
+ 2) Entering the references at all is not obvious.
+ The easiest thing is to start typing your first reference at the end of
+ the document, then mark it as type
+\family sans
+References
+\family default
+.
+ That will put a small gray box in front of what you just typed.
+ Click on the box to fill in the rest of the information.
+ For new references, go to the end of an existing reference and press return.
+ That will create a new line with its own box, etc.
\end_layout
-\begin_layout Definition*
-Guess what this is for.
- The font is different for this environment than for the previous ones.
-
+\begin_layout Subsubsection
+Including EPS files
\end_layout
-\begin_layout Example*
-Used for examples illustrating proven results.
+\begin_layout Standard
+Even though AASTeX provides its own figure commands (
+\family typewriter
+
+\backslash
+plotone
+\family default
+, for example), I much prefer LaTeX's standard figure commands (with the
+ default graphicx).
+ You can insert the
+\family typewriter
+
+\backslash
+plotone
+\family default
+, etc.
+\begin_inset space ~
+\end_inset
+
+commands as TeX code into a Figure Float box if you desire, but I never
+ have much luck getting the layout right.
+ With the standard graphics, LyX will insert a
+\family typewriter
+
+\backslash
+usepackage{graphicx}
+\family default
+ command into the LaTeX preamble and handle the figures in the standard
+ LaTeX2e way, interspersing the figures in the text.
+ I believe ApJ accepts figures exactly this way now; AJ might still use
+ the
+\begin_inset Quotes eld
+\end_inset
+
+stack everything at the end
+\begin_inset Quotes erd
+\end_inset
+
+ technique.
\end_layout
-\begin_layout Problem
-It's not really known what this is for.
- You should figure it out.
+\begin_layout Subsubsection
+Things I could have done, but didn't
\end_layout
-\begin_layout Exercise*
-Write a description for this one.
+\begin_layout Standard
+There are a few
+\begin_inset Quotes eld
+\end_inset
+
+pretty
+\begin_inset Quotes erd
+\end_inset
+
+ things I could have implemented, but chose not to.
+ For instance, I saw no point in double-spacing the text in the LyX window,
+ even though it is double-spaced in the paper manuscript.
+ Also, I chose not to make separate layouts for the preprint and preprint2
+ styles.
+ Since I assume you will spend most of your time in the plain manuscript
+ mode anyway, I decided not to chew up more disk space with this.
+
\end_layout
-\begin_layout Remark
-This environment is also a type of theorem, usually a lesser sort of observation.
+\begin_layout Subsection
+Final Caveat
\end_layout
-\begin_layout Claim*
-Often used in the course of giving a proof of a larger result.
+\begin_layout Standard
+Your mileage may vary.
+ I've now had papers published by both ApJ and AJ that have had 98% of the
+ effort done in LyX; the last 2% was the LaTeX post-processing and a few
+ cleanups.
+ I have had no trouble with the submission process, and I'm sure the journals
+ were never aware that there might be a difference.
+ So, go forth and publish!
\end_layout
-\begin_layout Case
-Generally, these are used to break up long arguments, using specific instances
- of some condition.
-
+\begin_layout Section
+AMS LaTeX
\end_layout
-\begin_layout Case
-The numbering scheme for cases is on its own, not together with other numbered
- statements.
-
+\begin_layout Standard
+by
+\noun on
+David Johnson
+\noun default
+; updated by
+\noun on
+Richard Heck
\end_layout
-\begin_layout Proof
-At the end of this environment, a QED symbol (usually a square, but it can
- vary with different styles) is placed.
- If you want to have other environments within this one—for example, Case
- environments—and have the QED symbol appear only after them, then the other
- environments need to be nested within the proof environment.
- See the section
-\emph on
-Nesting Environments
-\emph default
- of the
-\emph on
-User's Guide
-\emph default
- for information on nesting.
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
\end_layout
\begin_layout Standard
-And these environments are provided by
-\begin_inset Flex CharStyle:Code
-status collapsed
+\noindent
+The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
+ papers to be submitted to American Mathematical Society publications.
+ The layouts are not tailored to a specific journal, but easily can be.
+ You should refer to the AMS documentation for specific instructions for
+ each journal (usually it will entail only changing a single line in the
+ TeX output).
+ That documentation is available on the Web at
+\begin_inset Flex URL
+status open
\begin_layout Plain Layout
-Theorems (AMS-Extended)
+
+http://www.ams.org
\end_layout
\end_inset
-:
-\end_layout
+ or by ftp at
+\begin_inset Flex URL
+status open
-\begin_layout Criterion*
-A required condition.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Algorithm*
-A general procedure to be used.
+ftp://ftp.ams.org/pub/tex/amslatex/
\end_layout
-\begin_layout Axiom*
-This is a property or statement taken as true within the system being discussed.
-\end_layout
+\end_inset
-\begin_layout Condition*
-Sometimes used to state a condition assumed within the present context of
- discussion.
+.
+ These layouts are appropriate, and useful, for any mathematical writing.
+
\end_layout
-\begin_layout Note*
-Similar to a Remark.
+\begin_layout Standard
+There are two basic AMS LaTeX layouts:
\end_layout
-\begin_layout Notation*
-Used for the explanation of, yes, notation.
+\begin_layout Itemize
+amsart: The standard AMS article format.
\end_layout
-\begin_layout Summary
-Do we really need to tell you?
+\begin_layout Itemize
+amsbook: the standard AMS book (really, monograph) format.
+
\end_layout
-\begin_layout Acknowledgement*
-Acknowledgement.
-\end_layout
+\begin_layout Standard
+The layouts themselves contain only the minimum necessary to use the AMS
+ classes.
+ They do not, in particular, contain any of the `theorem' environments used
+ for setting theorems, lemmas, and the like.
+ These are contained, instead, in the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Conclusion*
-Sometimes used at the end of a long train of argument.
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Fact
-Used in a way similar to Proposition, though perhaps lower on the scale.
-\end_layout
+\end_inset
-\begin_layout Standard
-In addition, the AMS classes automatically provide the AMS LaTeX and AMS
- fonts packages.
- They need to be available on your system in order to use these environments.
+ module, which is loaded by default when when you select one of the AMS
+ classes.
+ (It can also be used with other classes and can be removed, if you would
+ rather use something else.) Less commonly used environments are in the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
-\begin_layout Section
-AGU journals (
-\family sans
-aguplus
-\family default
-)
+\end_inset
+
+ module, which must be loaded manually.
\end_layout
\begin_layout Standard
-by
-\shape smallcaps
-Martin Vermeer
-\end_layout
+By default, theorems and the like are numbered consecutively throughout
+ the document, but this may be modified by loading the module
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Description
+\begin_layout Plain Layout
+Theorems (Order by Section)
\end_layout
-\begin_layout Standard
-These are the layout files for some of the journals of the American Geophysical
- Society.
- It is assumed that you have both the AGU's own class files and AGUplus
- installed (everything to be found at
-\begin_inset Flex URL
+\end_inset
+
+ or, if you are using
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+book (AMS)
+\end_layout
-ftp://ftp.agu.org/journals/latex/journals
+\end_inset
+
+, the module
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (Order by Chapter)
\end_layout
\end_inset
-).
+.
+ These will number the results as
+\begin_inset Formula $n.m$
+\end_inset
+
+, where the first number refers to the section (or chapter) and the second
+ refers to the total number of results so far in that section (or chapter).
+ Many environments are also available unnumbered.
+ These are indicated by an asterisk at the end.
+ If you happen to want
+\emph on
+only
+\emph default
+ unnumbered results, the module
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (Starred)
\end_layout
-\begin_layout Subsection
-New styles
+\end_inset
+
+ provides that option.
\end_layout
\begin_layout Standard
-Redefined are
-\family sans
-Paragraph
-\family default
-,
-\family sans
-Paragraph*
-\family default
-.
- They are still called this in the LyX GUI, though their LaTeX equivalents
- in the AGU classes are
-\family sans
-Subsubsubsection
-\family default
- and
-\family sans
-Subsubsubsection*
-\family default
-.
-\end_layout
+Note that these modules do not
+\emph on
+have
+\emph default
+ to be used with the AMS classes.
+ It is perfectly possible to use the
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Newly defined styles are
-\family sans
-Left_Header
-\family default
-,
-\family sans
-Right_Header
-\family default
-,
-\family sans
-Received
-\family default
-,
-\family sans
-Revised
-\family default
-,
-\family sans
-Accepted
-\family default
-,
-\family sans
-CCC
-\family default
-,
-\family sans
-PaperId
-\family default
-,
-\family sans
-AuthorAddr
-\family default
-,
-\family sans
-SlugComment
-\family default
-.
- These are mostly manuscript attributes and defined in the AGU class documentati
-on.
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Standard
-I suspect this is still badly incomplete.
-\end_layout
+\end_inset
-\begin_layout Subsection
-New floats
+ module, and the others mentioned, with other classes, such as
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+article
\end_layout
-\begin_layout Standard
+\end_inset
-\family sans
-Planotable
-\family default
- and
-\family sans
-Plate
-\family default
-.
- We also have a new
-\family sans
-Table_Caption
-\family default
-.
-\end_layout
+,
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Supported journals
+\begin_layout Plain Layout
+report
\end_layout
-\begin_layout Itemize
+\end_inset
-\emph on
-Journal of Geophysical Research
-\emph default
-:
-\family typewriter
-jgrga.layout
-\family default
- — Martin Vermeer
+,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+book (KOMA-script)
\end_layout
-\begin_layout Standard
-Add your own, it isn't so hard! Look at the
-\family typewriter
-jgrga.layout
-\family default
- example and
-\family typewriter
-aguplus.inc
-\family default
-.
+\end_inset
+
+, and so forth.
\end_layout
\begin_layout Subsection
-Bugs and things to remember
+What these layouts provide
\end_layout
\begin_layout Standard
-In order to use the new layouts, you must remember to do the following for
- a new document:
+There is a long list of included environments provided by these layouts.
+ In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
+ variety of `theorem' environments.
+ However, the AMS recommends the environments that are available in LyX.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+The following environments—as well as the standard environments, such as
+
+\begin_inset Flex Noun
+status collapsed
-\emph on
-Turn off babel
-\emph default
-.
- This can be done in the
-\family sans
-Layout\SpecialChar \menuseparator
-Document
-\family default
- or
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- menu item.
- (AGU articles are always in English, right? So
-\emph on
-don't
-\emph default
- choose a language.)
+\begin_layout Plain Layout
+section
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
-jgrga
-\family default
- into the document's
-\family sans
-Extra Options
-\family default
- field.
- (Yes, this is a bug.)
-\end_layout
+\end_inset
-\begin_layout Enumerate
-Make sure you use the
-\family typewriter
-agu.bst
-\family default
- bibliography style, by entering
-\family sans
-agu
-\family default
- into the second field of the BibTeX inset.
- None of the standard styles will do.
-\end_layout
+,
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Section
-Broadway
+\begin_layout Plain Layout
+bibliography
\end_layout
-\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
-\end_layout
+\end_inset
-\begin_layout Subsection
-Introduction
-\end_layout
+,
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Standard
-Broadway is for writing plays.
- The format is more decorative than Hollywood, and much less standardized.
- This format should be suitable for workshops.
+\begin_layout Plain Layout
+title
\end_layout
-\begin_layout Subsection
-Special problems
-\end_layout
+\end_inset
-\begin_layout Standard
-The same as in Hollywood.
-\end_layout
+,
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Subsection
-Special features
+\begin_layout Plain Layout
+author
\end_layout
-\begin_layout Standard
-Insert the
-\family sans
-Speaker
-\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
-\end_layout
+\end_inset
-\begin_layout Subsection
-Paper size and Margins
-\end_layout
+, and
+\begin_inset Flex Noun
+status collapsed
-\begin_layout Standard
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\begin_layout Plain Layout
+date
\end_layout
-\begin_layout Subsection
-Environments
-\end_layout
+\end_inset
-\begin_layout Standard
-The following environments are available.
- You can use broadway.bind to get the bind keys shown at the right.
+—are provided by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+article (AMS)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Standard
-\begin_inset Newline newline
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
-\family default
-You should not have to use this, but it is here for anything that does not
- fit otherwise.
+\begin_layout Plain Layout
+book (AMS)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Narrative
-\begin_inset space \hfill{}
-\end_inset
-
-M-z n
-\begin_inset Newline newline
\end_inset
-
-\family default
-Used to describe stage setting and the action.
- First use of speaker names in all CAPs.
+:
\end_layout
-\begin_layout Itemize
-
-\family sans
-ACT
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Description
+Address This should be the author's permanent address.
+\end_layout
-M-z a
-\begin_inset Newline newline
+\begin_layout Description
+Current
+\begin_inset space ~
\end_inset
+Address This should be the author's temporary address at the time of submission,
+ if different from the Address.
+\end_layout
-\family default
-Automatically numbered.
- On screen it will be arabic, but will print as Roman.
+\begin_layout Description
+Email Author's e-mail address
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+URL Author's Web address, if desired.
+\end_layout
-\family sans
-ACT*
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
+\end_layout
-M-z S at
-\begin_inset Newline newline
-\end_inset
+\begin_layout Description
+Subjectclass These refer to the AMS Subject Classifications, published and
+ described in
+\emph on
+Mathematical Reviews
+\emph default
+.
+ These are also available online at the AMS cites listed above.
+\end_layout
+\begin_layout Description
+Thanks
+\end_layout
-\family default
-Subtitle for
-\family sans
-ACT.
+\begin_layout Description
+Dedicatory
+\end_layout
-\family default
- It is just centered text.
+\begin_layout Description
+Translator
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The following environments are provided by both the
+\begin_inset Flex Code
+status collapsed
-\family sans
-SCENE
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Plain Layout
+Theorems
+\end_layout
-M-z S-S
-\begin_inset Newline newline
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
-\family default
-Not automatically numbered.
- You supply the number.
- This is because I couldn't figure out how.
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Itemize
-
-\family sans
-AT_RISE:
-\begin_inset space \hfill{}
-\end_inset
-
-M-z S-R
-\begin_inset Newline newline
\end_inset
+ modules, in the latter case in both starred (unnumbered) and unstarred
+ (numbered) versions.
+ These same environments are provided only in the starred versions by the
+
+\begin_inset Flex Code
+status collapsed
-\family default
-A special case of Narrative to describe the setting and action as the curtain
- rises.
+\begin_layout Plain Layout
+Theorems (Starred)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Speaker
-\begin_inset space \hfill{}
-\end_inset
-
-M-z s
-\begin_inset Newline newline
\end_inset
+ module:
+\end_layout
-\family default
-The speaker's (actor's) title, centered in all CAPS.
+\begin_layout Theorem
+This is typically used for the statements of major results.
+
\end_layout
-\begin_layout Itemize
+\begin_layout Corollary*
+This is used for statements which follow fairly directly from previous statement
+s.
+ Again, these can be major results.
+
+\end_layout
-\family sans
-Parenthetical
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Lemma
+These are smaller results needed to prove other statements.
+\end_layout
-M-z p
-\begin_inset Newline newline
-\end_inset
+\begin_layout Proposition
+These are less major results which (hopefully) add to the general theory
+ being discussed.
+\end_layout
+\begin_layout Conjecture
+These are statements provided without justification, which the author does
+ not know how to prove, but which seem to be true (to the author, at least).
+\end_layout
-\family default
-Instructions to the speaker.
- The parentheses are automatically inserted.
- The ( will appear on screen, but both will be in the printed play.
- This environment is only used within
-\family sans
-Dialogue
-\family default
-.
+\begin_layout Definition*
+Guess what this is for.
+ The font is different for this environment than for the previous ones.
+
\end_layout
-\begin_layout Itemize
+\begin_layout Example*
+Used for examples illustrating proven results.
+\end_layout
-\family sans
-Dialogue
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Problem
+It's not really known what this is for.
+ You should figure it out.
+\end_layout
-M-z d
-\begin_inset Newline newline
-\end_inset
+\begin_layout Exercise*
+Write a description for this one.
+\end_layout
+\begin_layout Remark
+This environment is also a type of theorem, usually a lesser sort of observation.
+\end_layout
-\family default
-What the Speaker says.
+\begin_layout Claim*
+Often used in the course of giving a proof of a larger result.
\end_layout
-\begin_layout Itemize
+\begin_layout Case
+Generally, these are used to break up long arguments, using specific instances
+ of some condition.
+
+\end_layout
-\family sans
-CURTAIN
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Case
+The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
+\end_layout
-M-z S-C
-\begin_inset Newline newline
-\end_inset
+\begin_layout Proof
+At the end of this environment, a QED symbol (usually a square, but it can
+ vary with different styles) is placed.
+ If you want to have other environments within this one—for example, Case
+ environments—and have the QED symbol appear only after them, then the other
+ environments need to be nested within the proof environment.
+ See the section
+\emph on
+Nesting Environments
+\emph default
+ of the
+\emph on
+User's Guide
+\emph default
+ for information on nesting.
+\end_layout
+\begin_layout Standard
+And these environments are provided by
+\begin_inset Flex Code
+status collapsed
-\family default
-The curtain comes down.
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
-\begin_layout Itemize
-
-\family sans
-Title
-\begin_inset space \hfill{}
\end_inset
-M-z S-T
+:
\end_layout
-\begin_layout Itemize
+\begin_layout Criterion*
+A required condition.
+\end_layout
-\family sans
-Author
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Algorithm*
+A general procedure to be used.
+\end_layout
-M-z S-A
+\begin_layout Axiom*
+This is a property or statement taken as true within the system being discussed.
\end_layout
-\begin_layout Itemize
+\begin_layout Condition*
+Sometimes used to state a condition assumed within the present context of
+ discussion.
+\end_layout
-\family sans
-Right_Address
-\begin_inset space \hfill{}
-\end_inset
+\begin_layout Note*
+Similar to a Remark.
+\end_layout
-M-z r
+\begin_layout Notation*
+Used for the explanation of, yes, notation.
\end_layout
-\begin_layout Standard
-Hello there.
+\begin_layout Summary
+Do we really need to tell you?
\end_layout
-\begin_layout Section
-Dinbrief
+\begin_layout Acknowledgement*
+Acknowledgement.
+\end_layout
+
+\begin_layout Conclusion*
+Sometimes used at the end of a long train of argument.
+\end_layout
+
+\begin_layout Fact
+Used in a way similar to Proposition, though perhaps lower on the scale.
\end_layout
\begin_layout Standard
-The document class
-\family sans
-dinbrief
-\family default
- can be used to type letters according to German conventions.
- A template file is included in
-\family typewriter
-.../lyx/share/templates
-\family default
- for you to use as a starting point.
+In addition, the AMS classes automatically provide the AMS LaTeX and AMS
+ fonts packages.
+ They need to be available on your system in order to use these environments.
\end_layout
\begin_layout Section
-EGS journals (
+AGU journals (
\family sans
-egs
+aguplus
\family default
)
\end_layout
\end_layout
\begin_layout Standard
-This is the layout file for the European Geophysical Society journals.
- The needed
-\family typewriter
-egs.cls
-\family default
- can be downloaded from the web site of the EGS under
+These are the layout files for some of the journals of the American Geophysical
+ Society.
+ It is assumed that you have both the AGU's own class files and AGUplus
+ installed (everything to be found at
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-www.copernicus.org
+ftp://ftp.agu.org/journals/latex/journals
\end_layout
\end_inset
-.
+).
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-
+Redefined are
\family sans
-Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
- Accepted
+Paragraph
\family default
,
\family sans
-Offsets
+Paragraph*
\family default
.
- The current layout file is unfortunately very unmodular and would benefit
- from using the various
-\family typewriter
-std*.inc
+ They are still called this in the LyX GUI, though their LaTeX equivalents
+ in the AGU classes are
+\family sans
+Subsubsubsection
\family default
- file inclusions.
+ and
+\family sans
+Subsubsubsection*
+\family default
+.
\end_layout
-\begin_layout Section
-Elsevier Journals
+\begin_layout Standard
+Newly defined styles are
+\family sans
+Left_Header
+\family default
+,
+\family sans
+Right_Header
+\family default
+,
+\family sans
+Received
+\family default
+,
+\family sans
+Revised
+\family default
+,
+\family sans
+Accepted
+\family default
+,
+\family sans
+CCC
+\family default
+,
+\family sans
+PaperId
+\family default
+,
+\family sans
+AuthorAddr
+\family default
+,
+\family sans
+SlugComment
+\family default
+.
+ These are mostly manuscript attributes and defined in the AGU class documentati
+on.
\end_layout
\begin_layout Standard
-By
-\noun on
-Rod Pinna
+I suspect this is still badly incomplete.
+\end_layout
+
+\begin_layout Subsection
+New floats
\end_layout
\begin_layout Standard
-Elsevier Science Publishers B.V.
- provides a standard LaTeX document class (
-\family typewriter
-elsart.cls
-\family default
-) for submitting articles to their various journals.
- The style file can be downloaded directly from their web site:
-\begin_inset Flex URL
-status collapsed
-\begin_layout Plain Layout
+\family sans
+Planotable
+\family default
+ and
+\family sans
+Plate
+\family default
+.
+ We also have a new
+\family sans
+Table_Caption
+\family default
+.
+\end_layout
-http://authors.elsevier.com/
+\begin_layout Subsection
+Supported journals
\end_layout
-\end_inset
+\begin_layout Itemize
-.
- Instructions are supplied along with the class file, which details the
- requirements of the publishers.
- LyX includes package that allows for the use of this class, by a layout
- and a template file.
- Installation of the class file is the same as for any other LaTeX package;
- instructions are provided in the Elsevier documentation.
+\emph on
+Journal of Geophysical Research
+\emph default
+:
+\family typewriter
+jgrga.layout
+\family default
+ — Martin Vermeer
\end_layout
\begin_layout Standard
-To make use of
+Add your own, it isn't so hard! Look at the
\family typewriter
-elsart.cls
+jgrga.layout
\family default
-, a file
+ example and
\family typewriter
-elsart.layout
+aguplus.inc
\family default
- is supplied.
- As the Elsevier class file is based mainly on the standard article class,
- most of the normal functionality is provided.
- The Elsevier class defines a number of mathematical environments, which
- are similar to the AMS environments.
- These commands are all described in the Elsevier documentation, and are
- available in LyX.
+.
+\end_layout
+
+\begin_layout Subsection
+Bugs and things to remember
\end_layout
\begin_layout Standard
-The easiest way to use the Elsevier style is to base documents on the included
- template file.
- It is best not to use options such as fancy headings or the geometry package,
- as elements such as these are defined by Elsevier in their style file.
- Ideally, no extra packages except those mentioned in the Elsevier documentation
- should be used.
- Essentially, Elsevier require as
-\begin_inset Quotes eld
-\end_inset
+In order to use the new layouts, you must remember to do the following for
+ a new document:
+\end_layout
-clean
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
- a LaTeX file as possible, as their intention is to take the supplied file
- and replace the class file with one for the particular journal to which
- the paper has been submitted.
- This also means that not too much time should be spent on the formating
- of the document.
- When it comes to be published, this will change anyway.
- The rest of the usage for this layout is substantially the same as for
- the normal article class.
- For details of what Elsevier do and don't allow, refer to their documentation.
+\emph on
+Turn off babel
+\emph default
+.
+ This can be done in the
+\family sans
+Layout\SpecialChar \menuseparator
+Document
+\family default
+ or
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ menu item.
+ (AGU articles are always in English, right? So
+\emph on
+don't
+\emph default
+ choose a language.)
\end_layout
-\begin_layout Section
-Foils [aka
+\begin_layout Enumerate
+Enter
+\family typewriter
+jgrga
+\family default
+ into the document's
\family sans
-FoilTeX
+Extra Options
\family default
-]
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:foiltex"
-
-\end_inset
+ field.
+ (Yes, this is a bug.)
+\end_layout
+\begin_layout Enumerate
+Make sure you use the
+\family typewriter
+agu.bst
+\family default
+ bibliography style, by entering
+\family sans
+agu
+\family default
+ into the second field of the BibTeX inset.
+ None of the standard styles will do.
+\end_layout
+\begin_layout Section
+Broadway
\end_layout
\begin_layout Standard
by
-\noun on
-Allan Rae
+\shape smallcaps
+Garst Reese
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-This section describes how to use LyX to make slides for overhead projectors.
- There are two document classes that can do this: the default slides class
- and the
-\family sans
-FoilTeX
-\family default
- slides class.
- This section documents the latter.
+Broadway is for writing plays.
+ The format is more decorative than Hollywood, and much less standardized.
+ This format should be suitable for workshops.
\end_layout
-\begin_layout Standard
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\begin_layout Subsection
+Special problems
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
+The same as in Hollywood.
+\end_layout
+\begin_layout Subsection
+Special features
\end_layout
\begin_layout Standard
-\align center
-
-\size large
-This section documents the class
-\begin_inset Quotes eld
-\end_inset
-
-
+Insert the
\family sans
-slides (FoilTeX)
+Speaker
\family default
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-
-\emph on
-only.
+\begin_layout Subsection
+Paper size and Margins
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
-
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
+\begin_layout Subsection
+Environments
\end_layout
\begin_layout Standard
-If you're looking for the documentation for
-\begin_inset Quotes eld
-\end_inset
+The following environments are available.
+ You can use broadway.bind to get the bind keys shown at the right.
+\end_layout
+\begin_layout Itemize
\family sans
-slides (default)
-\family default
-
-\begin_inset Quotes erd
+Standard
+\begin_inset Newline newline
\end_inset
-, check out section
-\begin_inset space ~
-\end_inset
+\family default
+You should not have to use this, but it is here for anything that does not
+ fit otherwise.
+\end_layout
+
+\begin_layout Itemize
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:slitex"
+\family sans
+Narrative
+\begin_inset space \hfill{}
+\end_inset
+M-z n
+\begin_inset Newline newline
\end_inset
-.
- If your machine doesn't have the
-\family sans
-foils
+
\family default
- class [
-\begin_inset Quotes eld
-\end_inset
+Used to describe stage setting and the action.
+ First use of speaker names in all CAPs.
+\end_layout
+\begin_layout Itemize
\family sans
-slides (FoilTeX)
-\family default
+ACT
+\begin_inset space \hfill{}
+\end_inset
-\begin_inset Quotes erd
+M-z a
+\begin_inset Newline newline
\end_inset
-] installed, you'll probably have to use the default
-\family sans
-slides
-\family default
- class, which isn't quite as good as
-\family sans
-foils.
-\end_layout
-\begin_layout Standard
-The
-\family sans
-foils
-\family default
- class is designed for use with version 2.1 of the
-\family sans
-foils.cls
\family default
- LaTeX class file which is now an integral part of LaTeX2e.
+Automatically numbered.
+ On screen it will be arabic, but will print as Roman.
\end_layout
-\begin_layout Subsection
-Getting Started
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Obviously, to use this document class, you need to select
-\begin_inset Quotes eld
+\family sans
+ACT*
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S at
+\begin_inset Newline newline
\end_inset
+\family default
+Subtitle for
\family sans
-slides (FoilTeX)
+ACT.
+
\family default
+ It is just centered text.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from the
-\family sans
-Class
-\family default
- entry in the
\family sans
-Document
-\begin_inset space ~
+SCENE
+\begin_inset space \hfill{}
\end_inset
-Layout
-\family default
- dialog.
- There are some settings in the
-\family sans
-Document
-\begin_inset space ~
+M-z S-S
+\begin_inset Newline newline
\end_inset
-Layout
+
\family default
- dialog that you should know about that are specific to this class:
+Not automatically numbered.
+ You supply the number.
+ This is because I couldn't figure out how.
\end_layout
\begin_layout Itemize
-Don't change the options
-\family sans
-Sides
-\family default
- and
-\family sans
-Columns
-\family default
- on the
+
\family sans
-Document
-\begin_inset space ~
+AT_RISE:
+\begin_inset space \hfill{}
\end_inset
-Layout
-\family default
- dialog.
- They're ignored by the
-\family sans
-foils
+M-z S-R
+\begin_inset Newline newline
+\end_inset
+
+
\family default
- class.
+A special case of Narrative to describe the setting and action as the curtain
+ rises.
\end_layout
\begin_layout Itemize
-The default font size is 20
-\begin_inset space \thinspace{}
-\end_inset
-pt with the other options being 17
-\begin_inset space \thinspace{}
+\family sans
+Speaker
+\begin_inset space \hfill{}
\end_inset
-pt, 25
-\begin_inset space \thinspace{}
+M-z s
+\begin_inset Newline newline
\end_inset
-pt and 30
-\begin_inset space \thinspace{}
-\end_inset
-pt.
+\family default
+The speaker's (actor's) title, centered in all CAPS.
\end_layout
\begin_layout Itemize
-The default font is
+
\family sans
-sans
+Parenthetical
+\begin_inset space \hfill{}
+\end_inset
+
+M-z p
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-
+Instructions to the speaker.
+ The parentheses are automatically inserted.
+ The ( will appear on screen, but both will be in the printed play.
+ This environment is only used within
\family sans
-serif
+Dialogue
\family default
- but all math equations are still typeset in the usual roman font.
+.
\end_layout
\begin_layout Itemize
\family sans
-FoilTeX
-\family default
- supports A4 and Letter paper sizes as well as a special size for working
- with 35
-\begin_inset space \thinspace{}
+Dialogue
+\begin_inset space \hfill{}
+\end_inset
+
+M-z d
+\begin_inset Newline newline
\end_inset
-mm slides.
- It doesn't support A5, B5, legal or executive paper sizes.
-\end_layout
-\begin_layout Itemize
-Don't bother changing the
-\family sans
-Float Placement
\family default
- settings because they are ignored anyway.
- All floats appear where they are defined in the text.
+What the Speaker says.
\end_layout
\begin_layout Itemize
-The
+
\family sans
-Pagestyle
-\family default
- setting behaves a bit differently for this class.
-
-\family sans
-FoilTeX
-\family default
- provides extensive footer and header capabilities including a user-defined
- logo.
- See section
-\begin_inset space ~
+CURTAIN
+\begin_inset space \hfill{}
\end_inset
+M-z S-C
+\begin_inset Newline newline
+\end_inset
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:foilfoot"
+\family default
+The curtain comes down.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Title
+\begin_inset space \hfill{}
\end_inset
- for more details.
- The title page is treated differently to all other pages in the document
- and is
-\emph on
-always
-\emph default
- unnumbered and
-\emph on
-always
-\emph default
- has the logo centered at the bottom of the page (if one is defined).
- The possible page style choices and what they do are as follows:
+M-z S-T
\end_layout
-\begin_deeper
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
\family sans
-\series bold
-empty
-\family default
-\series default
- The final output contains no page numbers, or other headers or footers
- (except footnotes of course).
-
+Author
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-A
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Itemize
\family sans
-\series bold
-plain
-\family default
-\series default
- The final output contains page numbers centered at the bottom of the page.
- No other headings or footers (other than footnotes).
-\end_layout
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+M-z r
+\end_layout
-\series bold
-foilheadings
-\series default
- Page numbers in lower right corner.
- Additional headers and footers are also shown.
- This is also the default.
+\begin_layout Standard
+Hello there.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMM
+\begin_layout Section
+Dinbrief
+\end_layout
-\series bold
-fancy
-\series default
- Gives you access to the
-\family sans
-fancyheadings
-\family default
- package although its use with
+\begin_layout Standard
+The document class
\family sans
-FoilTeX
+dinbrief
\family default
- is discouraged by the writer of the
-\family sans
-FoilTeX
+ can be used to type letters according to German conventions.
+ A template file is included in
+\family typewriter
+.../lyx/share/templates
\family default
- package because of some potential page layout clashes.
-\end_layout
-
-\end_deeper
-\begin_layout Subsubsection
-Extra Options
+ for you to use as a starting point.
\end_layout
-\begin_layout Standard
-The following options may be used in the extra class options in the
+\begin_layout Section
+EGS journals (
\family sans
-Document\SpecialChar \menuseparator
-Settings
+egs
\family default
- dialog.
+)
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Standard
+by
+\shape smallcaps
+Martin Vermeer
+\end_layout
-\series bold
-35mmSlide
-\series default
- This sets up the page layout for 7.33
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Subsection
+Description
+\end_layout
-in by 11
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Standard
+This is the layout file for the European Geophysical Society journals.
+ The needed
+\family typewriter
+egs.cls
+\family default
+ can be downloaded from the web site of the EGS under
+\begin_inset Flex URL
+status collapsed
-in paper, which is about the same aspect ratio as a 35
-\begin_inset space \thinspace{}
-\end_inset
+\begin_layout Plain Layout
-mm slide, making it a bit easier to work with this medium.
+www.copernicus.org
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\end_inset
-\series bold
-headrule
-\series default
- Places a rule across the page below the header on every page except the
- title page.
+.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
-
-\series bold
-footrule
-\series default
- Places a rule across the page above the footer on every page except the
- title page.
+\begin_layout Subsection
+New styles
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Standard
-\series bold
-dvips
-\series default
- This is automatically set each time you create a new
\family sans
-foils
+Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
+ Accepted
\family default
- document.
- This option tells
+,
\family sans
-FoilTeX
+Offsets
\family default
- to use the dvips driver to rotate those pages that are set as landscape
- foils.
+.
+ The current layout file is unfortunately very unmodular and would benefit
+ from using the various
+\family typewriter
+std*.inc
+\family default
+ file inclusions.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\begin_layout Section
+Elsevier Journals
+\end_layout
-\series bold
-landscape
-\series default
- Simply changes the page dimensions to those of a landscape page but doesn't
- do any rotation.
- Thus if you use this option you need to use an external program to rotate
- each page or feed your paper through your printer as landscape.
- Note that this option effectively reverses the roles of the
-\family sans
-Foilhead
+\begin_layout Standard
+See the LyX template file
+\family typewriter
+elsarticle.lyx
\family default
- and
+.
+ It contains all infos you need.
+\end_layout
+
+\begin_layout Section
+Foils [aka
\family sans
-Rotatefoilhead
+FoilTeX
\family default
- environments (don't worry these are described in the next section).
-\end_layout
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foiltex"
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\end_inset
-\series bold
-leqno
-\series default
- Equation numbers on the left.
-\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMx
+\end_layout
-\series bold
-fleqn
-\series default
- Flush-left equations.
+\begin_layout Standard
+by
+\noun on
+Allan Rae
\end_layout
\begin_layout Subsection
-Supported Environments
+Introduction
\end_layout
\begin_layout Standard
-Most of the environments commonly supported in other classes are also supported
- by the
+This section describes how to use LyX to make slides for overhead projectors.
+ There are two document classes that can do this: the default slides class
+ and the
\family sans
-foils
+FoilTeX
\family default
- class.
- There are several additional environments provided by
-\family sans
-FoilTeX
-\family default
- as well as a couple added by LyX.
- The following environments are shared with other classes:
+ slides class.
+ This section documents the latter.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
+I'm going to say this again, nice and clear, so that there's no misunderstanding
+:
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\align center
-\family sans
-Standard
-\end_layout
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Itemize
-\end_layout
+slides (FoilTeX)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Enumerate
+
+\emph on
+only.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Description
-\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-\begin_layout Itemize
-\family sans
-List
\end_layout
-\begin_layout Itemize
-
-\family sans
-LyX-Code
-\end_layout
+\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Verse
-\end_layout
+slides (default)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Quote
-\end_layout
+, check out section
+\begin_inset space ~
+\end_inset
-\begin_layout Itemize
-\family sans
-Quotation
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slitex"
-\begin_layout Itemize
+\end_inset
+.
+ If your machine doesn't have the
\family sans
-Title
-\end_layout
+foils
+\family default
+ class [
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
\family sans
-Author
-\end_layout
+slides (FoilTeX)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+] installed, you'll probably have to use the default
\family sans
-Date
+slides
+\family default
+ class, which isn't quite as good as
+\family sans
+foils.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+The
\family sans
-Abstract
+foils
+\family default
+ class is designed for use with version 2.1 of the
+\family sans
+foils.cls
+\family default
+ LaTeX class file which is now an integral part of LaTeX2e.
\end_layout
-\begin_layout Itemize
-
-\family sans
-Bibliography
+\begin_layout Subsection
+Getting Started
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
+\end_inset
+
\family sans
-Address
-\end_layout
+slides (FoilTeX)
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
+ from the
\family sans
-RightAddress
-\end_layout
-
-\begin_layout Itemize
+Class
+\family default
+ entry in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+Layout
+\family default
+ dialog.
+ There are some settings in the
\family sans
-Caption
+Document
+\begin_inset space ~
+\end_inset
+
+Layout
+\family default
+ dialog that you should know about that are specific to this class:
\end_layout
\begin_layout Itemize
+Don't change the options
+\family sans
+Sides
+\family default
+ and
+\family sans
+Columns
+\family default
+ on the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+Layout
+\family default
+ dialog.
+ They're ignored by the
\family sans
-Comment
+foils
+\family default
+ class.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
+\begin_layout Itemize
+The default font size is 20
+\begin_inset space \thinspace{}
+\end_inset
-\backslash
-end{multicols}
-\end_layout
+pt with the other options being 17
+\begin_inset space \thinspace{}
+\end_inset
+pt, 25
+\begin_inset space \thinspace{}
\end_inset
+pt and 30
+\begin_inset space \thinspace{}
+\end_inset
+pt.
\end_layout
-\begin_layout 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
+The default font is
\family sans
-FoilTeX
+sans
\family default
- provides specific commands for starting new foils and these are:
-\end_layout
-
-\begin_layout Itemize
-
+
\family sans
-Foilhead
+serif
+\family default
+ but all math equations are still typeset in the usual roman font.
\end_layout
\begin_layout Itemize
\family sans
-Rotatefoilhead
-\end_layout
+FoilTeX
+\family default
+ supports A4 and Letter paper sizes as well as a special size for working
+ with 35
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Standard
-LyX also provides slightly modified versions of these two environments called:
+mm slides.
+ It doesn't support A5, B5, legal or executive paper sizes.
\end_layout
\begin_layout Itemize
-
+Don't bother changing the
\family sans
-ShortFoilhead
+Float Placement
+\family default
+ settings because they are ignored anyway.
+ All floats appear where they are defined in the text.
\end_layout
\begin_layout Itemize
-
+The
\family sans
-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
+Pagestyle
+\family default
+ setting behaves a bit differently for this class.
\family sans
FoilTeX
\family default
- also provides a comprehensive box of goodies for presenting them:
-\end_layout
+ provides extensive footer and header capabilities including a user-defined
+ logo.
+ See section
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status open
-\begin_layout Plain Layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foilfoot"
+\end_inset
-\backslash
-begin{multicols}{2}
+ for more details.
+ The title page is treated differently to all other pages in the document
+ and is
+\emph on
+always
+\emph default
+ unnumbered and
+\emph on
+always
+\emph default
+ has the logo centered at the bottom of the page (if one is defined).
+ The possible page style choices and what they do are as follows:
\end_layout
-\end_inset
-
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+\family sans
+\series bold
+empty
+\family default
+\series default
+ The final output contains no page numbers, or other headers or footers
+ (except footnotes of course).
+
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
\family sans
-Theorem
+\series bold
+plain
+\family default
+\series default
+ The final output contains page numbers centered at the bottom of the page.
+ No other headings or footers (other than footnotes).
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
-\family sans
-Lemma
+\series bold
+foilheadings
+\series default
+ Page numbers in lower right corner.
+ Additional headers and footers are also shown.
+ This is also the default.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+\series bold
+fancy
+\series default
+ Gives you access to the
\family sans
-Corollary
+fancyheadings
+\family default
+ package although its use with
+\family sans
+FoilTeX
+\family default
+ is discouraged by the writer of the
+\family sans
+FoilTeX
+\family default
+ package because of some potential page layout clashes.
\end_layout
-\begin_layout Itemize
+\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
-Proposition
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\family sans
-Definition
+\series bold
+35mmSlide
+\series default
+ This sets up the page layout for 7.33
+\begin_inset space \thinspace{}
+\end_inset
+
+in by 11
+\begin_inset space \thinspace{}
+\end_inset
+
+in paper, which is about the same aspect ratio as a 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slide, making it a bit easier to work with this medium.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\family sans
-Proof
+\series bold
+headrule
+\series default
+ Places a rule across the page below the header on every page except the
+ title page.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\family sans
-Theorem*
+\series bold
+footrule
+\series default
+ Places a rule across the page above the footer on every page except the
+ title page.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+\series bold
+dvips
+\series default
+ This is automatically set each time you create a new
\family sans
-Lemma*
+foils
+\family default
+ document.
+ This option tells
+\family sans
+FoilTeX
+\family default
+ to use the dvips driver to rotate those pages that are set as landscape
+ foils.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+\series bold
+landscape
+\series default
+ Simply changes the page dimensions to those of a landscape page but doesn't
+ do any rotation.
+ Thus if you use this option you need to use an external program to rotate
+ each page or feed your paper through your printer as landscape.
+ Note that this option effectively reverses the roles of the
\family sans
-Corollary*
+Foilhead
+\family default
+ and
+\family sans
+Rotatefoilhead
+\family default
+ environments (don't worry these are described in the next section).
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\family sans
-Proposition*
+\series bold
+leqno
+\series default
+ Equation numbers on the left.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+
+\series bold
+fleqn
+\series default
+ Flush-left equations.
+\end_layout
+\begin_layout Subsection
+Supported Environments
+\end_layout
+
+\begin_layout Standard
+Most of the environments commonly supported in other classes are also supported
+ by the
\family sans
-Definition*
+foils
+\family default
+ class.
+ There are several additional environments provided by
+\family sans
+FoilTeX
+\family default
+ as well as a couple added by LyX.
+ The following environments are shared with other classes:
\end_layout
\begin_layout Standard
\backslash
-end{multicols}
+begin{multicols}{2}
\end_layout
\end_inset
\end_layout
-\begin_layout Standard
-The starred versions are unnumbered while the unstarred versions are numbered.
- There are also two list environments added by LyX and these are:
+\begin_layout Itemize
+
+\family sans
+Standard
\end_layout
\begin_layout Itemize
\family sans
-TickList
+Itemize
\end_layout
\begin_layout Itemize
\family sans
-CrossList
+Enumerate
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-FoilTeX
-\family default
- provides some powerful header and footer capabilities that are best set
- in the preamble although they may be set at any point in a document.
- If you want to change these settings in your document the best place to
- do so is at the very top of a foil, i.
-\begin_inset space \thinspace{}
-\end_inset
+Description
+\end_layout
-g.
-\emph on
+\begin_layout Itemize
-\begin_inset space \space{}
-\end_inset
+\family sans
+List
+\end_layout
+\begin_layout Itemize
-\emph default
-straight after the foilhead.
+\family sans
+LyX-Code
\end_layout
-\begin_layout Standard
-For this purpose, the following command styles are provided [
-\shape smallcaps
-Martin Vermeer
-\shape default
-]:
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
+\family sans
+Verse
+\end_layout
+\begin_layout Itemize
-\backslash
-begin{multicols}{2}
+\family sans
+Quote
\end_layout
-\end_inset
-
+\begin_layout Itemize
+\family sans
+Quotation
\end_layout
\begin_layout Itemize
\family sans
-My
-\begin_inset space ~
-\end_inset
-
-Logo
+Title
\end_layout
\begin_layout Itemize
\family sans
-Restriction
+Author
\end_layout
\begin_layout Itemize
\family sans
-Right
-\begin_inset space ~
-\end_inset
-
-Footer
+Date
\end_layout
\begin_layout Itemize
\family sans
-Right
-\begin_inset space ~
-\end_inset
+Abstract
+\end_layout
-Header
+\begin_layout Itemize
+
+\family sans
+Bibliography
\end_layout
\begin_layout Itemize
\family sans
-Left
-\begin_inset space ~
-\end_inset
+Address
+\end_layout
-Header
+\begin_layout Itemize
+
+\family sans
+RightAddress
\end_layout
-\begin_deeper
-\begin_layout Standard
-\begin_inset space ~
-\end_inset
+\begin_layout Itemize
+\family sans
+Caption
+\end_layout
+
+\begin_layout Itemize
+\family sans
+Comment
\end_layout
-\end_deeper
\begin_layout Standard
\begin_inset ERT
status open
\end_layout
\begin_layout Standard
-There are also a few commands provided by
+That is, all the major environments apart from the sectioning environments.
+ Since foils are essentially self-contained sections, with a title and body,
+
\family sans
FoilTeX
\family default
- that aren't directly supported by LyX but I'll tell you what they do and
- how to use them in section
-\begin_inset space ~
-\end_inset
-
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:unsuppfoils"
+ provides specific commands for starting new foils and these are:
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
+\family sans
+Foilhead
\end_layout
-\begin_layout Subsection
-Building a Set of Foils
+\begin_layout Itemize
+
+\family sans
+Rotatefoilhead
\end_layout
\begin_layout Standard
-This section will give a simple introduction to using the different environments
- to build a set of foils.
- If you want to see an example set of foils, take a look at the
-\family typewriter
-Foils.lyx
-\family default
- file you find in LyX's
-\family typewriter
-examples
-\family default
- folder.
+LyX also provides slightly modified versions of these two environments called:
\end_layout
-\begin_layout Subsubsection
-Give It a Title Page
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-Unlike other classes that provide
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
- and
-\family sans
-Abstract
-\family default
- environments,
-\family sans
-foils
-\family default
- creates the title on a page of its own.
- If you leave out the
\family sans
-Date
-\family default
- environment LaTeX will substitute the current date (every time you regenerate
- the output).
+ShortFoilhead
\end_layout
-\begin_layout Subsubsection
-Start a New Foil
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-As I mentioned earlier, there are four ways of starting a new foil.
- For portrait foils you should use
-\family sans
-Foilhead
-\family default
- or
\family sans
-ShortFoilhead.
+ShortRotatefoilhead
+\end_layout
-\family default
- The difference between these two environments is the amount of space between
- the title of the foil (the foilhead) and the body of the foil.
+\begin_layout Standard
+and the differences will be explained in the next section.
\end_layout
\begin_layout Standard
-Landscape foils are generated using the
-\family sans
-Rotatefoilhead
-\family default
- and
+Since foils are often used in presenting ideas or new theorems and such
+
\family sans
-ShortRotatefoilhead
+FoilTeX
\family default
- environments.
- Again the only difference is the spacing between foilhead and body.
- Both of the short versions have 0.5 inches less separation between the foilhead
- and the body.
-
+ also provides a comprehensive box of goodies for presenting them:
\end_layout
\begin_layout Standard
-One problem with the support for landscape foils is the requirement that
- you have to use the
-\family typewriter
-dvips
-\family default
- driver to generate the PostScript output otherwise the foils won't be rotated.
- It is possible to get landscape foils even if you haven't got the
-\family typewriter
-dvips
-\family default
- driver provided you can feed your foils sideways through your printer ;-)
-\end_layout
+\begin_inset ERT
+status open
-\begin_layout Subsubsection
-Theorems, Lemmas, Proofs and more
+\begin_layout Plain Layout
+
+
+\backslash
+begin{multicols}{2}
\end_layout
-\begin_layout Standard
-Due to a small bug in LyX you can't have two of the same type of these environme
-nts directly following each other.
- They must be separated by something.
- If you try, you will just be extending the previous environment as if you
- had merged the two environments together.
- So, how do you get around this problem? The simplest option is to insert
- some text between the two environments or add a
-\family sans
-LaTeX
-\family default
- environment between the two with just a
-\begin_inset Quotes eld
\end_inset
-\family typewriter
-%
-\family default
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- in it.
- This will force LyX to produce two separate environments and hence the
- correct LaTeX output.
- An example is provided in the example file included with the LyX distribution.
- Remember, this problem only occurs if you are trying to place two of the
- same type of theorem-like environments one directly after the other.
+\family sans
+Theorem
\end_layout
-\begin_layout Subsubsection
-Lists
+\begin_layout Itemize
+
+\family sans
+Lemma
\end_layout
-\begin_layout Standard
-You get all the commonly supported list styles found in other classes as
- well as two new ones.
- I'll only describe the new ones here.
- If you want to find out more about the other list environments check out
- the
-\emph on
-User's Guide.
+\begin_layout Itemize
-\emph default
- If you intend to use itemized lists you might also want to read about the
-
\family sans
-Itemize
-\begin_inset space ~
-\end_inset
+Corollary
+\end_layout
-Bullet
-\begin_inset space ~
-\end_inset
+\begin_layout Itemize
-Selection
-\family default
- dialog described above in section
-\begin_inset space ~
-\end_inset
+\family sans
+Proposition
+\end_layout
+\begin_layout Itemize
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:bullet"
+\family sans
+Definition
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
+\family sans
+Proof
\end_layout
-\begin_layout Standard
-The two new list styles,
+\begin_layout Itemize
+
\family sans
-TickList
-\family default
- and
+Theorem*
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-CrossList
-\family default
-, are designed to make it easier for you to create lists of do's and don'ts
- or right and wrong by providing dedicated environments that use a tick
- or a cross as the label of the list.
- These lists are in fact dedicated variants of the
+Lemma*
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Itemize
-\family default
- environment.
- They do however require that you have the
-\family typewriter
-psnfss
-\family default
- packages installed.
+Corollary*
\end_layout
-\begin_layout Subsubsection
-Figures and Tables
+\begin_layout Itemize
+
+\family sans
+Proposition*
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
\family sans
-FoilTeX
-\family default
- redefines the floating tables and figures so that they appear exactly where
- they are in the text rather than pushing them to the top of the page or
- to some user specified location.
- In fact if you change the float placement settings they are simply ignored.
+Definition*
\end_layout
-\begin_layout Subsubsection
-Page Headers and Footers
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:foilfoot"
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+end{multicols}
+\end_layout
\end_inset
\end_layout
\begin_layout Standard
+The starred versions are unnumbered while the unstarred versions are numbered.
+ There are also two list environments added by LyX and these are:
+\end_layout
+
+\begin_layout Itemize
\family sans
-My
-\begin_inset space ~
-\end_inset
+TickList
+\end_layout
+
+\begin_layout Itemize
-Logo
-\family default
- and
\family sans
-Restriction
-\family default
- are two commands used to control the left-footer text string.
- The first is meant to allow you to include a graphic logo on your foils
- and defaults to
-\begin_inset Quotes eld
-\end_inset
+CrossList
+\end_layout
+
+\begin_layout Standard
--Typeset by
\family sans
FoilTeX
\family default
--
-\begin_inset Quotes erd
+ provides some powerful header and footer capabilities that are best set
+ in the preamble although they may be set at any point in a document.
+ If you want to change these settings in your document the best place to
+ do so is at the very top of a foil, i.
+\begin_inset space \thinspace{}
\end_inset
-.
- While the second is meant to provide a classification for the audience,
-
-\emph on
e.
-\begin_inset space \thinspace{}
+\emph on
+
+\begin_inset space \space{}
\end_inset
-g.
+
\emph default
+straight after the foilhead.
+\end_layout
+
+\begin_layout Standard
+For this purpose, the following command styles are provided [
+\shape smallcaps
+Martin Vermeer
+\shape default
+]:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+begin{multicols}{2}
+\end_layout
-\begin_inset space \space{}
\end_inset
-Confidential.
- It is empty by default.
+
\end_layout
-\begin_layout Standard
-The remaining page corners can be filled by
+\begin_layout Itemize
+
+\family sans
+My
+\begin_inset space ~
+\end_inset
+
+Logo
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Restriction
+\end_layout
+
+\begin_layout Itemize
+
\family sans
Right
\begin_inset space ~
\end_inset
Footer
-\family default
- (which defaults to page numbers),
+\end_layout
+
+\begin_layout Itemize
+
\family sans
Right
\begin_inset space ~
\end_inset
Header
-\family default
- (top right) and
+\end_layout
+
+\begin_layout Itemize
+
\family sans
Left
\begin_inset space ~
\end_inset
Header
-\family default
- (top left).
\end_layout
-\begin_layout Subsection
-Unsupported
+\begin_deeper
+\begin_layout Standard
+\begin_inset space ~
+\end_inset
+
+
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+
+\backslash
+end{multicols}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+There are also a few commands provided by
\family sans
FoilTeX
\family default
- Goodies
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:unsuppfoils"
+ that aren't directly supported by LyX but I'll tell you what they do and
+ how to use them in section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:unsuppfoils"
\end_inset
+.
+\end_layout
+\begin_layout Subsection
+Building a Set of Foils
\end_layout
\begin_layout Standard
-All the commands mentioned below need to be set in a
-\family sans
-LaTeX
+This section will give a simple introduction to using the different environments
+ to build a set of foils.
+ If you want to see an example set of foils, take a look at the
+\family typewriter
+Foils.lyx
\family default
- environment or as
-\family sans
-TeX
+ file you find in LyX's
+\family typewriter
+examples
\family default
- within another environment.
+ folder.
\end_layout
\begin_layout Subsubsection
-Lengths
+Give It a Title Page
\end_layout
\begin_layout Standard
-All lengths are adjusted using the
-\family typewriter
-
-\backslash
-setlength{
+Unlike other classes that provide
+\family sans
+Title
\family default
-\emph on
-lengthname
-\family typewriter
-\emph default
-}{
+,
+\family sans
+Author
\family default
-\emph on
-newlength
-\family typewriter
-\emph default
-}
+,
+\family sans
+Date
\family default
- command.
- Where
-\emph on
-lengthname
-\emph default
- should be replaced by the name given to the length you want to change and
-
-\emph on
-newlength
-\emph default
- is the length value.
- All lengths should be specified in units of length such as inches (
-\family typewriter
-in
+ and
+\family sans
+Abstract
\family default
-), millimeters (
-\family typewriter
-mm
+ environments,
+\family sans
+foils
\family default
-) or points (
-\family typewriter
-pt
+ creates the title on a page of its own.
+ If you leave out the
+\family sans
+Date
\family default
-) or relative to some document or font-based length such as
-\family typewriter
+ environment LaTeX will substitute the current date (every time you regenerate
+ the output).
+\end_layout
-\backslash
-textwidth
-\family default
-.
-
+\begin_layout Subsubsection
+Start a New Foil
\end_layout
\begin_layout Standard
-It's possible to change the spacing between a foilhead and the body of the
- foil by adjusting the length specified by
-\family typewriter
-
-\backslash
-foilheadskip
+As I mentioned earlier, there are four ways of starting a new foil.
+ For portrait foils you should use
+\family sans
+Foilhead
\family default
-.
- For example, to make
-\emph on
-all
-\emph default
- foilheads 0.5
-\begin_inset space \space{}
-\end_inset
-
-in closer to their bodies put the following in the preamble:
-\family typewriter
+ or
+\family sans
+ShortFoilhead.
-\backslash
-setlength{
-\backslash
-foilheadskip}{-0.5in}
+\family default
+ The difference between these two environments is the amount of space between
+ the title of the foil (the foilhead) and the body of the foil.
\end_layout
\begin_layout Standard
-The spacings around floats can be adjusted by setting these lengths:
+Landscape foils are generated using the
+\family sans
+Rotatefoilhead
+\family default
+ and
+\family sans
+ShortRotatefoilhead
+\family default
+ environments.
+ Again the only difference is the spacing between foilhead and body.
+ Both of the short versions have 0.5 inches less separation between the foilhead
+ and the body.
+
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
-
+\begin_layout Standard
+One problem with the support for landscape foils is the requirement that
+ you have to use the
\family typewriter
-
-\backslash
-abovefloatskip
+dvips
\family default
- Separation between the text and the top of the float
-\end_layout
-
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
-
+ driver to generate the PostScript output otherwise the foils won't be rotated.
+ It is possible to get landscape foils even if you haven't got the
\family typewriter
-
-\backslash
-abovecaptionskip
+dvips
\family default
- Separation between the float and the caption
+ driver provided you can feed your foils sideways through your printer ;-)
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+\begin_layout Subsubsection
+Theorems, Lemmas, Proofs and more
+\end_layout
-\backslash
-belowcaptionskip
+\begin_layout Standard
+Due to a small bug in LyX you can't have two of the same type of these environme
+nts directly following each other.
+ They must be separated by something.
+ If you try, you will just be extending the previous environment as if you
+ had merged the two environments together.
+ So, how do you get around this problem? The simplest option is to insert
+ some text between the two environments or add a
+\family sans
+LaTeX
\family default
- Separation between the caption and the following text
-\end_layout
+ environment between the two with just a
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
\family typewriter
-
-\backslash
-captionwidth
+%
\family default
- You can make the captions narrower than the surrounding text by adjusting
- this length.
- Best done relative to
-\family typewriter
-\backslash
-textwidth
-\family default
-.
+\begin_inset Quotes erd
+\end_inset
+
+ in it.
+ This will force LyX to produce two separate environments and hence the
+ correct LaTeX output.
+ An example is provided in the example file included with the LyX distribution.
+ Remember, this problem only occurs if you are trying to place two of the
+ same type of theorem-like environments one directly after the other.
\end_layout
-\begin_layout Standard
-There are also several title page related lengths that you may find useful
- if you have a long title or several authors:
+\begin_layout Subsubsection
+Lists
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Standard
+You get all the commonly supported list styles found in other classes as
+ well as two new ones.
+ I'll only describe the new ones here.
+ If you want to find out more about the other list environments check out
+ the
+\emph on
+User's Guide.
-\family typewriter
+\emph default
+ If you intend to use itemized lists you might also want to read about the
+
+\family sans
+Itemize
+\begin_inset space ~
+\end_inset
-\backslash
-abovetitleskip
+Bullet
+\begin_inset space ~
+\end_inset
+
+Selection
\family default
- Separation from headers to
-\family sans
-Title
-\end_layout
+ dialog described above in section
+\begin_inset space ~
+\end_inset
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
-\family typewriter
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:bullet"
-\backslash
-titleauthorskip
-\family default
- between
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+The two new list styles,
\family sans
-Title
+TickList
\family default
and
\family sans
-Author
+CrossList
\family default
- environments
+, are designed to make it easier for you to create lists of do's and don'ts
+ or right and wrong by providing dedicated environments that use a tick
+ or a cross as the label of the list.
+ These lists are in fact dedicated variants of the
+\family sans
+Itemize
+\family default
+ environment.
+ They do however require that you have the
+\family typewriter
+psnfss
+\family default
+ packages installed.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Subsubsection
+Figures and Tables
+\end_layout
-\family typewriter
+\begin_layout Standard
-\backslash
-authorauthorskip
-\family default
- between multiple
\family sans
-Author
+FoilTeX
\family default
- lines
+ redefines the floating tables and figures so that they appear exactly where
+ they are in the text rather than pushing them to the top of the page or
+ to some user specified location.
+ In fact if you change the float placement settings they are simply ignored.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
-
-\family typewriter
+\begin_layout Subsubsection
+Page Headers and Footers
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foilfoot"
-\backslash
-authordateskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
+\family sans
+My
+\begin_inset space ~
+\end_inset
+
+Logo
\family default
- between the
+ and
\family sans
-Author
+Restriction
\family default
- and the
+ are two commands used to control the left-footer text string.
+ The first is meant to allow you to include a graphic logo on your foils
+ and defaults to
+\begin_inset Quotes eld
+\end_inset
+
+-Typeset by
\family sans
-Date
+FoilTeX
+\family default
+-
+\begin_inset Quotes erd
+\end_inset
+
+.
+ While the second is meant to provide a classification for the audience,
+
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\emph default
+
+\begin_inset space \space{}
+\end_inset
+
+Confidential.
+ It is empty by default.
\end_layout
-\begin_layout Labeling
-\labelwidthstring MMMMMMMMMMM
+\begin_layout Standard
+The remaining page corners can be filled by
+\family sans
+Right
+\begin_inset space ~
+\end_inset
-\family typewriter
+Footer
+\family default
+ (which defaults to page numbers),
+\family sans
+Right
+\begin_inset space ~
+\end_inset
-\backslash
-dateabstractskip
+Header
\family default
- between the
+ (top right) and
\family sans
-Date
+Left
+\begin_inset space ~
+\end_inset
+
+Header
\family default
- and the
+ (top left).
+\end_layout
+
+\begin_layout Subsection
+Unsupported
\family sans
-Abstract
+FoilTeX
+\family default
+ Goodies
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:unsuppfoils"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-The last length related command affects all the list environments.
- If you place
-\family typewriter
-
-\backslash
-zerolistvertdimens
+All the commands mentioned below need to be set in a
+\family sans
+LaTeX
\family default
-
-\emph on
-inside
-\emph default
- a list environment then all the vertical spacing between the list items
- is removed.
- Note that this is a command not a length so it doesn't require
-\family typewriter
-
-\backslash
-setlength
+ environment or as
+\family sans
+TeX
\family default
- like the stuff mentioned above.
+ within another environment.
\end_layout
\begin_layout Subsubsection
-Headers and Footers
+Lengths
\end_layout
\begin_layout Standard
-The
+All lengths are adjusted using the
\family typewriter
\backslash
-LogoOn
+setlength{
\family default
- and
+\emph on
+lengthname
\family typewriter
-
-\backslash
-LogoOff
+\emph default
+}{
\family default
- commands control whether the logo in the
-\family sans
-MyLogo
+\emph on
+newlength
+\family typewriter
+\emph default
+}
\family default
- definition appear on a given page.
- If you put
+ command.
+ Where
+\emph on
+lengthname
+\emph default
+ should be replaced by the name given to the length you want to change and
+
+\emph on
+newlength
+\emph default
+ is the length value.
+ All lengths should be specified in units of length such as inches (
\family typewriter
-
-\backslash
-LogoOff
+in
\family default
- in the preamble then none of the foils will have the logo on them.
- If you don't want the logo on a particular page place the
+), millimeters (
\family typewriter
-
-\backslash
-LogoOff
+mm
\family default
- directly after the foilhead of that page and the
+) or points (
+\family typewriter
+pt
+\family default
+) or relative to some document or font-based length such as
\family typewriter
\backslash
-LogoOn
+textwidth
\family default
- directly after the next foilhead.
+.
+
\end_layout
\begin_layout Standard
-If you decide to use the
-\family sans
-fancy
+It's possible to change the spacing between a foilhead and the body of the
+ foil by adjusting the length specified by
+\family typewriter
+
+\backslash
+foilheadskip
\family default
- page style setting in the
-\family sans
-Document
-\begin_inset space ~
+.
+ For example, to make
+\emph on
+all
+\emph default
+ foilheads 0.5
+\begin_inset space \space{}
\end_inset
-Layout
-\family default
- dialog you should probably add
+in closer to their bodies put the following in the preamble:
\family typewriter
\backslash
-let
-\backslash
-headwidth
+setlength{
\backslash
-textwidth
-\family default
- to your preamble so headers and footers on landscape pages are correctly
- placed when rotated.
- This is due to some clashes between the page layouts provided by the
-\family sans
-fancyheadings
-\family default
- package and the
-\family sans
-foils
-\family default
- class.
-\end_layout
-
-\begin_layout Section
-Hollywood (Hollywood spec scripts)
+foilheadskip}{-0.5in}
\end_layout
\begin_layout Standard
-by
-\shape smallcaps
-Garst Reese
+The spacings around floats can be adjusted by setting these lengths:
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+abovefloatskip
+\family default
+ Separation between the text and the top of the float
\end_layout
-\begin_layout Standard
-Getting the format of a Hollywood script right is a
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-rite of passage.
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- It is designed to make the readers focus on content and to be easy and
- familiar for the actors to read.
+\backslash
+abovecaptionskip
+\family default
+ Separation between the float and the caption
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+belowcaptionskip
+\family default
+ Separation between the caption and the following text
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+captionwidth
+\family default
+ You can make the captions narrower than the surrounding text by adjusting
+ this length.
+ Best done relative to
+\family typewriter
+
+\backslash
+textwidth
+\family default
+.
+\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 Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+abovetitleskip
+\family default
+ Separation from headers to
+\family sans
+Title
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+titleauthorskip
+\family default
+ between
+\family sans
+Title
+\family default
+ and
+\family sans
+Author
+\family default
+ environments
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+authorauthorskip
+\family default
+ between multiple
+\family sans
+Author
+\family default
+ lines
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+authordateskip
+\family default
+ between the
+\family sans
+Author
+\family default
+ and the
+\family sans
+Date
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+dateabstractskip
+\family default
+ between the
+\family sans
+Date
+\family default
+ and the
+\family sans
+Abstract
+\end_layout
+
+\begin_layout Standard
+The last length related command affects all the list environments.
+ If you place
+\family typewriter
+
+\backslash
+zerolistvertdimens
+\family default
+
+\emph on
+inside
+\emph default
+ a list environment then all the vertical spacing between the list items
+ is removed.
+ Note that this is a command not a length so it doesn't require
+\family typewriter
+
+\backslash
+setlength
+\family default
+ like the stuff mentioned above.
+\end_layout
+
+\begin_layout Subsubsection
+Headers and Footers
+\end_layout
+
+\begin_layout Standard
+The
+\family typewriter
+
+\backslash
+LogoOn
+\family default
+ and
+\family typewriter
+
+\backslash
+LogoOff
+\family default
+ commands control whether the logo in the
+\family sans
+MyLogo
+\family default
+ definition appear on a given page.
+ If you put
+\family typewriter
+
+\backslash
+LogoOff
+\family default
+ in the preamble then none of the foils will have the logo on them.
+ If you don't want the logo on a particular page place the
+\family typewriter
+
+\backslash
+LogoOff
+\family default
+ directly after the foilhead of that page and the
+\family typewriter
+
+\backslash
+LogoOn
+\family default
+ directly after the next foilhead.
+\end_layout
+
+\begin_layout Standard
+If you decide to use the
+\family sans
+fancy
+\family default
+ page style setting in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
+
+Layout
+\family default
+ dialog you should probably add
+\family typewriter
+
+\backslash
+let
+\backslash
+headwidth
+\backslash
+textwidth
+\family default
+ to your preamble so headers and footers on landscape pages are correctly
+ placed when rotated.
+ This is due to some clashes between the page layouts provided by the
+\family sans
+fancyheadings
+\family default
+ package and the
+\family sans
+foils
+\family default
+ class.
+\end_layout
+
+\begin_layout Section
+Hollywood (Hollywood spec scripts)
+\end_layout
+
+\begin_layout Standard
+by
+\shape smallcaps
+Garst Reese
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+Getting the format of a Hollywood script right is a
+\begin_inset Quotes eld
+\end_inset
+
+rite of passage.
+\begin_inset Quotes erd
+\end_inset
+
+ It is designed to make the readers focus on content and to be easy and
+ familiar for the actors to read.
Each page of a script should be one minute of film.
Nothing goes in a script that you cannot see or hear on screen.
The courier 12 pt font should be used throughout.
command to implement table captions.
As a result, a table created by LyX is printed correctly, but its caption
is ignored.
- However, you can use some TeX code to overpass this problem, so that captions
+ However, you can use some TeX code to overcome this problem, so that captions
are printed as expected.
To do so, create a float table as usual, remove the caption, and replace
it with the TeX code
\end_layout
\begin_layout Itemize
-To be able to compile your document to a PDF, PS, or DVI, assure that the
+To be able to compile your document to a PDF, PS, or DVI, ensure that the
two options
\family sans
Use AMS math package
\emph default
, but there are many others (see a complete list at
\begin_inset Flex URL
-status collapsed
+status open
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
Document
\family default
).
- A detailed German description of these options can be found in the Koma-Script
- documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
Settings
\family default
.
- A detailed German description of these and other type area options can
- be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-A detailed German description of the LaTeX document classes of the Koma-Script
- family can be found in the Koma-Script documentation
+Detailed descriptions of the LaTeX document classes of the Koma-Script family
+ can be found in the Koma-Script documentation
\emph on
scrguide
\emph default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-There is an English translation
+ (German) and
\emph on
-screnggu
+scrguien
\emph default
-, but it is not a complete one.
-\end_layout
-
-\end_inset
-
- The following sections describe only those aspects, which are relevant
- in LyX.
+ (English).
\end_layout
\begin_layout Subsection
letter (koma-script)
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
\begin_layout Standard
\noindent
The document class
Furthermore, there are a number of new letter specific types.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\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.
.
It has — on the LaTeX side — a completely new interface and is not compatible
with the old class.
- Therefore, LyX supports both, though it is recommended to use the new class.
+ Therefore, LyX supports both, though it is recommended you use the new
+ class.
\end_layout
\begin_layout Standard
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_layout Standard
The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
+ to meet almost any needs.
This can be done via the preamble or with a special style file (Letter
Class Option, extension
\family typewriter
document to produce the gap, which is not what is wanted in this case.
\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
-\family sans
-latex.sty
-\family default
- package and associated bibliography style file is included in the kit.
- The Authors Kit is usually sent out by email once your initial submission
- has been accepted.
- There is a lot of useful information in the Authors Kit explaining formatting
- restrictions and so on and I will assume you have read this since that
- means I don't have to repeat it all here.
-\end_layout
-
-\begin_layout Subsection
-Getting Started
-\end_layout
-
-\begin_layout Standard
-[AR\SpecialChar \@.
- more to come]
-\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
- will appear in the output so don't let this worry you.
-\end_layout
-
\begin_layout Section
Memoir
\end_layout
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
+, lots will probably never be supported, due to the limitations of LyX's
+ framework.
Of course you can still use all features with the help of some native LaTeX
commands (TeX code
\begin_inset Foot
\end_inset
).
- In this section, we can only list those features which are natively supported
+ In this section, we can only list those features that are natively supported
by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
+ For detailed descriptions (and for the rest of features) we recommend you
+ have a look at the detailed manual of the Memoir class
\begin_inset Foot
status collapsed
\end_inset
style: The fancy page style is not supported, due to a command clash between
- Memoir and the fancyhdr package (they are both defining a command with
- the same name, which confuses LaTeX).
- Instead, Memoir comes with a bunch of own page styles (see
+ Memoir and the fancyhdr package (they both define a command with the same
+ name, which confuses LaTeX).
+ Instead, Memoir comes with a number of its own page styles (see
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
\end_layout
\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
+Sectioning: Sectionings (chapter, section, subsection etc.) come with an
+ optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
In LyX, you can do this via
\begin_inset Quotes erd
\end_inset
-, i.
-\begin_inset space \thinspace{}
-\end_inset
-
-g.
-\begin_inset space \space{}
-\end_inset
-
-without pagina).
+).
If you want an empty title page, type
\family typewriter
\end_layout
\begin_layout Description
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
+Chapterprecis: You may know this older typesetting style: The contents of
+ a chapter are summarized below the title and also in the table of contents
(e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
Slide
\family default
, for example.
- In that case, enter in your descriptive comment and hit
+ In that case, enter your descriptive comment and hit
\family sans
Return
\family default
\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.
+If, on the other hand, you don't want to enter any descriptive text, you'll
+ hit another LyX quirk.
LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
environment until you put something in the old one.
So, do this:
\family typewriter
chktex
\family default
- it from CTAN,
+ from CTAN,
\begin_inset CommandInset href
LatexCommand href
target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
ChkTeX
\family default
package is a program that was written by
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\begin_inset Newline newline
\end_inset
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
+If you have bad luck, the text will break right between the referenced text
+ and reference number, and that's a pity.
See section
\begin_inset CommandInset ref
LatexCommand ref
\family sans
ChkTeX
\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
+, and this gap can make some warnings seem arcane or just plain silly.
\end_layout
\begin_layout Standard
ChkTeX
\family default
to get better along with you.
- Another choice in the most desperate situations is to use
-\family sans
-View\SpecialChar \menuseparator
-Remove
-\begin_inset space ~
-\end_inset
-
-All
-\begin_inset space ~
-\end_inset
-
-Error
-\begin_inset space ~
-\end_inset
-
-Boxes
-\family default
-, which will get rid of all warnings instantly.
\end_layout
\begin_layout Standard
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
+ to the internal document structure, some of the warnings will not appear
+ correctly.
There are two things you can do about this:
\end_layout
ChkTeX
\family default
invocation command line in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Outputs
-\family default
-,
-\family sans
-Misc
-\family default
-), or the global
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+LaTeX\SpecialChar \menuseparator
+CheckTeX command
+\end_layout
+
+\end_inset
+
+, or the global
\family sans
ChkTeX
\family default
).
See below to learn what warnings can be enabled and disabled on the command
line.
-
\end_layout
\begin_layout Itemize
\begin_layout Enumerate
\size small
-\emph on
-Command terminated with space.
+\emph on
+Command terminated with space.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Non-breaking space (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+~
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) should have been used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+You should enclose the previous parenthesis with
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found in non-italic buffer.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found more than once.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+No italic correction (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Accent command
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+cmd
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ needs use of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+cmd
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Wrong length of dash may have been used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ expected, found
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Solo
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ to achieve an ellipsis.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Inter-word spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+
+\family default
+
+\begin_inset Quotes eld
+\end_inset
+
+) should perhaps be used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Inter-sentence spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+@
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+) should perhaps be used.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not find argument for command.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+No match found for
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Math mode still on at end of LaTeX file.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Number of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+char
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ doesn't match the number of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+char
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use either
+\family typewriter
+
+\begin_inset Quotes eld
+\end_inset
+
+
+\family default
+ or
+\family typewriter
+
+\begin_inset Quotes erd
+\end_inset
+
+
+\family default
+ as an alternative to
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+"
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use "
+\family typewriter
+'
+\family default
+" (ASCII 39) instead of "
+\family typewriter
+´
+\family default
+" (ASCII 180).
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+User-specified pattern found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This command might not be intended.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Comment displayed.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Either
+\family typewriter
+''
+\backslash
+,'
+\family default
+ or
+\family typewriter
+'
+\backslash
+,''
+\family default
+ will look better.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Delete this space to maintain correct page references.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+You might wish to put this between a pair of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+{}
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You ought to remove spaces in front of punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not execute LaTeX command.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Don't use
+\family typewriter
+
+\backslash
+/
+\family default
+ in front of small punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\family typewriter
+\size small
+$
+\backslash
+times$
+\family default
+ may look prettier here.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+\emph on
+Multiple spaces detected in output.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This text may be ignored.
\end_layout
\begin_layout Enumerate
\size small
-Non-breaking space (
+Use
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
+\family default
+ to begin quotation, not
\family typewriter
-~
+'
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-) should have been used.
+.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-You should enclose the previous parenthesis with
+Use
+\family typewriter
+'
+\family default
+ to end quotation, not
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-\family typewriter
-{}
\family default
+.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-.
+\size small
+Don't mix quotes.
\end_layout
\begin_layout Enumerate
\size small
-Italic correction (
+You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-/
+cmd
\family default
\begin_inset Quotes erd
\end_inset
-) found in non-italic buffer.
+ instead.
\end_layout
\begin_layout Enumerate
\size small
-Italic correction (
-\begin_inset Quotes eld
-\end_inset
+You should put a space in front of/after parenthesis.
+\end_layout
+\begin_layout Enumerate
-\family typewriter
+\size small
+You should avoid spaces in front of/after parenthesis.
+\end_layout
-\backslash
-/
-\family default
+\begin_layout Enumerate
-\begin_inset Quotes erd
-\end_inset
+\size small
+\emph on
+You should not use punctuation in front of/after quotes.
+\end_layout
-) found more than once.
+\begin_layout Enumerate
+
+\size small
+Double space found.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-No italic correction (
+You should put punctuation outside inner/inside display math mode.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You ought to not use primitive TeX in LaTeX code.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-/
+%s
\family default
\begin_inset Quotes erd
\end_inset
-) found.
+
\end_layout
\begin_layout Enumerate
\size small
-Accent command
\begin_inset Quotes eld
\end_inset
\family typewriter
-cmd
+%s
\family default
\begin_inset Quotes erd
\end_inset
- needs use of
+ is normally not followed by
\begin_inset Quotes eld
\end_inset
\family typewriter
-cmd
+%c
\family default
\begin_inset Quotes erd
.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+In later versions of LyX, we hope to provide a more complete interface to
+ this tool (and it's smaller cousin
+\family typewriter
+lacheck
+\family default
+) to exploit the full power of it.
+ But it's not exactly useless as it is now: go try it on one of your existing
+ documents of a certain length and be surprised.
+\end_layout
-\size small
-Wrong length of dash may have been used.
+\begin_layout Section
+Version Control in LyX
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+by
+\noun on
+ Lars Gullik Bjønnes
+\noun default
+and
+\noun on
+Pavel Sanda
+\end_layout
-\size small
-\emph on
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+A friend of mine wanted to try LyX for a group project.
+ When he didn't find support for version control or file locking, he dropped
+ it.
+ This angered me a bit, so I thought that I should at least make support
+ for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
+ This has been done.
+ LyX now supports some of the most basic RCS/CVS/SVN commands.
+ If you need something a bit more sophisticated you will have to do that
+ manually in a terminal.
+\end_layout
+
+\begin_layout Standard
+Also note that CVS support is not as good as subversion support so we advise
+ using SVN instead.
+ A good place to start learning Subversion is SVN Book
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+\begin_inset CommandInset href
+LatexCommand href
+target "http://svnbook.red-bean.com/"
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+.
+ In the case of RCS you should read
\begin_inset Quotes eld
\end_inset
+rcsintro
+\begin_inset Quotes erd
+\end_inset
+ (a man file, read it with
\family typewriter
-%s
+man rcsintro
+\family default
+).
+ This file describes all the basic features of RCS.
+ You should especially notice the comment about a RCS directory, and the
+ notion of a master RCS file (the file ending in
+\family typewriter
+,v
\family default
+).
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Standard
+Before you begin to use the version control features in LyX, you should
+ be familiar with RCS/CVS/SVN usage.
+ The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+ package—no guarantees are made for older versions.
+ Most of the log messages are not currently displayed after operations —
+ you can check them in the Messages pane if unsure.
+\end_layout
+
+\begin_layout Standard
+For introducing your own external commands consult vc-command in the manual
+ of LyX functions.
+\end_layout
+
+\begin_layout Subsection
+RCS commands in LyX
+\end_layout
+
+\begin_layout Standard
+The following sections describe the RCS commands supported by LyX.
+ You can find them in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
- expected, found
+Control
+\family default
+ submenu.
+ LyX was tested against RCS 5.7/5.8
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Note that old DOS / MS Windows builds (5.7) need to setup environment variables
+ in order to work properly with LyX.
+ In particular time zone (TZ) should be set and more importantly RCSINIT
+ in order to change default archive location ("SET RCSINIT=-x,v/") --- LyX
+ expects archive to be found in file.lyx,v within the original document directory.
+ See also README shipped with Windows RCS binaries.
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+
+\family sans
+Register
+\end_layout
+
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+Register
+\family default
+ item is not visible.
+
+\end_layout
+
+\begin_layout Standard
+This command registers your document with RCS (unless you are under the
+ directory managed by CVS)\SpecialChar \@.
+ You are asked interactively to supply an initial
+ description of the document.
+ The document is now set in Read-Only mode and you have to
+\family sans
+Check
+\begin_inset space ~
+\end_inset
+
+Out
+\begin_inset space ~
+\end_inset
+
+For
+\begin_inset space ~
+\end_inset
+
+Edit
+\family default
+, before making any changes to it.
+ A document under revision control has a
\begin_inset Quotes eld
\end_inset
+[RCS:<version> <locker>]
+\begin_inset Quotes erd
+\end_inset
+
+ item tagged to the filename in the minibuffer.
+\end_layout
+
+\begin_layout Standard
+RCS command that is run:
+\family typewriter
+ci -q -u -i -t-"<initial description>" <file-name>
+\end_layout
+\begin_layout Standard
+Read
\family typewriter
-%s
+man ci
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
+ to understand the switches.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Solo
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Check In Changes
+\end_layout
+\begin_layout Standard
+When you are finished editing a file, you check in your changes.
+ When you do this, you are asked for a description of the changes.
+ This is stored in the history log.
+ The version number is bumped, your changes are applied to the master RCS
+ file, the document is unlocked and set to Read-Only mode.
+
+\end_layout
+\begin_layout Standard
+RCS command:
\family typewriter
-%s
-\family default
+ci -q -u -m"<description>" <file-name>
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
- found.
+\family sans
+Check Out For Edit
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+By doing this you lock the document so that only you can edit it.
+ This will also make the document Read-Write only for you.
+ You will usually continue editing for a while and when you are finished
+ you check in your changes.
+ The status line is changed to reflect that you have locked the file.
+
+\end_layout
-\size small
-You should use
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -q -l <file-name>
+\end_layout
+\begin_layout Subsubsection
-\family typewriter
-%s
-\family default
+\family sans
+Revert To Repository Version
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\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
- to achieve an ellipsis.
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -f -u<version> <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Inter-word spacing (
-\begin_inset Quotes eld
-\end_inset
+\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>
+\end_layout
-\backslash
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+\begin_layout Standard
+This shows the complete history of the RCS document.
+ The output of
+\family typewriter
+rlog <file-name>
\family default
-
-\begin_inset Quotes eld
-\end_inset
+ is shown in a browser.
+ See
+\family typewriter
+man rlog
+\family default
+ for more info.
+\end_layout
-) should perhaps be used.
+\begin_layout Subsubsection
+Revision info
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+LyX supports RCS version number, author name, date and time of last commit.
+ All those are extracted from
+\family typewriter
+rlog -r <file-name>
+\family default
+.
+ For other details see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
-\size small
-Inter-sentence spacing (
-\begin_inset Quotes eld
\end_inset
+ for details.
+\end_layout
-\family typewriter
-
-\backslash
-@
-\family default
+\begin_layout Subsection
+CVS commands in LyX
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Standard
+A subset of CVS operations is supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
-) should perhaps be used.
+Control
+\family default
+ submenu.
+ The version control system SVN is more powerful, so please use it instead
+ of CVS if possible.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Could not find argument for command.
+\family sans
+General CVS usage
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+If you start from scratch with CVS you have to create your repository and
+ checkout the working copy with external tools.
+ If you're using a client-server setup you may need to login before doing
+ the first repository checkout.
+\end_layout
-\size small
-No match found for
+\begin_layout Standard
+If your documents are under revision control and others are using the same
+ repository problems arise when different changes to the same document at
+ the same location happen.
+ Standard CVS repositories doesn't operate with a file locking mechanism.
+ This may be surprising, but conflicts only occur if people disagree on
+ the proper content of the same part of a document.
+ So, if co-workers are used to communicate regularly, these conflicts occur
+ rarely.
+ If they don't communicate they have a fundamental problem anyway.
+ Nevertheless some people like to work with so called
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-%s
-\family default
-
+reserved checkouts
\begin_inset Quotes erd
\end_inset
.
-\end_layout
-
-\begin_layout Enumerate
+ If they do so the working copy of all files is readonly when checked out
+ first and the user starts editing after using a special command to make
+ the working copy writable.
+ When the changes are checked in the working copy returns to readonly state.
+ With LyX one has to edit the
+\begin_inset Flex Code
+status collapsed
-\size small
-Math mode still on at end of LaTeX file.
+\begin_layout Plain Layout
+.cvsrc
\end_layout
-\begin_layout Enumerate
-
-\size small
-Number of
-\begin_inset Quotes eld
\end_inset
+ file and add the line
+\begin_inset Flex Code
+status collapsed
-\family typewriter
-char
-\family default
+\begin_layout Plain Layout
+cvs -r
+\end_layout
-\begin_inset Quotes erd
\end_inset
- doesn't match the number of
-\begin_inset Quotes eld
-\end_inset
+ to work with reserved checkouts.
+ The benefit is the possibility to see who is using a writable copy of some
+ document.
+ It's not guaranteed only one user makes a copy writable.
+\end_layout
+\begin_layout Standard
+LyX tries to guess if you're using reserved or non-reserved checkouts.
+ If your working copy is readonly or it is writable and an additional copy
+ of your document exists in the CVS/Base sub-directory a reserved otherwise
+ a non-reserved checkout is assumed.
+ When a reserved checkout is detected you have to use
+\begin_inset Flex MenuItem
+status collapsed
-\family typewriter
-char
-\family default
+\begin_layout Plain Layout
+Check Out
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
+ to make your working copy writable if it's readonly.
+ After doing so the
+\begin_inset Flex MenuItem
+status collapsed
-\size small
-You should use either
-\family typewriter
+\begin_layout Plain Layout
+Check In
+\end_layout
-\begin_inset Quotes eld
\end_inset
+ operation is possible and that makes your working copy readonly again after
+ transferring your changes to the repository.
+\end_layout
-\family default
- or
-\family typewriter
+\begin_layout Standard
+More information about CVS can be found here
+\begin_inset Flex URL
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+http://www.nongnu.org/cvs
+\end_layout
-\family default
- as an alternative to
-\begin_inset Quotes eld
\end_inset
+ and here
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
-\family typewriter
-"
-\family default
+http://ximbiot.com/cvs
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should use "
-\family typewriter
-'
-\family default
-" (ASCII 39) instead of "
+\begin_layout Standard
+Read
\family typewriter
-´
+man cvs
\family default
-" (ASCII 180).
+ to understand the sub-commands and the switches mentioned below.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-User-specified pattern found.
+\family sans
+Register
+\end_layout
+
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
\end_layout
-\begin_layout Enumerate
-
-\size small
-This command might not be intended.
-\end_layout
+\begin_layout Standard
+This command registers in CVS your document
+\begin_inset Flex Strong
+status collapsed
-\begin_layout Enumerate
+\begin_layout Plain Layout
-\size small
\emph on
-Comment displayed.
+only
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-Either
+ in the case you have already the documents directory under CVS control
+ (in particular
\family typewriter
-''
-\backslash
-,'
-\family default
- or
-\family typewriter
-'
-\backslash
-,''
+CVS/Entries
\family default
- will look better.
+ file exists).
+ This means you have to create or checkout the archive by yourself using
+ external tools.
+ (In case you forget that step LyX registers the document with RCS.)
\end_layout
-\begin_layout Enumerate
-
-\size small
-Delete this space to maintain correct page references.
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet checked in.
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-You might wish to put this between a pair of
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Standard
+CVS command that is run:
+\family typewriter
+cvs -q add -m"<entered message>" "<file-name>"
+\end_layout
+\begin_layout Standard
+The term
\family typewriter
-{}
+"<file-name>"
\family default
+ above and for all other CVS commands is an abbreviation for
+\begin_inset Quotes eld
+\end_inset
+change the current working directory to file location and use the file name
+ without path component as argument
\begin_inset Quotes erd
\end_inset
.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-You ought to remove spaces in front of punctuation.
+\family sans
+Check In Changes
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this and you had changed the document, you are asked for a
+ description of the changes.
+ After that changes are written to the repository.
+ In case you didn't change the document and a reserved checkout is detected
+ the reservation made on
+\begin_inset Flex MenuItem
+status collapsed
-\size small
-Could not execute LaTeX command.
+\begin_layout Plain Layout
+Check Out
\end_layout
-\begin_layout Enumerate
-
-\size small
-Don't use
-\family typewriter
+\end_inset
-\backslash
-/
-\family default
- in front of small punctuation.
+ is undone.
\end_layout
-\begin_layout Enumerate
-
-\family typewriter
-\size small
-$
-\backslash
-times$
-\family default
- may look prettier here.
-\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
-\begin_layout Enumerate
+command:
+\begin_inset space ~
+\end_inset
-\size small
-\emph on
-Multiple spaces detected in output.
-\end_layout
-\begin_layout Enumerate
+\begin_inset Newline newline
+\end_inset
-\size small
-This text may be ignored.
-\end_layout
-\begin_layout Enumerate
+\begin_inset Flex Code
+status collapsed
-\size small
-Use
+\begin_layout Plain Layout
+cvs
\family typewriter
+-q commit -m"<description>" "<file-name>"
+\end_layout
-\begin_inset Quotes eld
\end_inset
+ or
+\begin_inset Newline newline
+\end_inset
-\family default
- to begin quotation, not
-\family typewriter
-'
-\family default
-.
-\end_layout
-\begin_layout Enumerate
+\begin_inset Flex Code
+status collapsed
-\size small
-Use
-\family typewriter
-'
-\family default
- to end quotation, not
+\begin_layout Plain Layout
+cvs -q unedit
\family typewriter
+"<file-name>"
+\end_layout
-\begin_inset Quotes eld
\end_inset
-\family default
-.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Don't mix quotes.
+\family sans
+Check Out Changes
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+When you are sharing a repository with others, you may have to incorporate
+ their changes into your working copy.
+\end_layout
-\size small
-You should perhaps use
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q update "<file-name>"
+\end_layout
+\begin_layout Standard
+If a readonly checkout is detected the working copy is made writable and
+ reserved.
+\end_layout
+\begin_layout Standard
+CVS command:
\family typewriter
-cmd
-\family default
+cvs -q edit "<file-name>"
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
- instead.
+\family sans
+Revert To Repository Version
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should put a space in front of/after parenthesis.
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q update "<file-name>"
+\end_layout
-\size small
-You should avoid spaces in front of/after parenthesis.
+\begin_layout Standard
+If a reserved checkout is detected and the working copy has no changes only
+ the reservation is undone.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs -q unedit "<file-name>"
+\end_layout
-\size small
-\emph on
-You should not use punctuation in front of/after quotes.
+\begin_layout Subsubsection
+Update of the local directory checkout from repository
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
-\size small
-Double space found.
+\begin_layout Plain Layout
+.tex
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-You should put punctuation outside inner/inside display math mode.
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+The
+\begin_inset Flex Code
+status collapsed
-\size small
-You ought to not use primitive TeX in LaTeX code.
+\begin_layout Plain Layout
+Update local directory from repository
\end_layout
-\begin_layout Enumerate
+\end_inset
+
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<<<<<<<
+\end_layout
-\size small
-You should remove spaces in front of
-\begin_inset Quotes eld
\end_inset
+ and
+\begin_inset Flex Code
+status collapsed
-\family typewriter
-%s
-\family default
+\begin_layout Plain Layout
+>>>>>>>
+\end_layout
-\begin_inset Quotes erd
\end_inset
+ separated by
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+=======
\end_layout
-\begin_layout Enumerate
+\end_inset
+
+.
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>
+\end_layout
-\size small
-\begin_inset Quotes eld
\end_inset
+ signs.
+\end_layout
-\family typewriter
-%s
-\family default
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
+\end_inset
-\begin_inset Quotes erd
+commands:
+\begin_inset space ~
\end_inset
- is normally not followed by
-\begin_inset Quotes eld
+
+\begin_inset Newline newline
\end_inset
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs diff
\family typewriter
-%c
-\family default
+"."
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
-\end_layout
+ (Ask if changes are detected.)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-In later versions of LyX, we hope to provide a more complete interface to
- this tool (and it's smaller cousin
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs -q update
\family typewriter
-lacheck
-\family default
-) to exploit the full power of it.
- But it's not exactly useless as it is now: go try it on one of your existing
- documents of a certain length and be surprised.
+"."
\end_layout
-\begin_layout Section
-Version Control in LyX
-\end_layout
+\end_inset
-\begin_layout Standard
-by
-\noun on
- Lars Gullik Bjønnes,
-\noun default
-updated by
-\noun on
-Pavel Sanda
-\end_layout
-\begin_layout Subsection
-Introduction
\end_layout
\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- it.
- This angered me a bit, so I thought that I should at least make support
- for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has now been done.
- LyX now supports some of the most basic RCS commands.
- If you need to something a bit more sophisticated you will have to do that
- manually in an xterm.
-\end_layout
+where
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- read
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+$path
+\end_layout
-rcsintro
-\begin_inset Quotes erd
\end_inset
- (a man file, read it with
-\family typewriter
-man rcsintro
-\family default
-).
- This file describes all the basic features of RCS.
- You should especially notice the comment about a RCS directory, and the
- notion of a master RCS file (the file ending in
-\family typewriter
-,v
-\family default
-).
+ stands for the path to the document.
\end_layout
-\begin_layout Standard
-Later basic CVS/SVN support was added.
- You should be familiar with CVS/SVN usage before start using it under LyX.
- Most of the log messages are not currently displayed after operations -
- you can check them in terminal window if unsure.
-\end_layout
+\begin_layout Subsubsection
-\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
- package—no guarantees are made for older versions.
+\family sans
+Show History
\end_layout
\begin_layout Standard
-For introducing your own external commands consult vc-command in the manual
- of LyX functions.
+This shows the complete history of the CVS document.
+ The output of
+\family typewriter
+cvs log "<file-name>"
+\family default
+ is shown in a browser.
\end_layout
\begin_layout Subsection
-RCS commands in LyX
+SVN commands in LyX
\end_layout
\begin_layout Standard
-The following sections describe the RCS commands supported by LyX.
- You can find them in the
+SVN is now partially supported by LyX.
+ You can find the commands in the
\family sans
File\SpecialChar \menuseparator
Version
Control
\family default
submenu.
- LyX was tested against RCS 5.7.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against SVN 1.5 and 1.6
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Most of the commands will work with 1.4 too, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:SVN-Repo-Update"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
in the menu.
And if it is under revision control, the
\family sans
-Register
+\bar under
+R
+\bar default
+egister
\family default
item is not visible.
\end_layout
\begin_layout Standard
-This command registers your document with RCS (unless you are under the
- directory managed by CVS)\SpecialChar \@.
- You are asked interactively to supply an initial
- description of the document.
- The document is now set in Read-Only mode and you have to
-\family sans
-Check
-\begin_inset space ~
-\end_inset
-
-Out
-\begin_inset space ~
-\end_inset
+This command registers in SVN your document ONLY in case you have already
+ the documents directory under SVN control (in particular
+\family typewriter
+.svn/entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
+\end_layout
-For
-\begin_inset space ~
-\end_inset
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
-Edit
-\family default
-, before making any changes to it.
- A document under revision control has a
+\begin_layout Standard
+SVN command that is run:
+\family typewriter
+svn add -q
\begin_inset Quotes eld
\end_inset
-[RCS:<version> <locker>]
+<file-name>
\begin_inset Quotes erd
\end_inset
- item tagged to the filename in the minibuffer.
-\end_layout
-\begin_layout Standard
-RCS command that is run:
-\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
\end_layout
\begin_layout Standard
Read
\family typewriter
-man ci
+man svn
\family default
to understand the switches.
\end_layout
\begin_layout Standard
-When you are finished editing a file, you check in your changes.
+When you are finished editing a file, you commit your changes.
When you do this, you are asked for a description of the changes.
- This is stored in the history log.
- The version number is bumped, your changes are applied to the master RCS
- file, the document is unlocked and set to Read-Only mode.
-
+ After that changes are commited.
\end_layout
\begin_layout Standard
-RCS command:
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+In case locking is not enabled.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:SVN-File-Locking"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
\family typewriter
-ci -q -u -m"<description>" <file-name>
+svn commit -q -m"<description>" <file-name>
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-By doing this you lock the document so that only you can edit it.
- This will also make the document Read-Write only for you.
- You will usually continue editing for a while and when you are finished
- you check in your changes.
- The status line is changed to reflect that you have locked the file.
-
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be resolved manually by you!
\end_layout
\begin_layout Standard
-RCS command:
+SVN command:
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Ditto.
+\end_layout
+
+\end_inset
+
+
\family typewriter
-co -q -l <file-name>
+svn update --non-interactive
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
This will discard all changes made to the document since the last check
in.
You get a warning before changes are discarded.
+
\end_layout
\begin_layout Standard
-RCS command:
+SVN command:
\family typewriter
-co -f -u<version> <file-name>
+svn revert -q
+\begin_inset Quotes eld
+\end_inset
+
+<file-name>
+\begin_inset Quotes erd
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:SVN-Repo-Update"
+
+\end_inset
+
+Update of the local directory checkout from repository
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this command will work only with subversion
+\begin_inset Formula $\geqq1.5$
+\end_inset
+
+
\end_layout
-\begin_layout Subsubsection
+\end_inset
+
-\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.
-
+All the commands above have one shortcomming - they deal with the current
+ document only.
+ Once your document contains pictures, includes external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
\end_layout
-\begin_layout Standard
-RCS command:
-\family typewriter
-rcs -o<version> <file-name>
+\end_inset
+
+ files and so on administration becomes more complicated.
+ LyX now supports updating the whole tree in which resides the document
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+One need to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Show History
+.
+ This become especially useful once you cooperate with people which neither
+ know about subversion management nor they have ambition to commit additional
+ material to the repository.
+
\end_layout
\begin_layout Standard
-This show the complete history of the RCS document.
- The output of
-\family typewriter
-rlog <file-name>
-\family default
- is shown in a browser.
- See
-\family typewriter
-man rlog
-\family default
- for more info.
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
\end_layout
-\begin_layout Subsection
-CVS commands in LyX
+\end_inset
+
+ command updates the whole directory and in case of merge conflicts local
+ version of the files are left, so no unintended data loss occurs.
+ If local changes are detected user is warned before update starts.
\end_layout
-\begin_layout Standard
-CVS is now partially supported by LyX.
- You can find the commands in the
-\family sans
-File\SpecialChar \menuseparator
-Version
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
\begin_inset space ~
\end_inset
-Control
-\family default
- submenu.
-\end_layout
+commands:
+\begin_inset space ~
+\end_inset
-\begin_layout Subsubsection
-\family sans
-Register
-\end_layout
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
-\bar under
-R
-\bar default
-egister
-\family default
- item is not visible.
-
-\end_layout
-\begin_layout Standard
-This command registers in CVS your document ONLY in case you have already
- the documents directory under CVS control (in particular
-\family typewriter
-CVS/Entries
-\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Then you are asked interactively to supply an initial description of the
- document.
- Don't forget that registered file is not yet commited.
+\begin_layout Plain Layout
+svn diff $path
\end_layout
-\begin_layout Standard
-CVS command that is run:
-\family typewriter
-cvs -q add -m
-\begin_inset Quotes erd
\end_inset
-<entered message>"
-\begin_inset Quotes eld
+ (Ask if changes are detected.)
+\begin_inset Newline newline
\end_inset
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+svn update --accept mine-full $path
\end_layout
-\begin_layout Standard
-Read
-\family typewriter
-man svn
-\family default
- to understand the switches.
-
-\end_layout
+\end_inset
-\begin_layout Subsubsection
-\family sans
-Check In Changes
\end_layout
\begin_layout Standard
-When you are finished editing a file, you commit your changes.
- When you do this, you are asked for a description of the changes.
- After that changes are commited.
+where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+$path
\end_layout
-\begin_layout Standard
-CVS command:
-\family typewriter
-cvs -q commit -m"<description>" "<file-name>"
+\end_inset
+
+ stands for the path to the document.
\end_layout
\begin_layout Subsubsection
\family sans
-Revert To Repository Version
-\end_layout
-
-\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
- Firstly the file is deleted, secondly CVS update command is run.
+Show History
\end_layout
\begin_layout Standard
-CVS command:
+This shows the complete history of the SVN document.
+ The output of
\family typewriter
-cvs update
+svn log
\begin_inset Quotes eld
\end_inset
\end_inset
+\family default
+ is shown in a browser.
\end_layout
\begin_layout Subsubsection
+File Locking
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:SVN-File-Locking"
+
+\end_inset
+
-\family sans
-Show History
\end_layout
\begin_layout Standard
-This show the complete history of the CVS document.
- The output of
-\family typewriter
-cvs log
-\begin_inset Quotes eld
-\end_inset
+The file exchange through various revision control systems brings the problem
+ of merge conflicts in case two different users try to edit the same (parts
+ of) document.
+ When such a conflict happens it needs manual resolving and one reasonable
+ alternative is to provide some kind of locking mechanism, which guarantees
+ that only one user is allowed to edit file at the given time.
+\end_layout
+
+\begin_layout Standard
+SVN has two such mechanisms to provide mutual exclusivity for file access
+ - locks and automatic setting of write permissions (see sec.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Automatical-Locking-Property"
-<file-name>
-\begin_inset Quotes erd
\end_inset
+) based on
+\begin_inset Flex Code
+status collapsed
-\family default
- is shown in a browser.
+\begin_layout Plain Layout
+svn:needs-lock
\end_layout
-\begin_layout Subsection
-SVN commands in LyX
+\end_inset
+
+ file svn property
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
\end_layout
-\begin_layout Standard
-SVN is now partially supported by LyX.
- You can find the commands in the
-\family sans
-File\SpecialChar \menuseparator
-Version
-\begin_inset space ~
\end_inset
-Control
-\family default
- submenu.
- Please note that if you use password protected access to repository via
- ssh, you will be asked in terminal window.
- LyX was tested against SVN 1.5 and 1.6
+.
+ If this property is detected for a given document LyX starts to use SVN
+ locks for document editing automatically and the whole check-in/out mechanism
+ switches to the same regimen as for RCS.
+ This in particular means there are two different modes of file use in LyX:
+\end_layout
+
+\begin_layout Itemize
+Unlocked state.
+ The loaded file is in the read-only mode.
+ For editing on needs to check-out.
+
+\emph on
+Check-out
+\emph default
+ consists of updating from the repository and gaining write lock.
+ If the lock is not possible to obtain, we remain in unlocked state.
+\end_layout
+
+\begin_layout Itemize
+Locked state.
+ The loaded file is in the 'normal' edit mode.
+ No other user is allowed to edit the file.
+
+\emph on
+Check-in
+\emph default
+ consists of commiting changes and releasing write-lock.
+ If no changes have been made to the document, no commit will be produced
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-Most of the commands will work with 1.4 too, see
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sub:SVN-Repo-Update"
+Don't be puzzled by the fact that you will be asked for commit message anyway.
+\end_layout
+
+\end_inset
+ and only the write-lock will be released.
+\end_layout
+
+\begin_layout Standard
+SVN commands:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-in:
+\family typewriter
+ svn commit -q -m"<description>" "<file-name>"
+\begin_inset Newline newline
\end_inset
-.
+svn unlock "<file-name>"
\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-out:
+\family typewriter
+svn update "<file-name>"
+\begin_inset Newline newline
\end_inset
-
+svn lock "<file-name>"
\end_layout
\begin_layout Subsubsection
-\family sans
-Register
+\family typewriter
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Automatical-Locking-Property"
+
+\end_inset
+
+
+\family default
+Automatic Locking Property
\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
+The above mentioned automatic setting of write permissions of the .lyx file
+ can be set through
\family sans
\bar under
-R
+ F
\bar default
-egister
-\family default
- item is not visible.
-
-\end_layout
+ile\SpecialChar \menuseparator
-\begin_layout Standard
-This command registers in SVN your document ONLY in case you have already
- the documents directory under SVN control (in particular
-\family typewriter
-.svn/entries
-\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
-\end_layout
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-Then you are asked interactively to supply an initial description of the
- document.
- Don't forget that registered file is not yet commited.
-\end_layout
+Control\SpecialChar \menuseparator
-\begin_layout Standard
-SVN command that is run:
-\family typewriter
-svn add -q
-\begin_inset Quotes eld
-\end_inset
+\bar under
+T
+\bar default
+oggle locking property
+\family default
+.
+ This command is active only when the file is not locked on the svn server
+ (i.e.
+ you need to check-out before proceeding).
+\end_layout
-<file-name>
-\begin_inset Quotes erd
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
\end_inset
+commands:
+\end_layout
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Set:
+\family typewriter
+ svn propset svn:needs-lock ON "<file-name>"
\end_layout
-\begin_layout Standard
-Read
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Unset:
\family typewriter
-man svn
-\family default
- to understand the switches.
-
+svn propdel svn:needs-lock "<file-name>"
\end_layout
\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:VCS-Revision-Information"
-\family sans
-Check In Changes
+\end_inset
+
+Revision Information in Documents
\end_layout
\begin_layout Standard
-When you are finished editing a file, you commit your changes.
- When you do this, you are asked for a description of the changes.
- After that changes are commited.
+There are more possibilities how to activate revision information in our
+ document.
\end_layout
-\begin_layout Standard
-SVN command:
-\begin_inset Foot
+\begin_layout Itemize
+LyX supports directly:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+tree revision information (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-In case locking is not enabled.
- See Section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:SVN-File-Locking"
+vcs-tree-revision
+\end_layout
\end_inset
-.
+).
+ The result is the output of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
\end_layout
\end_inset
-
-\family typewriter
-svn commit -q -m"<description>" <file-name>
+ command, the following table gives you an idea, how to read the results.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="6" columns="2">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
-\family sans
-Check Out For Edit
+\begin_layout Plain Layout
+Output
\end_layout
-\begin_layout Standard
-Updates the changes of this file from the repository.
- Be sure you understand SVN merging and conflicts resolving before using
- this function, because all conflicts has to be resolved manually by you!
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Meaning
\end_layout
-\begin_layout Standard
-SVN command:
-\begin_inset Foot
-status collapsed
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Ditto.
+4123:4168
\end_layout
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-
-\family typewriter
-svn update
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+mixed revision working copy
+\end_layout
-<file-name>
-\begin_inset Quotes erd
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
-
+\begin_layout Plain Layout
+4168M
\end_layout
-\begin_layout Subsubsection
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\family sans
-Revert To Repository Version
+\begin_layout Plain Layout
+modified working copy
\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_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123S
\end_layout
-\begin_layout Standard
-SVN command:
-\family typewriter
-svn revert -q
-\begin_inset Quotes eld
\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+switched working copy
+\end_layout
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+4123P
\end_layout
-\begin_layout Subsubsection
-\begin_inset CommandInset label
-LatexCommand label
-name "sub:SVN-Repo-Update"
-
\end_inset
-
-Update of the local directory checkout from repository
-\begin_inset Foot
-status collapsed
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
\begin_layout Plain Layout
-Note that this command will work only with subversion
-\begin_inset Formula $\geqq1.5$
+partial working copy, from a sparse checkout
+\end_layout
+
\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+4123:4168MS
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
+mixed revision, modified, switched working copy
\end_layout
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
\end_inset
\end_layout
-\begin_layout Standard
-All the commands above have one shortcomming - they deal with the current
- document only.
- Once your document contains pictures, includes external
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+file revision information.
+ The result comes from parsing the output of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-.tex
-\end_layout
+svn
+\begin_inset space ~
+\end_inset
+info
+\begin_inset space ~
\end_inset
- files and so on administration becomes more complicate.
- LyX now supports updating the whole tree in which resides the document
-\begin_inset Foot
-status collapsed
+--xml
+\begin_inset space ~
+\end_inset
-\begin_layout Plain Layout
-One need to organize the files structure so that all external files are
- in the same directory or subdirectories of the document.
-
+file.lyx
\end_layout
\end_inset
.
- This become especially useful once you cooperate with people which neither
- know about subversion management nor they have ambition to commit additional
- material to the repository.
-
+ Supported flags are:
\end_layout
-\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_deeper
+\begin_layout Itemize
+version number of the last commit (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Update local directory from repository
+vcs-revision
\end_layout
\end_inset
- command updates the whole directory and in case of merge conflicts local
- version of the files are left, so no unintended data loss occurs.
- If local changes are detected user is warned before update starts.
+)
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-SVN
-\begin_inset space ~
-\end_inset
-
-commands:
-\begin_inset space ~
-\end_inset
+\begin_layout Itemize
+author of the last commit (
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+vcs-author
+\end_layout
-\begin_inset Newline newline
\end_inset
+)
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+date of the last commit (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn diff $path
+vcs-date
\end_layout
\end_inset
- (Ask if changes are detected.)
-\begin_inset Newline newline
-\end_inset
-
+)
+\end_layout
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+time of the last commit (
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn update --accept mine-full $path
+vcs-time
\end_layout
\end_inset
-
+)
\end_layout
+\end_deeper
\begin_layout Standard
-where
-\begin_inset Flex CharStyle:Code
+You can obtain this info via InsetInfo (e.g.
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-$path
+info-insert buffer vcs-date
\end_layout
\end_inset
- stands for the path to the document.
-\end_layout
-
-\begin_layout Subsubsection
+).
+ The information will be available only when you have the file stored under
+ svn managment (i.e.
+ the
+\begin_inset Flex Code
+status collapsed
-\family sans
-Show History
+\begin_layout Plain Layout
+.svn
\end_layout
-\begin_layout Standard
-This show the complete history of the SVN document.
- The output of
-\family typewriter
-svn log
-\begin_inset Quotes eld
\end_inset
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+ directory is available with your document).
+\end_layout
+\end_deeper
+\begin_layout Itemize
+Another---a hacking one---possibility is to use svn keywords
+\begin_inset Foot
+status collapsed
-\family default
- is shown in a browser.
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
\end_layout
-\begin_layout Subsubsection
-File Locking
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:SVN-File-Locking"
-
\end_inset
+.
+ In short -- you set file keywords property (e.g.
+
+\family sans
+svn propset svn:keywords 'Rev' file.lyx
+\family default
+) and then paste keyword TeX code
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+This is an easy way how to ensure that LyX won't break the line in the middle
+ of keyword tag.
\end_layout
-\begin_layout Standard
-The file exchange through various revision control systems brings the problem
- of merge conflicts in case two different users try to edit the same (parts
- of) document.
- When such conflict happens it needs manual resolving and one reasonable
- alternative is to provide some kind of locking mechanism, which guarantees
- that only one user is allowed to edit file at the given time.
-\end_layout
-
-\begin_layout Standard
-SVN has two mechanisms to provide such kind of mutual exclusivity for file
- access - locks and automatical setting of write permissions (see sec.
-
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "subsec:Automatical-Locking-Property"
-
\end_inset
-) based on
-\begin_inset Flex CharStyle:Code
-status collapsed
+ tag in your document (e.g.
+
+\begin_inset ERT
+status open
\begin_layout Plain Layout
-svn:needs-lock
+
+$Rev$
\end_layout
\end_inset
- file svn property
-\begin_inset Foot
+).
+ This way svn client will automatically substitute revision number (e.g.
+
+\begin_inset ERT
status open
\begin_layout Plain Layout
-http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
+
+$Rev: 59 $
\end_layout
\end_inset
-.
- In a case this property is detected for a given document LyX starts to
- use SVN locks for document editing automatically and the whole check-in/out
- mechanism switches to the same regimen as for RCS.
- This in particular means there are two different modes how file is used
- in LyX:
+) after each update and commit.
+ There are more problems with this approach.
+ Firstly, the '$' character is used in TeX world for math equations, so
+ any occurence of math formula
+\begin_inset Formula $Rev$
+\end_inset
+
+ become
+\begin_inset Formula $Rev:59$
+\end_inset
+
+ in your LyX document.
+ Similarly for other keywords like Id, Date, Author, etc.
+ Secondly svn output is dependent on your locales, so its very easy that
+ svn would produce some problematic strings once Date is used.
+ Thirdly you get the whole 'Rev: 59' string in your document instead of
+ the plain number.
+ Until subversion implements user's custom keywords it will be hard to use
+ this approach reliably or let LyX to support it directly.
\end_layout
-\begin_layout Itemize
-Unlocked state.
- The loaded file is in the read-only mode.
- For editation on needs to check-out.
-
-\emph on
-Check-out
-\emph default
- consists of update from repository and gaining write lock.
- If the lock is not possible to obtain, we remain in unlocked state.
+\begin_layout Subsection
+SVN and Windows Environment
\end_layout
-\begin_layout Itemize
-Locked state.
- The loaded file is in the 'normal' edit mode.
- No other user is allowed to edit the file.
-
-\emph on
-Check-in
-\emph default
- consists of commiting changes and releasing write-lock.
- If no changes have been made to the document, no commit will be produced
-\begin_inset Foot
-status collapsed
+\begin_layout Quote
+My inclination is to say that if the user cannot figure out the command
+ line operations on their own fairly quickly, they would be well advised
+ to use TortoiseSVN.
+ ---P.
+ A.
+ Rubin
+\end_layout
-\begin_layout Plain Layout
-Don't be puzzled by the fact that you will be asked for commit message anyway.
+\begin_layout Subsubsection
+Preparation
\end_layout
+\begin_layout Standard
+In addition to installing LyX, and having access to a Subversion repository,
+ the user will need to install the Subversion client program.
+ A Windows installer for the client program is available from
+\begin_inset CommandInset href
+LatexCommand href
+name "CollabNet"
+target "http://www.collab.net/nonav/downloads/subversion/"
+
\end_inset
- and only the write-lock will be released.
+.
+ The user may also want to install
+\begin_inset CommandInset href
+LatexCommand href
+name "TortoiseSVN"
+target "http://tortoisesvn.tigris.org/"
+
+\end_inset
+
+, which integrates Subversion operations into the context (rightclick) menu
+ of Windows Explorer.
+ Operations done outside LyX will typically be more convenient using the
+ Explorer context menu.
+ Note that TortoiseSVN is not a replacement for the client program, which
+ is what LyX itself will use.
\end_layout
-\begin_layout Standard
-SVN commands:
+\begin_layout Subsubsection
+Bringing a document under Subversion control
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Check-in:
+\begin_layout Standard
+Before a LyX document can be brought under version control in Subversion,
+ its parent directory needs to be under version control.
+ If the document is being added to a project already in the repository,
+ this is accomplished by checking the project out to the directory where
+ the new document will be placed.
+ If the project itself is not yet under version control (for instance, if
+ this document starts a new project), the directory must be imported into
+ the repository.
+ This is done outside LyX.
+ Both import and checkout are easily accomplished from the Explorer context
+ menu using TortoiseSVN, or alternatively can be done using the command
+ line client at a DOS prompt.
+ The procedure for importing the project using TortoiseSVN is described
+ below, assuming an existing repository and a new project being started
+ in
\family typewriter
- svn commit -q -m"<description>" "<file-name>"
-\begin_inset Newline newline
-\end_inset
-
-svn unlock "<file-name>"
+C:
+\backslash
+new project
+\family default
+.
+ For information on using the Subversion client program, run
+\family typewriter
+svn --help
+\family default
+in a DOS shell.
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Check-out:
+\begin_layout Enumerate
+Locate
\family typewriter
-svn update "<file-name>"
-\begin_inset Newline newline
-\end_inset
-
-svn lock "<file-name>"
+C:
+\backslash
+new project
+\family default
+in Windows Explorer, right click it, and select
+\family typewriter
+TortoiseSVN > Repo-browser
+\family default
+.
+ If necessary, adjust the URL for the repository, then click OK.
\end_layout
-\begin_layout Subsubsection
-
+\begin_layout Enumerate
+Right click the level of the repository under which you want to place the
+ new project folder (typically the top level) and click
\family typewriter
-\begin_inset CommandInset label
-LatexCommand label
-name "subsec:Automatical-Locking-Property"
+Create folder\SpecialChar \ldots{}
-\end_inset
+\family default
+ Supply a name for the project folder and click OK.
+ Add a message for the log file if desired, then click OK again.
+ The new project folder should appear in the repository.
+ Finally, click OK again to exit the repository browser.
+\end_layout
+\begin_layout Enumerate
+Once again right click
+\family typewriter
+C:
+\backslash
+new project
+\family default
+, this time selecting SVN Checkout\SpecialChar \ldots{}
+ Select the URL of the project folder
+ you just created in the repository, and set the checkout directory to
+\family typewriter
+C:
+\backslash
+new project.
\family default
-Automatical Locking Property
+ Click OK.
+ You will be warned about a non-empty folder; click OK to proceed.
+ You should now have a
+\family typewriter
+.svn
+\family default
+ directory under
+\family typewriter
+C:
+\backslash
+new project.
\end_layout
-\begin_layout Standard
-The above mentioned automatical setting of write permissions of the .lyx
- file can be set through
+\begin_layout Enumerate
+Create or open your document in LyX and click
\family sans
\bar under
- F
+F
\bar default
ile\SpecialChar \menuseparator
Control\SpecialChar \menuseparator
\bar under
-T
+R
\bar default
-oggle locking property
+egister.
+
\family default
-.
- This command is active only when the file is not locked on the svn server
- (i.e.
- you need to check-out before proceeding).
+Add a log message and click OK to commit the document to version control.
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-SVN
+\begin_layout Standard
+From this point onward, you should have full functionality in the
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+V
+\bar default
+ersion
\begin_inset space ~
\end_inset
-commands:
+Control
+\family default
+ menu.
+ You also have the option of checking the document in and out, viewing its
+ history, etc.
+ using the TortoiseSVN context menu in Windows Explorer or the Subversion
+ client program from a command prompt.
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Set:
-\family typewriter
- svn propset svn:needs-lock ON "<file-name>"
+\begin_layout Subsubsection
+SSH tunnel used with SVN under Windows
\end_layout
-\begin_layout Labeling
-\labelwidthstring 00.00.0000
-Unset:
-\family typewriter
-svn propdel svn:needs-lock "<file-name>"
+\begin_layout Standard
+Compared with Linux setting up an svn client to communicate over ssh under
+ Windows is a rather troublesome task.
+ We will at least offer some hints how to setup the client side but prior
+ knowledge about ssh and the Windows command line is needed, also be prepared
+ for a great deal of frustration\SpecialChar \ldots{}
+
\end_layout
-\begin_layout Subsubsection
-Revision Information in Documents
+\begin_layout Enumerate
+Get an svn client for windows, as described in the previous sections.
+ When it is a fresh install run some svn command (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn --version
\end_layout
-\begin_layout Standard
-Currently there is no way how to provide such kind of information directly
- from LyX.
- There are possibilities how to activate it with the help of svn features,
- but each has its own drawbacks.
+\end_inset
+
+) to create config files, which you will need to change later on.
\end_layout
-\begin_layout Standard
-One possibility is to use svn keywords
+\begin_layout Enumerate
+Choose an ssh client for Windows.
+ There are several possibilities, we will use the one from Putty tools
\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
+
+http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
+\end_layout
+
+\end_inset
+
+
\end_layout
\end_inset
.
- In short -- you set file keywords property (e.g.
-
-\family sans
-svn propset svn:keywords 'Rev' file.lyx
-\family default
-) and then paste keyword ERT
-\begin_inset Foot
+ You will need to set the connection up so that the client doesn't ask for
+ any password from you.
+ To keep things easy we will use only keys without any additional password
+ protection etc.
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+Generate keys by
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-This is an easy way how to ensure that LyX won't break the line in the middle
- of keyword tag.
+puttygen
\end_layout
\end_inset
- tag in your document (e.g.
-
-\begin_inset ERT
-status open
+.
+ Save your private .ppk key file and put the public one on the server side.
+ If the SVN server runs on Linux, note that the format of the public key
+ is not compatible with Linux openssh and you will need to direcly copy-paste
+ the key from the “
+\emph on
+Public key for pasting into OpenSSH authorized_keys file
+\emph default
+:” edit field into the server's
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-
-$Rev$
+~/.ssh/authorized_keys
\end_layout
\end_inset
-).
- This way svn client will automatically substitute revision number (e.g.
-
-\begin_inset ERT
-status open
+/
+\begin_inset Flex Code
+status collapsed
\begin_layout Plain Layout
-
-$Rev: 59 $
+authorized_keys2
\end_layout
\end_inset
-) after each update and commit.
- There are more problems with this approach.
- Firstly, the '$' character is used in TeX world for math equations, so
- any occurence of math formula
-\begin_inset Formula $Rev$
-\end_inset
+ file.
+\end_layout
- become
-\begin_inset Formula $Rev:59$
-\end_inset
+\begin_layout Enumerate
+Get the Putty's
+\begin_inset Flex Code
+status collapsed
- in your LyX document.
- Similarly for other keywords like Id, Date, Author, etc.
- Secondly svn output is dependent on your locales, so its very easy that
- svn would produce some problematic strings once Date is used.
- Thirdly you get the whole 'Rev: 59' string in your document instead of
- the plain number.
- Until subversion implements user's custom keywords it will be hard to use
- this approach reliably or let LyX to support it directly .
+\begin_layout Plain Layout
+plink
\end_layout
-\begin_layout Standard
-The second possibility would be to write your own external-material template
- which calls either
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+.
+ In the SVN config file
+\begin_inset Foot
status collapsed
\begin_layout Plain Layout
-svnversion
+Exact path depends on Windows version, usually somewhere around
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+c:
+\backslash
+Documents and Settings
+\backslash
+user
+\backslash
+Application Data
+\backslash
+Subversion
+\backslash
+config
\end_layout
\end_inset
- utility or parses the output of
-\begin_inset Flex CharStyle:Code
+ /
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn info file.lyx
+AppData
+\backslash
+Roaming
+\backslash
+Subversion
\end_layout
\end_inset
- command and returns the result back, when typeseting the document.
+.
\end_layout
-\begin_layout Subsection
-SVN and Windows Environment
-\end_layout
+\end_inset
-\begin_layout Quote
-My inclination is to say that if the user cannot figure out the command
- line operations on their own fairly quickly, they would be well advised
- to use TortoiseSVN.
- ---P.
- A.
- Rubin
-\end_layout
+, section [tunnels], setup ssh command, e.g.
+
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsubsection
-Preparation
+\begin_layout Plain Layout
+ssh=c:/path/plink.exe -i c:/path/private_key.ppk
\end_layout
-\begin_layout Standard
-In addition to installing LyX, and having access to a Subversion repository,
- the user will need to install the Subversion client program.
- A Windows installer for the client program is available from
-\begin_inset CommandInset href
-LatexCommand href
-name "CollabNet"
-target "http://www.collab.net/nonav/downloads/subversion/"
-
\end_inset
.
- The user may also want to install
-\begin_inset CommandInset href
-LatexCommand href
-name "TortoiseSVN"
-target "http://tortoisesvn.tigris.org/"
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+It will usually take a lot of time to get exact command right and it depends
+ on many things.
+ For example do not have some remote server saved as a default session in
+ Putty etc.
+ If things fail, try to connect via plink without SVN first.
+\end_layout
\end_inset
-, which integrates Subversion operations into the context (rightclick) menu
- of Windows Explorer.
- Operations done outside LyX will typically be more convenient using the
- Explorer context menu.
- Note that TortoiseSVN is not a replacement for the client program, which
- is what LyX itself will use.
+
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Checkout the SVN archive, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn co svn+ssh://user@server/repository_path
+\end_layout
+
+\end_inset
+
+.
\end_layout
\begin_layout Subsubsection
-Bringing a document under Subversion control
+End-of-Line Conversions
\end_layout
\begin_layout Standard
-Before a LyX document can be brought under version control in Subversion,
- its parent directory needs to be under version control.
- If the document is being added to a project already in the repository,
- this is accomplished by checking the project out to the directory where
- the new document will be placed.
- If the project itself is not yet under version control (for instance, if
- this document starts a new project), the directory must be imported into
- the repository.
- This is done outside LyX.
- Both import and checkout are easily accomplished from the Explorer context
- menu using TortoiseSVN, or alternatively can be done using the command
- line client at a DOS prompt.
- The procedure for importing the project using TortoiseSVN is described
- below, assuming an existing repository and a new project being started
- in
-\family typewriter
-C:
-\backslash
-new project
-\family default
-.
- For information on using the Subversion client program, run
-\family typewriter
-svn --help
-\family default
-in a DOS shell.
-\end_layout
+When the collaborators are mixing Linux and Windows environments, LyX will
+ use different line endings inside the .lyx files.
+ This is not a problem as far as LyX functionality is concerned, but the
+ commit diffs will be huge and merge-conflicts prone.
+ Fortunately SVN itself knows
+\begin_inset Foot
+status collapsed
-\begin_layout Enumerate
-Locate
-\family typewriter
-C:
-\backslash
-new project
-\family default
-in Windows Explorer, right click it, and select
-\family typewriter
-TortoiseSVN > Repo-browser
-\family default
-.
- If necessary, adjust the URL for the repository, then click OK.
-\end_layout
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
-\begin_layout Enumerate
-Right click the level of the repository under which you want to place the
- new project folder (typically the top level) and click
-\family typewriter
-Create folder\SpecialChar \ldots{}
+\begin_layout Plain Layout
-\family default
- Supply a name for the project folder and click OK.
- Add a message for the log file if desired, then click OK again.
- The new project folder should appear in the repository.
- Finally, click OK again to exit the repository browser.
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
\end_layout
-\begin_layout Enumerate
-Once again right click
-\family typewriter
-C:
-\backslash
-new project
-\family default
-, this time selecting SVN Checkout\SpecialChar \ldots{}
- Select the URL of the project folder
- you just created in the repository, and set the checkout directory to
-\family typewriter
-C:
-\backslash
-new project.
+\end_inset
+
-\family default
- Click OK.
- You will be warned about a non-empty folder; click OK to proceed.
- You should now have a
-\family typewriter
-.svn
-\family default
- directory under
-\family typewriter
-C:
-\backslash
-new project.
\end_layout
-\begin_layout Enumerate
-Create or open your document in LyX and click
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\end_inset
+
+ how to deal with CR/LF problems when switching .lyx files to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+native
+\end_layout
-\bar under
-V
-\bar default
-ersion
-\begin_inset space ~
\end_inset
-Control\SpecialChar \menuseparator
+ mode.
+\begin_inset Foot
+status collapsed
-\bar under
-R
-\bar default
-egister.
-
-\family default
-Add a log message and click OK to commit the document to version control.
+\begin_layout Plain Layout
+For the lazy guys:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn propset svn:eol-style native FILE_NAME
\end_layout
-\begin_layout Standard
-From this point onward, you should have full functionality in the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\end_inset
+
+
+\end_layout
-\bar under
-V
-\bar default
-ersion
-\begin_inset space ~
\end_inset
-Control
-\family default
- menu.
- You also have the option of checking the document in and out, viewing its
- history, etc.
- using the TortoiseSVN context menu in Windows Explorer or the Subversion
- client program from a command prompt.
+
\end_layout
\begin_layout Subsection
\begin_layout Description
Commit:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Description
Revert:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
+\begin_layout Subsection
+Version control and Document comparison
+\end_layout
+
+\begin_layout Standard
+One of the typical uses of version control is to inspect the changes between
+ revisions, usually by creating
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+diff
+\end_layout
+
+\end_inset
+
+ dumps.
+ While this is useful for plain text files, it is much less useful in the
+ case of LyX files, which have more a complicated structure.
+ Hence we provide binding to the Document comparison feature.
+ There are two ways of calling this feature - either by direct call of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+VC_COMPARE
+\end_layout
+
+\end_inset
+
+ LyX function (for details see LyX functions manual) or by icon/menu item
+
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Compare with older revision...
+\end_layout
+
+\end_inset
+
+.
+ One can either compare two chosen revisions of the document or he can simply
+ compare the current version of edited text with older revisions (where
+ '
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+' revisions back means comparison of the edited file with last commited
+ revision).
+
+\end_layout
+
+\begin_layout Standard
+This feature is supported for SVN and RCS though due to the more complicated
+ versioning scheme of RCS there is a constraint -- when addressing the revisions
+ in dialog, numbers always point to the last number in RCS revision number,
+ i.e.
+ '35' in '1.2.35'.
+\end_layout
+
\begin_layout Section
Literate Programming
\end_layout
\begin_layout Standard
The main purpose of this documentation is to show you how to use LyX for
- literate programming.
- Where it is assumed that you are familiar with this programming technique,
- and know what
+ literate programming, where it is assumed that you are familiar with this
+ programming technique, and know what
\begin_inset Quotes eld
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+E.
Knuth during the development of his TeX typesetting software.
\end_layout
\begin_layout Plain Layout
-http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+http://www.literateprogramming.com/lpfaq.pdf
\end_layout
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
\end_layout
\begin_layout Chapter
-Secrets of the LaTeX Masters
-\begin_inset CommandInset label
-LatexCommand label
-name "cha:secrets"
-
-\end_inset
-
-
+Special features
\end_layout
\begin_layout Standard
-Though LyX is a powerful tool, it cannot hope to support everything that
- can be done with pure TeX/LaTeX.
- However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
- as long as you are not afraid to use that
-\begin_inset Quotes eld
-\end_inset
-
-TeX
-\begin_inset Quotes erd
+You can do everything with LyX that you can do with LaTeX.
+ However, LyX cannot support every LaTeX feature directly.
+ But you can always use TeX Code.
+ This chapter shows you some more special things you might want to use.
+ For other special things you can do with figures, tables, floats, boxes
+ and notes, have a look at the
+\emph on
+Embedded
+\begin_inset space ~
\end_inset
- button on the toolbar or add things to the LaTeX preamble.
- This section lists some tips, tricks, and otherwise cool ideas to give
- your document that extra little flair.
-
-\emph on
-Do try this at home
+Objects
\emph default
-, just start with something a little smaller and less important than your
- dissertation!
-\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.
- Often, there are several ways to do something, or several LaTeX style files
- which do the same thing.
- We do not endorse one choice over another, we simply claim that we have
- done a particular task with a particular file.
- Put on your wizard hat, keep an eye out for dragons, and let us begin.
+ manual.
\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
+Multiple Text Columns
\end_layout
\begin_layout Standard
-The aim for this chapter
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-Editor's note: Lars' original chapter was a masterful description of how
- to use the
-\family typewriter
-multicol
+This feature is independent of the option
+\family sans
+Two-column document
\family default
- package.
- However, it was too long to flow smoothly in this document.
- I have therefore chosen to excerpt the most important sections here (sorry,
- Lars); you can read the original chapter (and more of the story!) in the
- example file
-\family typewriter
-examples/multicol.lyx
+ in the document settings under
+\family sans
+Text Layout
\family default
.
- — mer
-\end_layout
-
+ If you want to have 2
+\begin_inset space ~
\end_inset
- is to show how the LaTeX package
-\family typewriter
-multicol
+columns for the whole document, it is recommended to use the
+\family sans
+Two-column document
\family default
- can be used in a LyX document.
- As LyX doesn't support the
-\family typewriter
-multicol
+ option.
+ For all other cases use this feature.
+\end_layout
+
+\begin_layout Standard
+To use multiple text columns in your document, you have to load the module
+
+\family sans
+Multiple Columns
+\family default
+ (menu
+\family sans
+Document\SpecialChar \menuseparator
+Settings\SpecialChar \menuseparator
+Modules
\family default
- package natively yet, we have to use some small hacks.
- By reading this section it should be obvious how to do this.
+) and must have the LaTeX-package
+\series bold
+multicol
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! multicol
\end_layout
-\begin_layout Subsection
-Limitations
+\end_inset
+
+ installed.
\end_layout
\begin_layout Standard
-The
-\family typewriter
-multicol
+Footnotes within multiple columns will be placed at the bottom of the page
+ and not under each column.
+ Within the different columns you can use everything, with the limitation
+ that for floats you need to use the float option
+\family sans
+Span columns
\family default
- package allows switching between one and multicolumn format on the same
- page.
- Footnotes are handled correctly (for the most part), but will be placed
- at the bottom of the page and not under each column.
- LaTeX's float mechanism, however, is partly disabled in the current implementat
-ion.
- At the moment only page-wide floats can be used within the scope of the
- environment.
+.
\end_layout
\begin_layout Subsection
-Examples
-\end_layout
-
-\begin_layout Subsubsection
-Two columns
+Basics
\end_layout
\begin_layout Standard
-If you want to have two columns in your text, you have use LaTeX mode to
- insert
-\family typewriter
+If you want to have 2
+\begin_inset space ~
+\end_inset
-\backslash
-begin{multicols}{2}
+columns in your text, use the style
+\family sans
+Begin Multiple Columns
\family default
- at the point where you want the two column layout to start, and then
-\family typewriter
+ where the columns should start.
+ The content of the style is the number of the columns, so in this case
+ use a
+\begin_inset Quotes eld
+\end_inset
-\backslash
-end{multicols}
+2
+\begin_inset Quotes erd
+\end_inset
+
+.
+ At the point where the columns should end use the style
+\family sans
+End Multiple Columns
\family default
- where you want it to end.
- Like this:
+ and keep it empty.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{2}
+Here is an example:
\end_layout
-\end_inset
-
-
+\begin_layout Begin Multiple Columns
+2
\end_layout
\begin_layout Standard
only withdrawn upon the third of last month.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-end{multicols}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Multiple columns
-\end_layout
+\begin_layout End Multiple Columns
-\begin_layout Standard
-The same pattern is used when you want more than two columns:
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
-
-\backslash
-begin{multicols}{3}
-\end_layout
-
+Here is an example with 3
+\begin_inset space ~
\end_inset
+columns:
+\end_layout
+\begin_layout Begin Multiple Columns
+3
\end_layout
\begin_layout Standard
as they were known to the public at the conclusion of the inquest.
\end_layout
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+You can have up to 10
+\begin_inset space ~
+\end_inset
+
+columns if you want to, but that might not be very pleasant for the readers
+ of your document.
+\end_layout
+
+\begin_layout Standard
+\begin_inset Newpage newpage
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Columns inside Columns
+\end_layout
+
+\begin_layout Standard
+You can also have columns inside columns:
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
+\end_layout
+
+\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.
+ Adair's mother had returned from Australia to undergo the operation for
+ cataract, and she, her son Ronald, and her daughter Hilda were living together
+ at 427 Park Lane.
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
+\end_layout
+
+\begin_layout Standard
+
+\size footnotesize
+The youth moved in the best society–had, so far as was known, no enemies
+ and no particular vices.
+ He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
+ had been broken off by mutual consent some months before, and there was
+ no sign that it had left any very profound feeling behind it.
+ For the rest {sic} the man's life moved in a narrow and conventional circle,
+ for his habits were quiet and his nature unemotional.
+ Yet it was upon this easy-going young aristocrat that death came, in most
+ strange and unexpected form, between the hours of ten and eleven-twenty
+ on the night of March 30, 1894.
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+
+\size footnotesize
+Ronald Adair was fond of cards–playing continually, but never for such stakes
+ as would hurt him.
+ He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
+ It was shown that, after dinner on the day of his death, he had played
+ a rubber of whist at the latter club.
+ He had also played there in the afternoon.
+
+\size default
+
+\size footnotesize
+The evidence of those who had played with him– Mr.
+ Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
+ and that there was a fairly equal fall of the cards.
+ Adair might have lost five pounds, but not more.
+ His fortune was a considerable one, and such a loss could not in any way
+ affect him.
+ He had played nearly every day at one club or other, but he was a cautious
+ player, and usually rose a winner.
+ It came out in evidence that, in partnership with Colonel Moran, he had
+ actually won as much as four hundred and twenty pounds in a sitting, some
+ weeks before, from Godfrey Milner and Lord Balmoral.
+ So much for his recent history as it came out at the inquest.
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Subsection
+Advanced Examples
+\end_layout
+
+\begin_layout Standard
+The examples in this section show some more special features of multiple
+ columns.
+\end_layout
+
+\begin_layout Standard
+For more features of multiple columns, have a look at the documentation
+ of the LaTeX-package
+\series bold
+multicol
+\series default
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! multicol
+\end_layout
+
+\end_inset
+
+,
+\begin_inset CommandInset citation
+LatexCommand cite
+key "multicol"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+Preface
+\end_layout
+
+\begin_layout Standard
+To add a preface text for multiple columns, add the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+}[
+\end_layout
+
+\begin_layout Standard
+as TeX Code behind the number of columns in the
+\family sans
+ Begin Multiple Columns
+\family default
+ style.
+ Behind the command follows the preface text.
+ At the end of the style use the command
+\end_layout
+
+\begin_layout Standard
+
+\series bold
+]{
+\end_layout
+
\begin_layout Standard
+as TeX Code.
+ An example with some preface text:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
\begin_inset ERT
-status open
+status collapsed
\begin_layout Plain Layout
+}[
+\end_layout
-\backslash
-end{multicols}
+\end_inset
+
+And the story continues and continues and continues and continues\SpecialChar \ldots{}
+
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+]{
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-You can have more than 3 columns if you want to, but that might not be very
- pleasant for the eye.
+
+\size small
+On the evening of the crime, he returned from the club exactly at ten.
+ His mother and sister were out spending the evening with a relation.
+ The servant deposed that she heard him enter the front room on the second
+ floor, generally used as his sitting-room.
+ She had lit a fire there, and as it smoked she had opened the window.
+ No sound was heard from the room until eleven-twenty, the hour of the return
+ of Lady Maynooth and her daughter.
+ Desiring to say good-night, she attempted to enter her son's room.
+ The door was locked on the inside, and no answer could be got to their
+ cries and knocking.
+ Help was obtained, and the door forced.
+ The unfortunate young man was found lying near the table.
+ His head had been horribly mutilated by an expanding revolver bullet, but
+ no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout Subsubsection
-Columns inside columns
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+You can also use a section heading as the preface if you use a section command
+ as TeX Code behind the first TeX Code.
+ For example the command
\end_layout
\begin_layout Standard
-You can even have columns inside columns:
+
+\series bold
+
+\backslash
+subsection{subsection title}
\end_layout
\begin_layout Standard
+creates a subsection.
+ In this example the preface is a subsubsection:
+\end_layout
+
+\begin_layout Begin Multiple Columns
+2
\begin_inset ERT
-status open
+status collapsed
+
+\begin_layout Plain Layout
+
+}[
+\end_layout
+
+\end_inset
+
+
+\begin_inset ERT
+status collapsed
\begin_layout Plain Layout
\backslash
-begin{multicols}{2}
+subsubsection{
\end_layout
\end_inset
+This is a subsubsection heading as a preface
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+}
\end_layout
-\begin_layout Standard
+\end_inset
-\size footnotesize
-The Honourable Ronald Adair was the second son of the Earl of Maynooth,
- at that time governor of one of the Australian colonies.
- Adair's mother had returned from Australia to undergo the operation for
- cataract, and she, her son Ronald, and her daughter Hilda were living together
- at 427 Park Lane.
-\end_layout
-\begin_layout Standard
\begin_inset ERT
-status open
+status collapsed
\begin_layout Plain Layout
-
-\backslash
-begin{multicols}{2}
+]{
\end_layout
\end_inset
\begin_layout Standard
-\size footnotesize
-The youth moved in the best society–had, so far as was known, no enemies
- and no particular vices.
- He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
- had been broken off by mutual consent some months before, and there was
- no sign that it had left any very profound feeling behind it.
- For the rest {sic} the man's life moved in a narrow and conventional circle,
- for his habits were quiet and his nature unemotional.
- Yet it was upon this easy-going young aristocrat that death came, in most
- strange and unexpected form, between the hours of ten and eleven-twenty
- on the night of March 30, 1894.
+\size small
+A minute examination of the circumstances served only to make the case more
+ complex.
+ In the first place, no reason could be given why the young man should have
+ fastened the door upon the inside.
+ There was the possibility that the murderer had done this, and had afterwards
+ escaped by the window.
+ The drop was at least twenty feet, however, and a bed of crocuses in full
+ bloom lay beneath.
+ Neither the flowers nor the earth showed any sign of having been disturbed,
+ nor were there any marks upon the narrow strip of grass which separated
+ the house from the road.
+ Apparently, therefore, it was the young man himself who had fastened the
+ door.
+ But how did he come by his death? No one could have climbed up to the window
+ without leaving traces.
+ Suppose a man had fired through the window, he would indeed be a remarkable
+ shot who could with a revolver inflict so deadly a wound.
+ Again, Park Lane is a frequented thoroughfare; there is a cab stand within
+ a hundred yards of the house.
+ No one had heard a shot.
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+If there is less vertical space left on the page at the beginning of the
+ multiple columns than needed for 6
+\begin_inset space ~
+\end_inset
+
+text lines, a page break will be inserted before the multiple columns.
+ Depending on the number of lines of the preface text, you might want to
+ change this value.
+ It is determined by inserting the command
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain Layout
-
+\series bold
+][number
\backslash
-end{multicols}
+baselineskip
\end_layout
+\begin_layout Standard
+as TeX Code behind the preface definition but before the final
+\series bold
+]{
+\series default
+ command.
+
+\emph on
+number
+\emph default
+ is hereby the number of text lines.
+ In this example the space is set to 7
+\begin_inset space ~
\end_inset
-
+text lines:
\end_layout
-\begin_layout Standard
+\begin_layout Begin Multiple Columns
+2
+\begin_inset ERT
+status collapsed
-\size footnotesize
-Ronald Adair was fond of cards–playing continually, but never for such stakes
- as would hurt him.
- He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
- It was shown that, after dinner on the day of his death, he had played
- a rubber of whist at the latter club.
- He had also played there in the afternoon.
+\begin_layout Plain Layout
-\size default
-
-\size footnotesize
-The evidence of those who had played with him– Mr.
- Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
- and that there was a fairly equal fall of the cards.
- Adair might have lost five pounds, but not more.
- His fortune was a considerable one, and such a loss could not in any way
- affect him.
- He had played nearly every day at one club or other, but he was a cautious
- player, and usually rose a winner.
- It came out in evidence that, in partnership with Colonel Moran, he had
- actually won as much as four hundred and twenty pounds in a sitting, some
- weeks before, from Godfrey Milner and Lord Balmoral.
- So much for his recent history as it came out at the inquest.
+}[
\end_layout
-\begin_layout Standard
+\end_inset
+
+
\begin_inset ERT
-status open
+status collapsed
\begin_layout Plain Layout
\backslash
-end{multicols}
+subsubsection{
\end_layout
\end_inset
+This is the sectioning command
+\begin_inset Newline newline
+\end_inset
-\end_layout
+as a preface and
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-Please do read the file
-\family typewriter
-examples/multicol.lyx
-\family default
- for more advanced examples including column and header spacing, vertical
- separator lines, and more.
+with multiple text lines
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+}
\end_layout
-\begin_layout Section
-Numbering in the
-\family sans
-Enumerate
-\family default
- Paragraph Environment
-\begin_inset OptArg
+\end_inset
+
+
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-Numbering in Enumerate
+
+][7
+\backslash
+baselineskip
\end_layout
\end_inset
-\end_layout
+\begin_inset ERT
+status collapsed
-\begin_layout Standard
-by
-\noun on
-John Weiss
+\begin_layout Plain Layout
+
+]{
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-\noindent
-The default numbering for the
-\family sans
-Enumerate
-\family default
- paragraph environment begins with Arabic numbers and ends with uppercase
- letters.
- Suppose, however, you wanted a different type of numbering scheme.
- Here's a quickie example of how to change the numbering scheme:
+
+\size small
+On the evening of the crime, he returned from the club exactly at ten.
+ His mother and sister were out spending the evening with a relation.
+ The servant deposed that she heard him enter the front room on the second
+ floor, generally used as his sitting-room.
+ She had lit a fire there, and as it smoked she had opened the window.
+ No sound was heard from the room until eleven-twenty, the hour of the return
+ of Lady Maynooth and her daughter.
+ Desiring to say good-night, she attempted to enter her son's room.
+ The door was locked on the inside, and no answer could be got to their
+ cries and knocking.
+ Help was obtained, and the door forced.
+ The unfortunate young man was found lying near the table.
+ His head had been horribly mutilated by an expanding revolver bullet, but
+ no weapon of any sort was to be found in the room.
\end_layout
-\begin_layout LyX-Code
+\begin_layout End Multiple Columns
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-Roman{enumi}.}
\end_layout
-\begin_layout LyX-Code
-
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumii}.}
+\begin_layout Subsubsection
+Surrounding Space
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+The amount of space before and after multiple columns can be changed by
+ changing the length
+\series bold
\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-arabic{enumiii}.}
+multicolsep
+\series default
+.
+ For example the command
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+
+\series bold
\backslash
-renewcommand{
-\backslash
-labelenumiv}{
+setlength{
\backslash
-alph{enumiv}.)}
-\end_layout
-
-\begin_layout Standard
-\SpecialChar \ldots{}
- which changes the numbering scheme to uppercase Roman numerals, uppercase
- letters, Arabic numbers, and lowercase letter.
+multicolsep}{3cm}
\end_layout
\begin_layout Standard
-Additionally, the previous example also adds a little bit extra to the numbering
- scheme.
- For example, the first level label actually looks like:
-\begin_inset Quotes eld
-\end_inset
-
-I.
-\begin_inset Quotes erd
-\end_inset
-
-.
- For ease of reading, we'll describe what the numbering schemes look like
- using a notation something like this: <
-\begin_inset Quotes eld
+in TeX Code changes its value to 3
+\begin_inset space \thinspace{}
\end_inset
-I.
-\begin_inset Quotes erd
+cm.
+ The change must be made before the multiple columns' start.
+ The predefined value is 13
+\begin_inset space \thinspace{}
\end_inset
-,
-\begin_inset space ~
-\end_inset
+pt.
+\end_layout
+\begin_layout Standard
+For this example
+\series bold
-\begin_inset Quotes erd
+\backslash
+multicolsep
+\series default
+ was set to 2.5
+\begin_inset space \thinspace{}
\end_inset
-A.
-\begin_inset Quotes erd
-\end_inset
+cm:
+\end_layout
-,
-\begin_inset space ~
-\end_inset
+\begin_layout Standard
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
-\begin_inset Quotes erd
-\end_inset
-1.
-\begin_inset Quotes erd
-\end_inset
+\backslash
+setlength{
+\backslash
+multicolsep}{2.5cm}
+\end_layout
-,
-\begin_inset space ~
\end_inset
-\begin_inset Quotes eld
-\end_inset
-
-a.)
-\begin_inset Quotes erd
-\end_inset
+\end_layout
->.
-
+\begin_layout Begin Multiple Columns
+2
\end_layout
\begin_layout Standard
-As you can see in the example, there is a label command for each nesting
- level,
-\family typewriter
-
-\backslash
-labelenumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
-
-\backslash
-labelenumiv
-\family default
-, as well as a counter,
-\family typewriter
-enumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
-enumiv
-\family default
-.
- There are also five
-\begin_inset Quotes eld
-\end_inset
-number printing
-\begin_inset Quotes erd
-\end_inset
+\size small
+All day I turned these facts over in my mind, endeavouring to hit upon some
+ theory which could reconcile them all, and to find that line of least resistanc
+e which my poor friend had declared to be the starting-point of every investigat
+ion.
+ I confess that I made little progress.
+ In the evening I strolled across the Park, and found myself about six o'clock
+ at the Oxford Street end of Park Lane.
+ A group of loafers upon the pavements, all staring up at a particular window,
+ directed me to the house which I had come to see.
+ A tall, thin man with coloured glasses, whom I strongly suspected of being
+ a plain-clothes detective, was pointing out some theory of his own, while
+ the others crowded round to listen to what he said.
+ I got as near him as I could, but his observations seemed to me to be absurd,
+ so I withdrew again in some disgust.
+ As I did so I struck against an elderly, deformed man, who had been behind
+ me, and I knocked down several books which he was carrying.
+\end_layout
- commands,
-\family typewriter
+\begin_layout End Multiple Columns
-\backslash
-arabic{}
-\family default
-,
-\family typewriter
+\end_layout
-\backslash
-roman{}
-\family default
-,
-\family typewriter
+\begin_layout Standard
+\begin_inset Note Greyedout
+status open
-\backslash
-Roman{}
-\family default
-,
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-alph{}
-\family default
-, and
-\family typewriter
+\series bold
+Note:
+\series default
+ The values you set with
+\series bold
\backslash
-Alph{}
-\family default
-, each of which take one counter as an argument.
- You can add characters before or after these, but there's no need to add
- spaces.
+setlength
+\series default
+ will be used for all following multiple columns until you change them again.
\end_layout
-\begin_layout Standard
-You can get really fancy with these.
- For example:
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-#
-\backslash
-Alph{enumi}
-\backslash
-#}
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumi}.
-\backslash
-arabic{enumii}}
-\end_layout
+\begin_layout Plain Layout
-\begin_layout LyX-Code
\backslash
-renewcommand{
-\backslash
-labelenumiii}{
+setlength{
\backslash
-alph{enumiii}+}
+multicolsep}{13pt}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-renewcommand{
-\backslash
-labelenumiv}{(
-\backslash
-roman{enumiv})}
-\end_layout
-\begin_layout Standard
-produces the somewhat out of hand numbering scheme: <
-\begin_inset Quotes eld
-\end_inset
+\begin_inset Note Note
+status collapsed
-#A#
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+go back to the default
+\end_layout
-,
-\begin_inset space ~
\end_inset
-\begin_inset Quotes erd
-\end_inset
+\end_layout
-A.1
-\begin_inset Quotes erd
+\begin_layout Standard
+\begin_inset Newpage newpage
\end_inset
-,
-\begin_inset space ~
-\end_inset
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
+Column Separation
+\end_layout
-a+
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The width of the columns is automatically calculated, but you can modify
+ the space between the columns.
+ This is done by changing the length
+\series bold
-,
-\begin_inset space ~
+\backslash
+columnsep
+\series default
+.
+ Its predefined value is 10
+\begin_inset space \thinspace{}
\end_inset
+pt.
+ Here is an example where
+\series bold
-\begin_inset Quotes eld
-\end_inset
-
-(i)
-\begin_inset Quotes erd
+\backslash
+columnsep
+\series default
+ is set to 3
+\begin_inset space \thinspace{}
\end_inset
->.
-
+cm:
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
+
+\backslash
+setlength{
+\backslash
+columnsep}{3cm}
\end_layout
-\begin_layout Section
-Dropped Capitals
+\end_inset
+
+
\end_layout
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+\begin_layout Begin Multiple Columns
+2
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+
+\size small
+My observations of No.
+\begin_inset space \space{}
\end_inset
+427 Park Lane did little to clear up the problem in which I was interested.
+ The house was separated from the street by a low wall and railing, the
+ whole not more than five feet high.
+ It was perfectly easy, therefore, for anyone to get into the garden, but
+ the window was entirely inaccessible, since there was no water pipe or
+ anything which could help the most active man to climb it.
+ More puzzled than ever, I retraced my steps to Kensington.
+ I had not been in my study five minutes when the maid entered to say that
+ a person desired to see me.
+ To my astonishment it was none other than my strange old book collector,
+ his sharp, wizened face peering out from a frame of white hair, and his
+ precious volumes, a dozen of them at least, wedged under his right arm.
+\end_layout
+
+\begin_layout End Multiple Columns
\end_layout
\begin_layout Standard
-\noindent
\begin_inset ERT
status collapsed
\backslash
-newfont{
-\backslash
-tmpfont}{cmr17 scaled 2500}{
-\backslash
-tmpfont T}
+setlength{
\backslash
-vspace*{-8.4ex}
+columnsep}{10pt}
\end_layout
\end_inset
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
\end_layout
-\begin_layout Standard
-\noindent
-\begin_inset ERT
-status open
+\end_inset
-\begin_layout Plain Layout
+\end_layout
-\backslash
-hangindent=3.3em
-\backslash
-hangafter=-3
+\begin_layout Subsubsection
+Vertical Lines
\end_layout
-\end_inset
+\begin_layout Standard
+Between the columns a rule with a width of the length
+\series bold
- hose of you who like the style of old books probably also like
-\begin_inset Quotes eld
+\backslash
+columnseprule
+\series default
+ is placed.
+ If this rule width is set to 0
+\begin_inset space \thinspace{}
\end_inset
-dropped capitals
-\begin_inset Quotes erd
+pt (this is the default), the rule is suppressed.
+ In the following example the line is 2
+\begin_inset space \thinspace{}
\end_inset
-—those large capital letters which begin each new chapter or section.
- Implementing them with plain LyX/LaTeX is straightforward (assuming you
- know some plain TeX!) but does require a lot of work and many iterations,
- as you can see by all the ugly TeX-mode stuff at the beginning of this
- paragraph.
+pt wide:
\end_layout
\begin_layout Standard
\backslash
-verb+
+setlength{
\backslash
-bigdrop{-1em}{3}{ptmri}{T}+
+columnseprule}{2pt}
\end_layout
\end_inset
-here is a much easier way of doing this, of course.
- The
-\family typewriter
-dropcaps
-\family default
- (or the newer
-\family typewriter
-dropping
-\family default
-) package from CTAN allows a simple way to add such letters to your documents.
- Since this package is not a standard part of teTeX, I can't demonstrate
- it within this document, but if you copy this paragraph to a new document,
- delete the
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-\family typewriter
+\begin_layout Begin Multiple Columns
+2
+\end_layout
-\backslash
-verb
-\family default
+\begin_layout Standard
+\size small
+\begin_inset Quotes eld
+\end_inset
+
+You're surprised to see me, sir,
\begin_inset Quotes erd
\end_inset
- and the pluses from the TeX code at the beginning of the paragraph, and
- add
-\family typewriter
+ said he, in a strange, croaking voice.
+\end_layout
-\backslash
-usepackage{dropcaps}
-\family default
- to your LaTeX preamble, you will get a nice Times Roman Italic
+\begin_layout Standard
+
+\size small
+I acknowledged that I was.
+\end_layout
+
+\begin_layout Standard
+
+\size small
\begin_inset Quotes eld
\end_inset
-T
+Well, I've a conscience, sir, and when I chanced to see you go into this
+ house, as I came hobbling after you, I thought to myself, I'll just step
+ in and see that kind gentleman, and tell him that if I was a bit gruff
+ in my manner there was not any harm meant, and that I am much obliged to
+ him for picking up my books.
\begin_inset Quotes erd
\end_inset
-, whose height is three lines of text and which protrudes 1 em into the
- margin.
- (Make certain you have copied
+
+\end_layout
+
+\begin_layout Standard
+
+\size small
\begin_inset Quotes eld
\end_inset
+You make too much of a trifle,
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-dropcaps.sty
-\family default
+ said I.
+
+\begin_inset Quotes eld
+\end_inset
+May I ask how you knew who I was?
\begin_inset Quotes erd
\end_inset
- into a directory where TeX can see it.) The first argument is the amount
- of indentation; in this case the negative sign moves it into the margin.
- The second argument is the height of the letter in number of lines of text.
- The third argument is the font name: virtually anything which has a tfm
- file should work (wade through the
-\family typewriter
-.../texmf/fonts/tfm
-\family default
- directory for possibilities).
- My personal favorite is
+
+\end_layout
+
+\begin_layout Standard
+
+\size small
\begin_inset Quotes eld
\end_inset
+Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
+ you'll find my little bookshop at the corner of Church Street, and very
+ happy to see you, I am sure.
+ Maybe you collect yourself, sir.
+ Here's
+\noun on
+British
+\begin_inset space ~
+\end_inset
-\family typewriter
-yinit
-\family default
-
+Birds
+\noun default
+, and
+\noun on
+Catullus
+\noun default
+, and
+\noun on
+The Holy War
+\noun default
+--a bargain, every one of them.
+ With five volumes you could just fill that gap on that second shelf.
+ It looks untidy, does it not, sir?
\begin_inset Quotes erd
\end_inset
-, a fancy German font specifically designed for dropped capitals.
- The fourth argument is the letter (or letters) to be dropped.
- The
-\family typewriter
-dropping
-\family default
- package also offers the
-\family typewriter
-\backslash
-bigdrop
-\family default
- command, as well as a slightly simplified
-\family typewriter
+\end_layout
+
+\begin_layout End Multiple Columns
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
\backslash
-dropping
-\family default
- command.
+setlength{
+\backslash
+columnseprule}{0pt}
\end_layout
-\begin_layout Section
-Non-standard Paragraph Shapes
+\end_inset
+
+
+\begin_inset Note Note
+status collapsed
+
+\begin_layout Plain Layout
+go back to the default
\end_layout
-\begin_layout Standard
-by
-\noun on
-Mike Ressler
+\end_inset
+
+
\end_layout
\begin_layout Standard
-\begin_inset VSpace bigskip
+\begin_inset Newpage newpage
\end_inset
\end_layout
+\begin_layout Section
+Non-standard Paragraph Shapes
+\end_layout
+
\begin_layout Standard
\begin_inset ERT
status collapsed
\family default
is called for.
As you can see, completely arbitrary shapes can be laid out with a suitable
- set of linelength definitions.
+ set of line length definitions.
While this parshape may look a bit silly and useless, one could conceive
of situations such as finely tuned dropped capitals, word wrapping around
non-rectangular graphics, etc.
\end_layout
-\begin_layout Section
-Summary
+\begin_layout Bibliography
+\begin_inset CommandInset bibitem
+LatexCommand bibitem
+key "multicol"
+
+\end_inset
+
+Documentation of the LaTeX-package
+\begin_inset CommandInset href
+LatexCommand href
+name "multicol"
+target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
+
+\end_inset
+
+
+\begin_inset Index idx
+status collapsed
+
+\begin_layout Plain Layout
+LaTeX-packages ! multicol
\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
-d in the last section, the important point is that you can do almost anything
- you want in LyX if you are willing to figure out how to do it in TeX and
- LaTeX.
- TeX is a fantastically powerful typesetting system and all that power is
- available to you since LyX uses it as its backend.
- Happy LyXing!
+\end_inset
+
+
\end_layout
\end_body
projects / lyx.git / blobdiff