#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
-\lyxformat 370
+\lyxformat 407
\begin_document
\begin_header
\textclass scrbook
theorems-ams
theorems-ams-extended
\end_modules
+\maintain_unincluded_children false
\begin_local_layout
Format 7
InsetLayout CharStyle:MenuItem
\end_local_layout
\language english
\inputencoding latin1
+\fontencoding global
\font_roman default
\font_sans default
\font_typewriter default
\graphics default
\default_output_format default
+\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize 12
\use_geometry false
\use_amsmath 0
\use_esint 0
+\use_mhchem 1
+\use_mathdots 1
\cite_engine basic
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
+\use_refstyle 0
\index Index
\shortcut idx
\color #008000
\papercolumns 1
\papersides 2
\paperpagestyle headings
-\tracking_changes false
+\tracking_changes true
\output_changes false
+\html_math_output 0
+\html_be_strict true
\end_header
\begin_body
.
If you have comments or error corrections, please send them to the LyX
Documentation mailing list,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph default
is already quite lengthy, and it contains information on all of the basic
features one needs to know in order to prepare most documents.
- However, the LyX Team has worked to LyX extensible through various configuratio
-n files and external packages.
+ However, the LyX Team has worked to make LyX extensible through various
+ configuration files and external packages.
That means that if you want to support the Fizzwizzle LaTeX package, you
can create a layout file (or module) for it without having to alter LyX
itself.
- We've already had contributions of several new features this way.
- This is the place where all of those get documented.
+ We've already had contributions of several new features this way, and some
+ of them are documented here.
+ There are also some more `advanced' features, such as how to control the
+ presentation of bibliographies and how to work with multi-part documents,
+ that are not covered in the
+\emph on
+User's Guide
+\emph default
+ and are discussed here.
\end_layout
\begin_layout Standard
This manual also documents some special features, like fax support, version
control, and SGML support, which require additional software to work properly.
- Lastly, there's a chapter of LaTeX tools and tips, things you can use to
- spruce up your documents by directly using the powerful features of LaTeX.
+ There is also a chapter on LyX's support for HTML.
+ And lastly, there's a chapter of LaTeX tools and tips, things you can use
+ to spruce up your documents by directly using the powerful features of
+ LaTeX.
After all, LyX
\emph on
is
\end_layout
\begin_layout Standard
-Since all the topics in this manual depend heavily on LyX's interaction
+Since many of the topics in this manual depend heavily on LyX's interaction
with LaTeX, this first chapter covers the inner workings of LyX and how
to direct LyX to generate exactly the LaTeX code you want.
It is obviously for more seasoned LyX users.
For one thing, you don't need to know LaTeX to use LyX effectively.
And LyX has added its own extensions to LaTeX.
Try the following sometime: select
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
from the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu (or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
), then look at the preamble of the resulting
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Convert the document to LaTeX and save to a file with the extension
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
in place of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Enumerate
Run LaTeX on the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
file (maybe several times), and run any other commands (such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
If you've run LaTeX using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
, LyX then runs a DVI viewer to display the DVI-file.
If you've used
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Run a PostScript viewer, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can import a LaTeX file into LyX by using the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
command in LyX.
This will call a program named
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
which will create a file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
from the file
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
status collapsed
\begin_layout Plain Layout
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
will translate most legal LaTeX, but not everything.
It will put things it doesn't understand into TeX code, so after translating
a file with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LyX cannot, and will never be able to, display every possible LaTeX construct.
If ever you need to insert LaTeX commands into your LyX document, you can
use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
box, which you can insert into your document with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
In addition to using TeX code, you can also create a separate file containing
some complex LaTeX structure and then use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
to include your file (you should select the type
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
).
We recommend that you only do this if you have a
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
For example, the package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Declare user defined commands (with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX adds its own set of definitions to the preamble of the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
The commands which LyX adds to the preamble of a LaTeX file are fixed; you
can't change them without patching LyX itself.
You can, however, add your own stuff to the preamble by selecting
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
dialog.
LyX adds anything in the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
There are two variables under LaTeX that control page position:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Sometimes, the size of a print medium and the area of the medium that you
can actually print on aren't the same.
This is where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The default values for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_inset space \thinspace{}
\end_inset
-g.
+e.
\begin_inset space \space{}
\end_inset
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
your sysadmin is a doofus,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
can save the day.
- Suppose you're left and top margins are always 0.5
+ Suppose your left and top margins are always 0.5
\begin_inset space \thinspace{}
\end_inset
Speaking of labels, suppose you wanted to print out a bunch of address labels.
There's a rather nice package, available at your nearest CTAN archive,
for printing sheets of labels:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First, make sure you're using the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
This sets things up for Avery label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
around each label text.
This and other special features of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Some folks also like to look at the log file directly: It is available from
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
You can also enable the `draft' option in
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
isn't installed on this system.
This usually appears because some package your document needs isn't installed.
If you didn't touch the preamble or didn't use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
command, then one of the packages LyX tried to load is missing.
Use
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
to get a list of packages that LyX knows about.
This file is updated whenever you reconfigure LyX (using
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
If you did use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
misuse
\emph default
any of them, like trying to manually insert lots of
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
spacing it will add in order to break a line.
Preferably, you should rework the paragraph to avoid the problem.
If this isn't an option, you can wrap your text in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-The basics how to use BibTeX are explained in section
+The most basic information about how to use BibTeX with LyX is contained
+ in the section
\emph on
Bibliography databases (BibTeX)
\emph default
).
LyX supports two packages that provide this style,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Both packages have their pros and cons, which cannot be listed in detail.
If you only want to have simple author-year (or author-numerical) style,
or if you want to use one of the countless style files for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, than the established
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package is probably your choice.
If you need special features like short title references, ibidem etc., you
might consider the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The handling of both packages in LyX is basically the same.
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and select under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
for
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and check under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
the option
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
Now you can insert multiple BibTeX bibliographies, one for each section
of your bibliography.
Returning to our example: Insert the BibTeX bibliography
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and a second one for the database
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
The titles for the sections can be added as ordinary sections or subsections.
Since
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
a bibliography for each section or chapter of the document, are not supported
by BibTeX itself.
But the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
package, which is used for the creation of sectioned bibliographies in
LyX (see the previous section), provides an easy way to solve this task,
if you are willing to use some
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
An alternative approach is to use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
First go to
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
and under
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
check
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
In the document, you have to enclose the sections, which shall contain
their own bibliography (including the BibTeX bibliography itself), between
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
(those commands have to be inserted as TeX code).
The bibliography will contain all references which have been cited in the
current
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\series default
If you are using this approach, then every citation reference has to be
inside some
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.
Also, the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
everything up to and including the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
line as well as the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
LyX allows you to include files quite easily with
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
in
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Normally, spaces in this file are invisible, though two consecutive spaces
are conserved, unlike LyX's normal treatment of spaces.
However, setting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
has_inner_box 1
inner_pos "t"
use_parbox 0
+use_makebox 0
width "100col%"
special "none"
height "1in"
Copy the bibliography list with all entries to all subdocuments and transform
them to a comment.
This way LyX will find the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
As the bibliography list is in a comment, LaTeX won't use use it and the
references will look like this: [?], instead of like this: [1].
One solution is to use the LaTeX-package
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The default page layout is rather plain; for an
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
For more information on fancy headers, see the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
package documentation.
- This can be found in the file
-\begin_inset Flex CharStyle:Code
+ (
+\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
-fancyhdr.dvi
-\end_layout
-
-\end_inset
-, which should have been installed with your LaTeX distribution, or
-\begin_inset CommandInset href
-LatexCommand href
-name "online"
-target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
+http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
+\end_layout
\end_inset
-.
+)
\end_layout
\begin_layout Standard
.
The footer is also divided into these three fields.
The LaTeX commands to set these fields in the simplest manner are
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The commands
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
access LaTeX's section and page counters, and so print out the current
section and page numbers.
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family default
like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
You can switch the header/footer settings on and off for individual pages
using commands like
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
\noindent
(you may need to preface this with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
Open the dialog by selecting the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
menu item and then select the
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\begin_layout Itemize
Use the LaTeX command
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Specify each individual entry by starting each item with the bullet shape
enclosed in square brackets and set as
-\begin_inset Flex CharStyle:MenuItem
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
.
For example, this item was started with
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Chapter
-The LyX Server
+LyX and the World Wide Web
\end_layout
-\begin_layout Section
-Introduction
+\begin_layout Standard
+LyX has long supported the export of documents to various web-friendly formats,
+ such as HTML.
+ Before verson 2.0, however, HTML export was always accomplished by the use
+ of external converters.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For details on the use of external converters with LyX, see the
+\emph on
+Converters
+\emph default
+ section of the Customization manual.
\end_layout
-\begin_layout Standard
-The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
- and retrieve information about the LyX internal state.
- This is only intended for advanced users, but they should find it useful.
- It is by writing to the LyX server, for example, that bibliography managers,
- such as JabRef, are able to
-\begin_inset Quotes eld
\end_inset
-push
-\begin_inset Quotes erd
-\end_inset
+ These fall into two large groups: there are converters that use LaTeX as
+ an intermediate format, such as
+\begin_inset Flex Code
+status collapsed
- citations to LyX.
+\begin_layout Plain Layout
+htlatex
\end_layout
-\begin_layout Section
-Starting the LyX Server
-\end_layout
+\end_inset
-\begin_layout Standard
-The LyX server works through the use of a pair of named pipes.
- These are usually located in
-\begin_inset Flex CharStyle:Code
+,
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-UserDir
+html2latex
\end_layout
\end_inset
-
-\begin_inset Foot
+, and
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-On Windows,
-\emph on
-local
-\emph default
- named pipes are special objects located in
-\begin_inset Flex CharStyle:Code
-status collapsed
+plastex
+\end_layout
-\begin_layout Plain Layout
+\end_inset
-\backslash
+, relying upon LyX to produce the LaTeX; and there is a converter that works
+ directly on LyX files,
+\begin_inset Flex Code
+status collapsed
-\backslash
-.
-\backslash
-pipe
+\begin_layout Plain Layout
+eLyXer
\end_layout
\end_inset
.
+ All of these have different advantages and disadvantages.
+
\end_layout
-\end_inset
-
- and have the names
-\begin_inset Quotes eld
-\end_inset
-
-
-\begin_inset Flex CharStyle:Code
+\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
\begin_layout Plain Layout
-lyxpipe.in
+aux
\end_layout
\end_inset
+ files, counters, and references, and can often make use of the
+\begin_inset Flex Code
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+bbl
+\end_layout
- and
-\begin_inset Quotes eld
\end_inset
-
-\begin_inset Flex CharStyle:Code
+ 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_layout Plain Layout
-lyxpipe.out
+htlatex
\end_layout
\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 Quotes erd
-\end_inset
-
-.
- External programs write into
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Alex Fernandez's
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.in
+eLyXer
\end_layout
\end_inset
- and read back data from
-\begin_inset Flex CharStyle:Code
+ solves some of these problems.
+ In particular, its rendering of math tends to look better than
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxpipe.out
+htlatex
\end_layout
\end_inset
-.
- The stem of the pipe names can be defined in the
-\begin_inset Flex CharStyle:MenuItem
+'s, at least in simpler cases, since it renders math using a combination
+ of HTML and CSS rather than converting the formulae to images.
+ But more complex formula tend to be rendered less well than with
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Tools\SpecialChar \menuseparator
-Preferences
+htlatex
\end_layout
\end_inset
- dialog, for example
-\begin_inset Flex CharStyle:Code
+, since there is no reasonable way of scaling parentheses in HTML, for example.
+ More importantly (as of version 0.39, 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 no support for math macros, for user-defined paragraph or character
+ styles, or for tables of contents and figures, and its treatment of cross-refer
+ences is minimal.
+ 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 more advanced LyX users would produce.
+ In principle, of course, all of 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.
+\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 advantege 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 everything 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
+\emph on
+exactly
+\emph default
+ 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 MathML---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.
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
-argument is an optional argument which is meaningful only to some functions
- (for instance, the
+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
+
+\begin_inset Newline newline
\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.
+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 Standard
-In case of errors, the response from LyX will have this form
-\end_layout
+\begin_layout Itemize
+LaTeX
+\begin_inset Newline newline
+\end_inset
-\begin_layout Quote
-ERROR:
-\emph on
-clientname
-\emph default
-:
-\emph on
-function
-\emph default
-:
-\emph on
-error message
-\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
-where the
-\emph on
-error message
-\emph default
- should contain an explanation of why the command failed.
-\end_layout
+\end_inset
-\begin_layout Standard
-Examples:
+, 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 Quotes eld
-\end_inset
+.
+\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
-hello
-\begin_inset Quotes erd
\end_inset
- or
+ 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
-bye
+ !
\begin_inset Quotes erd
\end_inset
-.
- If
+, 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
-hello
+|see\SpecialChar \ldots{}
+
\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
+ 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
-bye
+entry|textbf
\begin_inset Quotes erd
\end_inset
- sent from LyX will inform clients that LyX is closing.
+.
+ 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
-Reverse DVI/PDF search
+Nomenclature and Glossary
\end_layout
\begin_layout Standard
-Some DVI/PDF viewers
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
- Skim on Mac OSX and SumatraPDF on Windows.
+There is at present no support for glossaries.
\end_layout
-\end_inset
+\begin_layout Chapter
+The LyX Server
+\end_layout
- provide
-\emph on
-reverse search
-\emph default
- facility (also called
-\emph on
-inverse search
-\emph default
-).
- This means that you can tell LyX to put the cursor to a specific line in
- the document by clicking at the respective position in the DVI/PDF output.
- To achieve this, the viewer must be able to communicate with LyX.
- This is done via the LyX server either by using the named pipe (
-\emph on
-lyxpipe
-\emph default
-), or the UNIX domain socket (
-\emph on
-lyxsocket
-\emph default
-) that LyX creates in its temporary directory (this is the way the
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxclient
+\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
+
+push
+\begin_inset Quotes erd
\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.
+ citations to LyX.
\end_layout
-\begin_layout Subsection
-Enabling reverse search
+\begin_layout Section
+Starting the LyX Server
\end_layout
\begin_layout Standard
-LaTeX provides several different methods for reverse search.
- Some are built-in in the
-\begin_inset Flex CharStyle:Code
+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
-latex/pdflatex
+UserDir
\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
+, (except on Windows, where
+\emph on
+local
+\emph default
+ named pipes are special objects located in
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsubsection*
-Built-in DVI-search via src-specials (DVI only)
+\begin_layout Plain Layout
+
+\backslash
+
+\backslash
+.
+\backslash
+pipe
\end_layout
-\begin_layout Standard
-This method provides the DVI file with the necessary information for reverse
- search.
- It is available in LaTeX since quite some time (any somewhat recent LaTeX
- distribution should include it), and it works reliably.
- To enable it, change the
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
+\end_inset
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+) and have the names
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+lyxpipe.in
\end_layout
\end_inset
-eX (plain)->DVI
-\end_layout
+\begin_inset Quotes erd
\end_inset
- or
-\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)->DraftDVI
-\end_layout
+\begin_inset Quotes erd
\end_inset
- converter in
-\begin_inset Flex CharStyle:MenuItem
+.
+ External programs write into
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+lyxpipe.in
\end_layout
\end_inset
- to
-\begin_inset Flex CharStyle:Code
+ and read back data from
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-latex -src-specials $$i
+lyxpipe.out
\end_layout
\end_inset
.
- If this doesn't work, check if your TeX engine needs different options
- (the syntax might differ in some distributions).
-\end_layout
+ The stem of the pipe names can be defined in the
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Subsubsection*
-External Packages (PDFSync and scrltx)
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
-\begin_layout Standard
-The packages
-\emph on
-pdfsync
-\emph default
- and
-\emph on
-scrltx
-\emph default
- provide reverse search facility for PDF output (via pdflatex) and DVI output,
- respectively.
- In order to enable it, load the packages in the LyX preamble:
-\end_layout
+\end_inset
-\begin_layout Itemize
-\begin_inset Flex CharStyle:Code
+ dialog, for example
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-\backslash
-usepackage{pdfsync}
+"/home/myhome/lyxpipe"
\end_layout
\end_inset
- for reverse PDF search,
-\end_layout
-
-\begin_layout Itemize
-
-\begin_inset Flex CharStyle:Code
+, or
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
+"
+\backslash
\backslash
-usepackage[active]{srcltx}
+.
+\backslash
+pipe
+\backslash
+lyxpipe"
\end_layout
\end_inset
- for reverse DVI search.
+ on Windows.
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
\begin_layout Standard
-If you want to be able to perform both DVI and PDF reverse searches, you
- can also insert in the preamble the following lines
-\end_layout
+LyX will add the '
+\begin_inset Flex Code
+status collapsed
-\begin_layout LyX-Code
+\begin_layout Plain Layout
+.in
+\end_layout
-\backslash
-usepackage{ifpdf}
-\begin_inset Newline newline
\end_inset
+' and '
+\begin_inset Flex Code
+status collapsed
-\backslash
-ifpdf
-\begin_inset Newline newline
-\end_inset
+\begin_layout Plain Layout
+.out
+\end_layout
-
-\backslash
-usepackage{pdfsync}
-\begin_inset Newline newline
\end_inset
+' to create the pipes.
+ If one of the pipes already exists, LyX will assume that another LyX process
+ is already running and will not start the server.
+ On POSIX (Unix like) systems, if for some other reason, an unused
+\begin_inset Quotes eld
+\end_inset
-\backslash
-else
-\begin_inset Newline newline
+stale
+\begin_inset Quotes erd
\end_inset
-
-\backslash
-usepackage[active]{srcltx}
-\begin_inset Newline newline
+ pipe is left in existence when LyX closes, then LyX will try to delete
+ it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart LyX.
+ On Windows, pipes are deleted by the OS on program termination or crash,
+ so
+\begin_inset Quotes eld
\end_inset
+stale
+\begin_inset Quotes erd
+\end_inset
-\backslash
-fi
+ pipes should not be possible.
\end_layout
\begin_layout Standard
-This way, you can preview the file as either DVI or PDF (pdflatex) and the
- right package will be used.
-\end_layout
+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 Standard
-Note that PDFSync might affect the output layout of your document.
- It is therefore advised to disable PDFsync for final documents.
+\begin_layout Plain Layout
+preferences
\end_layout
-\begin_layout Subsubsection*
-Built-in reverse search via SyncTeX (DVI and PDF)
+\end_inset
+
+ file, for each process.
\end_layout
\begin_layout Standard
-Recent versions of
-\begin_inset Flex CharStyle:Code
+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
-(pdf)latex
+lyx -dbg lyxserver
\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.
+.
\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
+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) -> DVI
+.
\end_layout
-\end_inset
-
- or
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-LaT
-\begin_inset ERT
+\begin_layout Standard
+Another useful tool is command-line based client you will find in
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+src/client/lyxclient
\end_layout
\end_inset
-eX (plain) -> DraftDVI
+.
\end_layout
-\end_inset
-
- converter in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-Converters
+\begin_layout Section
+Normal communication
\end_layout
-\end_inset
-
- to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-latex -synctex=1 $$i
+\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
-
-, 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 Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
\end_layout
-\end_inset
-
-eX (pdflatex) -> PDF (pdflatex)
+\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
-
- or converter to
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-pdflatex -synctex=1 $$i
+\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
-.
- 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
-\end_layout
-
+self-insert
+\begin_inset Quotes erd
\end_inset
- option enables gzip compression.
- If your viewer does not support it, you should instead use
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
--synctex=-1
+ 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
-, you don't need to do anything else for performing a reverse DVI search,
- as LyX already provides the necessary hooks for automatically using the
-
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-lyxclient
-\end_layout
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+\begin_inset Newline newline
+\end_inset
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
\end_inset
- program.
- Just setup your document as described above (reverse search is triggered
- by Ctrl-click or Alt-click on Mac OSX, respectively).
+echo $a
\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
+\begin_layout Section
+Notification
\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
- to
-\begin_inset Foot
-status collapsed
+notify
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Plain Layout
-On Mac OSX you have to use
-\begin_inset Flex CharStyle:Code
+.
+ The format of the string LyX sends is as follows:
+\end_layout
+
+\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
+ 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
+
+ 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
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:rev-search"
+
\end_inset
-XServer pipe path specified in
-\begin_inset Flex CharStyle:MenuItem
+Automatical enabling
+\end_layout
+
+\begin_layout Standard
+In most cases LyX will do the work for you by enabling
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-Paths
+Document\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+Output Sync
\end_layout
\end_inset
.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-In the
-\begin_inset Flex CharStyle:Code
+ In such a case LyX will automatically insert SyncTeX macro (for PDF) or
+ srcltx package (for DVI) respectively.
+ This option can be easily reached also on
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-development/tools
+View/update
\end_layout
\end_inset
- folder of a source distribution you can find a
-\begin_inset Flex CharStyle:Code
+ Toolbar.
+\end_layout
+
+\begin_layout Standard
+Plase note that including
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor
+srcltx
\end_layout
\end_inset
- script which is able to locate the
-\emph on
-lyxpipe
-\emph default
- based on your preferences.
+ package or
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+src-specials
\end_layout
\end_inset
+ sometimes have an impact on the typeset and you should switch them off
+ for the final typesets.
+\end_layout
+\begin_layout Standard
+You can also define custom macro in preferences and in case you need some
+ special tweaks read the next section about manual enabling.
+
\end_layout
-\begin_layout Subsubsection*
-MacDviX (Mac OSX)
+\begin_layout Subsection
+Manual enabling
\end_layout
\begin_layout Standard
-At the end of
-\begin_inset Flex CharStyle:Code
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-/Applications/MacDviX_Folder/calleditor.script
+latex/pdflatex
\end_layout
\end_inset
-, add the following lines:
+ 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 LyX-Code
-/Applications/Ly
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
+\end_layout
+
+\begin_layout Standard
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in LaTeX since quite some time (any somewhat recent LaTeX
+ distribution should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+LaT
\begin_inset ERT
status collapsed
\end_inset
-X.app/Contents/MacOS/lyxeditor "$2" $1
-\begin_inset Newline newline
-\end_inset
-
-exit 1
-\end_layout
-
-\begin_layout Standard
-Modify the lines accordingly if you install LyX somewhere else than in the
- Applications folder.
+eX (plain)->DVI
\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
+ or
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Standard
-Enter
-\begin_inset Flex CharStyle:Code
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-open -a Skim.app $$i
+
+{}
\end_layout
\end_inset
- to the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+eX (plain)->DraftDVI
\end_layout
\end_inset
-, and then in
-\begin_inset Flex CharStyle:MenuItem
+ converter in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Skim\SpecialChar \menuseparator
Preferences\SpecialChar \menuseparator
-Sync
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
\end_inset
- select Ly
-\begin_inset ERT
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-{}
+latex -src-specials $$i
\end_layout
\end_inset
-X.
-\end_layout
-
-\begin_layout Standard
-Reverse search is triggered by COMMAND-SHIFT-click
+.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
\end_layout
\begin_layout Subsubsection*
-Okular (KDE)
+External Packages (PDFSync and scrltx)
\end_layout
\begin_layout Standard
-Go to
-\begin_inset Flex CharStyle:MenuItem
+The packages
+\emph on
+pdfsync
+\emph default
+ and
+\emph on
+scrltx
+\emph default
+ provide reverse search facility for PDF output (via pdflatex) and DVI output,
+ respectively.
+ In order to enable it, load the packages in the LyX preamble:
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Settings\SpecialChar \menuseparator
-Configure Okular\SpecialChar \ldots{}
-\SpecialChar \menuseparator
-Editor
-\end_layout
-\end_inset
+\backslash
+usepackage{pdfsync}
+\end_layout
-, select
-\begin_inset Quotes eld
\end_inset
-Custom Text Editor
-\begin_inset Quotes erd
-\end_inset
+ for reverse PDF search,
+\end_layout
- and add the command
-\begin_inset Flex CharStyle:Code
+\begin_layout Itemize
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient -g %f %l
+
+\backslash
+usepackage[active]{srcltx}
\end_layout
\end_inset
-.
+ for reverse DVI search.
\end_layout
\begin_layout Standard
-Reverse search is triggered by SHIFT-click.
-\end_layout
-
-\begin_layout Subsubsection*
-YAP (Windows)
+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 Standard
-Launch yap, choose its
-\begin_inset Flex CharStyle:MenuItem
-status collapsed
-
-\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Options
-\end_layout
+\begin_layout LyX-Code
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
\end_inset
- menu and select the
-\begin_inset Quotes eld
-\end_inset
-Inverse DVI Search
-\begin_inset Quotes erd
+\backslash
+ifpdf
+\begin_inset Newline newline
\end_inset
- tab.
- Click on the
-\begin_inset Quotes eld
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
\end_inset
-New\SpecialChar \ldots{}
-
-\begin_inset Quotes erd
-\end_inset
- button and, in the window that opens, enter
-\begin_inset Quotes eld
+\backslash
+else
+\begin_inset Newline newline
\end_inset
-LyX Editor
-\begin_inset Quotes erd
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
\end_inset
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
-Name:
-\begin_inset Quotes erd
-\end_inset
+\backslash
+fi
+\end_layout
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
-\end_inset
+\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
-\SpecialChar \ldots{}
+\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_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection*
+Built-in reverse search via SyncTeX (DVI and PDF)
+\end_layout
- to open a file dialog and navigate to the directory containing the batch
- file
-\begin_inset Flex CharStyle:Code
+\begin_layout Standard
+Recent versions of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+(pdf)latex
\end_layout
\end_inset
- (see below).
- Select
-\begin_inset Flex CharStyle:Code
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+SyncTeX
+\emph default
+ facility is basically the result of the integration of the PDFSync package
+ to the pdftex program and its merge with the
+\emph on
+scr-specials
+\emph default
+ approach.
+ You need at least TeXLive 2008 or a recent MikTeX distribution in order
+ to use it.
+ Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
+ already provide SyncTeX support.
+\end_layout
+
+\begin_layout Standard
+To enable SyncTeX for DVI output, change the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+LaT
+\begin_inset ERT
+status collapsed
+
+\begin_layout Plain Layout
+
+{}
\end_layout
\end_inset
- and then specify the program arguments as
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-%f %l
+eX (plain) -> DVI
\end_layout
\end_inset
-.
- The
-\begin_inset Flex CharStyle:Code
+ or
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
-\end_layout
+LaT
+\begin_inset ERT
+status collapsed
-\end_inset
+\begin_layout Plain Layout
- wrapper is used for communicating with LyX through the
-\emph on
-lyxpipe
-\emph default
- and is as follows:
+{}
\end_layout
-\begin_layout LyX-Code
-@echo off
-\begin_inset Newline newline
\end_inset
-echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
-\backslash
+eX (plain) -> DraftDVI
+\end_layout
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.in
-\begin_inset Newline newline
\end_inset
-type
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe.out
-\end_layout
-
-\begin_layout Standard
-Make sure that the LyXServer pipe path you specified in LyX is
-\begin_inset Flex CharStyle:Code
+ converter in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-
-\backslash
-
-\backslash
-.
-\backslash
-pipe
-\backslash
-lyxpipe
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
\end_inset
-, otherwise change the
-\begin_inset Flex CharStyle:Code
+ to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.bat
+latex -synctex=1 $$i
\end_layout
\end_inset
- wrapper accordingly.
- You are advised to select in
-\begin_inset Flex CharStyle:MenuItem
+, and for PDF output, change the
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-Preferences\SpecialChar \menuseparator
-Paths
-\end_layout
+LaT
+\begin_inset ERT
+status collapsed
-\end_inset
+\begin_layout Plain Layout
- a temporary directory whose name does not contain spaces, otherwise inverse
- search will fail.
+{}
\end_layout
-\begin_layout Standard
-In yap, reverse search is triggered by double-click.
-\end_layout
+\end_inset
-\begin_layout Subsubsection*
-SumatraPDF (Windows)
+eX (pdflatex) -> PDF (pdflatex)
\end_layout
-\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+\end_inset
+
+ or converter to
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SumatraPDF -inverse-search "lyxeditor.bat %f %l"
+pdflatex -synctex=1 $$i
\end_layout
\end_inset
- in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+.
+ 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
-Preferences\SpecialChar \menuseparator
-File Handling\SpecialChar \menuseparator
-File formats\SpecialChar \menuseparator
-PDF (pdflatex)
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-synctex=1
\end_layout
\end_inset
-, where
-\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
-lyxeditor.bat
+-synctex=-1
\end_layout
\end_inset
- is the previous wrapper.
- If SumatraPDF.exe is not in your command PATH, use its full file name.
- Again, make sure that the LyX temporary directory name does not contain
- spaces, otherwise inverse search will fail.
+.
\end_layout
-\begin_layout Standard
-Reverse search is triggered by double-click.
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+Configuring and using specific viewers
\end_layout
\begin_layout Subsubsection*
-YAP (Cygwin)
+Xdvi (all platforms)
\end_layout
\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
+If you use
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-View\SpecialChar \menuseparator
-Options
+xdvi
\end_layout
\end_inset
- menu and select the
-\begin_inset Quotes eld
-\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 Code
+status collapsed
-Inverse DVI Search
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+lyxclient
+\end_layout
- tab.
- Click on the
-\begin_inset Quotes eld
\end_inset
-New\SpecialChar \ldots{}
+ 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_inset Quotes erd
-\end_inset
+\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
- button and, in the window that opens, enter
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats
+\end_layout
-LyX Editor
-\begin_inset Quotes erd
\end_inset
- (or any other name you like) in the
-\begin_inset Quotes eld
-\end_inset
+ to
+\begin_inset Foot
+status collapsed
-Name:
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+On Mac OSX you have to use
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
+\end_layout
- field.
- Now click on the button labeled
-\begin_inset Quotes eld
\end_inset
-\SpecialChar \ldots{}
-\begin_inset Quotes erd
+\end_layout
+
\end_inset
- to open a file dialog and navigate to the directory containing the
-\begin_inset Flex CharStyle:Code
+
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
\end_inset
- program.
- Select
-\begin_inset Flex CharStyle:Code
+, where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+lyxeditor.sh
+\end_layout
+
+\end_inset
+
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
+
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
+\end_inset
+
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
+\end_inset
+
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
\end_inset
- and then specify the program arguments as as
-\begin_inset Flex CharStyle:Code
+read < "${LYXPIPE}".out || exit
+\end_layout
+
+\begin_layout Standard
+where
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
--g %f %l
+/path/to/lyxpipe
\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
+ is the Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-bash.exe
+
+{}
\end_layout
\end_inset
- instead of
-\begin_inset Flex CharStyle:Code
+XServer pipe path specified in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-lyxclient.exe
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
\end_inset
- and specify
-\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
--c 'lyxeditor.sh "%f" %l'
+development/tools
\end_layout
\end_inset
- as program arguments (here, don't forget the double quotes around
-\begin_inset Flex CharStyle:Code
+ folder of a source distribution you can find a
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-%f
+lyxeditor
+\end_layout
+
+\end_inset
+
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
\end_layout
\end_inset
- as they are essential), where
-\begin_inset Flex CharStyle:Code
+
+\end_layout
+
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
+\end_layout
+
+\begin_layout Standard
+At the end of
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-lyxeditor.sh
+/Applications/MacDviX_Folder/calleditor.script
\end_layout
\end_inset
- is the previously introduced shell script (make sure that
-\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
-lyxeditor.sh
+
+{}
\end_layout
\end_inset
- is in the bash command PATH, otherwise use its full posix name).
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
+
+exit 1
\end_layout
\begin_layout Standard
-In yap, 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 Standard
+Reverse search is triggered by Alt-click (OPTION-click).
\end_layout
\begin_layout Subsubsection*
-SumatraPDF (Cygwin)
+Skim (Mac OSX)
\end_layout
\begin_layout Standard
-In order to use SumatraPDF for inverse search, enter
-\begin_inset Flex CharStyle:Code
+Enter
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+open -a Skim.app $$i
\end_layout
\end_inset
- in the viewer setting in
-\begin_inset Flex CharStyle:MenuItem
+ to the viewer setting in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
\end_inset
-, where
-\begin_inset Flex CharStyle:Code
+, and then in
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-SumatraPDF.sh
+Skim\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Sync
\end_layout
\end_inset
- is the following script (to be placed in your command PATH,
-\begin_inset Flex CharStyle:Code
+ select Ly
+\begin_inset ERT
status collapsed
\begin_layout Plain Layout
-/usr/local/bin
+
+{}
\end_layout
\end_inset
- being the best choice):
+X.
\end_layout
-\begin_layout LyX-Code
-#!/bin/bash
-\begin_inset Newline newline
-\end_inset
-
-cd $(dirname $1)
-\begin_inset Newline newline
-\end_inset
+\begin_layout Standard
+Reverse search is triggered by COMMAND-SHIFT-click
+\end_layout
-SumatraPDF -inverse-search "lyxclient -g %f %l" $(basename $1)
+\begin_layout Subsubsection*
+Okular (KDE)
\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
+Go to
+\begin_inset Flex MenuItem
status collapsed
\begin_layout Plain Layout
-"lyxclient -g %f %l"
+Settings\SpecialChar \menuseparator
+Configure Okular\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Editor
\end_layout
\end_inset
- with
-\begin_inset Flex CharStyle:Code
+, 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
-"bash -c 'lyxeditor.sh
-\backslash
-"%f
-\backslash
-" %l'"
+lyxclient -g %f %l
\end_layout
\end_inset
\end_layout
\begin_layout Standard
-Reverse search is triggered by double-click.
+Reverse search is triggered by SHIFT-click.
\end_layout
-\begin_layout Chapter
-Special Document Classes
-\end_layout
-
-\begin_layout Section
-A&A Paper
+\begin_layout Subsubsection*
+YAP (Windows)
\end_layout
\begin_layout Standard
-by
-\noun on
-Peter Sütterlin
-\end_layout
+Launch yap, choose its
+\begin_inset Flex MenuItem
+status collapsed
-\begin_layout Subsection
-Introduction
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
\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
-status collapsed
+\end_inset
-\begin_layout Plain Layout
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
-http://www.edpsciences.fr/aa/
-\end_layout
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
+ tab.
+ Click on the
+\begin_inset Quotes eld
\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
+New\SpecialChar \ldots{}
-\begin_layout Standard
-\begin_inset VSpace medskip
+\begin_inset Quotes erd
+\end_inset
+
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
\end_inset
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-\align center
-\begin_inset Flex URL
+Name:
+\begin_inset Quotes erd
+\end_inset
+
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
+
+\SpecialChar \ldots{}
+
+\begin_inset Quotes erd
+\end_inset
+
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-
-ftp://ftp.edpsciences.org/pub/aa/readme.html
+lyxeditor.bat
\end_layout
\end_inset
+ (see below).
+ Select
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
+\begin_layout Plain Layout
+%f %l
\end_layout
-\begin_layout Standard
-A manual comes together with that package, and this text is not meant to
- replace the original manual but merely a short guide how to realize the
- correct form of your paper.
-
-\end_layout
+\end_inset
-\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
+ The
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Getting started
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Standard
-It is recommended you start from the example template distributed with LyX.
- If you are not using a template, note the following settings:
-\end_layout
+\end_inset
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-Document\SpecialChar \menuseparator
-Settings
-\family default
- dialog (OK, that one was obvious).
+ wrapper is used for communicating with LyX through the
+\emph on
+lyxpipe
+\emph default
+ and is as follows:
\end_layout
-\begin_layout Itemize
-Don't change the option
-\family sans
-Page
-\begin_inset space ~
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
\end_inset
-style
-\family default
-: Leave it set to
-\family sans
-default
-\family default
+echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
+\backslash
+
+\backslash
.
- The whole layout is done by the macros, you shouldn't change anything.
-\end_layout
+\backslash
+pipe
+\backslash
+lyxpipe.in
+\begin_inset Newline newline
+\end_inset
-\begin_layout Subsection
-The header block
+type
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe.out
\end_layout
\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
-\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 sans
-Title
-\family default
-: [required]
+\backslash
+
+\backslash
+.
+\backslash
+pipe
+\backslash
+lyxpipe
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subtitle
-\family default
-: [optional]
+, otherwise change the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Author
-\family default
-: [required]
+ wrapper accordingly.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
-\family sans
-Address
-\family default
-: [required]
+\begin_layout Subsubsection*
+SumatraPDF (Windows)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat %f %l"
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
+ in the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+, where
+\begin_inset Flex Code
+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.
\end_layout
\begin_layout Standard
-There is no need to issue the
-\family typewriter
+Reverse search is triggered by double-click.
+\end_layout
-\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.
+\begin_layout Subsubsection*
+YAP (Cygwin)
\end_layout
\begin_layout Standard
-If you want to place footnotes in the header block, e.
-\begin_inset space \thinspace{}
+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
+
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
+\end_layout
+
\end_inset
-g.
-\begin_inset space \space{}
+ menu and select the
+\begin_inset Quotes eld
\end_inset
-to state your present address, just use the standard footnote via the menu
-
-\family sans
-Insert\SpecialChar \menuseparator
-Footnote.
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\family default
- LyX will automagically use the term
-\family typewriter
+ tab.
+ Click on the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-thanks{}
-\family default
- in that case.
-\end_layout
+New\SpecialChar \ldots{}
-\begin_layout Standard
-In addition to these topics, the macros use three additional LaTeX commands
- that have no counterpart in LyX:
-\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 typewriter
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
-\end_layout
+ (or any other name you like) in the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Name:
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\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.
-\end_layout
+\SpecialChar \ldots{}
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+ to open a file dialog and navigate to the directory containing the
+\begin_inset Flex Code
+status collapsed
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
+\begin_layout Plain Layout
+lyxeditor.exe
\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.
-
-\end_layout
+\end_inset
-\begin_layout Subsection
-The abstract
+ 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 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
+\end_inset
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
-\end_layout
+ and then specify the program arguments as
+\begin_inset Flex Code
+status collapsed
-\begin_layout Subsection
-Supported environments
+\begin_layout Plain Layout
+-g %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 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
-\family sans
-Standard
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Section
+ option and be sure to specify the LyXServer pipe path in the LyX preferences.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
-\family sans
-Subsection
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In order to use SumatraPDF for inverse search, enter
+\begin_inset Flex Code
+status collapsed
-\family sans
-Subsubsection
+\begin_layout Plain Layout
+SumatraPDF.sh
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Itemize
+ in the viewer setting in
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Enumerate
+, where
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF.sh
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Description
+ is the following script (to be placed in your command PATH,
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+/usr/local/bin
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Caption
+ being the best choice):
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+#!/bin/bash
+\begin_inset Newline newline
+\end_inset
-\family sans
-Abstract
+cd $(dirname $1)
+\begin_inset Newline newline
+\end_inset
+
+SumatraPDF -inverse-search "lyxeditor -g %f %l" $(basename $1)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+This wrapper script is needed because SumatraPDF is a native Windows application
+ and does not understand the posix paths used by the Cygwin version of LyX.
+ If SumatraPDF.exe is not in your command PATH, use its full posix path in
+ the script above.
+ The
+\begin_inset Flex Code
+status collapsed
-\family sans
-Acknowledgment
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Bibliography
+ enables communication via the
+\emph on
+lyxsocket
+\emph default
+.
+ Again, omit the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-LaTeX
+ 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 Subsection
-Commands not supported by LyX
+\begin_layout Standard
+Reverse search is triggered by double-click.
\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:
+\begin_layout Section
+Forward search
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+To make forward search possible you need to provide generated output PDF/DVI
+ file with additional information about TeX sources.
+ This can be done via the methods described in the section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:rev-search"
-\family typewriter
+\end_inset
-\backslash
-and
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Secondly you need to configure LyX for using your viewers in
+\begin_inset Flex MenuItem
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+Output\SpecialChar \menuseparator
+General
+\end_layout
-\backslash
-email
+\end_inset
+
+.
+ Only some of the viewers allows this operation --- yap, xdvi, okular, Sumatra
+ PDF
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For Sumatra CMCDDE is needed --- downloadable from http://www.istri.fr/zip/CMCDDE.z
+ip
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+.
+ Some other viewers allow at least reloading and positioning to particular
+ page of the file --- Evince or xpdf --- for these cases you can use external
+ call of synctex.
+ Please study the prepared examples in the Preferences dialog.
+\end_layout
-\backslash
-appendix
+\begin_layout Chapter
+Special Document Classes
\end_layout
-\begin_layout Itemize
+\begin_layout Section
+A&A Paper
+\end_layout
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Peter Sütterlin
+\end_layout
-\backslash
-authorrunning
+\begin_layout Subsection
+Introduction
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-inst{}
+http://www.edpsciences.fr/aa/
\end_layout
-\begin_layout Itemize
+\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_inset VSpace medskip
+\end_inset
+
-\backslash
-keywords{}
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-object{}
+ftp://ftp.edpsciences.org/pub/aa/readme.html
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
-\backslash
-titlerunning{}
\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!
+\begin_inset VSpace medskip
+\end_inset
+
+
\end_layout
-\begin_layout Subsection
-Figure and Table Floats
+\begin_layout Standard
+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
-LyX provides support for the necessary float environments
+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
-figure, figure*, table
+article (A&A V4)
\family default
- and
-\family sans
-table*
+.
+ Please refer to the comments in
+\family typewriter
+LyXDir/layouts/aapaper.layout
\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
+\end_layout
-Settings.
+\begin_layout Subsection
+Getting started
\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:
+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
-Create a wide figure float:
+\begin_layout Itemize
+Select
\family sans
-Insert\SpecialChar \menuseparator
-Float\SpecialChar \menuseparator
-Figure
+article (A&A)
\family default
-, then right click in the figure and select
+ in the
\family sans
-\bar under
-S
-\bar default
-pan
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog (OK, that one was obvious).
+\end_layout
+
+\begin_layout Itemize
+Don't change the option
+\family sans
+Page
\begin_inset space ~
\end_inset
-columns
+style
+\family default
+: Leave it set to
+\family sans
+default
\family default
.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\begin_layout Enumerate
-Enter your caption text.
+\begin_layout Subsection
+The header block
\end_layout
-\begin_layout Enumerate
-Press
+\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 Itemize
+
\family sans
-Return
+Title
\family default
- to move the cursor above the caption.
+: [required]
\end_layout
-\begin_layout Enumerate
-Insert your figure
-\end_layout
+\begin_layout Itemize
-\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
+Subtitle
+\family default
+: [optional]
+\end_layout
-Character\SpecialChar \menuseparator
-Horizontal
-\begin_inset space ~
-\end_inset
+\begin_layout Itemize
-Fill
+\family sans
+Author
\family default
-.
+: [required]
\end_layout
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c
-\begin_inset space ~
-\end_inset
+\begin_layout Itemize
-t
+\family sans
+Address
\family default
-.
+: [required]
\end_layout
-\begin_layout Enumerate
-Enter
-\family typewriter
+\begin_layout Itemize
-\backslash
-parbox[b]{55mm}{
+\family sans
+Offprints
\family default
-.
-
-\series bold
-Do not close the brace!
+: [optional] if more than one author: whom to contact for offprint requests.
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the caption text, switch to LaTeX mode and insert
- the closing brace:
+\begin_layout Itemize
+
\family sans
-M-c
-\begin_inset space ~
-\end_inset
+Mail
+\family default
+: [optional] mail address for contacts.
+\end_layout
-t
+\begin_layout Itemize
+
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
+\end_layout
+
+\begin_layout Standard
+There is no need to issue the
+\family typewriter
+
+\backslash
+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
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+to state your present address, just use the standard footnote via the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Footnote.
+
+\family default
+ LyX will automagically use the term
\family typewriter
-}
+
+\backslash
+thanks{}
\family default
-.
+ in that case.
\end_layout
\begin_layout Standard
-Also, refer to the figures in the example paper.
+In addition to these topics, the macros use three additional LaTeX commands
+ that have no counterpart in LyX:
\end_layout
-\begin_layout Subsection
-Referee layout
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+and
+\family default
+ to separate different names for more than one author and institute, respectivel
+y.
\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
+\begin_layout Itemize
+
\family typewriter
-referee
+
+\backslash
+inst{<nr>}
\family default
- to the documentclass.
- This must be done using the extra class options field in the
+to mark corresponding author/institute pairs.
+ The institutes are numbered sequentially as they appear in the
\family sans
-Document\SpecialChar \menuseparator
-Settings
+Address
\family default
- dialog.
- Just enter the string
+ field, so you have to put a marker to each author.
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
-referee
+
+\backslash
+email{address}
\family default
- there.
+ to supply an email address for fast contact.
+\end_layout
+
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
+
\end_layout
\begin_layout Subsection
-The example paper
+The abstract
\end_layout
\begin_layout Standard
-The
-\family sans
-Examples
+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
- 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.
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
\end_layout
-\begin_layout Section
-AASTeX
+\begin_layout Subsection
+Supported environments
\end_layout
\begin_layout Standard
-by
-\noun on
-Mike Ressler
+The A&A paper layout supports the following environments for structuring
+ your text:
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Itemize
+
+\family sans
+Standard
\end_layout
-\begin_layout Standard
-AASTeX is a set of macros produced by the American Astronomical Society
- to facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- LyX 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
+\begin_layout Itemize
+
+\family sans
+Section
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+
+\family sans
+Subsection
+\end_layout
+\begin_layout Itemize
+\family sans
+Subsubsection
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Flex URL
-status collapsed
+\begin_layout Itemize
-\begin_layout Plain Layout
+\family sans
+Itemize
+\end_layout
-http://www.journals.uchicago.edu/AAS/AASTeX
+\begin_layout Itemize
+
+\family sans
+Enumerate
\end_layout
-\end_inset
+\begin_layout Itemize
+
+\family sans
+Description
+\end_layout
+\begin_layout Itemize
+\family sans
+Caption
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Itemize
+
+\family sans
+Abstract
+\end_layout
+\begin_layout Itemize
+\family sans
+Acknowledgment
\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.
+\begin_layout Itemize
+
+\family sans
+Bibliography
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+LaTeX
\end_layout
\begin_layout Subsection
-Starting a New Paper
+Commands not supported by LyX
\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
-
+Some commands are not yet supported by the
\family sans
-Template
+paper (A&A)
\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
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-altaffilmark
-\family default
- and
+and
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-altaffiltext
-\family default
-, which should stick out like a sore thumb if you actually just opened the
- template file.
- For commands such as these, the LaTeX code must be entered directly and
- marked as such.
- Such commands are referred to as 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
+email
\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
+\begin_layout Itemize
-postprocessing
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- actions which need to be done before you submit it to the journals.
-
+\backslash
+appendix
\end_layout
-\begin_layout Enumerate
-Export your paper as a LaTeX file (
-\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
-\family default
-).
-
-\end_layout
+\begin_layout Itemize
-\begin_layout Enumerate
-Edit the resulting
\family typewriter
-.tex
-\family default
- file with your favorite text editor
+
+\backslash
+authorrunning
\end_layout
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
+\begin_layout Itemize
+
\family typewriter
\backslash
-documentclass
-\family default
- command
+inst{}
\end_layout
-\begin_layout Enumerate
-remove the
-\family typewriter
+\begin_layout Itemize
-\backslash
-usepackage...{fontenc}
-\family default
- line if it appears (usually just after
\family typewriter
\backslash
-documentclass
-\family default
-}; also remove the
+keywords{}
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-secnumdepth
-\family default
- line if it appears.
+object{}
\end_layout
-\begin_layout Enumerate
-remove everything between (and including) the
+\begin_layout Itemize
+
\family typewriter
\backslash
-makeatletter
+titlerunning{}
+\end_layout
+
+\begin_layout Standard
+If you want to use any of these commands, you have to enter them yourself.
+
+\series bold
+Do not forget to mark them as LaTeX code!
+\end_layout
+
+\begin_layout Subsection
+Figure and Table Floats
+\end_layout
+
+\begin_layout Standard
+LyX provides support for the necessary float environments
+\family sans
+figure, figure*, table
\family default
and
-\family typewriter
-
-\backslash
-makeatother
+\family sans
+table*
\family default
- commands, except for any commands you specifically put into the LaTeX preamble
- (which should appear immediately after the
-\begin_inset Quotes eld
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's
+\begin_inset space ~
\end_inset
-User specified LaTeX commands
-\begin_inset Quotes erd
+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
- comment in the
-\family typewriter
-.tex
-\family default
- file).
+Settings.
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
+\begin_layout Standard
+There is only one special thing: the figures with caption besides the figure.
+ To create such a figure, you have to do the following:
\end_layout
\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
-\end_layout
+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
-\begin_layout Enumerate
-Submit it.
+columns
+\family default
+.
\end_layout
-\begin_layout Subsection
-Comments On Specific Commands
+\begin_layout Enumerate
+Enter your caption text.
\end_layout
-\begin_layout Standard
-I will not describe the detailed usage of the individual AASTeX commands:
- the AASTeX User Guide (
-\family typewriter
-aasguide.tex
+\begin_layout Enumerate
+Press
+\family sans
+Return
\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{}
-
+ to move the cursor above the caption.
\end_layout
-\begin_layout Subsubsection
-Things that work as expected
+\begin_layout Enumerate
+Insert your figure
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status open
-
-\begin_layout Plain 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
-\backslash
-begin{sloppypar}
+Fill
+\family default
+.
\end_layout
+\begin_layout Enumerate
+Switch to LaTeX mode:
+\family sans
+M-c
+\begin_inset space ~
\end_inset
-
+t
+\family default
+.
\end_layout
-\begin_layout Standard
-Because they work as you might expect, I simply list them and the section
- they are found in:
+\begin_layout Enumerate
+Enter
\family typewriter
\backslash
-documentclass
+parbox[b]{55mm}{
\family default
- (2.1.1),
-\family typewriter
+.
+
+\series bold
+Do not close the brace!
+\end_layout
-\backslash
-begin{document}
-\family default
- (2.2),
-\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
-title
+t
\family default
- (2.3),
+
\family typewriter
-
-\backslash
-author
+}
\family default
- (2.3),
-\family typewriter
+.
+\end_layout
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
+\begin_layout Standard
+Also, refer to the figures in the example paper.
+\end_layout
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
+\begin_layout Subsection
+Referee layout
+\end_layout
-\backslash
-keywords
+\begin_layout Standard
+For submission, the paper has to be formated in a special double-spacing
+ layout.
+ For this purpose, you have to give the option
+\family typewriter
+referee
\family default
- (2.5),
+ to the documentclass.
+ This must be done using the extra class options field in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
+ Just enter the string
\family typewriter
+referee
+\family default
+ there.
+\end_layout
-\backslash
-section
+\begin_layout Subsection
+The example paper
+\end_layout
+
+\begin_layout Standard
+The
+\family sans
+Examples
\family default
- (2.7),
-\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
-subsection
+\begin_layout Section
+AASTeX
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+AASTeX is a set of macros produced by the American Astronomical Society
+ to facilitate electronic manuscript submission to the three journals they
+ publish: the Astrophysical Journal (including the Letters and Supplement),
+ the 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.7),
+
+\family sans
+Template
+\family default
+, enter the new file name, then choose the
\family typewriter
-
-\backslash
-subsubsection
+aastex.lyx
\family default
- (2.7),
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
\family typewriter
-
-\backslash
-paragraph
+<>
\family default
- (2.7),
+) 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
-facility
+altaffilmark
\family default
- (2.10),
+ and
\family typewriter
\backslash
-begin{displaymath}
+altaffiltext
\family default
- (2.12),
-\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
-begin{equation}
+\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
- (2.12),
-\family typewriter
+).
+
+\end_layout
-\backslash
-begin{eqnarray}
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
\family default
- (2.12),
+ file with your favorite text editor
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
\family typewriter
\backslash
-begin{mathletters}
+documentclass
\family default
- (2.12),
+ command
+\end_layout
+
+\begin_layout Enumerate
+remove the
\family typewriter
\backslash
-begin{thebibliography}
+usepackage...{fontenc}
\family default
- (2.13.1),
+ line if it appears (usually just after
\family typewriter
\backslash
-bibitem
+documentclass
\family default
- (2.13.2), all the cite commands and their variations (2.13.2), the generic
- graphicx figure commands (2.14.1),
+}; also remove the
\family typewriter
\backslash
-begin{table}
+secnumdepth
\family default
- (2.15.4),
+ line if it appears.
+\end_layout
+
+\begin_layout Enumerate
+remove everything between (and including) the
\family typewriter
\backslash
-begin{tabular}
+makeatletter
\family default
- (2.15.4),
+ and
\family typewriter
\backslash
-caption
+makeatother
+\family default
+ commands, except for any commands you specifically put into the LaTeX preamble
+ (which should appear immediately after the
+\begin_inset Quotes eld
+\end_inset
+
+User specified LaTeX commands
+\begin_inset Quotes erd
+\end_inset
+
+ comment in the
+\family typewriter
+.tex
+\family default
+ file).
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through LaTeX to make sure it still processes correctly.
+\end_layout
+
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
+\end_layout
+
+\begin_layout Enumerate
+Submit it.
+\end_layout
+
+\begin_layout Subsection
+Comments On Specific Commands
+\end_layout
+
+\begin_layout Standard
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
+\family typewriter
+aasguide.tex
+\family default
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar \ldots{}
+
+\end_layout
+
+\begin_layout Subsubsection
+Things that work as expected
+\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
+Because they work as you might expect, I simply list them and the section
+ they are found in:
+\family typewriter
+
+\backslash
+documentclass
+\family default
+ (2.1.1),
+\family typewriter
+
+\backslash
+begin{document}
+\family default
+ (2.2),
+\family typewriter
+
+\backslash
+title
+\family default
+ (2.3),
+\family typewriter
+
+\backslash
+author
+\family default
+ (2.3),
+\family typewriter
+
+\backslash
+affil
+\family default
+ (2.3),
+\family typewriter
+
+\backslash
+abstract
+\family default
+ (2.4),
+\family typewriter
+
+\backslash
+keywords
+\family default
+ (2.5),
+\family typewriter
+
+\backslash
+section
+\family default
+ (2.7),
+\family typewriter
+
+\backslash
+subsection
+\family default
+ (2.7),
+\family typewriter
+
+\backslash
+subsubsection
+\family default
+ (2.7),
+\family typewriter
+
+\backslash
+paragraph
+\family default
+ (2.7),
+\family typewriter
+
+\backslash
+facility
+\family default
+ (2.10),
+\family typewriter
+
+\backslash
+begin{displaymath}
+\family default
+ (2.12),
+\family typewriter
+
+\backslash
+begin{equation}
+\family default
+ (2.12),
+\family typewriter
+
+\backslash
+begin{eqnarray}
+\family default
+ (2.12),
+\family typewriter
+
+\backslash
+begin{mathletters}
+\family default
+ (2.12),
+\family typewriter
+
+\backslash
+begin{thebibliography}
+\family default
+ (2.13.1),
+\family typewriter
+
+\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
+
+\backslash
+begin{table}
+\family default
+ (2.15.4),
+\family typewriter
+
+\backslash
+begin{tabular}
+\family default
+ (2.15.4),
+\family typewriter
+
+\backslash
+caption
\family default
(2.15.4),
\family typewriter
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
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
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
By default, theorems and the like are numbered consecutively throughout
the document, but this may be modified by loading the module
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
or, if you are using
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
, the module
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph on
only
\emph default
- unnumbered results, the the module
-\begin_inset Flex CharStyle:Code
+ unnumbered results, the module
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\emph default
to be used with the AMS classes.
It is perfectly possible to use the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
module, and the others mentioned, with other classes, such as
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
The following environments—as well as the standard environments, such as
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
,
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
, and
-\begin_inset Flex CharStyle:Noun
+\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
\end_inset
—are provided by
-\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 following environments are provided by both the
-\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
(numbered) versions.
These same environments are provided only in the starred versions by the
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Standard
And these environments are provided by
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Plain Layout
-http://authors.elsevier.com/
+http://www.elsevier.com/wps/find/authorsview.authors/latex
\end_layout
\end_inset
.
Instructions are supplied along with the class file, which details the
requirements of the publishers.
- LyX includes package that allows for the use of this class, by a layout
+ LyX includes a package that allows for the use of this class, by a layout
and a template file.
Installation of the class file is the same as for any other LaTeX package;
instructions are provided in the Elsevier documentation.
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
Document
\family default
).
- A detailed German description of these options can be found in the Koma-Script
- documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
Settings
\family default
.
- A detailed German description of these and other type area options can
- be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
+
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-A detailed German description of the LaTeX document classes of the Koma-Script
- family can be found in the Koma-Script documentation
+Detailed descriptions of the LaTeX document classes of the Koma-Script family
+ can be found in the Koma-Script documentation
\emph on
scrguide
\emph default
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Plain Layout
-There is an English translation
+ (German) and
\emph on
-screnggu
+scrguien
\emph default
-, but it is not a complete one.
-\end_layout
-
-\end_inset
-
- The following sections describe only those aspects, which are relevant
- in LyX.
+ (English).
\end_layout
\begin_layout Subsection
.
It has — on the LaTeX side — a completely new interface and is not compatible
with the old class.
- Therefore, LyX supports both, though it is recommended to use the new class.
+ Therefore, LyX supports both, though it is recommended you use the new
+ class.
\end_layout
\begin_layout Standard
\begin_layout Standard
The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
+ to meet almost any needs.
This can be done via the preamble or with a special style file (Letter
Class Option, extension
\family typewriter
).
In this section, we can only list those features which are natively supported
by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
+ For detailed descriptions (and for the rest of features) we recommend you
+ have a look at the detailed manual of the Memoir class
\begin_inset Foot
status collapsed
\end_inset
style: The fancy page style is not supported, due to a command clash between
- Memoir and the fancyhdr package (they are both defining a command with
- the same name, which confuses LaTeX).
- Instead, Memoir comes with a bunch of own page styles (see
+ Memoir and the fancyhdr package (they both define a command with the same
+ name, which confuses LaTeX).
+ Instead, Memoir comes with a number of its own page styles (see
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
\end_layout
\begin_layout Description
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
+Sectioning: Sectionings (chapter, section, subsection etc.) come with an
+ optional argument in the standard classes.
With this, you can specify an alternative version of the title for the
table of contents and the headers (for instance, if the title is too long).
In LyX, you can do this via
\end_layout
\begin_layout Description
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
+Chapterprecis: You may know this older typesetting style: The contents of
+ a chapter are summarized below the title and also in the table of contents
(e.
\begin_inset space \thinspace{}
\end_inset
\begin_layout Section
Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
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:
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
and flags some common errors.
In other technical words, it is
\family typewriter
-lint
+lint
+\family default
+ for LaTeX.
+\end_layout
+
+\begin_layout Standard
+Well, what is a syntax checker doing in LyX which is supposed to produce
+ correct LaTeX anyways? The answer is simple: Just as
+\family typewriter
+Lint
+\family default
+ not only checks the
+\emph on
+syntax
+\emph default
+ of C programs, but also does
+\emph on
+semantic
+\emph default
+ checks for type-errors,
+\family sans
+ChkTeX
+\family default
+ catches some common
+\emph on
+typographic
+\emph default
+ errors, in addition to the syntactical ones.
+ Specifically,
+\family sans
+ChkTeX
+\family default
+ is capable of detecting several common errors, such as
+\end_layout
+
+\begin_layout Itemize
+Ellipsis detection:
+\begin_inset Newline newline
+\end_inset
+
+Use \SpecialChar \ldots{}
+ instead of ...
+\end_layout
+
+\begin_layout Itemize
+No space in front of/after parenthesis:
+\begin_inset Newline newline
+\end_inset
+
+( wrong spacing )
+\end_layout
+
+\begin_layout Itemize
+Enforcement of normal space after common abbreviations:
+\begin_inset Newline newline
+\end_inset
+
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+is too wide spacing.
+\end_layout
+
+\begin_layout Itemize
+Enforcement of end-of-sentence space when the last sentence ends with a
+ capital letter:
+\begin_inset Newline newline
+\end_inset
+
+This is a TEST.
+ And this is wrong spacing.
+\end_layout
+
+\begin_layout Itemize
+Space in front of labels and similar commands:
+\begin_inset Newline newline
+\end_inset
+
+The label should stick right up to the text to avoid falling to a wrong
+ page.
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:chktex"
+
+\end_inset
+
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This footnote is in danger of falling off to a wrong page
+\end_layout
+
+\end_inset
+
+ The label is separated too much.
+\end_layout
+
+\begin_layout Itemize
+Space in front of references, instead of hard spaces:
+\begin_inset Newline newline
+\end_inset
+
+In you are in bad luck, the text will break right between the referenced
+ text and reference number, and that's a pity.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:chktex"
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Itemize
+Use of
+\begin_inset Quotes eld
+\end_inset
+
+x
+\begin_inset Quotes erd
+\end_inset
+
+ instead of
+\begin_inset Formula $\times$
+\end_inset
+
+ between numbers:
+\begin_inset Newline newline
+\end_inset
+
+2x2 looks cheap compared to
+\begin_inset Formula $2\times2$
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+and more \SpecialChar \ldots{}
+ It is an invaluable tool when you are
+\begin_inset Quotes eld
+\end_inset
+
+finishing up
+\begin_inset Quotes erd
+\end_inset
+
+ your document before printing, and you should run it right after the obligatory
+ spelling check, and before you go fine tuning the typesetting.
+\end_layout
+
+\begin_layout Subsection
+How to use it
+\end_layout
+
+\begin_layout Standard
+If you have the program installed, usage is as simple as choosing
+\family sans
+Tools\SpecialChar \menuseparator
+Check
+\begin_inset space ~
+\end_inset
+
+TeX
+\family default
+.
+ This will make LyX generate a LaTeX file of your document, start
+\family sans
+ChkTeX
+\family default
+ to check it, and then make LyX insert
+\begin_inset Quotes eld
+\end_inset
+
+error boxes
+\begin_inset Quotes erd
+\end_inset
+
+ with the warnings from
+\family sans
+ChkTeX
+\family default
+, if there were any.
+ The warnings will be placed close to the point of the mistake, and you
+ can quickly find them by using the
+\family sans
+Navigate\SpecialChar \menuseparator
+Error
+\family default
+ menu item, or the shortcut key
+\family sans
+C-g
+\family default
+ from the default
+\family typewriter
+cua
+\family default
+ bind file.
+ Open the error boxes by clicking on them with the mouse, or use the shortcut
+ key
+\family sans
+C-i
+\family default
+ from
+\family typewriter
+cua
+\family default
+ bindings, or the corresponding
+\family sans
+C-o
+\family default
+ for the alternate
+\family typewriter
+emacs
+\family default
+ bind file.
+ Read the warning and correct the mistake, if it is a mistake.
+ If you have trouble understanding what the warning is about, you can safely
+ ignore it.
+ Remember that there is a hidden layer between the document on screen and
+ the technical details in invoking
+\family sans
+ChkTeX
+\family default
+, and this gap can make some warnings seem arcane or just right down plain
+ silly.
+\end_layout
+
+\begin_layout Standard
+This document is an excellent testing bed for the feature, and it should
+ provide quite a few warnings for you to fiddle with.
+ Since computers are only so smart, expect most of the warnings to be false
+ alarms, though.
+\end_layout
+
+\begin_layout Subsection
+How to fine tune it
+\end_layout
+
+\begin_layout Standard
+Sometimes, you'll find that
+\family sans
+ChkTeX
+\family default
+ makes more noise than suits your mood.
+ Then you can choose not to use it, wait until your mood changes, or try
+ to customize
+\family sans
+ChkTeX
+\family default
+ to get better along with you.
+ Another choice in the most desperate situations is to use
+\family sans
+View\SpecialChar \menuseparator
+Remove
+\begin_inset space ~
+\end_inset
+
+All
+\begin_inset space ~
+\end_inset
+
+Error
+\begin_inset space ~
+\end_inset
+
+Boxes
+\family default
+, which will get rid of all warnings instantly.
+\end_layout
+
+\begin_layout Standard
+Although
+\family sans
+ChkTeX
+\family default
+
+\emph on
+is
+\emph default
+ very configurable and extensible, you shouldn't expect to solve all problems
+ with
+\family sans
+ChkTeX
+\family default
+ in LyX this way.
+ Since LyX has to generate a somewhat special LaTeX file to be able to match
+ the line numbers from the
+\family sans
+ChkTeX
+\family default
+ output
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You can inspect the specific output from
+\family sans
+chktex
+\family default
+ by using
+\family sans
+Edit\SpecialChar \menuseparator
+View
+\begin_inset space ~
+\end_inset
+
+LaTeX
+\begin_inset space ~
+\end_inset
+
+Log
+\family default
+ right after a
+\family sans
+chktex
+\family default
+ run.
+\end_layout
+
+\end_inset
+
+ to the internal document structure, some of the warnings will not seen
+ to appear correctly.
+ There are two things you can do about this:
+\end_layout
+
+\begin_layout Itemize
+Fine tune the
+\family sans
+ChkTeX
+\family default
+ invocation command line in
+\family sans
+Preferences
+\family default
+ (tabs
+\family sans
+Outputs
+\family default
+,
+\family sans
+Misc
+\family default
+), or the global
+\family sans
+ChkTeX
+\family default
+ installation configuration file (usually with the file
+\family typewriter
+chktexrc
+\family default
+).
+ See below to learn what warnings can be enabled and disabled on the command
+ line.
+
+\end_layout
+
+\begin_layout Itemize
+Export your document as a raw LaTeX file using
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
+\family default
+ and run
+\family typewriter
+chktex
+\family default
+ manually on that.
+ Invoked in this way, it can be a hassle to find the corresponding place
+ in the document inside LyX, but with a little patience, you should be able
+ to do it.
+\end_layout
+
+\begin_layout Standard
+Here follows the warning messages that can be enabled and disabled in
+\family sans
+Preferences
+\family default
+.
+ Use
+\family typewriter
+-n#
+\family default
+ to disable a warning, and
+\family typewriter
+-w#
+\family default
+ to enable a warning.
+ The emphasized entries are disabled by default, because the default is
+ "
+\family typewriter
+chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
\family default
- for LaTeX.
+".
\end_layout
\begin_layout Standard
-Well, what is a syntax checker doing in LyX which is supposed to produce
- correct LaTeX anyways? The answer is simple: Just as
+Notice that you should only use the options that enable and disable warnings,
+ because LyX relies on some of the other command line parameters to be set
+ in a specific way to have a chance to communicate with
\family typewriter
-Lint
-\family default
- not only checks the
-\emph on
-syntax
-\emph default
- of C programs, but also does
-\emph on
-semantic
-\emph default
- checks for type-errors,
-\family sans
-ChkTeX
-\family default
- catches some common
-\emph on
-typographic
-\emph default
- errors, in addition to the syntactical ones.
- Specifically,
-\family sans
-ChkTeX
+chktex
\family default
- is capable of detecting several common errors, such as
-\end_layout
-
-\begin_layout Itemize
-Ellipsis detection:
-\begin_inset Newline newline
-\end_inset
-
-Use \SpecialChar \ldots{}
- instead of ...
+.
\end_layout
-\begin_layout Itemize
-No space in front of/after parenthesis:
-\begin_inset Newline newline
-\end_inset
+\begin_layout Enumerate
-( wrong spacing )
+\size small
+\emph on
+Command terminated with space.
\end_layout
-\begin_layout Itemize
-Enforcement of normal space after common abbreviations:
-\begin_inset Newline newline
-\end_inset
+\begin_layout Enumerate
-e.
-\begin_inset space \thinspace{}
+\size small
+Non-breaking space (
+\begin_inset Quotes eld
\end_inset
-g.
-\begin_inset space \space{}
-\end_inset
-is too wide spacing.
-\end_layout
+\family typewriter
+~
+\family default
-\begin_layout Itemize
-Enforcement of end-of-sentence space when the last sentence ends with a
- capital letter:
-\begin_inset Newline newline
+\begin_inset Quotes erd
\end_inset
-This is a TEST.
- And this is wrong spacing.
+) should have been used.
\end_layout
-\begin_layout Itemize
-Space in front of labels and similar commands:
-\begin_inset Newline newline
-\end_inset
-
-The label should stick right up to the text to avoid falling to a wrong
- page.
-
-\begin_inset CommandInset label
-LatexCommand label
-name "sec:chktex"
+\begin_layout Enumerate
+\size small
+\emph on
+You should enclose the previous parenthesis with
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset Foot
-status collapsed
-\begin_layout Plain Layout
-This footnote is in danger of falling off to a wrong page
-\end_layout
+\family typewriter
+{}
+\family default
+\begin_inset Quotes erd
\end_inset
- The label is separated too much.
+.
\end_layout
-\begin_layout Itemize
-Space in front of references, instead of hard spaces:
-\begin_inset Newline newline
+\begin_layout Enumerate
+
+\size small
+Italic correction (
+\begin_inset Quotes eld
\end_inset
-In you are in bad luck, the text will break right between the referenced
- text and reference number, and that's a pity.
- See section
-\begin_inset CommandInset ref
-LatexCommand ref
-reference "sec:chktex"
+\family typewriter
+
+\backslash
+/
+\family default
+
+\begin_inset Quotes erd
\end_inset
-.
+) found in non-italic buffer.
\end_layout
-\begin_layout Itemize
-Use of
+\begin_layout Enumerate
+
+\size small
+Italic correction (
\begin_inset Quotes eld
\end_inset
-x
-\begin_inset Quotes erd
-\end_inset
- instead of
-\begin_inset Formula $\times$
-\end_inset
+\family typewriter
- between numbers:
-\begin_inset Newline newline
-\end_inset
+\backslash
+/
+\family default
-2x2 looks cheap compared to
-\begin_inset Formula $2\times2$
+\begin_inset Quotes erd
\end_inset
-.
+) found more than once.
\end_layout
-\begin_layout Standard
-and more \SpecialChar \ldots{}
- It is an invaluable tool when you are
+\begin_layout Enumerate
+
+\size small
+\emph on
+No italic correction (
\begin_inset Quotes eld
\end_inset
-finishing up
+
+\family typewriter
+
+\backslash
+/
+\family default
+
\begin_inset Quotes erd
\end_inset
- your document before printing, and you should run it right after the obligatory
- spelling check, and before you go fine tuning the typesetting.
+) found.
\end_layout
-\begin_layout Subsection
-How to use it
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
-If you have the program installed, usage is as simple as choosing
-\family sans
-Tools\SpecialChar \menuseparator
-Check
-\begin_inset space ~
+\size small
+Accent command
+\begin_inset Quotes eld
\end_inset
-TeX
-\family default
-.
- This will make LyX generate a LaTeX file of your document, start
-\family sans
-ChkTeX
+
+\family typewriter
+cmd
\family default
- to check it, and then make LyX insert
-\begin_inset Quotes eld
-\end_inset
-error boxes
\begin_inset Quotes erd
\end_inset
- with the warnings from
-\family sans
-ChkTeX
-\family default
-, if there were any.
- The warnings will be placed close to the point of the mistake, and you
- can quickly find them by using the
-\family sans
-Navigate\SpecialChar \menuseparator
-Error
-\family default
- menu item, or the shortcut key
-\family sans
-C-g
-\family default
- from the default
-\family typewriter
-cua
-\family default
- bind file.
- Open the error boxes by clicking on them with the mouse, or use the shortcut
- key
-\family sans
-C-i
-\family default
- from
-\family typewriter
-cua
-\family default
- bindings, or the corresponding
-\family sans
-C-o
-\family default
- for the alternate
+ needs use of
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-emacs
-\family default
- bind file.
- Read the warning and correct the mistake, if it is a mistake.
- If you have trouble understanding what the warning is about, you can safely
- ignore it.
- Remember that there is a hidden layer between the document on screen and
- the technical details in invoking
-\family sans
-ChkTeX
-\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
-\end_layout
+cmd
+\family default
-\begin_layout Standard
-This document is an excellent testing bed for the feature, and it should
- provide quite a few warnings for you to fiddle with.
- Since computers are only so smart, expect most of the warnings to be false
- alarms, though.
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Subsection
-How to fine tune it
+\begin_layout Enumerate
+
+\size small
+Wrong length of dash may have been used.
\end_layout
-\begin_layout Standard
-Sometimes, you'll find that
-\family sans
-ChkTeX
-\family default
- makes more noise than suits your mood.
- Then you can choose not to use it, wait until your mood changes, or try
- to customize
-\family sans
-ChkTeX
-\family default
- to get better along with you.
- Another choice in the most desperate situations is to use
-\family sans
-View\SpecialChar \menuseparator
-Remove
-\begin_inset space ~
+\begin_layout Enumerate
+
+\size small
+\emph on
+\begin_inset Quotes eld
\end_inset
-All
-\begin_inset space ~
+
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
\end_inset
-Error
-\begin_inset space ~
+ expected, found
+\begin_inset Quotes eld
\end_inset
-Boxes
+
+\family typewriter
+%s
\family default
-, which will get rid of all warnings instantly.
+
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-Although
-\family sans
-ChkTeX
-\family default
-
-\emph on
-is
-\emph default
- very configurable and extensible, you shouldn't expect to solve all problems
- with
-\family sans
-ChkTeX
-\family default
- in LyX this way.
- Since LyX has to generate a somewhat special LaTeX file to be able to match
- the line numbers from the
-\family sans
-ChkTeX
-\family default
- output
-\begin_inset Foot
-status collapsed
+\begin_layout Enumerate
-\begin_layout Plain Layout
-You can inspect the specific output from
-\family sans
-chktex
+\size small
+Solo
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+%s
\family default
- by using
-\family sans
-Edit\SpecialChar \menuseparator
-View
-\begin_inset space ~
+
+\begin_inset Quotes erd
\end_inset
-LaTeX
-\begin_inset space ~
+ found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use
+\begin_inset Quotes eld
\end_inset
-Log
-\family default
- right after a
-\family sans
-chktex
+
+\family typewriter
+%s
\family default
- run.
-\end_layout
+\begin_inset Quotes erd
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
- There are two things you can do about this:
+ to achieve an ellipsis.
\end_layout
-\begin_layout Itemize
-Fine tune the
-\family sans
-ChkTeX
-\family default
- invocation command line in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Outputs
-\family default
-,
-\family sans
-Misc
-\family default
-), or the global
-\family sans
-ChkTeX
-\family default
- installation configuration file (usually with the file
+\begin_layout Enumerate
+
+\size small
+Inter-word spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-chktexrc
+
+\backslash
+
\family default
-).
- See below to learn what warnings can be enabled and disabled on the command
- line.
+\begin_inset Quotes eld
+\end_inset
+
+) should perhaps be used.
\end_layout
-\begin_layout Itemize
-Export your document as a raw LaTeX file using
-\family sans
-File\SpecialChar \menuseparator
-Export\SpecialChar \menuseparator
-LaTeX
-\family default
- and run
+\begin_layout Enumerate
+
+\size small
+Inter-sentence spacing (
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-chktex
+
+\backslash
+@
\family default
- manually on that.
- Invoked in this way, it can be a hassle to find the corresponding place
- in the document inside LyX, but with a little patience, you should be able
- to do it.
+
+\begin_inset Quotes erd
+\end_inset
+
+) should perhaps be used.
\end_layout
-\begin_layout Standard
-Here follows the warning messages that can be enabled and disabled in
-\family sans
-Preferences
-\family default
-.
- Use
-\family typewriter
--n#
-\family default
- to disable a warning, and
-\family typewriter
--w#
-\family default
- to enable a warning.
- The emphasized entries are disabled by default, because the default is
- "
-\family typewriter
-chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
-\family default
-".
+\begin_layout Enumerate
+
+\size small
+Could not find argument for command.
\end_layout
-\begin_layout Standard
-Notice that you should only use the options that enable and disable warnings,
- because LyX relies on some of the other command line parameters to be set
- in a specific way to have a chance to communicate with
+\begin_layout Enumerate
+
+\size small
+No match found for
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-chktex
+%s
\family default
+
+\begin_inset Quotes erd
+\end_inset
+
.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-Command terminated with space.
+Math mode still on at end of LaTeX file.
\end_layout
\begin_layout Enumerate
\size small
-Non-breaking space (
+Number of
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+char
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ doesn't match the number of
\begin_inset Quotes eld
\end_inset
\family typewriter
-~
+char
\family default
\begin_inset Quotes erd
\end_inset
-) should have been used.
+.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-You should enclose the previous parenthesis with
+You should use either
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-\family typewriter
-{}
\family default
+ or
+\family typewriter
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-\size small
-Italic correction (
+\family default
+ as an alternative to
\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-/
+"
\family default
\begin_inset Quotes erd
\end_inset
-) found in non-italic buffer.
+.
\end_layout
\begin_layout Enumerate
\size small
-Italic correction (
-\begin_inset Quotes eld
-\end_inset
-
-
+You should use "
\family typewriter
-
-\backslash
-/
+'
+\family default
+" (ASCII 39) instead of "
+\family typewriter
+´
\family default
+" (ASCII 180).
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-) found more than once.
+\size small
+User-specified pattern found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+This command might not be intended.
\end_layout
\begin_layout Enumerate
\size small
\emph on
-No italic correction (
-\begin_inset Quotes eld
-\end_inset
+Comment displayed.
+\end_layout
+\begin_layout Enumerate
+\size small
+Either
\family typewriter
-
+''
\backslash
-/
+,'
+\family default
+ or
+\family typewriter
+'
+\backslash
+,''
\family default
+ will look better.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-) found.
+\size small
+Delete this space to maintain correct page references.
\end_layout
\begin_layout Enumerate
\size small
-Accent command
+\emph on
+You might wish to put this between a pair of
\begin_inset Quotes eld
\end_inset
\family typewriter
-cmd
+{}
\family default
\begin_inset Quotes erd
\end_inset
- needs use of
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You ought to remove spaces in front of punctuation.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+Could not execute LaTeX command.
+\end_layout
+\begin_layout Enumerate
+\size small
+Don't use
\family typewriter
-cmd
+
+\backslash
+/
\family default
+ in front of small punctuation.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-.
+\family typewriter
+\size small
+$
+\backslash
+times$
+\family default
+ may look prettier here.
\end_layout
\begin_layout Enumerate
\size small
-Wrong length of dash may have been used.
+\emph on
+Multiple spaces detected in output.
\end_layout
\begin_layout Enumerate
\size small
-\emph on
-\begin_inset Quotes eld
-\end_inset
+This text may be ignored.
+\end_layout
+\begin_layout Enumerate
+\size small
+Use
\family typewriter
-%s
-\family default
-
-\begin_inset Quotes erd
-\end_inset
- expected, found
\begin_inset Quotes eld
\end_inset
+\family default
+ to begin quotation, not
\family typewriter
-%s
+'
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
.
\end_layout
\begin_layout Enumerate
\size small
-Solo
+Use
+\family typewriter
+'
+\family default
+ to end quotation, not
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-\family typewriter
-%s
\family default
+.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
- found.
+\size small
+Don't mix quotes.
\end_layout
\begin_layout Enumerate
\size small
-You should use
+You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+cmd
\family default
\begin_inset Quotes erd
\end_inset
- to achieve an ellipsis.
+ instead.
\end_layout
\begin_layout Enumerate
\size small
-Inter-word spacing (
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
+You should put a space in front of/after parenthesis.
+\end_layout
-\family default
-
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
-) should perhaps be used.
+\size small
+You should avoid spaces in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
\size small
-Inter-sentence spacing (
-\begin_inset Quotes eld
-\end_inset
-
+\emph on
+You should not use punctuation in front of/after quotes.
+\end_layout
-\family typewriter
+\begin_layout Enumerate
-\backslash
-@
-\family default
+\size small
+Double space found.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
-) should perhaps be used.
+\size small
+You should put punctuation outside inner/inside display math mode.
\end_layout
\begin_layout Enumerate
\size small
-Could not find argument for command.
+You ought to not use primitive TeX in LaTeX code.
\end_layout
\begin_layout Enumerate
\size small
-No match found for
+You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-\size small
-Math mode still on at end of LaTeX file.
\end_layout
\begin_layout Enumerate
\size small
-Number of
\begin_inset Quotes eld
\end_inset
\family typewriter
-char
+%s
\family default
\begin_inset Quotes erd
\end_inset
- doesn't match the number of
+ is normally not followed by
\begin_inset Quotes eld
\end_inset
\family typewriter
-char
+%c
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Standard
+In later versions of LyX, we hope to provide a more complete interface to
+ this tool (and it's smaller cousin
+\family typewriter
+lacheck
\family default
+) to exploit the full power of it.
+ But it's not exactly useless as it is now: go try it on one of your existing
+ documents of a certain length and be surprised.
+\end_layout
+
+\begin_layout Section
+Version Control in LyX
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+ Lars Gullik Bjønnes
+\noun default
+and
+\noun on
+Pavel Sanda
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Introduction
+\end_layout
-.
+\begin_layout Standard
+A friend of mine wanted to try LyX for a group project.
+ When he didn't find support for version control or file locking, he dropped
+ it.
+ This angered me a bit, so I thought that I should at least make support
+ for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
+ This has been done.
+ LyX now supports some of the most basic RCS/CVS/SVN commands.
+ If you need something a bit more sophisticated you will have to do that
+ manually in a terminal.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+Before you begin to use the version control features in LyX, you should
+ be familiar with RCS/CVS/SVN usage before start using it under LyX.
+ Also note that CVS support is not as good as subversion support so we advice
+ using SVN instead.
+ Good place to start with Subversion is SVN Book
+\begin_inset Foot
+status open
-\size small
-You should use either
-\family typewriter
+\begin_layout Plain Layout
+\begin_inset CommandInset href
+LatexCommand href
+target "http://svnbook.red-bean.com/"
-\begin_inset Quotes eld
\end_inset
-\family default
- or
-\family typewriter
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
-\family default
- as an alternative to
+.
+ In case of RCS you should read
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-"
-\family default
-
+rcsintro
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You should use "
+ (a man file, read it with
\family typewriter
-'
+man rcsintro
\family default
-" (ASCII 39) instead of "
+).
+ This file describes all the basic features of RCS.
+ You should especially notice the comment about a RCS directory, and the
+ notion of a master RCS file (the file ending in
\family typewriter
-´
+,v
\family default
-" (ASCII 180).
+).
\end_layout
-\begin_layout Enumerate
-
-\size small
-User-specified pattern found.
+\begin_layout Standard
+The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+ package—no guarantees are made for older versions.
+ Most of the log messages are not currently displayed after operations —
+ you can check them in Messages pane if unsure.
\end_layout
-\begin_layout Enumerate
-
-\size small
-This command might not be intended.
+\begin_layout Standard
+For introducing your own external commands consult vc-command in the manual
+ of LyX functions.
\end_layout
-\begin_layout Enumerate
-
-\size small
-\emph on
-Comment displayed.
+\begin_layout Subsection
+RCS commands in LyX
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+The following sections describe the RCS commands supported by LyX.
+ You can find them in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
+\end_inset
-\size small
-Either
-\family typewriter
-''
-\backslash
-,'
-\family default
- or
-\family typewriter
-'
-\backslash
-,''
+Control
\family default
- will look better.
+ submenu.
+ LyX was tested against RCS 5.7.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Delete this space to maintain correct page references.
+\family sans
+Register
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+Register
+\family default
+ item is not visible.
+
+\end_layout
-\size small
-\emph on
-You might wish to put this between a pair of
-\begin_inset Quotes eld
+\begin_layout Standard
+This command registers your document with RCS (unless you are under the
+ directory managed by CVS)\SpecialChar \@.
+ You are asked interactively to supply an initial
+ description of the document.
+ The document is now set in Read-Only mode and you have to
+\family sans
+Check
+\begin_inset space ~
\end_inset
+Out
+\begin_inset space ~
+\end_inset
-\family typewriter
-{}
+For
+\begin_inset space ~
+\end_inset
+
+Edit
\family default
+, before making any changes to it.
+ A document under revision control has a
+\begin_inset Quotes eld
+\end_inset
+[RCS:<version> <locker>]
\begin_inset Quotes erd
\end_inset
-.
+ item tagged to the filename in the minibuffer.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+RCS command that is run:
+\family typewriter
+ci -q -u -i -t-"<initial description>" <file-name>
+\end_layout
-\size small
-You ought to remove spaces in front of punctuation.
+\begin_layout Standard
+Read
+\family typewriter
+man ci
+\family default
+ to understand the switches.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Could not execute LaTeX command.
+\family sans
+Check In Changes
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+When you are finished editing a file, you check in your changes.
+ When you do this, you are asked for a description of the changes.
+ This is stored in the history log.
+ The version number is bumped, your changes are applied to the master RCS
+ file, the document is unlocked and set to Read-Only mode.
+
+\end_layout
-\size small
-Don't use
+\begin_layout Standard
+RCS command:
\family typewriter
-
-\backslash
-/
-\family default
- in front of small punctuation.
+ci -q -u -m"<description>" <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\family typewriter
-\size small
-$
-\backslash
-times$
-\family default
- may look prettier here.
+\family sans
+Check Out For Edit
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+By doing this you lock the document so that only you can edit it.
+ This will also make the document Read-Write only for you.
+ You will usually continue editing for a while and when you are finished
+ you check in your changes.
+ The status line is changed to reflect that you have locked the file.
+
+\end_layout
-\size small
-\emph on
-Multiple spaces detected in output.
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -q -l <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-This text may be ignored.
+\family sans
+Revert To Repository Version
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
-\size small
-Use
+\begin_layout Standard
+RCS command:
\family typewriter
+co -f -u<version> <file-name>
+\end_layout
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
+\family sans
+Undo Last Checkin
+\end_layout
-\family default
- to begin quotation, not
+\begin_layout Standard
+This makes as if the last check in never happened.
+ No changes are made to the document loaded into LyX, but the last version
+ is removed from the master RCS file.
+
+\end_layout
+
+\begin_layout Standard
+RCS command:
\family typewriter
-'
-\family default
-.
+rcs -o<version> <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-Use
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This shows the complete history of the RCS document.
+ The output of
\family typewriter
-'
+rlog <file-name>
\family default
- to end quotation, not
+ is shown in a browser.
+ See
\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
-
+man rlog
\family default
-.
+ for more info.
\end_layout
-\begin_layout Enumerate
-
-\size small
-Don't mix quotes.
+\begin_layout Subsubsection
+Revision info
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+LyX supports RCS version number information (only), see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:VCS-Revision-Information"
-\size small
-You should perhaps use
-\begin_inset Quotes eld
\end_inset
+ for details.
+\end_layout
-\family typewriter
-cmd
-\family default
+\begin_layout Subsection
+CVS commands in LyX
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Standard
+A subset of CVS operations is supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
- instead.
+Control
+\family default
+ submenu.
+ The version control system SVN is more powerful, so please use it instead
+ of CVS if possible.
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-\size small
-You should put a space in front of/after parenthesis.
+\family sans
+General CVS usage
\end_layout
-\begin_layout Enumerate
-
-\size small
-You should avoid spaces in front of/after parenthesis.
+\begin_layout Standard
+If you start from scratch with CVS you have to create your repository and
+ checkout the working copy with external tools.
+ If you're using a client-server setup you may need to login before doing
+ the first repository checkout.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+If your documents are under revision control and others are using the same
+ repository problems arise when different changes to the same document at
+ the same location happen.
+ Standard CVS repositories doesn't operate with a file locking mechanism.
+ This may be surprising, but conflicts only occur if people disagree on
+ the proper content of the same part of a document.
+ So, if co-workers are used to communicate regularly, these conflicts occur
+ rarely.
+ If they don't communicate they have a fundamental problem anyway.
+ Nevertheless some people like to work with so called
+\begin_inset Quotes eld
+\end_inset
-\size small
-\emph on
-You should not use punctuation in front of/after quotes.
-\end_layout
+reserved checkouts
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Enumerate
+.
+ If they do so the working copy of all files is readonly when checked out
+ first and the user starts editing after using a special command to make
+ the working copy writable.
+ When the changes are checked in the working copy returns to readonly state.
+ With LyX one has to edit the
+\begin_inset Flex Code
+status collapsed
-\size small
-Double space found.
+\begin_layout Plain Layout
+.cvsrc
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-You should put punctuation outside inner/inside display math mode.
+ file and add the line
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -r
\end_layout
-\begin_layout Enumerate
+\end_inset
-\size small
-You ought to not use primitive TeX in LaTeX code.
+ to work with reserved checkouts.
+ The benefit is the possibility to see who is using a writable copy of some
+ document.
+ It's not guaranteed only one user makes a copy writable.
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+LyX tries to guess if you're using reserved or non-reserved checkouts.
+ If your working copy is readonly or it is writable and an additional copy
+ of your document exists in the CVS/Base sub-directory a reserved otherwise
+ a non-reserved checkout is assumed.
+ When a reserved checkout is detected you have to use
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check Out
+\end_layout
-\size small
-You should remove spaces in front of
-\begin_inset Quotes eld
\end_inset
+ to make your working copy writable if it's readonly.
+ After doing so the
+\begin_inset Flex MenuItem
+status collapsed
-\family typewriter
-%s
-\family default
+\begin_layout Plain Layout
+Check In
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
+ operation is possible and that makes your working copy readonly again after
+ transferring your changes to the repository.
\end_layout
-\begin_layout Enumerate
-
-\size small
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+More information about CVS can be found here
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family typewriter
-%s
-\family default
+http://www.nongnu.org/cvs
+\end_layout
-\begin_inset Quotes erd
\end_inset
- is normally not followed by
-\begin_inset Quotes eld
-\end_inset
+ and here
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family typewriter
-%c
-\family default
+http://ximbiot.com/cvs
+\end_layout
-\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Standard
-In later versions of LyX, we hope to provide a more complete interface to
- this tool (and it's smaller cousin
+Read
\family typewriter
-lacheck
+man cvs
\family default
-) to exploit the full power of it.
- But it's not exactly useless as it is now: go try it on one of your existing
- documents of a certain length and be surprised.
+ to understand the sub-commands and the switches mentioned below.
\end_layout
-\begin_layout Section
-Version Control in LyX
-\end_layout
+\begin_layout Subsubsection
-\begin_layout Standard
-by
-\noun on
- Lars Gullik Bjønnes,
-\noun default
-updated by
-\noun on
-Pavel Sanda
+\family sans
+Register
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
\end_layout
\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- it.
- This angered me a bit, so I thought that I should at least make support
- for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has now been done.
- LyX now supports some of the most basic RCS commands.
- If you need to something a bit more sophisticated you will have to do that
- manually in an xterm.
+This command registers in CVS your document
+\emph on
+
+\begin_inset Flex Strong
+status collapsed
+
+\begin_layout Plain Layout
+
+\emph on
+only
\end_layout
-\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- read
-\begin_inset Quotes eld
\end_inset
-rcsintro
-\begin_inset Quotes erd
-\end_inset
- (a man file, read it with
-\family typewriter
-man rcsintro
-\family default
-).
- This file describes all the basic features of RCS.
- You should especially notice the comment about a RCS directory, and the
- notion of a master RCS file (the file ending in
+\emph default
+ in case you have already the documents directory under CVS control (in
+ particular
\family typewriter
-,v
+CVS/Entries
\family default
-).
+ file exists).
+ This means you have to create or checkout the archive by yourself using
+ external tools.
+ (In case you forget that step LyX registers the document with RCS.)
\end_layout
\begin_layout Standard
-Later basic CVS/SVN support was added.
- You should be familiar with CVS/SVN usage before start using it under LyX.
- Most of the log messages are not currently displayed after operations -
- you can check them in terminal window if unsure.
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet checked in.
\end_layout
\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
- package—no guarantees are made for older versions.
+CVS command that is run:
+\family typewriter
+cvs -q add -m"<entered message>" "<file-name>"
\end_layout
\begin_layout Standard
-For introducing your own external commands consult vc-command in the manual
- of LyX functions.
-\end_layout
-
-\begin_layout Subsection
-RCS commands in LyX
-\end_layout
+The term
+\family typewriter
+"<file-name>"
+\family default
+ above and for all other CVS commands is an abbreviation for
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-The following sections describe the RCS commands supported by LyX.
- You can find them in the
-\family sans
-File\SpecialChar \menuseparator
-Version
-\begin_inset space ~
+change the current working directory to file location and use the file name
+ without path component as argument
+\begin_inset Quotes erd
\end_inset
-Control
-\family default
- submenu.
- LyX was tested against RCS 5.7.
+.
\end_layout
\begin_layout Subsubsection
\family sans
-Register
+Check In Changes
\end_layout
\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
-Register
-\family default
- item is not visible.
-
+When you are finished editing a file, you commit your changes.
+ When you do this and you had changed the document, you are asked for a
+ description of the changes.
+ After that changes are written to the repository.
+ In case you didn't change the document and a reserved checkout is detected
+ the reservation made on
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Check Out
\end_layout
-\begin_layout Standard
-This command registers your document with RCS (unless you are under the
- directory managed by CVS)\SpecialChar \@.
- You are asked interactively to supply an initial
- description of the document.
- The document is now set in Read-Only mode and you have to
-\family sans
-Check
-\begin_inset space ~
\end_inset
-Out
+ is undone.
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
\begin_inset space ~
\end_inset
-For
+command:
\begin_inset space ~
\end_inset
-Edit
-\family default
-, before making any changes to it.
- A document under revision control has a
-\begin_inset Quotes eld
-\end_inset
-[RCS:<version> <locker>]
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
- item tagged to the filename in the minibuffer.
-\end_layout
-\begin_layout Standard
-RCS command that is run:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs
\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
+-q commit -m"<description>" "<file-name>"
\end_layout
-\begin_layout Standard
-Read
+\end_inset
+
+ or
+\begin_inset Newline newline
+\end_inset
+
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cvs -q unedit
\family typewriter
-man ci
-\family default
- to understand the switches.
-
+"<file-name>"
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\family sans
-Check In Changes
+Check Out Changes
\end_layout
\begin_layout Standard
-When you are finished editing a file, you check in your changes.
- When you do this, you are asked for a description of the changes.
- This is stored in the history log.
- The version number is bumped, your changes are applied to the master RCS
- file, the document is unlocked and set to Read-Only mode.
-
+When you are sharing a repository with others, you may have to incorporate
+ their changes into your working copy.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-ci -q -u -m"<description>" <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Check Out For Edit
+cvs -q update "<file-name>"
\end_layout
\begin_layout Standard
-By doing this you lock the document so that only you can edit it.
- This will also make the document Read-Write only for you.
- You will usually continue editing for a while and when you are finished
- you check in your changes.
- The status line is changed to reflect that you have locked the file.
-
+If a readonly checkout is detected the working copy is made writable and
+ reserved.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-co -q -l <file-name>
+cvs -q edit "<file-name>"
\end_layout
\begin_layout Subsubsection
This will discard all changes made to the document since the last check
in.
You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-co -f -u<version> <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Undo Last Checkin
+cvs -q update "<file-name>"
\end_layout
\begin_layout Standard
-This makes as if the last check in never happened.
- No changes are made to the document loaded into LyX, but the last version
- is removed from the master RCS file.
-
+If a reserved checkout is detected and the working copy has no changes only
+ the reservation is undone.
\end_layout
\begin_layout Standard
-RCS command:
+CVS command:
\family typewriter
-rcs -o<version> <file-name>
+cvs -q unedit "<file-name>"
\end_layout
\begin_layout Subsubsection
-
-\family sans
-Show History
+Update of the local directory checkout from repository
\end_layout
\begin_layout Standard
-This show the complete history of the RCS document.
- The output of
-\family typewriter
-rlog <file-name>
-\family default
- is shown in a browser.
- See
-\family typewriter
-man rlog
-\family default
- for more info.
+Once your documents gets more complex, containing sub-documents and pictures,
+ including external
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.tex
\end_layout
-\begin_layout Subsection
-CVS commands in LyX
+\end_inset
+
+ files and so on using version control becomes more complicated.
+ LyX supports updating the whole tree in which resides the document.
+ This become especially useful once you cooperate with people which neither
+ have detailed knowledge about CVS usage nor they have ambition to commit
+ additional material to the repository.
+ You have to organize the files structure so that all external files are
+ in the same directory or subdirectories of the document.
+ It's good practice anyway to store multipart documents in an extra directory.
\end_layout
\begin_layout Standard
-CVS is now partially supported by LyX.
- You can find the commands in the
-\family sans
-File\SpecialChar \menuseparator
-Version
-\begin_inset space ~
+The
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+Update local directory from repository
+\end_layout
+
\end_inset
-Control
-\family default
- submenu.
+ command updates the whole directory.
+ If local changes are detected user is warned before update starts.
+ In case of merge conflicts both versions of the conflicting document parts
+ are placed in the final document.
+ You have to review and correct the result of the merge.
+ You'll find the conflicts enclosed in pairs of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+<<<<<<<
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Register
+ and
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>>>>>>>
\end_layout
-\begin_layout Standard
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
-\bar under
-R
-\bar default
-egister
-\family default
- item is not visible.
-
+\end_inset
+
+ separated by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+=======
\end_layout
-\begin_layout Standard
-This command registers in CVS your document ONLY in case you have already
- the documents directory under CVS control (in particular
-\family typewriter
-CVS/Entries
-\family default
- file exists).
- This means you have to checkout the archive by yourself.
-
+\end_inset
+
+.
+ The first part is your version as before the update operation with the
+ document name prepended.
+ The second one is the repository version with the version number after
+ the sequence of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+>
\end_layout
-\begin_layout Standard
-Then you are asked interactively to supply an initial description of the
- document.
- Don't forget that registered file is not yet commited.
+\end_inset
+
+ signs.
\end_layout
-\begin_layout Standard
-CVS command that is run:
-\family typewriter
-cvs -q add -m
-\begin_inset Quotes erd
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+CVS
+\begin_inset space ~
\end_inset
-<entered message>"
-\begin_inset Quotes eld
+commands:
+\begin_inset space ~
\end_inset
-<file-name>
-\begin_inset Quotes erd
+
+\begin_inset Newline newline
\end_inset
-\end_layout
+\begin_inset Flex Code
+status collapsed
-\begin_layout Standard
-Read
+\begin_layout Plain Layout
+cd $path; cvs diff
\family typewriter
-man svn
-\family default
- to understand the switches.
-
+"."
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Check In Changes
-\end_layout
+ (Ask if changes are detected.)
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
-When you are finished editing a file, you commit your changes.
- When you do this, you are asked for a description of the changes.
- After that changes are commited.
-\end_layout
-\begin_layout Standard
-CVS command:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+cd $path; cvs -q update
\family typewriter
-cvs -q commit -m"<description>" "<file-name>"
+"."
\end_layout
-\begin_layout Subsubsection
+\end_inset
-\family sans
-Revert To Repository Version
-\end_layout
-\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
- Firstly the file is deleted, secondly CVS update command is run.
\end_layout
\begin_layout Standard
-CVS command:
-\family typewriter
-cvs update
-\begin_inset Quotes eld
-\end_inset
+where
+\begin_inset Flex Code
+status collapsed
-<file-name>
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+$path
+\end_layout
+\end_inset
+ stands for the path to the document.
\end_layout
\begin_layout Subsubsection
\end_layout
\begin_layout Standard
-This show the complete history of the CVS document.
+This shows the complete history of the CVS document.
The output of
\family typewriter
-cvs log
-\begin_inset Quotes eld
-\end_inset
-
-<file-name>
-\begin_inset Quotes erd
-\end_inset
-
-
+cvs log "<file-name>"
\family default
is shown in a browser.
\end_layout
submenu.
Please note that if you use password protected access to repository via
ssh, you will be asked in terminal window.
- LyX was tested against SVN 1.4 and 1.5.
+ LyX was tested against SVN 1.5 and 1.6
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+Most of the commands will work with 1.4 too, see
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sub:SVN-Repo-Update"
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Subsubsection
\family typewriter
-svn update
+svn update --non-interactive
\begin_inset Quotes eld
\end_inset
\end_layout
\begin_layout Subsubsection
-Synchronization of local directory checkout with repository
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:SVN-Repo-Update"
+
+\end_inset
+
+Update of the local directory checkout from repository
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Note that this command will work only with subversion
+\begin_inset Formula $\geqq1.5$
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
All the commands above have one shortcomming - they deal with the current
document only.
Once your document contains pictures, includes external
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
- files and so on administration becomes more complicate.
+ files and so on administration becomes more complicated.
LyX now supports updating the whole tree in which resides the document
\begin_inset Foot
status collapsed
\end_layout
\begin_layout Standard
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-Synchronize local directory with repository
+Update local directory from repository
\end_layout
\end_inset
- command firstly reverts all local changes (to avoid merge conflicts aftwards)
- and then updates the whole directory structure from the archive.
- If local changes are detected user is warned before reversion starts.
+ command updates the whole directory and in case of merge conflicts local
+ version of the files are left, so no unintended data loss occurs.
+ If local changes are detected user is warned before update starts.
\end_layout
\begin_layout Labeling
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
-svn revert -R $path
-\begin_inset Newline newline
-\end_inset
-
-svn update $path
+svn update --accept mine-full $path
\end_layout
\end_inset
\begin_layout Standard
where
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
\begin_layout Standard
-This show the complete history of the SVN document.
+This shows the complete history of the SVN document.
The output of
\family typewriter
svn log
The file exchange through various revision control systems brings the problem
of merge conflicts in case two different users try to edit the same (parts
of) document.
- When such conflict happens it needs manual resolving and one reasonable
+ When such a conflict happens it needs manual resolving and one reasonable
alternative is to provide some kind of locking mechanism, which guarantees
that only one user is allowed to edit file at the given time.
\end_layout
\begin_layout Standard
-SVN has two mechanisms to provide such kind of mutual exclusivity for file
- access - locks and automatical setting of write permissions (see sec.
+SVN has two such mechanisms to provide mutual exclusivity for file access
+ - locks and automatic setting of write permissions (see sec.
\begin_inset CommandInset ref
LatexCommand ref
\end_inset
) based on
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_inset
.
- In a case this property is detected for a given document LyX starts to
- use SVN locks for document editing automatically and the whole check-in/out
- mechanism switches to the same regimen as for RCS.
- This in particular means there are two different modes how file is used
- in LyX:
+ If this property is detected for a given document LyX starts to use SVN
+ locks for document editing automatically and the whole check-in/out mechanism
+ switches to the same regimen as for RCS.
+ This in particular means there are two different modes of file use in LyX:
\end_layout
\begin_layout Itemize
Unlocked state.
The loaded file is in the read-only mode.
- For editation on needs to check-out.
+ For editing on needs to check-out.
\emph on
Check-out
\emph default
- consists of update from repository and gaining write lock.
+ consists of updating from the repository and gaining write lock.
If the lock is not possible to obtain, we remain in unlocked state.
\end_layout
\family default
-Automatical Locking Property
+Automatic Locking Property
\end_layout
\begin_layout Standard
-The above mentioned automatical setting of write permissions of the .lyx
- file can be set through
+The above mentioned automatic setting of write permissions of the .lyx file
+ can be set through
\family sans
\bar under
F
\end_layout
\begin_layout Subsubsection
+\begin_inset CommandInset label
+LatexCommand label
+name "sub:VCS-Revision-Information"
+
+\end_inset
+
Revision Information in Documents
\end_layout
\begin_layout Standard
-Currently there is no way how to provide such kind of information directly
- from LyX.
- There are possibilities how to activate it with the help of svn features,
- but each has its own drawbacks.
+There are more possibilities how to activate revision information in our
+ document.
+\end_layout
+
+\begin_layout Itemize
+LyX supports directly:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+tree revision information (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-tree-revision
+\end_layout
+
+\end_inset
+
+).
+ The result is the output of the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
+\end_layout
+
+\end_inset
+
+ command, the following table gives you an idea, how to read the results.
+\end_layout
+
+\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="6" columns="2">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0">
+<column alignment="center" valignment="top" width="0">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Output
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+Meaning
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123:4168
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mixed revision working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4168M
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+modified working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123S
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+switched working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123P
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+partial working copy, from a sparse checkout
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+4123:4168MS
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Plain Layout
+mixed revision, modified, switched working copy
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Itemize
+file revision information.
+ The result comes from parsing the output of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn
+\begin_inset space ~
+\end_inset
+
+info
+\begin_inset space ~
+\end_inset
+
+--xml
+\begin_inset space ~
+\end_inset
+
+file.lyx
+\end_layout
+
+\end_inset
+
+.
+ Supported flags are:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+version number of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-revision
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+author of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-author
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+date of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-date
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\begin_layout Itemize
+time of the last commit (
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+vcs-time
+\end_layout
+
+\end_inset
+
+)
+\end_layout
+
+\end_deeper
+\begin_layout Standard
+You can obtain this info via InsetInfo (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+info-insert buffer vcs-date
+\end_layout
+
+\end_inset
+
+).
+ The information will be available only when you have the file stored under
+ svn managment (i.e.
+ the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+.svn
+\end_layout
+
+\end_inset
+
+ directory is available with your document).
\end_layout
-\begin_layout Standard
-One possibility is to use svn keywords
+\end_deeper
+\begin_layout Itemize
+Another---a hacking one---possibility is to use svn keywords
\begin_inset Foot
status collapsed
\family sans
svn propset svn:keywords 'Rev' file.lyx
\family default
-) and then paste keyword ERT
+) and then paste keyword TeX code
\begin_inset Foot
status collapsed
Thirdly you get the whole 'Rev: 59' string in your document instead of
the plain number.
Until subversion implements user's custom keywords it will be hard to use
- this approach reliably or let LyX to support it directly .
-\end_layout
-
-\begin_layout Standard
-The second possibility would be to write your own external-material template
- which calls either
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-svnversion
-\end_layout
-
-\end_inset
-
- utility or parses the output of
-\begin_inset Flex CharStyle:Code
-status collapsed
-
-\begin_layout Plain Layout
-svn info file.lyx
-\end_layout
-
-\end_inset
-
- command and returns the result back, when typeseting the document.
+ this approach reliably or let LyX to support it directly.
\end_layout
\begin_layout Subsection
client program from a command prompt.
\end_layout
+\begin_layout Subsubsection
+SSH tunnel used with SVN under Windows
+\end_layout
+
+\begin_layout Standard
+Compared with Linux setting up svn client to communicate over ssh under
+ Windows is a rather troublesome task.
+ We will at least offer some hints how to setup the client side but prior
+ knowledge about ssh and the Windows command line is needed, also be prepared
+ for a great deal of frustration\SpecialChar \ldots{}
+
+\end_layout
+
+\begin_layout Enumerate
+Get a svn client for windows, as described in the previous sections.
+ When it is a fresh install run some svn command (e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn --version
+\end_layout
+
+\end_inset
+
+) to create config files, which you will need to change later on.
+\end_layout
+
+\begin_layout Enumerate
+Choose a ssh client for Windows.
+ There are several possibilities, we will use the one from Putty tools
+\begin_inset Foot
+status open
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+.
+ You will need to set the connection up so that the client doesn't ask for
+ any password from you.
+ To keep things easy we will use only keys without any additional password
+ protection etc.
+\end_layout
+
+\begin_deeper
+\begin_layout Enumerate
+Generate keys by
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+puttygen
+\end_layout
+
+\end_inset
+
+.
+ Save your private .ppk key file and put the public one on the server side.
+ If the SVN server runs on Linux, note that the format of the public key
+ is not compatible with Linux openssh and you will need to direcly copy-paste
+ the key from the “
+\emph on
+Public key for pasting into OpenSSH authorized_keys file
+\emph default
+:” edit field into the server's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+~/.ssh/authorized_keys
+\end_layout
+
+\end_inset
+
+/
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+authorized_keys2
+\end_layout
+
+\end_inset
+
+ file.
+\end_layout
+
+\begin_layout Enumerate
+Get the Putty's
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+plink
+\end_layout
+
+\end_inset
+
+.
+ In the SVN config file
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Exact path depends on Windows version, usually somewhere around
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+c:
+\backslash
+Documents and Settings
+\backslash
+user
+\backslash
+Application Data
+\backslash
+Subversion
+\backslash
+config
+\end_layout
+
+\end_inset
+
+ /
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+AppData
+\backslash
+Roaming
+\backslash
+Subversion
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\end_inset
+
+, section [tunnels], setup ssh command, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+ssh=c:/path/plink.exe -i c:/path/private_key.ppk
+\end_layout
+
+\end_inset
+
+.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+It will usually take a lot of time to get exact command right and it depends
+ on many things.
+ For example do not have some remote server saved as a default session in
+ Putty etc.
+ If things fail, try to connect via plink without SVN first.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Checkout the SVN archive, e.g.
+
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn co svn+ssh://user@server/repository_path
+\end_layout
+
+\end_inset
+
+.
+\end_layout
+
+\begin_layout Subsubsection
+End-of-Line Conversions
+\end_layout
+
+\begin_layout Standard
+When the collsraborators are mixing Linux and Windows environments, LyX
+ will use different line endings inside the .lyx files.
+ This is not a problem as far as LyX functionality is concerned, but the
+ commit diffs will be huge and merge-conflicts prone.
+ Fortunately SVN itself knows
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+ how to deal with CR/LF problems when switching .lyx files to the
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+native
+\end_layout
+
+\end_inset
+
+ mode.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+For the lazy guys:
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+svn propset svn:eol-style native FILE_NAME
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
\begin_layout Subsection
Further tuning
\end_layout
\begin_layout Description
Commit:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\begin_layout Description
Revert:
-\begin_inset Flex CharStyle:Code
+\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\end_layout
+\begin_layout Subsection
+Version control and Document comparison
+\end_layout
+
+\begin_layout Standard
+One of the typical uses of version control is to inspect the changes between
+ revisions, usually by creating
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+diff
+\end_layout
+
+\end_inset
+
+ dumps.
+ While this is useful for plain text files, it is much less useful in the
+ case of LyX files, which have more complicated structure.
+ Hence we provide binding to the Document comparison feature.
+ They are two ways of calling this feature - either by direct call of
+\begin_inset Flex Code
+status collapsed
+
+\begin_layout Plain Layout
+VC_COMPARE
+\end_layout
+
+\end_inset
+
+ LyX function (for details see LyX functions manual) or by icon/menu item
+
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Compare with older revision...
+\end_layout
+
+\end_inset
+
+.
+ One can either compare two chosen revisions of the document or he can simply
+ compare the current version of edited text with older revisions (where
+ '
+\begin_inset Flex MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+0
+\end_layout
+
+\end_inset
+
+' revisions back means comparison of the edited file with last commited
+ revision).
+
+\end_layout
+
+\begin_layout Standard
+This feature is supported for SVN and RCS though due to the more complicated
+ versioning scheme of RCS there is a constraint -- when addressing the revisions
+ in dialog, numbers always point to the last number in RCS revision number,
+ i.e.
+ '35' in '1.2.35'.
+\end_layout
+
\begin_layout Section
Literate Programming
\end_layout
\begin_layout Standard
The main purpose of this documentation is to show you how to use LyX for
- literate programming.
- Where it is assumed that you are familiar with this programming technique,
- and know what
+ literate programming, where it is assumed that you are familiar with this
+ programming technique, and know what
\begin_inset Quotes eld
\end_inset
\begin_inset space \thinspace{}
\end_inset
-g.
+E.
Knuth during the development of his TeX typesetting software.
\end_layout
\begin_layout Plain Layout
-http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
+http://www.literateprogramming.com/lpfaq.pdf
\end_layout
\end_inset
\begin_layout Standard
Most ideas in this section require less common files in your LaTeX installation.
- If you have a system like teTeX, most will already be available.
+ If you have a system like TeXLive, most will already be available.
A few, however, will need to be downloaded from one of the CTAN archives.
Often, there are several ways to do something, or several LaTeX style files
which do the same thing.
Enumerate
\family default
Paragraph Environment
-\begin_inset OptArg
+\begin_inset Argument
status collapsed
\begin_layout Plain Layout
\end_layout
-\begin_layout Standard
-
-\end_layout
-
\begin_layout Section
Dropped Capitals
\end_layout
dropping
\family default
) package from CTAN allows a simple way to add such letters to your documents.
- Since this package is not a standard part of teTeX, I can't demonstrate
+ Since this package is not a standard part of TeXLive, I can't demonstrate
it within this document, but if you copy this paragraph to a new document,
delete the
\begin_inset Quotes eld
projects / lyx.git / blobdiff