layouts are set up to conform to suggested styles for mathematical papers to be submitted to American Mathematical Society publications.
The layouts are not tailored to a specific journal,
but easily can be.
You should refer to the AMS documentation for specific instructions for each journal (usually it will entail only changing a single line in the \SpecialChar TeX
output).
That documentation is available on the Web at
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://www.ams.org
\end_layout
\end_inset
or by ftp at
\begin_inset Flex URL
status open
\begin_layout Plain Layout
ftp://ftp.ams.org/pub/tex/amslatex/
\end_layout
\end_inset
.
These layouts are appropriate,
and useful,
for any mathematical writing.
\end_layout
\begin_layout Standard
There are three basic AMS \SpecialChar LaTeX
layouts:
\end_layout
\begin_layout Itemize
amsart:
The standard AMS article format;
see
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Articles\SpecialChar menuseparator
American Mathematical Society (AMS)
\family default
.
\end_layout
\begin_layout Itemize
amsbook:
the standard AMS book (really,
monograph) format;
see
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Books\SpecialChar menuseparator
American Mathematical Society (AMS)
\family default
.
\end_layout
\begin_layout Itemize
amsproc:
the standard AMS proceedings format.
\end_layout
\begin_layout Standard
\SpecialChar LyX
only supports the first two natively;
see the
\emph on
Installing New Document Classes
\emph default
chapter of the
\emph on
Customization
\emph default
manual if you want to use
\family sans
amsproc
\family default
.
\end_layout
\begin_layout Standard
The layouts themselves contain only the minimum necessary to use the AMS classes.
They do not,
in particular,
contain any of the `theorem' environments used for setting theorems,
lemmas,
and the like.
These are contained,
instead,
in the
\family sans
AMS Theorems
\family default
module,
which is loaded by default when you select one of the AMS classes.
(It can also be used with other classes and can be removed,
if you would rather use something else.) Less commonly used environments are in the
\family sans
AMS Theorems (Extended)
\family default
module,
which must be loaded manually.
\end_layout
\begin_layout Standard
By default,
theorems and the like are numbered consecutively throughout the document,
but this may be modified by loading the module
\family sans
Standard Theorems (Numbered by Section)
\family default
or,
if you are using
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
book (AMS)
\end_layout
\end_inset
,
the module
\family sans
Standard Theorems (Numbered by Chapter)
\family default
.
These will number the results as
\begin_inset Formula $n.m$
\end_inset
,
where the first number refers to the section (or chapter) and the second refers to the total number of results so far in that section (or chapter).
Many environments are also available unnumbered.
These are indicated by an asterisk at the end.
If you happen to want
\emph on
only
\emph default
unnumbered results,
the module
\family sans
Standard Theorems (Unnumbered)
\family default
provides that option.
\end_layout
\begin_layout Standard
Note that these modules do not
\emph on
have
\emph default
to be used with the AMS classes.
It is perfectly possible to use the
\family sans
AMS Theorems
\family default
module,
and the others mentioned,
with other classes,
such as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Article (Standard Class)
\end_layout
\end_inset
,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Report (Standard Class)
\end_layout
\end_inset
,
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
KOMA-Script Book
\end_layout
\end_inset
,
and so forth.
\end_layout
\begin_layout Subsubsection
What these layouts provide
\end_layout
\begin_layout Standard
There is a long list of included environments provided by these layouts.
In AMS-\SpecialChar LaTeX
,
there is,
in fact,
an opportunity to define an unlimited variety of `theorem' environments.
However,
the AMS recommends the environments that are available in \SpecialChar LyX
.
\end_layout
\begin_layout Standard
The following environments—
as well as the standard environments,
such as
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
section
\end_layout
\end_inset
,
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
bibliography
\end_layout
\end_inset
,
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
title
\end_layout
\end_inset
,
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
author
\end_layout
\end_inset
,
and
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
date
\end_layout
\end_inset
—
are provided by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
article (AMS)
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
book (AMS)
\end_layout
\end_inset
:
\end_layout
\begin_layout Description
Address This should be the author's permanent address.
\end_layout
\begin_layout Description
Current
\begin_inset space ~
\end_inset
Address This should be the author's temporary address at the time of submission,
if different from the Address.
\end_layout
\begin_layout Description
Email Author's e-mail address
\end_layout
\begin_layout Description
URL Author's Web address,
if desired.
\end_layout
\begin_layout Description
Keywords Key words or phrases used to identify specific topics discussed in the paper.
\end_layout
\begin_layout Description
Subjectclass These refer to the AMS Subject Classifications,
published and described in
\emph on
Mathematical Reviews
\emph default
.
These are also available online at the AMS cites listed above.
\end_layout
\begin_layout Description
Thanks
\end_layout
\begin_layout Description
Dedicatory
\end_layout
\begin_layout Description
Translator
\end_layout
\begin_layout Standard
The following environments are provided by both the
\family sans
Standard Theorems
\family default
and
\family sans
AMS Theorems
\family default
modules,
in the latter case in both unnumbered and numbered versions.
These same environments are provided only in the starred versions by the
\family sans
Standard Theorems (Unnumbered)
\family default
module:
\end_layout
\begin_layout Theorem
This is typically used for the statements of major results.
\end_layout
\begin_layout Corollary*
This is used for statements which follow fairly directly from previous statements.
Again,
these can be major results.
\end_layout
\begin_layout Lemma
These are smaller results needed to prove other statements.
\end_layout
\begin_layout Proposition
These are less major results which (hopefully) add to the general theory being discussed.
\end_layout
\begin_layout Conjecture
These are statements provided without justification,
which the author does not know how to prove,
but which seem to be true (to the author,
at least).
\end_layout
\begin_layout Definition*
Guess what this is for.
The font is different for this environment than for the previous ones.
\end_layout
\begin_layout Example*
Used for examples illustrating proven results.
\end_layout
\begin_layout Problem
It's not really known what this is for.
You should figure it out.
\end_layout
\begin_layout Exercise*
Write a description for this one.
\end_layout
\begin_layout Remark
This environment is also a type of theorem,
usually a lesser sort of observation.
\end_layout
\begin_layout Claim*
Often used in the course of giving a proof of a larger result.
\end_layout
\begin_layout Case
Generally,
these are used to break up long arguments,
using specific instances of some condition.
\end_layout
\begin_layout Case
The numbering scheme for cases is on its own,
not together with other numbered statements.
\end_layout
\begin_layout Proof
At the end of this environment,
a QED symbol (usually a square,
but it can vary with different styles) is placed.
If you want to have other environments within this one—
for example,
Case environments—
and have the QED symbol appear only after them,
then the other environments need to be nested within the proof environment.
See the section
\emph on
Nesting Environments
\emph default
of the
\emph on
User's Guide
\emph default
for information on nesting.
\end_layout
\begin_layout Fact
Used in a way similar to Proposition,
though perhaps lower on the scale.
\end_layout
\begin_layout Standard
And these environments are provided by
\family sans
AMS Theorems (Extended
\family default
):
\end_layout
\begin_layout Criterion*
A required condition.
\end_layout
\begin_layout Algorithm*
A general procedure to be used.
\end_layout
\begin_layout Axiom*
This is a property or statement taken as true within the system being discussed.
\end_layout
\begin_layout Condition*
Sometimes used to state a condition assumed within the present context of discussion.
\end_layout
\begin_layout Note*
Similar to a Remark.
\end_layout
\begin_layout Notation*
Used for the explanation of,
yes,
notation.
\end_layout
\begin_layout Summary
Do we really need to tell you?
\end_layout
\begin_layout Conclusion*
Sometimes used at the end of a long train of argument.
\end_layout
\begin_layout Assumption*
Assumption
\end_layout
\begin_layout Question*
Question
\end_layout
\begin_layout Standard
There are ten more Maths modules available including several offering options ordered on
\family sans
(Numbered by Type \SpecialChar ldots
)
\family default
.
\end_layout
\begin_layout Standard
In addition,
the AMS classes automatically provide the AMS \SpecialChar LaTeX
and AMS fonts packages.
They need to be available on your system in order to use these environments.
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
name "subsec:Extra-font-sizes"
\end_inset
Extra font sizes
\end_layout
\begin_layout Standard
The “Extra font sizes” collection provides the document classes
\family sans
article
\begin_inset space \thinspace{}
\end_inset
(with extra font sizes)
\family default
,
\family sans
book
\begin_inset space \thinspace{}
\end_inset
(with extra font sizes)
\family default
,
\family sans
letter
\begin_inset space \thinspace{}
\end_inset
(with extra font sizes)
\family default
and
\family sans
report
\begin_inset space \thinspace{}
\end_inset
(with extra font sizes)
\family default
which use the
\family typewriter
article.cls
\family default
,
\family typewriter
book.cls
\family default
,
\family typewriter
letter.cls
\family default
and
\family typewriter
report.cls
\family default
document classes respectively but offer the additional
The KOMA-Script collection of document classes is a development of the Script classes created by Frank Neukam in the early 1990s;
it was formally launched with the addition of a letter class in 1994.
Since then,
a second letter class has been added.
Frank Neukam's classes were inspired by the principles of typography and this has been fully integrated into the design of the KOMA-Script classes.
\end_layout
\begin_layout Standard
The \SpecialChar LyX
document classes
\emph on
KOMA-Script Article
\emph default
,
\emph on
KOMA-Script Report
\emph default
,
\emph on
KOMA-Script Book
\emph default
,
and
\emph on
KOMA-Script Letter
\emph default
correspond to the \SpecialChar LaTeX
document classes
\family typewriter
scrartcl.cls
\family default
,
\family typewriter
scrreprt.cls
\family default
,
\family typewriter
scrbook.cls
\family default
,
and
\family typewriter
scrlettr.cls
\family default
,
resp.
\begin_inset space ~
\end_inset
of the Koma-Script family.
They are replacements for the standard document classes
\family typewriter
article.cls
\family default
,
\family typewriter
report.cls
\family default
,
\family typewriter
book.cls
\family default
and
\family typewriter
letter.cls
\family default
,
resp.,
and fit better to European typography conventions in a number of points.
\end_layout
\begin_layout Itemize
The base character sizes when you select a KOMA-Script class are 11pt in
\emph on
KOMA-Script Article
\emph default
,
\emph on
KOMA-Script Report
\emph default
,
and
\emph on
KOMA-Script Book
\emph default
and 12pt in
\emph on
KOMA-Script Letter
\emph default
.
\end_layout
\begin_layout Itemize
Headings,
labels of the description environment,
and a number of elements of the
\emph on
KOMA-Script Letter
\emph default
document class are set in a bold sans serif font.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
There is a big difference between the bold sans serif old cm fonts and new ec fonts,
especially in the appearance of headings.
In comparison,
the ec bold sans serif fonts look a bit thin.
Here the \SpecialChar LaTeX
package
\family typewriter
cmsd.sty by
\family default
\shape smallcaps
Walter Schmidt
\shape default
helps to produce the
\begin_inset Quotes eld
\end_inset
usual
\begin_inset Quotes erd
\end_inset
appearance when using the ec fonts.
\end_layout
\end_inset
The numbering of chapter headings is made in the same way as the numbering of section headings,
that is without the extra line
\begin_inset Quotes eld
\end_inset
Chapter\SpecialChar ldots
\begin_inset Quotes erd
\end_inset
.
In addition,
the appearance of the headings can be modified by using a number of options (in \SpecialChar LyX
to be entered in the field
\family sans
Extra
\begin_inset space ~
\end_inset
Options
\family default
of the dialog
\family sans
Layout\SpecialChar menuseparator
Document
\family default
).
\end_layout
\begin_layout Itemize
The layout of a KOMA-Script page follows one of two traditional typesetting conventions based on dividing the page into strips or drawing a circle.
The default is to imagine that a page is divided horizontally and vertically into strips and allocate strips to the margins leaving the unused strips for the text area.
You can change the sizes of the margins by changing the factor by which the page is divided into strips;
the default for an A4 page is 9 and increasing this factor will produce increasingly narrower strips and therefore narrower margins.
\end_layout
\begin_deeper
\begin_layout Standard
Whatever the factor,
two strips are allocated to the outer and bottom margins of a two-sided document and one strip to the inner and top margins,
leaving a text area occupying around half the page.
Since most two-sided documents have a binding,
this can make the inner margins appear too narrow;
so you can apply a binding correction to the page which is deducted before the size of the strips is calculated.
\end_layout
\begin_layout Standard
The main means in the Koma-Script document classes to design the type area are the options
\family sans
BCOR
\family default
and
\family sans
DIV
\family default
entered in
\family sans
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
Document Class\SpecialChar menuseparator
Class Options\SpecialChar menuseparator
Custom
\family default
.
\end_layout
\begin_layout Standard
In this document,
the binding correction is 7.5mm which is added in the form
\family typewriter
BCOR7.5mm
\family default
to
\family sans
Class
\begin_inset space ~
\end_inset
options\SpecialChar menuseparator
Cus
\bar under
t
\bar default
om
\family default
dialog.
To change the factor to 11,
for example,
add the entry
\family typewriter
DIV=11
\family default
to the comma separated list of entries in the
\family sans
Cus
\bar under
t
\bar default
om
\family default
\family sans
Class
\begin_inset space ~
\end_inset
options
\family default
.
If you want the default value of this factor for a page size other than A4,
add the entry
\family typewriter
DIV=calc
\family default
.
\end_layout
\begin_layout Standard
To use the circle method of calculating the page layout,
use
\family typewriter
DIV=classic
\family default
instead.
\end_layout
\end_deeper
\begin_layout Itemize
The \SpecialChar LaTeX
document classes of the Koma-Script family define a number of additional commands.
Those part of it which makes sense in \SpecialChar LyX
is implemented in corresponding paragraph types.
\end_layout
\begin_layout Standard
Detailed descriptions of the \SpecialChar LaTeX
document classes of the Koma-Script family can be found in the Koma-Script documentation
\emph on
scrguide
\emph default
(German) and
\emph on
scrguien
\emph default
(English).
\end_layout
\begin_layout Subsubsection
\series bold
\begin_inset CommandInset label
LatexCommand label
name "subsec:article-(KOMA-Script),-report"
\end_inset
\series default
\emph on
KOMA-Script Article
\emph default
,
\emph on
KOMA-Script Report
\emph default
,
and
\emph on
KOMA-Script Book
\end_layout
\begin_layout Standard
The document classes
\emph on
KOMA-Script Article
\emph default
,
\emph on
KOMA-Script Report
\emph default
,
and
\emph on
KOMA-Script Book
\emph default
are implemented in the layout files
\family typewriter
scrartcl.layout
\family default
,
\family typewriter
scrreprt.layout
\family default
,
and
\family typewriter
scrbook.layout
\family default
,
resp.
They contain all the paragraph types of the corresponding standard document classes
\emph on
article
\emph default
,
\emph on
report
\emph default
,
and
\emph on
book
\emph default
,
resp.,
partly modified,
with the exception of the \SpecialChar LyX
specific
\family sans
List
\family default
-type,
which is replaced by the new
\family sans
Labeling
\family default
-type having the same functionality.
Beside the
\family sans
Labeling
\family default
-Type there is a number of new paragraph types added.
They are
\emph on
not
\emph default
part of
\emph on
letter (koma-script)
\emph default
.
\end_layout
\begin_layout Itemize
\family sans
Addpart,
Addchap
\family default
,
\family sans
Addsec
\family default
:
are equivalents to
\family sans
Part*,
Chapter*
\family default
and
\family sans
Section*
\family default
,
resp.,
additionally inserting an entry in the table of contents.
\family sans
Addpart
\family default
and
\family sans
Addchap
\family default
are not contained in
\emph on
article (koma-script)
\emph default
.
\end_layout
\begin_layout Itemize
\family sans
Addchap*
\family default
,
\family sans
Addsec*
\family default
:
behave exactly as
\family sans
Addchap
\family default
and
\family sans
Addsec
\family default
,
resp.,
additionally clearing running heads.
\family sans
Addchap*
\family default
is not contained in
\emph on
article (koma-script)
\emph default
.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
There is also an
\family typewriter
\backslash
addpart*
\family default
command in
\emph on
book (koma-script)
\emph default
and in
\emph on
report (koma-script)
\emph default
,
but since this is identical to
\family sans
Part*
\family default
,
is has not been implemented in \SpecialChar LyX
.
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
\family sans
Minisec
\family default
:
generates a heading directly above the following paragraph in the standard character size without affecting the structure of the document.
\end_layout
\begin_layout Itemize
\family sans
Captionabove
\family default
and
\family sans
Captionbelow
\family default
are special captions which respect the different space settings needed for captions placed above or below an element (if you follow strict typographic rules,
you might want to place table captions always above the table).
You can also use the class option
\family typewriter
tablecaptionsabove
\family default
,
which will switch
\family sans
caption
\family default
to
\family sans
captionabove
\family default
for tables and
\family sans
captionbelow
\family default
for figures.
You need at least Koma-Script version 2.8q to use this.
\end_layout
\begin_layout Itemize
\family sans
Dictum
\family default
:
can be used to set a bonmot,
e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
at the beginning of a chapter.
If you use the optional argument (
\family sans
Insert\SpecialChar menuseparator
Dictum
\begin_inset space ~
\end_inset
Author
\family default
),
you can insert the dictum's author there.
Dictum and author are separated by a line.
You need at least Koma-Script version 2.8q to use this.
\family sans
Dictum
\family default
is not contained in
\emph on
article (koma-script)
\emph default
.
\end_layout
\begin_layout Standard
The following types,
together with the standard types
\family sans
Title
\family default
,
\family sans
Author
\family default
,
and
\family sans
Date
\family default
,
form the title area of the document.
They must be entered ahead of the first
\begin_inset Quotes eld
\end_inset
ordinary
\begin_inset Quotes erd
\end_inset
paragraph.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
The corresponding \SpecialChar LaTeX
commands must appear before the
\family typewriter
\backslash
maketitle
\family default
command.
\end_layout
\end_inset
When such a type is used more than once,
the latter usage overwrites the former one,
that means,
for every type only the latest usage is valid.
The order of the different types however has,
like
\family sans
Title
\family default
,
\family sans
Author
\family default
,
and
\family sans
Date
\family default
,
no effect on the appearance of the produced document.
\end_layout
\begin_layout Itemize
\family sans
Subject
\family default
:
produces a centered paragraph above the ordinary title (
\family sans
Title
\family default
,
\family sans
Author
\family default
,
\family sans
Date
\family default
) for the subject of the document.
\end_layout
\begin_layout Itemize
\family sans
Publishers
\family default
:
produces a centered paragraph below the ordinary title (
\family sans
Title
\family default
,
\family sans
Author
\family default
,
\family sans
Date
\family default
) for the publishers' name.
\end_layout
\begin_layout Itemize
\family sans
Dedication
\family default
:
in
\emph on
report (koma-script)
\emph default
and
\emph on
book (koma-script)
\emph default
produces a centered paragraph on its own page behind the title page,
or in
\emph on
article (koma-script)
\emph default
produces a centered paragraph below the ordinary title (
\family sans
Title
\family default
,
\family sans
Author
\family default
,
\family sans
Date
\family default
,
\family sans
Publishers
\family default
) for a dedication.
\end_layout
\begin_layout Itemize
\family sans
Titlehead
\family default
:
produces a left aligned paragraph above the ordinary title (
\family sans
Title
\family default
,
\family sans
Author
\family default
,
\family sans
Date
\family default
,
\family sans
Subject
\family default
) for a document`s head.
\end_layout
\begin_layout Itemize
\family sans
Uppertitleback
\family default
:
produces in a double-sided print in
\emph on
report (koma-script)
\emph default
and
\emph on
book (koma-script)
\emph default
a left-aligned paragraph at the top of the title page`s back or has no effect in a single-sided print or in
\emph on
article (koma-script)
\emph default
.
\end_layout
\begin_layout Itemize
\family sans
Lowertitleback
\family default
:
produces in a double-sided print in
\emph on
report (koma-script)
\emph default
and
\emph on
book (koma-script)
\emph default
a left-aligned paragraph at the bottom of the title page`s back or has no effect in a single-sided print or in
\emph on
article (koma-script)
\emph default
.
\end_layout
\begin_layout Itemize
\family sans
Extratitle
\family default
:
produces a special
\begin_inset Quotes eld
\end_inset
dirty
\begin_inset Quotes erd
\end_inset
page ahead of the actual document containing a paragraph without special formatting.
\end_layout
\begin_layout Standard
KOMA-Script offers a wide range of
\family sans
Cus
\bar under
t
\bar default
om Class
\begin_inset space ~
\end_inset
options
\family default
for the
\family sans
\bar under
D
\bar default
ocument\SpecialChar menuseparator
\bar under
S
\bar default
ettings\SpecialChar menuseparator
Document
\begin_inset space ~
\end_inset
class
\family default
dialog which you can apply to the whole document,
among them
\end_layout
\begin_layout Description
\family typewriter
\series medium
draft=true
\family default
\series default
which produces a PDF with a small black box at the end any line in which a formatting error occurs;
the default setting is
\family typewriter
false
\end_layout
\begin_layout Description
\family typewriter
\series medium
headings=
\family default
\series default
which may take the values
\family typewriter
big
\family default
,
\family typewriter
normal
\family default
or
\family typewriter
small
\family default
;
the first and last adjust the sizes of the headings to take account of page sizes where the default values may not be suitable
\end_layout
\begin_layout Description
\family typewriter
\series medium
numbers=
\family default
\series default
which may take the values
\family typewriter
auto
\family default
(the default),
\family typewriter
enddot
\family default
or
\family typewriter
noenddot
\family default
;
the first leaves it up to KOMA-Script to add periods after chapter,
section numbers,
etc.;
the second forces the addition of periods and third suppresses them
\end_layout
\begin_layout Standard
and the math options:
\end_layout
\begin_layout Description
\family typewriter
\series medium
leqno
\family default
\series default
which causes equations to be numbered on the left rather than on the right,
and
\end_layout
\begin_layout Description
\family typewriter
\series medium
fleqn
\family default
\series default
which causes equations to be left justified rather than centered.
\end_layout
\begin_layout Standard
It also provides commands to affect the output of the document independently of the standard \SpecialChar LaTeX
commands and packages;
for example,
if you want your captions in bold add
\end_layout
\begin_layout Standard
\family typewriter
\backslash
setkomafont{captionlabel}{
\backslash
bfseries}
\end_layout
\begin_layout Standard
to
\family sans
\bar under
D
\bar default
ocument\SpecialChar menuseparator
\bar under
S
\bar default
ettings
\family default
\SpecialChar menuseparator
\family sans
\SpecialChar LaTeX
\begin_inset space ~
\end_inset
Preamble
\family default
) and the problem is solved.
\end_layout
\begin_layout Standard
If you are writing a book,
it is normal to have the preliminary pages numbered in Roman numerals and the Chapters in this part unnumbered.
If you use the Chapter* environment,
your Foreword and Preface will not appear in the Table of Contents;
to make them to appear in the Table of contents,
you need to use Chapter environments and add the \SpecialChar TeX
code
\end_layout
\begin_layout Standard
\family typewriter
\backslash
frontmatter
\end_layout
\begin_layout Standard
at the very start of the book (not in the \SpecialChar LaTeX
Preamble) and
\end_layout
\begin_layout Standard
\family typewriter
\backslash
mainmatter
\end_layout
\begin_layout Standard
before the first chapter of the body of the text.
Alternatively,
you might also use
\family sans
Chapter* (TOC)
\family default
.
\end_layout
\begin_layout Standard
You may also want to have some unnumbered Chapter environments at the end of the book after the Appendices,
if any.
\begin_inset Foot
status open
\begin_layout Plain Layout
Appendices are normally “numbered” with letters.
\end_layout
\end_inset
If you use the Chapter* environment,
they will not appear in the Table of Contents;
so add the \SpecialChar TeX
code
\end_layout
\begin_layout Standard
\family typewriter
\backslash
backmatter
\end_layout
\begin_layout Standard
before the first of these headings and use the Chapter environment.
These commands will have no effect on the numbering in \SpecialChar LyX
,
only on the PDF output where the headings will be unnumbered and appear in the Table of Contents.
\end_layout
\begin_layout Standard
The layout files for the document classes
\emph on
article (koma-script)
\emph default
,
\emph on
report (koma-script)
\emph default
,
and
\emph on
book (koma-script)
\emph default
do include the file
\family typewriter
scrmacros.inc
\family default
.
This is thought of as a place to define your own types.
Copy scrmacros
\family typewriter
.inc
\family default
in your personal layout directory and edit the file!
\end_layout
\begin_layout Subsubsection
\begin_inset CommandInset label
LatexCommand label
name "subsec:The-new-letter"
\end_inset
The new letter class:
KOMA-Script Letter (V.
2)
\end_layout
\begin_layout Standard
by
\noun on
Jürgen Spitzmüller
\end_layout
\begin_layout Standard
\begin_inset VSpace medskip
\end_inset
\end_layout
\begin_layout Standard
\noindent
Koma-Script version 2.8 has introduced a new letter class
\family typewriter
scrlttr2
\family default
which supersedes the now unsupported
\family typewriter
scrlettr
\family default
.
It has —
on the \SpecialChar LaTeX
side —
a completely new interface and is not compatible with the old class.
Therefore,
\SpecialChar LyX
supports both,
though it is recommended you use the new class.
\end_layout
\begin_layout Standard
This class covers the same functionality as
\emph on
letter (koma-script),
\emph default
and a few more.
The basic items are
\family sans
Address
\family default
(receiver's address,
same as
\family sans
Letter
\family default
in the old layout),
\family sans
Opening
\family default
,
and
\family sans
Closing
\family default
.
\family sans
NextAddress
\family default
will start a new letter (i.
\begin_inset space \thinspace{}
\end_inset
e.
\begin_inset space \space{}
\end_inset
you can write several letters per document).
New elements are sender's
\family sans
E-Mail
\family default
,
\family sans
URL
\family default
,
\family sans
Fax
\family default
,
\family sans
Bank
\family default
and the possibility to use a
\family sans
Logo
\family default
(via
\family sans
Insert\SpecialChar menuseparator
Graphics
\family default
) in the header.
\end_layout
\begin_layout Standard
The biggest improvement is,
though,
that the letter's layout is configurable to meet almost any needs.
This can be done via the preamble or with a special style file (Letter Class Option,
extension
\family typewriter
*.lco
\family default
),
that will be read in as a class option.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
The KOMA package comes with some default
\family typewriter
*.lco
\family default
files.
There is,
for instance,
a
\family typewriter
DIN.lco
\family default
file that follows german typesetting rules,
or a
\family typewriter
KOMAold.lco
\family default
that provides the default layout of the old
\family typewriter
scrlettr
\family default
class.
The latter can be loaded with the class option
\family typewriter
KOMAold
\family default
,
inserted via the
\family sans
Layout\SpecialChar menuseparator
Document\SpecialChar menuseparator
Extra Options
\family default
field.
\end_layout
\end_inset
Have a look at the template in
\family sans
\bar under
F
\bar default
ile\SpecialChar menuseparator
New
\begin_inset space ~
\end_inset
fro
\bar under
m
\bar default
\begin_inset space ~
\end_inset
Template\SpecialChar menuseparator
Letters\SpecialChar menuseparator
KOMA-Script Letter (V.2)
\family default
.
A detailed description is to be found in the Koma-Script documentation (
\emph on
scrguide
\emph default
).
\end_layout
\begin_layout Subsubsection
Problems
\end_layout
\begin_layout Standard
Visualizing the Koma-Script document classes in \SpecialChar LyX
,
the \SpecialChar LyX
internals cause some problems.
\end_layout
\begin_layout Itemize
The chapter number of a
\family sans
Chapter
\family default
type appears on a line of its own above the chapter heading instead of appearing in the same line ahead of it.
The cause for that is the \SpecialChar LyX
internal behavior for the labeltype
\family sans
Counter_Chapter
\family default
in the layout file.
\end_layout
\begin_layout Itemize
The headings of the types
\family sans
Addchap
\family default
and
\family sans
Addsec
\family default
are only put in the
\begin_inset Quotes eld
\end_inset
true
\begin_inset Quotes erd
\end_inset
\SpecialChar LaTeX
table of contents,
but not in the \SpecialChar LyX
table of contents (
\family sans
Document\SpecialChar menuseparator
Table
\begin_inset space ~
\end_inset
of
\begin_inset space ~
\end_inset
Contents
\family default
).
\end_layout
\begin_layout Itemize
The paragraphs in a
\emph on
letter
\emph default
document class appear in a skip separation mode,
not indented.
This is the standard behavior,
no special \SpecialChar LaTeX
commands are needed for that.
But in the
\family sans
Document\SpecialChar menuseparator
Settings
\family default
dialog the corresponding radio button indicates
\family sans
Indent
\family default
.
A
\family sans
Skip
\family default
value always has the effect that extra \SpecialChar LaTeX
commands are inserted in the document to produce the gap,
which is not what is wanted in this case.
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
name "subsec:Polish-M.W.collection"
\end_inset
Polish M.
\begin_inset space \thinspace{}
\end_inset
W.
\begin_inset space \space{}
\end_inset
collection
\end_layout
\begin_layout Standard
by
\noun on
Tomasz Luczak
\end_layout
\begin_layout Standard
The \SpecialChar LyX
document classes
\emph on
Polish Article (MW Bundle)
\emph default
,
\emph on
Polish Report (MW Bundle)
\emph default
and
\emph on
Polish Book (MW Bundle)
\emph default
correspond to the \SpecialChar LaTeX
document classes
\family typewriter
mwart.cls
\family default
,
\family typewriter
mwrep.cls
\family default
and
\family typewriter
mwbk.cls
\family default
,
resp.
They are replacements for the standard document classes
\family typewriter
article.cls
\family default
,
\family typewriter
report.cls
\family default
and
\family typewriter
book.cls
\family default
,
resp.,
and fit better to Polish typography conventions in a number of points.
\end_layout
\begin_layout Standard
Basic differences:
\end_layout
\begin_layout Itemize
Unnumbered titles (with star,
e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
\family sans
Section*
\family default
) are added into table of contents,
\end_layout
\begin_layout Itemize
Additional page styles:
\end_layout
\begin_deeper
\begin_layout Description
uheadings header with separated lines,
\end_layout
\begin_layout Description
myheadings custom header,
contents headers via commands:
\family typewriter
\backslash
markright
\family default
and
\family typewriter
\backslash
markboth
\family default
,
\end_layout
\begin_layout Description
myuheadings custom header with separated lines,
\end_layout
\begin_layout Description
outer page number is placed on outer side of page
\end_layout
\end_deeper
\begin_layout Itemize
Options
\end_layout
\begin_deeper
\begin_layout Description
rmheadings serif titles —
default,
\end_layout
\begin_layout Description
sfheadings sansserif titles,
\end_layout
\begin_layout Description
authortitle on title page first placed is author next title —
default,
\end_layout
\begin_layout Description
titleauthor on title page first placed is title next author,
\end_layout
\begin_layout Description
withmarginpar reserve place on page for margins.
\end_layout
\end_deeper
\begin_layout Subsection
Tufte Collection
\end_layout
\begin_layout Standard
The document classes
\family sans
Tufte Book
\family default
and
\family sans
Tufte Handout
\family default
use the
\family typewriter
tufte-book.cls
\family default
and
\family typewriter
tufte-handout.cls
\family default
document classes.
Detailed information about these document classes can be found in
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Books\SpecialChar menuseparator
Tufte Book
\family default
and
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Handouts\SpecialChar menuseparator
Tufte Handout
\family default
.
\end_layout
\begin_layout Section
Articles
\end_layout
\begin_layout Standard
See also the document classes in the Collections (section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Collections"
nolink "false"
\end_inset
).
\end_layout
\begin_layout Subsection
Astronomy & Astrophysics
\end_layout
\begin_layout Standard
Original by
\noun on
Peter Sütterlin
\noun default
;
updated by the \SpecialChar LyX
Team
\end_layout
\begin_layout Subsubsection
Introduction
\end_layout
\begin_layout Standard
This section describes how \SpecialChar LyX
can be used to write articles for submission to the scientific journal
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.
\SpecialChar LyX
has proven to be an excellent tool for generating these documents,
especially given its equation,
citation,
and figure handling capabilities.
\SpecialChar LyX
requires version 5.0 (or higher) of these macros;
preferably 6.0,
which is the version described here,
or higher.
Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
2.09 and are fundamentally incompatible with \SpecialChar LyX
.
The AAS\SpecialChar TeX
package may be downloaded from the AAS\SpecialChar TeX
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
https://aas.org/aastex/aastex-downloads
\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 \SpecialChar LyX
.
\SpecialChar LyX
will not reduce the need to figure out all the AAS\SpecialChar TeX
commands,
it will only reduce the drudgery of typing everything in.
It is your responsibility to ensure that the final exported \SpecialChar LaTeX
document conforms completely to the requirements of the journal to which you are submitting your paper.
\end_layout
\begin_layout Subsubsection
Starting a New Paper
\end_layout
\begin_layout Standard
I strongly suggest that you start with the AAS\SpecialChar TeX
template file.
Click on
\family sans
File\SpecialChar menuseparator
New from
\family default
\family sans
Template\SpecialChar menuseparator
Articles\SpecialChar menuseparator
American Astronomical Society
\family default
.
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 AAS\SpecialChar TeX
commands and environments can be implemented directly in \SpecialChar LyX
,
but some cannot.
For commands such as these,
the \SpecialChar LaTeX
code must be entered directly and marked as such.
Such commands are referred to as \SpecialChar TeX
code,
or Evil Red Text.
I tried to minimize the amount of \SpecialChar TeX
code needed in an AAS\SpecialChar TeX
document.
\end_layout
\begin_layout Subsubsection
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 \SpecialChar LaTeX
file (
\family sans
File\SpecialChar menuseparator
Export\SpecialChar menuseparator
\SpecialChar LaTeX
\family default
).
\end_layout
\begin_layout Enumerate
Edit the resulting
\family typewriter
.tex
\family default
file with your favorite text editor
\end_layout
\begin_deeper
\begin_layout Enumerate
remove the comment lines before the
\family typewriter
\backslash
documentclass
\family default
command
\end_layout
\begin_layout Enumerate
remove the
\family typewriter
\backslash
usepackage...{fontenc}
\family default
line if it appears (usually just after
\family typewriter
\backslash
documentclass
\family default
};
also remove the
\family typewriter
\backslash
secnumdepth
\family default
line if it appears.
\end_layout
\begin_layout Enumerate
remove everything between (and including) the
\family typewriter
\backslash
makeatletter
\family default
and
\family typewriter
\backslash
makeatother
\family default
commands,
except for any commands you specifically put into the \SpecialChar LaTeX
preamble (which should appear immediately after the
\begin_inset Quotes eld
\end_inset
User specified \SpecialChar 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 \SpecialChar 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 Subsubsection
Comments On Specific Commands
\end_layout
\begin_layout Standard
I will not describe the detailed usage of the individual AAS\SpecialChar TeX
commands:
the AAS\SpecialChar TeX
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 Paragraph
Things that work as expected
\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
\backslash
label
\family default
(2.15.4,
amongst other places),
\family typewriter
\backslash
tablerefs
\family default
(2.15.5),
\family typewriter
\backslash
tablecomments
\family default
(2.15.5),
\family typewriter
\backslash
url
\family default
(2.17.4),
\family typewriter
\backslash
end{document}
\family default
(2.18).
\end_layout
\begin_layout Standard
The following style options also work correctly:
\family typewriter
longabstract
\family default
(2.4),
\family typewriter
preprint
\family default
(3.2.1),
\family typewriter
preprint2
\family default
(3.2.2),
\family typewriter
eqsecnum
\family default
(3.3),
\family typewriter
flushrt
\family default
(3.4).
Simply put them in the
\family sans
Options
\family default
box in
\family sans
Layout\SpecialChar menuseparator
Document
\family default
.
\end_layout
\begin_layout Paragraph
Things that work,
but require more comment
\end_layout
\begin_layout Standard
The following items work,
but require a little more discussion:
\end_layout
\begin_layout Itemize
These items are reserved for use by the journal editors,
but you can put them into the \SpecialChar LaTeX
preamble if you feel compelled to do so:
\family typewriter
\backslash
received
\family default
,
\family typewriter
\backslash
revised
\family default
,
\family typewriter
\backslash
accepted
\family default
,
\family typewriter
\backslash
ccc
\family default
,
\family typewriter
\backslash
cpright
\family default
(all from 2.1.3)
\end_layout
\begin_layout Itemize
These items may be placed in the \SpecialChar LaTeX
preamble,
and are included as blanks in the template file:
\family typewriter
\backslash
slugcomment
\family default
(2.1.4),
\family typewriter
\backslash
shorttitle
\family default
(2.1.5),
\family typewriter
\backslash
shortauthors
\family default
(2.1.5)
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
email
\family default
(2.3) – can only be used
\begin_inset Quotes eld
\end_inset
standalone
\begin_inset Quotes erd
\end_inset
,
not in the middle of a paragraph.
Use \SpecialChar TeX
code if you need to embed it.
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
and
\family default
(2.3) – will have extra {} after it.
This should not cause an error.
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
notetoeditor
\family default
(2.6) – can only be used
\begin_inset Quotes eld
\end_inset
standalone
\begin_inset Quotes erd
\end_inset
,
not in the middle of a paragraph.
Use \SpecialChar TeX
code if you need to embed it.
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
placetable
\family default
(2.8) – can't insert a cross-reference tag,
you must type the tag name by hand
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
placefigure
\family default
(2.8) – same as for
\family typewriter
\backslash
placetable
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
acknowledgements
\family default
(2.9) – will have extra {} after it.
This should not cause an error.
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
appendix
\family default
(2.11) – will have extra {} after it.
This should not cause an error.
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
figcaption
\family default
(2.14.2) – you can insert an optional filename argument by placing the cursor at the beginning of the text and selecting
\family sans
Insert\SpecialChar menuseparator
Short Title
\family default
.
\begin_inset Quotes eld
\end_inset
Short Title
\begin_inset Quotes erd
\end_inset
inserts an optional argument of the type needed by
\family typewriter
\backslash
figcaption
\family default
.
Hopefully it will be renamed someday.
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
objectname
\family default
(2.17.1) – same as
\family typewriter
\backslash
figcaption
\family default
for the catalog ID optional parameter
\end_layout
\begin_layout Itemize
\family typewriter
\backslash
dataset
\family default
(2.17.1) – same as
\family typewriter
\backslash
figcaption
\family default
for the catalog ID optional parameter
\end_layout
\begin_layout Paragraph
Things not implemented,
use \SpecialChar TeX
code
\end_layout
\begin_layout Standard
\family typewriter
\backslash
eqnum
\family default
(2.12),
\family typewriter
\backslash
setcounter{equation}
\family default
(2.12),
Journal name abbreviations (2.13.4),
\family typewriter
\backslash
figurenum
\family default
(2.14.1),
\family typewriter
\backslash
epsscale
\family default
(2.14.1),
\family typewriter
\backslash
plotone
\family default
(2.14.1),
\family typewriter
\backslash
plottwo
\family default
(2.14.1),
\family typewriter
\backslash
tablenum
\family default
(2.15.4),
\family typewriter
\backslash
tableline
\family default
(2.15.4,
insert it as the first element in the lefthand cell after where you want it.
Don't use any of \SpecialChar LyX
's rules in the table),
\family typewriter
\backslash
tablenotemark
\family default
(2.15.5),
\family typewriter
\backslash
tablenotetext
\family default
(2.15.5),
much of Misc (2.17,
except
\family typewriter
\backslash
objectname
\family default
,
\family typewriter
\backslash
dataset
\family default
,
\family typewriter
\backslash
url
\family default
,
and
\family typewriter
\backslash
email
\family default
;
see above),
\family typewriter
\backslash
singlespace
\family default
(3.1),
\family typewriter
\backslash
doublespace
\family default
(3.1),
\family typewriter
\backslash
onecolumn
\family default
(3.2),
\family typewriter
\backslash
twocolumn
\family default
(3.2)
\end_layout
\begin_layout Paragraph
Things that cannot be implemented
\end_layout
\begin_layout Standard
\SpecialChar ldots
at least in any meaningful sort of way,
so I suggest ignoring them.
They are the references environment (2.13.3),
and the deluxetable environment (2.15).
If you really,
really need to use deluxetable,
I suggest editing it in a separate file with a text editor,
then using
\family sans
Insert\SpecialChar menuseparator
Child
\begin_inset space ~
\end_inset
Document
\family default
to include it in your \SpecialChar LyX
document.
See
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Articles\SpecialChar menuseparator
American Astronomical Society
\family default
for an example of this.
\end_layout
\begin_layout Subsubsection
FAQs,
Tips,
Tricks,
and Other Ruminations
\end_layout
\begin_layout Paragraph
Getting \SpecialChar LyX
and AAS\SpecialChar TeX
to cooperate
\end_layout
\begin_layout Standard
It can be a bit tricky to get \SpecialChar LyX
to recognize a new layout and document class.
When all else fails,
do this:
\end_layout
\begin_layout Enumerate
Make certain that \SpecialChar LaTeX
can find AAS\SpecialChar TeX
.
Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
distribution into a directory completely unrelated to \SpecialChar LaTeX
document class to make slides for overhead projectors.
There are two document classes that can do this:
the
\family sans
Slides
\family default
document class (section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:slitex"
plural "false"
caps "false"
noprefix "false"
nolink "false"
\end_inset
) and the
\family sans
Foil\SpecialChar TeX
\family default
slides class.
As of 2023 the former has continued to be maintained whereas
\family sans
Foil\SpecialChar TeX
\family default
has not been maintained since 2008.
This section documents the latter.
If your machine doesn’t have the
\family sans
Foil\SpecialChar TeX
\family default
document class installed,
you’ll probably have to use the
\family sans
Slides
\family default
document class.
If you want to install the
\family typewriter
foils.cls
\family default
document class,
it is available from
\begin_inset CommandInset href
LatexCommand href
name "CTAN"
target "https://www.ctan.org/pkg/foiltex"
literal "false"
\end_inset
.
You should also read the
\emph on
Installing New Document Classes
\emph default
chapter of the
\emph on
Customization
\emph default
manual.
\end_layout
\begin_layout Subsubsection
Getting Started
\end_layout
\begin_layout Standard
Obviously,
to use this document class,
you need to select
\family sans
FoilTeX
\family default
from the
\family sans
Class
\family default
entry in the
\family sans
Document
\begin_inset space ~
\end_inset
Layout
\family default
dialog.
There are some settings in the
\family sans
Document
\begin_inset space ~
\end_inset
Layout
\family default
dialog that you should know about that are specific to this class:
\end_layout
\begin_layout Itemize
Don't change the options
\family sans
Sides
\family default
and
\family sans
Columns
\family default
on the
\family sans
Document
\begin_inset space ~
\end_inset
Layout
\family default
dialog.
They're ignored by the
\family sans
foils
\family default
class.
\end_layout
\begin_layout Itemize
The default font size is 20
\begin_inset space \thinspace{}
\end_inset
pt with the other options being 17
\begin_inset space \thinspace{}
\end_inset
pt,
25
\begin_inset space \thinspace{}
\end_inset
pt and 30
\begin_inset space \thinspace{}
\end_inset
pt.
\end_layout
\begin_layout Itemize
The default font is
\family sans
sans
\family default
\family sans
serif
\family default
but all math equations are still typeset in the usual roman font.
\end_layout
\begin_layout Itemize
\family sans
Foil\SpecialChar TeX
\family default
supports A4 and Letter paper sizes as well as a special size for working with 35
\begin_inset space \thinspace{}
\end_inset
mm slides.
It doesn't support A5,
B5,
legal or executive paper sizes.
\end_layout
\begin_layout Itemize
Don't bother changing the
\family sans
Float Placement
\family default
settings because they are ignored anyway.
All floats appear where they are defined in the text.
\end_layout
\begin_layout Itemize
The
\family sans
Pagestyle
\family default
setting behaves a bit differently for this class.
\family sans
Foil\SpecialChar TeX
\family default
provides extensive footer and header capabilities including a user-defined logo.
See section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:foilfoot"
nolink "false"
\end_inset
for more details.
The title page is treated differently to all other pages in the document and is
\emph on
always
\emph default
unnumbered and
\emph on
always
\emph default
has the logo centered at the bottom of the page (if one is defined).
The possible page style choices and what they do are as follows:
\end_layout
\begin_deeper
\begin_layout Labeling
\labelwidthstring MMMMMMM
\family sans
\series bold
empty
\family default
\series default
The final output contains no page numbers,
or other headers or footers (except footnotes of course).
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMM
\family sans
\series bold
plain
\family default
\series default
The final output contains page numbers centered at the bottom of the page.
No other headings or footers (other than footnotes).
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMM
\series bold
foilheadings
\series default
Page numbers in lower right corner.
Additional headers and footers are also shown.
This is also the default.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMM
\series bold
fancy
\series default
Gives you access to the
\family sans
fancyheadings
\family default
package although its use with
\family sans
Foil\SpecialChar TeX
\family default
is discouraged by the writer of the
\family sans
Foil\SpecialChar TeX
\family default
package because of some potential page layout clashes.
\end_layout
\end_deeper
\begin_layout Paragraph
Extra Options
\end_layout
\begin_layout Standard
The following options may be used in the extra class options in the
\family sans
Document\SpecialChar menuseparator
Settings
\family default
dialog.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
35mmSlide
\series default
This sets up the page layout for 7.33
\begin_inset space \thinspace{}
\end_inset
in by 11
\begin_inset space \thinspace{}
\end_inset
in paper,
which is about the same aspect ratio as a 35
\begin_inset space \thinspace{}
\end_inset
mm slide,
making it a bit easier to work with this medium.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
headrule
\series default
Places a rule across the page below the header on every page except the title page.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
footrule
\series default
Places a rule across the page above the footer on every page except the title page.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
dvips
\series default
This is automatically set each time you create a new
\family sans
foils
\family default
document.
This option tells
\family sans
Foil\SpecialChar TeX
\family default
to use the dvips driver to rotate those pages that are set as landscape foils.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
landscape
\series default
Simply changes the page dimensions to those of a landscape page but doesn't do any rotation.
Thus if you use this option you need to use an external program to rotate each page or feed your paper through your printer as landscape.
Note that this option effectively reverses the roles of the
\family sans
Foilhead
\family default
and
\family sans
Rotatefoilhead
\family default
environments (don't worry these are described in the next section).
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
leqno
\series default
Equation numbers on the left.
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMx
\series bold
fleqn
\series default
Flush-left equations.
\end_layout
\begin_layout Subsubsection
Supported Environments
\end_layout
\begin_layout Standard
Most of the environments commonly supported in other classes are also supported by the
\family sans
Foil\SpecialChar TeX
\family default
class.
There are several additional environments provided by
\family sans
Foil\SpecialChar TeX
\family default
as well as a couple added by \SpecialChar LyX
.
The following environments are shared with other classes:
\end_layout
\begin_layout Standard
\begin_inset Flex Multiple Columns
status open
\begin_layout Itemize
\family sans
Standard
\end_layout
\begin_layout Itemize
\family sans
Itemize
\end_layout
\begin_layout Itemize
\family sans
Enumerate
\end_layout
\begin_layout Itemize
\family sans
Description
\end_layout
\begin_layout Itemize
\family sans
List
\end_layout
\begin_layout Itemize
\family sans
\SpecialChar LyX
-Code
\end_layout
\begin_layout Itemize
\family sans
Verse
\end_layout
\begin_layout Itemize
\family sans
Quote
\end_layout
\begin_layout Itemize
\family sans
Quotation
\end_layout
\begin_layout Itemize
\family sans
Title
\end_layout
\begin_layout Itemize
\family sans
Author
\end_layout
\begin_layout Itemize
\family sans
Date
\end_layout
\begin_layout Itemize
\family sans
Abstract
\end_layout
\begin_layout Itemize
\family sans
Bibliography
\end_layout
\begin_layout Itemize
\family sans
Address
\end_layout
\begin_layout Itemize
\family sans
RightAddress
\end_layout
\end_inset
\end_layout
\begin_layout Standard
That is,
all the major environments apart from the sectioning environments.
Since foils are essentially self-contained sections,
with a title and body,
\family sans
Foil\SpecialChar TeX
\family default
provides specific commands for starting new foils and these are:
\end_layout
\begin_layout Itemize
\family sans
Foilhead
\end_layout
\begin_layout Itemize
\family sans
Rotatefoilhead
\end_layout
\begin_layout Standard
\SpecialChar LyX
also provides slightly modified versions of these two environments called:
\end_layout
\begin_layout Itemize
\family sans
ShortFoilhead
\end_layout
\begin_layout Itemize
\family sans
ShortRotatefoilhead
\end_layout
\begin_layout Standard
and the differences will be explained in the next section.
\end_layout
\begin_layout Standard
Since foils are often used in presenting ideas or new theorems and such
\family sans
Foil\SpecialChar TeX
\family default
also provides a comprehensive box of goodies for presenting them:
\end_layout
\begin_layout Standard
\begin_inset Flex Multiple Columns
status open
\begin_layout Itemize
\family sans
Theorem
\end_layout
\begin_layout Itemize
\family sans
Lemma
\end_layout
\begin_layout Itemize
\family sans
Corollary
\end_layout
\begin_layout Itemize
\family sans
Proposition
\end_layout
\begin_layout Itemize
\family sans
Definition
\end_layout
\begin_layout Itemize
\family sans
Proof
\end_layout
\begin_layout Itemize
\family sans
Theorem*
\end_layout
\begin_layout Itemize
\family sans
Lemma*
\end_layout
\begin_layout Itemize
\family sans
Corollary*
\end_layout
\begin_layout Itemize
\family sans
Proposition*
\end_layout
\begin_layout Itemize
\family sans
Definition*
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The starred versions are unnumbered while the unstarred versions are numbered.
There are also two list environments added by \SpecialChar LyX
and these are:
\end_layout
\begin_layout Itemize
\family sans
TickList
\end_layout
\begin_layout Itemize
\family sans
CrossList
\end_layout
\begin_layout Standard
\family sans
Foil\SpecialChar TeX
\family default
provides some powerful header and footer capabilities that are best set in the preamble although they may be set at any point in a document.
If you want to change these settings in your document the best place to do so is at the very top of a foil,
i.
\begin_inset space \thinspace{}
\end_inset
e.
\emph on
\begin_inset space \space{}
\end_inset
\emph default
straight after the foilhead.
\end_layout
\begin_layout Standard
For this purpose,
the following command styles are provided [
\shape smallcaps
Martin Vermeer
\shape default
]:
\end_layout
\begin_layout Standard
\begin_inset Flex Multiple Columns
status open
\begin_layout Itemize
\family sans
My
\begin_inset space ~
\end_inset
Logo
\end_layout
\begin_layout Itemize
\family sans
Restriction
\end_layout
\begin_layout Itemize
\family sans
Right
\begin_inset space ~
\end_inset
Footer
\end_layout
\begin_layout Itemize
\family sans
Right
\begin_inset space ~
\end_inset
Header
\end_layout
\begin_layout Itemize
\family sans
Left
\begin_inset space ~
\end_inset
Header
\end_layout
\begin_deeper
\begin_layout Plain Layout
\begin_inset space ~
\end_inset
\end_layout
\end_deeper
\end_inset
\end_layout
\begin_layout Standard
There are also a few commands provided by
\family sans
Foil\SpecialChar TeX
\family default
that aren't directly supported by \SpecialChar LyX
but I'll tell you what they do and how to use them in section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:unsuppfoils"
nolink "false"
\end_inset
.
\end_layout
\begin_layout Subsubsection
Building a Set of Foils
\end_layout
\begin_layout Standard
This section will give a simple introduction to using the different environments to build a set of foils.
If you want to see an example set of foils,
take a look at
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Presentations\SpecialChar menuseparator
Foils
\family default
.
\end_layout
\begin_layout Paragraph
Give It a Title Page
\end_layout
\begin_layout Standard
Unlike other classes that provide
\family sans
Title
\family default
,
\family sans
Author
\family default
,
\family sans
Date
\family default
and
\family sans
Abstract
\family default
environments,
\family sans
\lang ngerman
FoilTeX
\family default
\lang english
creates the title on a page of its own.
If you leave out the
\family sans
Date
\family default
environment \SpecialChar LaTeX
will substitute the current date (every time you regenerate the output).
\end_layout
\begin_layout Paragraph
Start a New Foil
\end_layout
\begin_layout Standard
As I mentioned earlier,
there are four ways of starting a new foil.
For portrait foils you should use
\family sans
Foilhead
\family default
or
\family sans
ShortFoilhead.
\family default
The difference between these two environments is the amount of space between the title of the foil (the foilhead) and the body of the foil.
\end_layout
\begin_layout Standard
Landscape foils are generated using the
\family sans
Rotatefoilhead
\family default
and
\family sans
ShortRotatefoilhead
\family default
environments.
Again the only difference is the spacing between foilhead and body.
Both of the short versions have 0.5
\begin_inset space ~
\end_inset
inches less separation between the foilhead and the body.
\end_layout
\begin_layout Standard
One problem with the support for landscape foils is the requirement that you have to use the
\family typewriter
dvips
\family default
driver to generate the PostScript output otherwise the foils won't be rotated.
It is possible to get landscape foils even if you haven't got the
\family typewriter
dvips
\family default
driver provided you can feed your foils sideways through your printer ;-)
\end_layout
\begin_layout Paragraph
Theorems,
Lemmas,
Proofs and more
\end_layout
\begin_layout Standard
You can't have two of the same type of these environments directly following each other.
If you use a normal paragraph break,
,
you will just be extending the previous environment as if you had merged the two environments together.
Rather than that,
you need to insert a so-called separator.
Please refer to the section entitled
\emph on
Separate Nestings
\emph default
in the
\emph on
User's Guide
\emph default
.
\end_layout
\begin_layout Paragraph
Lists
\end_layout
\begin_layout Standard
You get all the commonly supported list styles found in other classes as well as two new ones.
I'll only describe the new ones here.
If you want to find out more about the other list environments check out the
\emph on
User's Guide.
\emph default
If you intend to use itemized lists you might also want to read about the
\family sans
Itemize
\begin_inset space ~
\end_inset
Bullet
\begin_inset space ~
\end_inset
Selection
\family default
dialog described above in section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "chap:bullets"
nolink "false"
\end_inset
.
\end_layout
\begin_layout Standard
The two new list styles,
\family sans
TickList
\family default
and
\family sans
CrossList
\family default
,
are designed to make it easier for you to create lists of do's and don'ts or right and wrong by providing dedicated environments that use a tick or a cross as the label of the list.
These lists are in fact dedicated variants of the
\family sans
Itemize
\family default
environment.
They do however require that you have the
\family typewriter
psnfss
\family default
packages installed.
\end_layout
\begin_layout Paragraph
Figures and Tables
\end_layout
\begin_layout Standard
\family sans
Foil\SpecialChar TeX
\family default
redefines the floating tables and figures so that they appear exactly where they are in the text rather than pushing them to the top of the page or to some user specified location.
In fact if you change the float placement settings they are simply ignored.
\end_layout
\begin_layout Paragraph
Page Headers and Footers
\begin_inset CommandInset label
LatexCommand label
name "sec:foilfoot"
\end_inset
\end_layout
\begin_layout Standard
\family sans
My
\begin_inset space ~
\end_inset
Logo
\family default
and
\family sans
Restriction
\family default
are two commands used to control the left-footer text string.
The first is meant to allow you to include a graphic logo on your foils and defaults to
\begin_inset Quotes eld
\end_inset
-Typeset by
\family sans
Foil\SpecialChar TeX
\family default
-
\begin_inset Quotes erd
\end_inset
.
While the second is meant to provide a classification for the audience,
\emph on
e.
\begin_inset space \thinspace{}
\end_inset
g.
\emph default
\begin_inset space \space{}
\end_inset
Confidential.
It is empty by default.
\end_layout
\begin_layout Standard
The remaining page corners can be filled by
\family sans
Right
\begin_inset space ~
\end_inset
Footer
\family default
(which defaults to page numbers),
\family sans
Right
\begin_inset space ~
\end_inset
Header
\family default
(top right) and
\family sans
Left
\begin_inset space ~
\end_inset
Header
\family default
(top left).
\end_layout
\begin_layout Subsubsection
Unsupported
\family sans
Foil\SpecialChar TeX
\family default
Goodies
\begin_inset CommandInset label
LatexCommand label
name "sec:unsuppfoils"
\end_inset
\end_layout
\begin_layout Standard
All the commands mentioned below need to be set in a
\family sans
\SpecialChar LaTeX
\family default
environment or as
\family sans
\SpecialChar TeX
\family default
within another environment.
\end_layout
\begin_layout Paragraph
Lengths
\end_layout
\begin_layout Standard
All lengths are adjusted using the
\family typewriter
\backslash
setlength{
\family default
\emph on
lengthname
\family typewriter
\emph default
}{
\family default
\emph on
newlength
\family typewriter
\emph default
}
\family default
command.
Where
\emph on
lengthname
\emph default
should be replaced by the name given to the length you want to change and
\emph on
newlength
\emph default
is the length value.
All lengths should be specified in units of length such as inches (
\family typewriter
in
\family default
),
millimeters (
\family typewriter
mm
\family default
) or points (
\family typewriter
pt
\family default
) or relative to some document or font-based length such as
\family typewriter
\backslash
textwidth
\family default
.
\end_layout
\begin_layout Standard
It's possible to change the spacing between a foilhead and the body of the foil by adjusting the length specified by
\family typewriter
\backslash
foilheadskip
\family default
.
For example,
to make
\emph on
all
\emph default
foilheads 0.5
\begin_inset space \space{}
\end_inset
in closer to their bodies put the following in the preamble:
\family typewriter
\backslash
setlength{
\backslash
foilheadskip}{-0.5in}
\end_layout
\begin_layout Standard
The spacings around floats can be adjusted by setting these lengths:
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
abovefloatskip
\family default
Separation between the text and the top of the float
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
abovecaptionskip
\family default
Separation between the float and the caption
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
belowcaptionskip
\family default
Separation between the caption and the following text
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
captionwidth
\family default
You can make the captions narrower than the surrounding text by adjusting this length.
Best done relative to
\family typewriter
\backslash
textwidth
\family default
.
\end_layout
\begin_layout Standard
There are also several title page related lengths that you may find useful if you have a long title or several authors:
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
abovetitleskip
\family default
Separation from headers to
\family sans
Title
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
titleauthorskip
\family default
between
\family sans
Title
\family default
and
\family sans
Author
\family default
environments
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
authorauthorskip
\family default
between multiple
\family sans
Author
\family default
lines
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
authordateskip
\family default
between the
\family sans
Author
\family default
and the
\family sans
Date
\end_layout
\begin_layout Labeling
\labelwidthstring MMMMMMMMMMM
\family typewriter
\backslash
dateabstractskip
\family default
between the
\family sans
Date
\family default
and the
\family sans
Abstract
\end_layout
\begin_layout Standard
The last length related command affects all the list environments.
If you place
\family typewriter
\backslash
zerolistvertdimens
\family default
\emph on
inside
\emph default
a list environment then all the vertical spacing between the list items is removed.
Note that this is a command not a length so it doesn't require
\family typewriter
\backslash
setlength
\family default
like the stuff mentioned above.
\end_layout
\begin_layout Paragraph
Headers and Footers
\end_layout
\begin_layout Standard
The
\family typewriter
\backslash
LogoOn
\family default
and
\family typewriter
\backslash
LogoOff
\family default
commands control whether the logo in the
\family sans
MyLogo
\family default
definition appear on a given page.
If you put
\family typewriter
\backslash
LogoOff
\family default
in the preamble then none of the foils will have the logo on them.
If you don't want the logo on a particular page place the
\family typewriter
\backslash
LogoOff
\family default
directly after the foilhead of that page and the
\family typewriter
\backslash
LogoOn
\family default
directly after the next foilhead.
\end_layout
\begin_layout Standard
If you decide to use the
\family sans
fancy
\family default
page style setting in the
\family sans
Document
\begin_inset space ~
\end_inset
Layout
\family default
dialog you should probably add
\family typewriter
\backslash
let
\backslash
headwidth
\backslash
textwidth
\family default
to your preamble so headers and footers on landscape pages are correctly placed when rotated.
This is due to some clashes between the page layouts provided by the
This module allows the use of Noweb as a literate programming tool.
The files and the documentation for Noweb can be obtained from
\begin_inset CommandInset href
LatexCommand href
name "CTAN"
target "https://www.ctan.org/pkg/noweb"
literal "false"
\end_inset
.
Literate programming is described in section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Literate-Programming"
nolink "false"
\end_inset
and there are three example files:
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Noweb
\family default
,
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Noweb Listerrors
\family default
and
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Noweb2\SpecialChar LyX
\family default
.
\end_layout
\begin_layout Subsection
Rnw (knitr)
\end_layout
\begin_layout Standard
This module uses the
\family typewriter
knitr
\family default
and
\family sans
includernw
\family default
packages.
The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
knitr
\end_layout
\end_inset
package in R for dynamic report generation has to be installed for this module to work:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
install.packages(“knitr”)
\end_layout
\end_inset
.
\end_layout
\begin_layout Paragraph
Note
\end_layout
\begin_layout Itemize
it depends on R >= 2.14.1.
For more info see
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
http://yihui.name/knitr
\end_layout
\end_inset
.
\end_layout
\begin_layout Itemize
The package
\family sans
includernw
\family default
also has to be installed.
\end_layout
\begin_layout Itemize
It cannot be used if the modules
\family sans
LilyPond
\begin_inset space ~
\end_inset
Book
\family default
or
\family sans
Sweave
\family default
are loaded.
\end_layout
\begin_layout Standard
See
\family sans
Help\SpecialChar menuseparator
Specific Manuals\SpecialChar menuseparator
Knitr
\family default
,
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Rnw (knitr)
\family default
and section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Literate-Programming"
nolink "false"
\end_inset
for information about literate programming.
\end_layout
\begin_layout Subsection
Sweave
\end_layout
\begin_layout Standard
This module allows the use of the statistical language S/R as a literate programming tool.
It requires the
\family sans
includernw
\family default
and
\family sans
fancyvrb
\family default
packages.
Both
\begin_inset CommandInset href
LatexCommand href
name "includernw"
target "https://www.ctan.org/pkg/includernw"
literal "false"
\end_inset
and
\begin_inset CommandInset href
LatexCommand href
name "fancyvrb"
target "https://www.ctan.org/pkg/fancyvrb"
literal "false"
\end_inset
are available from CTAN.
It cannot be used if the module
\family sans
LilyPond
\begin_inset space ~
\end_inset
Book
\family default
has been loaded.
See
\family sans
Help\SpecialChar menuseparator
Specific Manuals\SpecialChar menuseparator
Sweave,
\family default
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Sweave
\family default
and section
\begin_inset space ~
\end_inset
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:Literate-Programming"
nolink "false"
\end_inset
for information about literate programming.
\end_layout
\begin_layout Section
Maths
\end_layout
\begin_layout Subsection
AMS Theorems
\end_layout
\begin_layout Standard
This modules defines theorem environments and the proof environment using the extended AMS machinery.
Both numbered and unnumbered types are provided.
By default,
the theorems are numbered consecutively throughout the document.
This can be changed by loading one of the
\family sans
AMS Theorems (Numbered by \SpecialChar ldots
)
\family default
modules.
It cannot be used if the modules
\family sans
Standard Theorems
\family default
or
\family sans
Standard Theorems (Unnumbered)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
AMS Theorems (Extended)
\end_layout
\begin_layout Standard
This module defines some additional theorem environments for use with the
\family sans
AMS Theorems
\family default
package (which must be loaded).
It includes
\family sans
Criterion
\family default
,
\family sans
Algorithm
\family default
,
\family sans
Axiom
\family default
,
\family sans
Condition
\family default
,
\family sans
Note
\family default
,
\family sans
Notation
\family default
,
\family sans
Summary
\family default
,
\family sans
Conclusion
\family default
,
\family sans
Fact
\family default
,
\family sans
Assumption
\family default
,
\family sans
Case
\family default
and
\family sans
Question
\family default
in both numbered and unnumbered forms.
\end_layout
\begin_layout Subsection
AMS Theorems (Extended,
Numbered by Type within Chapters)
\end_layout
\begin_layout Standard
This module defines some additional theorem environments for use with the
\family sans
AMS Theorems (Numbered by Type within Chapters)
\family default
module (which must be loaded).
It includes
\family sans
Criterion
\family default
,
\family sans
Algorithm
\family default
,
\family sans
Axiom
\family default
,
\family sans
Condition
\family default
,
\family sans
Note
\family default
,
\family sans
Notation
\family default
,
\family sans
Summary
\family default
,
\family sans
Conclusion
\family default
,
\family sans
Assumption
\family default
and
\family sans
Case
\family default
in both numbered and unnumbered forms.
\end_layout
\begin_layout Standard
Unlike the
\family sans
AMS Theorems (Extended)
\family default
module,
the different theorem types provided here each have a separate counter,
restarted with each new chapter (e.g.,
\emph on
Criterion 1.1
\emph default
,
\emph on
Criterion 1.2
\emph default
,
\emph on
Axiom 1.1
\emph default
,
\emph on
Assumption 1.1
\emph default
,
\emph on
Criterion 2.1
\emph default
,
\emph on
Criterion 2.2
\emph default
,
\emph on
Axiom 2.1
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Criterion 1
\emph default
,
\emph on
Criterion 2
\emph default
,
\emph on
Axiom 3
\emph default
,
\emph on
Assumption 4
\emph default
,
\SpecialChar ldots
).
\end_layout
\begin_layout Subsection
AMS Theorems (Extended,
Numbered by Type)
\end_layout
\begin_layout Standard
This module defines some additional theorem environments for use with the
\family sans
AMS Theorems (Numbered by Type)
\family default
package (which must be loaded).
It includes
\family sans
Criterion
\family default
,
\family sans
Algorithm
\family default
,
\family sans
Axiom
\family default
,
\family sans
Condition
\family default
,
\family sans
Note
\family default
,
\family sans
Notation
\family default
,
\family sans
Summary
\family default
,
\family sans
Conclusion
\family default
,
\family sans
Assumption
\family default
and
\family sans
Case
\family default
in both numbered and unnumbered forms.
\end_layout
\begin_layout Standard
Unlike the
\family sans
AMS Theorems (Extended)
\family default
module,
the different theorem types provided here each have a separate counter (e.g.,
\emph on
Criterion 1
\emph default
,
\emph on
Criterion 2
\emph default
,
\emph on
Axiom 1
\emph default
,
\emph on
Assumption 1
\emph default
,
\emph on
Criterion 3
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Criterion 1
\emph default
,
\emph on
Criterion 2
\emph default
,
\emph on
Axiom 3
\emph default
,
\emph on
Assumption 4
\emph default
,
\SpecialChar ldots
).
\end_layout
\begin_layout Subsection
AMS Theorems (Numbered by Type within Chapters)
\end_layout
\begin_layout Standard
This module defines theorem environments and the proof environment using the extended AMS machinery.
Both numbered and unnumbered types are provided.
\end_layout
\begin_layout Standard
Unlike the
\family sans
AMS Theorems
\family default
module,
the different theorem types provided here each have a separate counter (e.g.,
\emph on
Theorem 1.1
\emph default
,
\emph on
Theorem 1.2
\emph default
,
\emph on
Lemma 1.1
\emph default
,
\emph on
Proposition 1.1
\emph default
,
\emph on
Theorem 1.3
\emph default
,
\emph on
Lemma 1.2
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 3
\emph default
,
\emph on
Proposition 4
\emph default
,
\SpecialChar ldots
).
The numbering restarts for each chapter:
\emph on
Theorem 1.1
\emph default
,
\emph on
Theorem 2.1
\emph default
,
\SpecialChar ldots
\end_layout
\begin_layout Standard
It cannot be used if the modules
\family sans
AMS Theorems
\family default
,
\family sans
Standard Theorems
\family default
,
\family sans
Standard Theorems (Numbered by Type)
\family default
or
\family sans
Standard Theorems (Unnumbered)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
AMS Theorems (Numbered by Type)
\end_layout
\begin_layout Standard
This module defines theorem environments and the proof environment using the extended AMS machinery.
Both numbered and unnumbered types are provided.
Unlike the
\family sans
AMS Theorems
\family default
module,
the different theorem types provided here each have a separate counter (e.g.,
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 1
\emph default
,
\emph on
Proposition 1
\emph default
,
\emph on
Theorem 3
\emph default
,
\emph on
Lemma 2
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 3
\emph default
,
\emph on
Proposition 4
\emph default
,
\SpecialChar ldots
).
The numbering’s scope is the whole document.
For chapter- and section-wide numbering,
use one of the ‘within Sections’/‘within Chapters’ modules,
respectively.
\end_layout
\begin_layout Standard
It cannot be used if the modules
\family sans
AMS Theorems
\family default
,
\family sans
Standard Theorems
\family default
,
\family sans
Standard Theorems (Numbered by Type)
\family default
or
\family sans
Standard Theorems (Unnumbered)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
Number Equations by Section
\end_layout
\begin_layout Standard
This module resets the equation number at section start and prepends the section number to the equation number,
as in
\emph on
(2.1)
\emph default
.
\end_layout
\begin_layout Subsection
Standard Theorems
\end_layout
\begin_layout Standard
This module defines some theorem environments for use with non-AMS classes.
By default,
the theorems are numbered consecutively throughout the document.
This can be changed by loading one of the
\family sans
Standard Theorems (Numbered by \SpecialChar ldots
)
\family default
modules.
\end_layout
\begin_layout Standard
It cannot be used if the modules
\family sans
AMS Theorems
\family default
or
\family sans
Standard Theorems (Unnumbered)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
Standard Theorems (Nameable)
\end_layout
\begin_layout Standard
This module facilitates the use of named theorems.
The name of the theorem can be inserted via
\family sans
Insert\SpecialChar menuseparator
Additional Theorem Text
\family default
.
\end_layout
\begin_layout Subsection
Standard Theorems (Numbered by Chapter)
\end_layout
\begin_layout Standard
This module numbers theorems and the like by chapter (i.e.,
the counter is reset at each chapter start).
Use this module only with document classes that provide a chapter environment.
\end_layout
\begin_layout Standard
One of the modules
\family sans
AMS Theorems
\family default
or
\family sans
Standard Theorems
\family default
must be loaded.
\end_layout
\begin_layout Standard
It cannot be used if the module
\family sans
Standard Theorems (Numbered by Section)
\family default
has been loaded.
\end_layout
\begin_layout Subsection
Standard Theorems (Numbered by Section)
\end_layout
\begin_layout Standard
This module numbers theorems and the like by section (i.e.,
the counter is reset at each section start).
One of the modules
\family sans
AMS Theorems
\family default
or
\family sans
Standard Theorems
\family default
must be loaded.
It cannot be used if the module
\family sans
Standard Theorems (Numbered by Chapter)
\family default
has been loaded.
\end_layout
\begin_layout Subsection
Standard Theorems (Numbered by Type within Chapters)
\end_layout
\begin_layout Standard
This module defines some theorem environments for use with non-AMS classes.
Unlike the
\family sans
AMS Theorems
\family default
and
\family sans
Standard Theorems
\family default
modules,
the different theorem types provided here each have a separate counter (e.g.,
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 1
\emph default
,
\emph on
Proposition 1
\emph default
,
\emph on
Theorem 3
\emph default
,
\emph on
Lemma 2
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 3
\emph default
,
\emph on
Proposition 4
\emph default
,
\SpecialChar ldots
).
The numbering is reset at each chapter start.
\end_layout
\begin_layout Standard
One of the modules
\family sans
AMS Theorems (Numbered by Type)
\family default
or
\family sans
Standard Theorems (Numbered by Type)
\family default
must be loaded.
\end_layout
\begin_layout Standard
It cannot be used if any of the modules
\family sans
AMS Theorems
\family default
,
\family sans
Standard Theorems
\family default
,
\family sans
Standard Theorems (Unnumbered)
\family default
,
\family sans
Standard Theorems (Numbered by Sections)
\family default
or
\family sans
Standard Theorems (Numbered by Type within Sections)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
Standard Theorems (Numbered by Type within Sections)
\end_layout
\begin_layout Standard
This module defines some theorem environments for use with non-AMS classes.
Unlike the
\family sans
AMS Theorems
\family default
and
\family sans
Standard Theorems
\family default
modules,
the different theorem types provided here each have a separate counter (e.g.,
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 1
\emph default
,
\emph on
Proposition 1
\emph default
,
\emph on
Theorem 3
\emph default
,
\emph on
Lemma 2
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 3
\emph default
,
\emph on
Proposition 4
\emph default
,
\SpecialChar ldots
).
The numbering is reset at each section start.
\end_layout
\begin_layout Standard
One of the modules
\family sans
AMS Theorems (Numbered by Type)
\family default
or
\family sans
Standard Theorems (Numbered by Type)
\family default
must be loaded.
\end_layout
\begin_layout Standard
It cannot be used if any of the modules
\family sans
AMS Theorems
\family default
,
\family sans
Standard Theorems
\family default
,
\family sans
Standard Theorems (Unnumbered)
\family default
,
\family sans
Standard Theorems (Numbered by Chapters)
\family default
or
\family sans
Standard Theorems (Numbered by Type within Chapters)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
Standard Theorems (Numbered by Type)
\end_layout
\begin_layout Standard
This module defines some theorem environments for use with non-AMS classes.
Unlike the
\family sans
AMS Theorems
\family default
and
\family sans
Standard Theorems
\family default
modules,
the different theorem types provided here each have a separate counter (e.g.,
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 1
\emph default
,
\emph on
Proposition 1
\emph default
,
\emph on
Theorem 3
\emph default
,
\emph on
Lemma 2
\emph default
,
\SpecialChar ldots
,
as opposed to
\emph on
Theorem 1
\emph default
,
\emph on
Theorem 2
\emph default
,
\emph on
Lemma 3
\emph default
,
\emph on
Proposition 4
\emph default
,
\SpecialChar ldots
).
The numbering’s scope is the whole document.
For chapter- and section-wide numbering,
use one of the “within Chapters”/“within Sections” modules,
respectively.
\end_layout
\begin_layout Standard
It cannot be used if any of the modules
\family sans
AMS Theorems
\family default
,
\family sans
Standard Theorems
\family default
,
\family sans
Standard Theorems (Unnumbered)
\family default
or
\family sans
AMS Theorems (Numbered by Type)
\family default
have been loaded.
\end_layout
\begin_layout Subsection
Standard Theorems (Unnumbered)
\end_layout
\begin_layout Standard
This module defines only unnumbered theorem environments and the proof environment,
using the extended AMS machinery.
It cannot be used if either of the modules
\family sans
AMS Theorems
\family default
or
\family sans
Standard Theorems
\family default
have been loaded.
\end_layout
\begin_layout Subsection
Subequations
\end_layout
\begin_layout Standard
This module provides a straightforward way to segregate subequations in LyX.
See
\family sans
Help\SpecialChar menuseparator
Math\SpecialChar menuseparator
Subnumbering
\family default
.
\end_layout
\begin_layout Section
Page Layout
\end_layout
\begin_layout Subsection
Custom Header/Footer Text
\end_layout
\begin_layout Standard
This module requires the
\family sans
Page
\begin_inset space ~
\end_inset
\bar under
s
\bar default
tyle
\family default
option in the
\family sans
\bar under
D
\bar default
ocument\SpecialChar menuseparator
\bar under
S
\bar default
ettings\SpecialChar menuseparator
Page
\begin_inset space ~
\end_inset
Layout
\family default
dialog to be set to
\family typewriter
fancy
\family default
.
It adds six environments to document classes which support the
\family typewriter
fancyhdr
\family default
package:
\end_layout
\begin_layout Itemize
\family sans
Left Header
\end_layout
\begin_layout Itemize
\family sans
Center Header
\end_layout
\begin_layout Itemize
\family sans
Right Header
\end_layout
\begin_layout Itemize
\family sans
Left Footer
\end_layout
\begin_layout Itemize
\family sans
Center Footer
\end_layout
\begin_layout Itemize
\family sans
Right Footer
\end_layout
\begin_layout Subsubsection
Fancy Headers and Footers
\end_layout
\begin_layout Standard
The default page layout is rather plain;
for an
\family sans
Article (Standard Class)
\family default
document class,
all you get is a centered page number at the bottom of the page.
This document uses the
\family sans
KOMA-Script Book
\family default
class;
so it appears to be a bit fancier.
\end_layout
\begin_layout Standard
Once the
\family sans
Page
\begin_inset space ~
\end_inset
\bar under
s
\bar default
tyle
\family default
in
\family sans
\bar under
D
\bar default
ocument\SpecialChar menuseparator
\bar under
S
\bar default
ettings\SpecialChar menuseparator
Page Layout
\family default
is set to
\begin_inset Quotes eld
\end_inset
fancy
\begin_inset Quotes erd
\end_inset
,
you will find that the page header is divided into three fields,
not surprisingly labeled
\begin_inset Quotes eld
\end_inset
left
\begin_inset Quotes erd
\end_inset
,
\begin_inset Quotes eld
\end_inset
center
\begin_inset Quotes erd
\end_inset
,
and
\begin_inset Quotes eld
\end_inset
right
\begin_inset Quotes erd
\end_inset
.
The footer is also divided into these three fields.
The \SpecialChar LaTeX
commands to set these fields in the simplest manner are
\family typewriter
\backslash
lhead
\family default
,
\family typewriter
\backslash
chead
\family default
,
\family typewriter
\backslash
rhead
\family default
,
\family typewriter
\backslash
lfoot
\family default
,
etc.
Suppose you wish to put your name in the upper left hand corner of each page.
Simply insert the following command in the preamble:
\end_layout
\begin_layout LyX-Code
\backslash
lhead{John Q.
DocWriter}
\end_layout
\begin_layout Standard
You will now see your name in the upper left.
If a field has a default entry that you would like to get rid of (often the page number appears in the central footer) simply include a command with a blank argument,
e.
\begin_inset space \thinspace{}
\end_inset
g.:
\end_layout
\begin_layout LyX-Code
\backslash
cfoot{}
\end_layout
\begin_layout Standard
There is,
however,
an easier way to make simple changes.
If you load the
\family sans
\bar under
D
\bar default
ocument\SpecialChar menuseparator
\bar under
S
\bar default
ettings\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Page Layout\SpecialChar menuseparator
Custom Header/Footer Text
\family default
module,
you will find you have six new environments corresponding to the six fields described above.
\end_layout
\begin_layout Standard
Let's get really fancy:
lets put the section number with the word
\begin_inset Quotes eld
\end_inset
Section
\begin_inset Quotes erd
\end_inset
(e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
Section 3) in the upper left,
the page number (e.
\begin_inset space \thinspace{}
\end_inset
g.
\begin_inset space \space{}
\end_inset
Page 4) in the upper right,
your name in the lower left,
and the date in the lower right.
Use your newly enabled environments to add these entries:
\end_layout
\begin_layout LyX-Code
\family sans
Left
\begin_inset space ~
\end_inset
header:
\family default
\series bold
\family roman
\series default
Section
\family typewriter
\family default
\backslash
thesection
\end_layout
\begin_layout LyX-Code
\family sans
Center header:
\end_layout
\begin_layout LyX-Code
\family sans
Right header:
\family default
\family roman
Page
\family typewriter
\family default
\backslash
thepage
\end_layout
\begin_layout LyX-Code
\family sans
Left footer:
\family default
\family roman
John Q.
DocWriter
\end_layout
\begin_layout LyX-Code
\family sans
Center footer:
\end_layout
\begin_layout LyX-Code
\family sans
Right footer:
\family default
\series bold
\series default
\backslash
today
\end_layout
\begin_layout Standard
Make sure you enter the commands
\family typewriter
\backslash
thesection
\family default
,
\family typewriter
\backslash
thepage
\family default
and
\family typewriter
\backslash
today
\family default
as \SpecialChar TeX
Code commands
\series bold
.
\series default
The commands
\family typewriter
\backslash
thesection
\family default
and
\family typewriter
\backslash
thepage
\family default
access \SpecialChar LaTeX
’s section and page counters,
and so print out the current section and page numbers.
\family typewriter
\backslash
today
\family default
simply prints out today’s date.
\end_layout
\begin_layout Standard
The thicknesses of the horizontal rules drawn beneath the header and above the footer can also be modified.
If you don't want one of the rules,
set its thickness to 0.
The header rule has a default thickness of 0.4pt,
the footer rule is 0pt.
For this you will need to use \SpecialChar TeX
Code commands like
\end_layout
\begin_layout Standard
\family typewriter
\backslash
renewcommand{
\backslash
headrulewidth}{0.4pt}
\family default
and
\end_layout
\begin_layout Standard
\family typewriter
\backslash
renewcommand{
\backslash
footrulewidth}{0.4pt}
\family default
to set the thicknesses.
\end_layout
\begin_layout Standard
You can switch the header/footer settings on and off for individual pages using \SpecialChar TeX
Code commands like
\family typewriter
\backslash
thispagestyle{empty}
\family default
,
\family typewriter
\backslash
thispagestyle{plain}
\family default
,
and
\family typewriter
\backslash
thispagestyle{fancy}
\family default
.
Simply insert them in the text on the page you want changed and mark them as \SpecialChar TeX
code.
In fact,
title pages are marked as plain by default,
while following pages are marked fancy when using the global fancy setting.
\end_layout
\begin_layout Standard
If you want a header or footer to be on the outer side of a two sided document,
you need to use something like:
\end_layout
\begin_layout LyX-Code
\backslash
fancyfoot{}
\end_layout
\begin_layout LyX-Code
\backslash
fancyfoot[LE,RO]{
\backslash
thepage}
\end_layout
\begin_layout Standard
The first command clears all existing footers avoiding any conflicts with your new command.
\end_layout
\begin_layout Standard
You can enter any of these commands,
the simpler ones in any of your new environments,
the more complex ones as \SpecialChar TeX
Code commands,
at any point in your document and they will take effect on the next page.
\end_layout
\begin_layout Standard
As a final example,
it is possible to include an image in the header or footer.
Suppose you want to put a company logo in the upper left hand corner.
You might try something like this in
\family sans
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
LaTeX Preamble
\family default
:
\end_layout
\begin_layout LyX-Code
\backslash
lhead{
\backslash
resizebox{1in}{!}{
\backslash
includegraphics{logo.png}}}
\end_layout
\begin_layout Standard
\noindent
You may need to preface this with
\family typewriter
\backslash
usepackage{graphics}
\family default
if you don't include graphics elsewhere in your document.
\end_layout
\begin_layout Standard
For more information on fancy headers,
you can get the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
fancyhdr
\end_layout
\end_inset
documentation from
\begin_inset CommandInset href
LatexCommand href
name "CTAN"
target "http://www.ctan.org/pkg/fancyhdr"
literal "false"
\end_inset
.
\end_layout
\begin_layout Subsection
Landscape Document Parts
\end_layout
\begin_layout Standard
This module outputs parts of the document in landscape mode using
\family sans
Insert\SpecialChar menuseparator
Custom Insets\SpecialChar menuseparator
Landscape
\family default
or
\family sans
Insert\SpecialChar menuseparator
Custom Insets\SpecialChar menuseparator
Landscape (Floating)
\family default
.
\end_layout
\begin_layout Subsection
\begin_inset CommandInset label
LatexCommand label
name "sec:Multiple-Columns"
\end_inset
Multiple Columns
\end_layout
\begin_layout Standard
This module uses the
\family sans
multicol
\family default
\begin_inset Index idx
range none
pageformat default
status collapsed
\begin_layout Plain Layout
\SpecialChar LaTeX
-packages !
multicol
\end_layout
\end_inset
package and is independent of the option
\family sans
Two-
\bar under
c
\bar default
olumn document
\family default
in the
\family sans
\bar under
D
\bar default
ocument\SpecialChar menuseparator
\bar under
S
\bar default
ettings\SpecialChar menuseparator
Text
\begin_inset space ~
\end_inset
Layout
\family default
dialog.
If you want to have two columns for the whole document,
you are recommended to use the
\family sans
Two-
\bar under
c
\bar default
olumn document
\family default
option.
For all other cases use this module.
\end_layout
\begin_layout Standard
Footnotes within multiple columns will be placed at the bottom of the page and not under each column.
Within the different columns you can use everything,
with the limitation that for floats you need to check the option
\family sans
\bar under
S
\bar default
pan
\begin_inset space ~
\end_inset
columns
\family default
in
\family sans
\bar under
E
\bar default
dit\SpecialChar menuseparator
Flo
\bar under
a
\bar default
t
\begin_inset space ~
\end_inset
Settings
\family default
.
\end_layout
\begin_layout Subsubsection
Basics
\end_layout
\begin_layout Standard
If you want to have two columns in your text,
insert a multicolumn inset via the menu
\family sans
Insert\SpecialChar menuseparator
Custom
\begin_inset space ~
\end_inset
Insets\SpecialChar menuseparator
Multiple
\begin_inset space ~
\end_inset
Columns
\family default
where the columns should start.
Write all text that should be printed in 2
\begin_inset space ~
\end_inset
columns into this inset.
\end_layout
\begin_layout Standard
Here is an example:
\end_layout
\begin_layout Standard
\noindent
\begin_inset Flex Multiple Columns
status open
\begin_layout Plain Layout
\noindent
\series bold
\size small
The Adventure of the Empty House
\series default
\begin_inset Newline newline
\end_inset
by
\noun on
Sir Arthur Conan Doyle
\end_layout
\begin_layout Plain Layout
\size small
It was in the spring of the year 1894 that all London was interested,
and the fashionable world dismayed,
by the murder of the Honourable Ronald Adair under most unusual and inexplicable circumstances.
The public has already learned those particulars of the crime which came out in the police investigation,
but a good deal was suppressed upon that occasion,
since the case for the prosecution was so overwhelmingly strong that it was not necessary to bring forward all the facts.
Only now,
at the end of nearly ten years,
am I allowed to supply those missing links which make up the whole of that remarkable chain.
The crime was of interest in itself,
but that interest was as nothing to me compared to the inconceivable sequel,
which afforded me the greatest shock and surprise of any event in my adventurous life.
Even now,
after this long interval,
I find myself thrilling as I think of it,
and feeling once more that sudden flood of joy,
amazement,
and incredulity which utterly submerged my mind.
Let me say to that public,
which has shown some interest in those glimpses which I have occasionally given them of the thoughts and actions of a very remarkable man,
that they are not to blame me if I have not shared my knowledge with them,
for I should have considered it my first duty to do so,
had I not been barred by a positive prohibition from his own lips,
which was only withdrawn upon the third of last month.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
To get 3 or more columns,
set the cursor into the multicolumn inset and use the menu
\family sans
Insert\SpecialChar menuseparator
Number
\begin_inset space ~
\end_inset
of
\begin_inset space ~
\end_inset
Columns
\family default
.
The number of the desired columns is written into that inset (for 3
\begin_inset space ~
\end_inset
columns write
\begin_inset Quotes eld
\end_inset
3
\begin_inset Quotes erd
\end_inset
).
\begin_inset Newline newline
\end_inset
Here is an example with 3
\begin_inset space ~
\end_inset
columns:
\end_layout
\begin_layout Standard
\begin_inset Flex Multiple Columns
status open
\begin_layout Plain Layout
\size footnotesize
\begin_inset Argument 1
status open
\begin_layout Plain Layout
3
\end_layout
\end_inset
It can be imagined that my close intimacy with Sherlock Holmes had interested me deeply in crime,
and that after his disappearance I never failed to read with care the various problems which came before the public.
And I even attempted,
more than once,
for my own private satisfaction,
to employ his methods in their solution,
though with indifferent success.
There was none,
however,
which appealed to me like this tragedy of Ronald Adair.
As I read the evidence at the inquest,
which led up to a verdict of willful murder against some person or persons unknown,
I realized more clearly than I had ever done the loss which the community had sustained by the death of Sherlock Holmes.
There were points about this strange business which would,
I was sure,
have specially appealed to him,
and the efforts of the police would have been supplemented,
or more probably anticipated,
by the trained observation and the alert mind of the first criminal agent in Europe.
All day,
as I drove upon my round,
I turned over the case in my mind and found no explanation which appeared to me to be adequate.
At the risk of telling a twice-told tale,
I will recapitulate the facts as they were known to the public at the conclusion of the inquest.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
You can have up to 10
\begin_inset space ~
\end_inset
columns if you want to,
but that might not be very pleasant for the readers of your document.
\end_layout
\begin_layout Subsubsection
Columns inside Columns
\end_layout
\begin_layout Standard
You can also have columns inside columns:
\end_layout
\begin_layout Standard
\begin_inset Flex Multiple Columns
status open
\begin_layout Plain Layout
\size footnotesize
The Honourable Ronald Adair was the second son of the Earl of Maynooth,
at that time governor of one of the Australian colonies.
Adair's mother had returned from Australia to undergo the operation for cataract,
and she,
her son Ronald,
and her daughter Hilda were living together at 427 Park Lane.
\end_layout
\begin_layout Plain Layout
\begin_inset Flex Multiple Columns
status open
\begin_layout Plain Layout
\size footnotesize
The youth moved in the best society
\begin_inset space ~
\end_inset
– had,
so far as was known,
no enemies and no particular vices.
He had been engaged to Miss Edith Woodley,
of Carstairs,
but the engagement had been broken off by mutual consent some months before,
and there was no sign that it had left any very profound feeling behind it.
For the rest {sic} the man's life moved in a narrow and conventional circle,
for his habits were quiet and his nature unemotional.
Yet it was upon this easy-going young aristocrat that death came,
in most strange and unexpected form,
between the hours of ten and eleven-twenty on the night of March 30,
1894.
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\size footnotesize
Ronald Adair was fond of cards
\begin_inset space ~
\end_inset
– playing continually,
but never for such stakes as would hurt him.
He was a member of the Baldwin,
the Cavendish,
and the Bagatelle card clubs.
It was shown that,
after dinner on the day of his death,
he had played a rubber of whist at the latter club.
He had also played there in the afternoon.
\size default
\size footnotesize
The evidence of those who had played with him
\begin_inset space ~
\end_inset
– Mr.
Murray,
Sir John Hardy,
and Colonel Moran
\begin_inset space ~
\end_inset
– showed that the game was whist,
and that there was a fairly equal fall of the cards.
Adair might have lost five pounds,
but not more.
His fortune was a considerable one,
and such a loss could not in any way affect him.
He had played nearly every day at one club or other,
but he was a cautious player,
and usually rose a winner.
It came out in evidence that,
in partnership with Colonel Moran,
he had actually won as much as four hundred and twenty pounds in a sitting,
some weeks before,
from Godfrey Milner and Lord Balmoral.
So much for his recent history as it came out at the inquest.
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
Advanced Examples
\end_layout
\begin_layout Standard
The examples in this section show some more special features of multiple columns.
in frustration because some constructs in \SpecialChar LaTeX
are sometimes non-intuitive,
and easy to forget.
The program runs over your \SpecialChar LaTeX
file,
checks the integrity of the file,
and flags some common errors.
In other technical words,
it is
\family typewriter
lint
\family default
for \SpecialChar LaTeX
.
\end_layout
\begin_layout Standard
Well,
what is a syntax checker doing in \SpecialChar LyX
which is supposed to produce correct \SpecialChar 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
Chk\SpecialChar TeX
\family default
catches some common
\emph on
typographic
\emph default
errors,
in addition to the syntactical ones.
Specifically,
\family sans
Chk\SpecialChar TeX
\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
If you have bad luck,
the text will break right between the referenced text and reference number,
and that's a pity.
See section
\begin_inset CommandInset ref
LatexCommand ref
reference "sec:chktex"
nolink "false"
\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 \SpecialChar LyX
generate a \SpecialChar LaTeX
file of your document,
start
\family sans
Chk\SpecialChar TeX
\family default
to check it,
and then make \SpecialChar LyX
insert
\begin_inset Quotes eld
\end_inset
error boxes
\begin_inset Quotes erd
\end_inset
with the warnings from
\family sans
Chk\SpecialChar TeX
\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
Chk\SpecialChar TeX
\family default
,
and this gap can make some warnings seem arcane or just 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
Chk\SpecialChar TeX
\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
Chk\SpecialChar TeX
\family default
to get better along with you.
\end_layout
\begin_layout Standard
Although
\family sans
Chk\SpecialChar TeX
\family default
\emph on
is
\emph default
very configurable and extensible,
you should not expect to solve all problems with
\family sans
Chk\SpecialChar TeX
\family default
in \SpecialChar LyX
this way.
Since \SpecialChar LyX
has to generate a somewhat special \SpecialChar LaTeX
file to be able to match the line numbers from the
\family sans
Chk\SpecialChar TeX
\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
Document\SpecialChar menuseparator
\SpecialChar 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 appear correctly.
There are two things you can do about this:
\end_layout
\begin_layout Itemize
Fine tune the
\family sans
Chk\SpecialChar TeX
\family default
invocation command line in
\family sans
Tools\SpecialChar menuseparator
Preferences\SpecialChar menuseparator
Output\SpecialChar menuseparator
LaTeX\SpecialChar menuseparator
CheckTeX command
\family default
,
or the global
\family sans
Chk\SpecialChar TeX
\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 \SpecialChar LaTeX
file using
\family sans
File\SpecialChar menuseparator
Export\SpecialChar menuseparator
\SpecialChar 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 \SpecialChar 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
".
\end_layout
\begin_layout Standard
Notice that you should only use the options that enable and disable warnings,
because \SpecialChar 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
chktex
\family default
.
\end_layout
\begin_layout Enumerate
\size small
\emph on
Command terminated with space.
\end_layout
\begin_layout Enumerate
\size small
Non-breaking space (
\begin_inset Quotes eld
\end_inset
\family typewriter
~
\family default
\begin_inset Quotes erd
\end_inset
) should have been used.
\end_layout
\begin_layout Enumerate
\size small
\emph on
You should enclose the previous parenthesis with
\begin_inset Quotes eld
\end_inset
\family typewriter
{}
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
Italic correction (
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
/
\family default
\begin_inset Quotes erd
\end_inset
) found in non-italic buffer.
\end_layout
\begin_layout Enumerate
\size small
Italic correction (
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
/
\family default
\begin_inset Quotes erd
\end_inset
) found more than once.
\end_layout
\begin_layout Enumerate
\size small
\emph on
No italic correction (
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
/
\family default
\begin_inset Quotes erd
\end_inset
) found.
\end_layout
\begin_layout Enumerate
\size small
Accent command
\begin_inset Quotes eld
\end_inset
\family typewriter
cmd
\family default
\begin_inset Quotes erd
\end_inset
needs use of
\begin_inset Quotes eld
\end_inset
\family typewriter
cmd
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
Wrong length of dash may have been used.
\end_layout
\begin_layout Enumerate
\size small
\emph on
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
expected,
found
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
Solo
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
found.
\end_layout
\begin_layout Enumerate
\size small
You should use
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
to achieve an ellipsis.
\end_layout
\begin_layout Enumerate
\size small
Inter-word spacing (
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
\family default
\begin_inset Quotes eld
\end_inset
) should perhaps be used.
\end_layout
\begin_layout Enumerate
\size small
Inter-sentence spacing (
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
@
\family default
\begin_inset Quotes erd
\end_inset
) should perhaps be used.
\end_layout
\begin_layout Enumerate
\size small
Could not find argument for command.
\end_layout
\begin_layout Enumerate
\size small
No match found for
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
Math mode still on at end of \SpecialChar LaTeX
file.
\end_layout
\begin_layout Enumerate
\size small
Number of
\begin_inset Quotes eld
\end_inset
\family typewriter
char
\family default
\begin_inset Quotes erd
\end_inset
doesn't match the number of
\begin_inset Quotes eld
\end_inset
\family typewriter
char
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
You should use either
\family typewriter
\begin_inset Quotes eld
\end_inset
\family default
or
\family typewriter
\begin_inset Quotes erd
\end_inset
\family default
as an alternative to
\begin_inset Quotes eld
\end_inset
\family typewriter
"
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
You should use "
\family typewriter
'
\family default
" (ASCII 39) instead of "
\family typewriter
´
\family default
" (ASCII 180).
\end_layout
\begin_layout Enumerate
\size small
User-specified pattern found.
\end_layout
\begin_layout Enumerate
\size small
This command might not be intended.
\end_layout
\begin_layout Enumerate
\size small
\emph on
Comment displayed.
\end_layout
\begin_layout Enumerate
\size small
Either
\family typewriter
''
\backslash
,'
\family default
or
\family typewriter
'
\backslash
,''
\family default
will look better.
\end_layout
\begin_layout Enumerate
\size small
Delete this space to maintain correct page references.
\end_layout
\begin_layout Enumerate
\size small
\emph on
You might wish to put this between a pair of
\begin_inset Quotes eld
\end_inset
\family typewriter
{}
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Enumerate
\size small
You ought to remove spaces in front of punctuation.
\end_layout
\begin_layout Enumerate
\size small
Could not execute \SpecialChar LaTeX
command.
\end_layout
\begin_layout Enumerate
\size small
Don't use
\family typewriter
\backslash
/
\family default
in front of small punctuation.
\end_layout
\begin_layout Enumerate
\family typewriter
\size small
$
\backslash
times$
\family default
may look prettier here.
\end_layout
\begin_layout Enumerate
\size small
\emph on
Multiple spaces detected in output.
\end_layout
\begin_layout Enumerate
\size small
This text may be ignored.
\end_layout
\begin_layout Enumerate
\size small
Use
\family typewriter
\begin_inset Quotes eld
\end_inset
\family default
to begin quotation,
not
\family typewriter
'
\family default
.
\end_layout
\begin_layout Enumerate
\size small
Use
\family typewriter
'
\family default
to end quotation,
not
\family typewriter
\begin_inset Quotes eld
\end_inset
\family default
.
\end_layout
\begin_layout Enumerate
\size small
Don't mix quotes.
\end_layout
\begin_layout Enumerate
\size small
You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
cmd
\family default
\begin_inset Quotes erd
\end_inset
instead.
\end_layout
\begin_layout Enumerate
\size small
You should put a space in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
\size small
You should avoid spaces in front of/after parenthesis.
\end_layout
\begin_layout Enumerate
\size small
\emph on
You should not use punctuation in front of/after quotes.
\end_layout
\begin_layout Enumerate
\size small
Double space found.
\end_layout
\begin_layout Enumerate
\size small
You should put punctuation outside inner/inside display math mode.
\end_layout
\begin_layout Enumerate
\size small
You ought to not use primitive \SpecialChar TeX
in \SpecialChar LaTeX
code.
\end_layout
\begin_layout Enumerate
\size small
You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Enumerate
\size small
\begin_inset Quotes eld
\end_inset
\family typewriter
%s
\family default
\begin_inset Quotes erd
\end_inset
is normally not followed by
\begin_inset Quotes eld
\end_inset
\family typewriter
%c
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Standard
In later versions of \SpecialChar 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 \SpecialChar LyX
\end_layout
\begin_layout Standard
by
\noun on
Lars Gullik Bjønnes
\noun default
and
\noun on
Pavel Sanda
\end_layout
\begin_layout Subsection
Introduction
\end_layout
\begin_layout Standard
\SpecialChar LyX
supports some of the most basic RCS/CVS/SVN/GIT commands.
If you need something a bit more sophisticated you will have to do that manually in a terminal or your favourite client.
\end_layout
\begin_layout Standard
Also note that CVS support is not as good as subversion support,
so we advise using SVN instead.
A good place to start learning Subversion is the SVN Book
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\begin_inset CommandInset href
LatexCommand href
target "http://svnbook.red-bean.com/"
literal "false"
\end_inset
\end_layout
\end_inset
.
In the case of RCS you should read
\begin_inset Quotes eld
\end_inset
rcsintro
\begin_inset Quotes erd
\end_inset
(a man file,
read it with
\family typewriter
man rcsintro
\family default
).
This file describes all the basic features of RCS.
You should especially notice the comment about a RCS directory,
and the notion of a master RCS file (the file ending in
\family typewriter
,v
\family default
).
\end_layout
\begin_layout Standard
Before you begin to use the version control features in \SpecialChar LyX
,
you should be familiar with RCS/CVS/SVN/GIT usage.
The implementation in \SpecialChar LyX
assumes a recent version of the GNU RCS or CVS/SVN package —
no guarantees are made for older versions.
Most of the log messages are not currently displayed after operations —
you can check them in the Messages pane if you are unsure.
Regular users of version control will appreciate the VC toolbar,
which can be enabled via
\family sans
View\SpecialChar menuseparator
Toolbars\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
Control
\family default
.
\end_layout
\begin_layout Standard
For introducing your own external commands consult
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
vc-command
\end_layout
\end_inset
in the manual
\emph on
\SpecialChar LyX
Functions
\emph default
.
\end_layout
\begin_layout Standard
It is strongly recommended to store documents in uncompressed format if using version control (uncheck
\family sans
Document\SpecialChar menuseparator
Compressed
\family default
if it is checked):
Uncompressed LyX documents are text files and therefore for merging two different versions by version control systems.
Compressed LyX documents are binary files,
which cannot be merged by version control systems.
Also to avoid unnecessary merge conflicts we advise to disable
\family sans
Document\SpecialChar menuseparator
Settings\SpecialChar menuseparator
Output\SpecialChar menuseparator
Save transient properties
\family default
when more users work on the same document.
\end_layout
\begin_layout Subsection
RCS commands in \SpecialChar LyX
\end_layout
\begin_layout Standard
The following sections describe the RCS commands supported by \SpecialChar LyX
.
You can find them in the
\family sans
File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
Control
\family default
submenu.
\SpecialChar LyX
was tested against RCS 5.7/5.8/5.10.
\end_layout
\begin_layout Subsubsection
\family sans
Register
\end_layout
\begin_layout Standard
If your document is not under revision control,
this is the only item shown in the menu.
And if it is under revision control,
the
\family sans
Register
\family default
item is not visible.
\end_layout
\begin_layout Standard
This command registers your document with RCS (unless you are under the directory managed by CVS)\SpecialChar endofsentence
You are asked interactively to supply an initial description of the document.
The document is now set in Read-Only mode and you have to
\family sans
Check
\begin_inset space ~
\end_inset
Out
\begin_inset space ~
\end_inset
For
\begin_inset space ~
\end_inset
Edit
\family default
,
before making any changes to it.
A document under revision control has a
\begin_inset Quotes eld
\end_inset
[RCS:<version> <locker>]
\begin_inset Quotes erd
\end_inset
item tagged to the filename in the minibuffer.
\end_layout
\begin_layout Standard
RCS command that is run:
\end_layout
\begin_layout LyX-Code
\family typewriter
ci -q -u -i -t-"<initial description>" <file-name>
\end_layout
\begin_layout Standard
Read
\family typewriter
man ci
\family default
to understand the switches.
\end_layout
\begin_layout Subsubsection
\family sans
Check In Changes
\end_layout
\begin_layout Standard
When you are finished editing a file,
you check in your changes.
When you do this,
you are asked for a description of the changes.
This is stored in the history log.
The version number is bumped,
your changes are applied to the master RCS file,
the document is unlocked and set to Read-Only mode.
\end_layout
\begin_layout Itemize
RCS command:
\family typewriter
ci -q -u -m"<description>" <file-name>
\end_layout
\begin_layout Subsubsection
\family sans
Check Out For Edit
\end_layout
\begin_layout Standard
By doing this you lock the document so that only you can edit it.
This will also make the document Read-Write only for you.
You will usually continue editing for a while and when you are finished you check in your changes.
The status line is changed to reflect that you have locked the file.
\end_layout
\begin_layout Itemize
RCS command:
\family typewriter
co -q -l <file-name>
\end_layout
\begin_layout Subsubsection
\family sans
Revert To Repository Version
\end_layout
\begin_layout Standard
This will discard all changes made to the document since the last check in.
You get a warning before changes are discarded.
\end_layout
\begin_layout Itemize
RCS command:
\family typewriter
co -f -u<version> <file-name>
\end_layout
\begin_layout Subsubsection
\family sans
Copy
\end_layout
\begin_layout Standard
This will create a copy of the current document.
Since RCS does not support copy operations natively,
the version history is not preserved,
and the copy is added as a new file.
It requires a clean document without any changes since the last checkin.
You are asked for a file name and a description of the copy operation.
After that the copy is created,
both locally and in the repository.
If the parent directories of the copied and original document differ,
all relative paths of included files of the copy are adjusted (like in
\family sans
File\SpecialChar menuseparator
Save As
\family default
\SpecialChar ldots
).
Finally,
the copy is loaded instead of the original document.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
RCS
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
Copy
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family typewriter
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\end_inset
to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
\family typewriter
\begin_inset Quotes qld
\end_inset
<new-file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
ci -q -u
\family typewriter
-i
\begin_inset Quotes qld
\end_inset
<new-file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Undo Last Checkin
\end_layout
\begin_layout Standard
This makes as if the last check in never happened.
No changes are made to the document loaded into \SpecialChar LyX
,
but the last version is removed from the master RCS file.
\end_layout
\begin_layout Itemize
RCS command:
\family typewriter
rcs -o<version> <file-name>
\end_layout
\begin_layout Subsubsection
\family sans
Show History
\end_layout
\begin_layout Standard
This shows the complete history of the RCS document.
The output of
\family typewriter
rlog <file-name>
\family default
is shown in a browser.
See
\family typewriter
man rlog
\family default
for more info.
\end_layout
\begin_layout Subsubsection
Revision info
\end_layout
\begin_layout Standard
\SpecialChar LyX
supports RCS version number,
author name,
date and time of last commit.
All those are extracted from
\family typewriter
rlog -r <file-name>
\family default
.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:VCS-Revision-Information"
nolink "false"
\end_inset
for details.
\end_layout
\begin_layout Subsection
CVS commands in \SpecialChar LyX
\end_layout
\begin_layout Standard
A subset of CVS operations is supported by \SpecialChar LyX
.
You can find the commands in the
\family sans
File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
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 Subsubsection
\family sans
General CVS usage
\end_layout
\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 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 don'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
reserved checkouts
\begin_inset Quotes erd
\end_inset
.
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 \SpecialChar LyX
one has to edit the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.cvsrc
\end_layout
\end_inset
file and add the line
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cvs -r
\end_layout
\end_inset
to work with reserved checkouts.
The benefit is the possibility to see who is using a writable copy of some document.
It's not guaranteed only one user makes a copy writable.
\end_layout
\begin_layout Standard
\SpecialChar 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 Noun
status collapsed
\begin_layout Plain Layout
Check Out
\end_layout
\end_inset
to make your working copy writable if it's readonly.
After doing so the
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Check In
\end_layout
\end_inset
operation is possible and that makes your working copy readonly again after transferring your changes to the repository.
\end_layout
\begin_layout Standard
More information about CVS can be found here
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
http://www.nongnu.org/cvs
\end_layout
\end_inset
and here
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
http://ximbiot.com/cvs
\end_layout
\end_inset
.
\end_layout
\begin_layout Standard
Read
\family typewriter
man cvs
\family default
to understand the sub-commands and the switches mentioned below.
\end_layout
\begin_layout Subsubsection
\family sans
Register
\end_layout
\begin_layout Standard
If your document is not under revision control,
this is the only item shown in the menu.
And if it is under revision control,
the
\family sans
Register
\family default
item is not visible.
\end_layout
\begin_layout Standard
This command registers in CVS your document
\begin_inset Flex Strong
status collapsed
\begin_layout Plain Layout
\emph on
only
\end_layout
\end_inset
in the 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 create or checkout the archive by yourself using external tools.
(In case you forget that step \SpecialChar LyX
registers the document with RCS.)
\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 checked in.
\end_layout
\begin_layout Standard
CVS command that is run:
\family typewriter
cvs -q add -m"<entered message>" "<file-name>"
\end_layout
\begin_layout Standard
The term
\family typewriter
"<file-name>"
\family default
above and for all other CVS commands is an abbreviation for
\begin_inset Quotes eld
\end_inset
change the current working directory to file location and use the file name without path component as argument
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Subsubsection
\family sans
Check In Changes
\end_layout
\begin_layout Standard
When you are finished editing a file,
you commit your changes.
When you do this 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 Noun
status collapsed
\begin_layout Plain Layout
Check Out
\end_layout
\end_inset
is undone.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
CVS
\begin_inset space ~
\end_inset
command:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cvs
\family typewriter
-q commit -m"<description>" "<file-name>"
\end_layout
\end_inset
or
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cvs -q unedit
\family typewriter
"<file-name>"
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Check Out Changes
\end_layout
\begin_layout Standard
When you are sharing a repository with others,
you may have to incorporate their changes into your working copy.
\end_layout
\begin_layout Standard
CVS command:
\family typewriter
cvs -q update "<file-name>"
\end_layout
\begin_layout Standard
If a readonly checkout is detected the working copy is made writable and reserved.
\end_layout
\begin_layout Standard
CVS command:
\family typewriter
cvs -q edit "<file-name>"
\end_layout
\begin_layout Subsubsection
\family sans
Revert To Repository Version
\end_layout
\begin_layout Standard
This will discard all changes made to the document since the last check in.
You get a warning before changes are discarded.
Firstly the file is deleted,
secondly CVS update command is run.
\end_layout
\begin_layout Standard
CVS command:
\family typewriter
cvs -q update "<file-name>"
\end_layout
\begin_layout Standard
If a reserved checkout is detected and the working copy has no changes only the reservation is undone.
\end_layout
\begin_layout Standard
CVS command:
\family typewriter
cvs -q unedit "<file-name>"
\end_layout
\begin_layout Subsubsection
\family sans
Copy
\end_layout
\begin_layout Standard
This will create a copy of the current document.
Since CVS does not support copy operations natively,
the version history is not preserved,
and the copy is added as a new file.
It requires a clean document without any changes since the last checkin.
You are asked for a file name and a description of the copy operation.
After that the copy is created,
both locally and in the repository.
If the parent directories of the copied and original document differ,
all relative paths of included files of the copy are adjusted (like in
\family sans
File\SpecialChar menuseparator
Save As
\family default
\SpecialChar ldots
).
Finally,
the copy is loaded instead of the original document.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
CVS
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
Copy
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
"<file-name>"
\end_layout
\end_inset
to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
"<new-file-name>"
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cvs -q add "<new-file-name>"
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Rename
\end_layout
\begin_layout Standard
This will rename the current document.
Since CVS does not support rename operations natively,
the version history is not preserved,
the renamed document is added as a new file,
and the original document is deleted.
It requires a clean document without any changes since the last checkin.
You are asked for a file name and a description of the rename operation.
After that the document is renamed,
both locally and in the repository.
If the parent directories of the new and old file names differ,
all relative paths of included files are adjusted (like in
\family sans
File\SpecialChar menuseparator
Save As
\family default
\SpecialChar ldots
).
Finally,
the document is reloaded using the new name.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
CVS
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
Rename
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
"<file-name>"
\end_layout
\end_inset
to
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
"<new-file-name>"
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cvs -q add "<new-file-name>"
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cvs -q remove "<file-name>"
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
Update of the local directory checkout from repository
\end_layout
\begin_layout Standard
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
\end_inset
files and so on using version control becomes more complicated.
\SpecialChar 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
The
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update local directory from repository
\end_layout
\end_inset
command updates the whole directory.
If local changes are detected user is warned before update starts.
In case of merge conflicts both versions of the conflicting document parts are placed in the final document.
You have to review and correct the result of the merge.
You'll find the conflicts enclosed in pairs of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
<<<<<<<
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
>>>>>>>
\end_layout
\end_inset
separated by
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
=======
\end_layout
\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
\end_inset
signs.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
CVS
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cd $path;
cvs diff
\family typewriter
"."
\end_layout
\end_inset
(Ask if changes are detected.)
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
cd $path;
cvs -q update
\family typewriter
"."
\end_layout
\end_inset
\end_layout
\begin_layout Standard
where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
$path
\end_layout
\end_inset
stands for the path to the document.
\end_layout
\begin_layout Subsubsection
\family sans
Show History
\end_layout
\begin_layout Standard
This shows the complete history of the CVS document.
The output of
\family typewriter
cvs log "<file-name>"
\family default
is shown in a browser.
\end_layout
\begin_layout Subsubsection
Revision info
\end_layout
\begin_layout Standard
\SpecialChar LyX
supports CVS version number,
author name,
date and time of last commit.
All those are extracted from
\family typewriter
cvs log -r <file-name>
\family default
.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:VCS-Revision-Information"
nolink "false"
\end_inset
for details.
\end_layout
\begin_layout Subsection
SVN commands in \SpecialChar LyX
\end_layout
\begin_layout Standard
SVN is now partially supported by \SpecialChar LyX
.
You can find the commands in the
\family sans
File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
Control
\family default
submenu.
Please note that if you use password protected access to repository via ssh,
you will be asked in terminal window.
\SpecialChar LyX
was tested against SVN 1.5,
1.6,
1.7 and 1.8
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Most of the commands will work with 1.4 too,
see
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:SVN-Repo-Update"
nolink "false"
\end_inset
.
There seems to be currently unresolved permissions problem under SVN 1.8 with reverting changes when file is locked.
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Register
\end_layout
\begin_layout Standard
If your document is not under revision control,
this is the only item shown in the menu.
And if it is under revision control,
the
\family sans
Register
\family default
item is not visible.
\end_layout
\begin_layout Standard
This command registers in SVN your document ONLY in case you have already the documents directory under SVN control (in particular
\family typewriter
.svn/entries
\family default
file exists).
This means you have to checkout the archive by yourself.
\end_layout
\begin_layout Standard
Then you are asked interactively to supply an initial description of the document.
Don't forget that registered file is not yet commited.
\end_layout
\begin_layout Standard
SVN command that is run:
\family typewriter
svn add -q
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\begin_layout Standard
Read
\family typewriter
man svn
\family default
to understand the switches.
\end_layout
\begin_layout Subsubsection
\family sans
Check In Changes
\end_layout
\begin_layout Standard
When you are finished editing a file,
you commit your changes.
When you do this,
you are asked for a description of the changes.
After that changes are commited.
\end_layout
\begin_layout Standard
SVN command:
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
In case locking is not enabled.
See Section
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:SVN-File-Locking"
nolink "false"
\end_inset
.
\end_layout
\end_inset
\family typewriter
svn commit -q -m"<description>" <file-name>
\end_layout
\begin_layout Subsubsection
\family sans
Check Out For Edit
\end_layout
\begin_layout Standard
Updates the changes of this file from the repository.
Be sure you understand SVN merging and conflicts resolving before using this function,
because all conflicts has to be resolved manually by you!
\end_layout
\begin_layout Standard
SVN command:
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Ditto.
\end_layout
\end_inset
\family typewriter
svn update --non-interactive
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Revert To Repository Version
\end_layout
\begin_layout Standard
This will discard all changes made to the document since the last check in.
You get a warning before changes are discarded.
\end_layout
\begin_layout Standard
SVN command:
\family typewriter
svn revert -q
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Copy
\end_layout
\begin_layout Standard
This will create a copy of the current document including the version history.
It requires a clean document without any changes since the last checkin.
You are asked for a file name and a description of the copy operation.
After that the copy is created,
both locally and in the repository.
If the parent directories of the copied and original document differ,
all relative paths of included files of the copy are adjusted (like in
\family sans
File\SpecialChar menuseparator
Save As
\family default
\SpecialChar ldots
).
Finally,
the copy is loaded instead of the original document.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
SVN
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
svn copy -q
\family typewriter
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\begin_inset Quotes qld
\end_inset
<new-file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
svn commit
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Rename
\end_layout
\begin_layout Standard
This will rename the current document including the version history.
It requires a clean document without any changes since the last checkin.
You are asked for a file name and a description of the rename operation.
After that the document is renamed,
both locally and in the repository.
If the parent directories of the new and old file names differ,
all relative paths of included files are adjusted (like in
\family sans
File\SpecialChar menuseparator
Save As
\family default
\SpecialChar ldots
).
Finally,
the document is reloaded using the new name.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
SVN
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
svn move -q
\family typewriter
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\begin_inset Quotes qld
\end_inset
<new-file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
svn commit
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\begin_inset CommandInset label
LatexCommand label
name "subsec: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 shortcoming – they deal with the current document only.
Once your document contains pictures,
includes external
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
.tex
\end_layout
\end_inset
files and so on administration becomes more complicated.
\SpecialChar LyX
now supports updating the whole tree in which resides the document
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
One need to organize the files structure so that all external files are in the same directory or subdirectories of the document.
\end_layout
\end_inset
.
This become especially useful once you cooperate with people which neither know about subversion management nor they have ambition to commit additional material to the repository.
\end_layout
\begin_layout Standard
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
Update local directory from repository
\end_layout
\end_inset
command updates the whole directory and in case of merge conflicts local version of the files are left,
so no unintended data loss occurs.
If local changes are detected user is warned before update starts.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
SVN
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
svn diff $path
\end_layout
\end_inset
(Ask if changes are detected.)
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
svn update --accept mine-full $path
\end_layout
\end_inset
\end_layout
\begin_layout Standard
where
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
$path
\end_layout
\end_inset
stands for the path to the document.
\end_layout
\begin_layout Subsubsection
\family sans
Show History
\end_layout
\begin_layout Standard
This shows the complete history of the SVN document.
The output of
\family typewriter
svn log
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\family default
is shown in a browser.
\end_layout
\begin_layout Subsubsection
File Locking
\begin_inset CommandInset label
LatexCommand label
name "subsec:SVN-File-Locking"
\end_inset
\end_layout
\begin_layout Standard
The file exchange through various revision control systems brings the problem of merge conflicts in case two different users try to edit the same (parts of) document.
When such a conflict happens it needs manual resolving and one reasonable alternative is to provide some kind of locking mechanism,
which guarantees that only one user is allowed to edit file at the given time.
\end_layout
\begin_layout Standard
SVN has two such mechanisms to provide mutual exclusivity for file access – locks and automatic setting of write permissions (see sec.
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
GIT commands in \SpecialChar LyX
\end_layout
\begin_layout Standard
A minimal subset of GIT commands is now supported by \SpecialChar LyX
.
You can find the commands in the
\family sans
File\SpecialChar menuseparator
Version
\begin_inset space ~
\end_inset
Control
\family default
submenu.
Please note that if you use password protected access to repository via ssh,
you will be asked in terminal window.
\SpecialChar LyX
was tested against GIT 1.7/2.30.
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
Windows users please note that you need to ensure that git is on the path.
This can be set from within \SpecialChar LyX
at
\family sans
Tools\SpecialChar menuseparator
Preferences\SpecialChar menuseparator
Paths\SpecialChar menuseparator
PATH prefix
\family default
.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
One big difference of GIT and the other supported version control systems is the distributed nature of GIT:
With traditional version control systems there is one central server which hosts the repository.
Users commit their changes to the server,
and get updates made by other users from it.
With GIT,
users commit to a local repository.
The local repository can be synchronized with one or more remote repositories using the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
pull
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
push
\end_layout
\end_inset
GIT commands.
\SpecialChar LyX
does not interact in any way with remote GIT repositories.
It works exclusively with the local repository in a very similar way as with a central CVS or SVN repository.
If you use remote GIT repositories you need to do the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
pull
\end_layout
\end_inset
and
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
push
\end_layout
\end_inset
operations with your favourite GIT client.
\end_layout
\begin_layout Subsubsection
\family sans
Register
\end_layout
\begin_layout Standard
If your document is not under revision control,
this is the only item shown in the menu.
And if it is under revision control,
the
\family sans
Register
\family default
item is not visible.
\end_layout
\begin_layout Standard
This command registers in GIT your document ONLY in case you have already the documents directory under GIT control (in particular
\family typewriter
.git/index
\family default
file exists
\begin_inset Foot
status open
\begin_layout Plain Layout
For that both
\family typewriter
git init
\family default
*and* initial repository commit (or at least
\family typewriter
git add
\family default
) needs to be manually done.
\end_layout
\end_inset
).
This means you have to checkout the archive by yourself.
\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 committed.
\end_layout
\begin_layout Standard
GIT command that is run:
\family typewriter
git add
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\begin_layout Standard
Read
\family typewriter
man git
\family default
to understand the switches.
\end_layout
\begin_layout Subsubsection
\family sans
Check In Changes
\end_layout
\begin_layout Standard
When you are finished editing a file,
you commit your changes.
When you do this,
you are asked for a description of the changes.
After that changes are committed.
\end_layout
\begin_layout Standard
GIT command:
\family typewriter
git commit -q -m"<description>" <file-name>
\end_layout
\begin_layout Subsubsection
\family sans
Revert To Repository Version
\end_layout
\begin_layout Standard
This will discard all changes made to the document since the last check in.
You get a warning before changes are discarded.
\end_layout
\begin_layout Standard
GIT command:
\family typewriter
git checkout -q
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Rename
\end_layout
\begin_layout Standard
This will rename the current document including the version history.
It requires a clean document without any changes since the last checkin.
You are asked for a file name and a description of the rename operation.
After that the document is renamed,
both locally and in the repository.
If the parent directories of the new and old file names differ,
all relative paths of included files are adjusted (like in
\family sans
File\SpecialChar menuseparator
Save As
\family default
\SpecialChar ldots
).
Finally,
the document is reloaded using the new name.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
GIT
\begin_inset space ~
\end_inset
commands:
\begin_inset space ~
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
git mv
\family typewriter
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\begin_inset Quotes qld
\end_inset
<new-file-name>
\begin_inset Quotes qld
\end_inset
\end_layout
\end_inset
\begin_inset Newline newline
\end_inset
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
git commit
\end_layout
\end_inset
\end_layout
\begin_layout Subsubsection
\family sans
Show History
\end_layout
\begin_layout Standard
This shows the complete history of the GIT document.
The output of
\family typewriter
git log
\begin_inset Quotes qld
\end_inset
<file-name>
\begin_inset Quotes qld
\end_inset
\family default
is shown in a browser.
\end_layout
\begin_layout Subsubsection
Version Info
\end_layout
\begin_layout Standard
\SpecialChar LyX
supports GIT hash number of the last commit to the file,
its abbreviated form,
author name,
date and time of last commit.
All those are extracted from
\family typewriter
git log -n 1 --pretty=format:%H%n%h%n%an%n%ai
\family default
.
Tree version information is obtained via
\family typewriter
git describe --abbrev --dirty --long
\family default
.
See
\begin_inset CommandInset ref
LatexCommand ref
reference "subsec:VCS-Revision-Information"
nolink "false"
\end_inset
for other details.
\end_layout
\begin_layout Subsection
Further tuning
\end_layout
\begin_layout Standard
With the recent addition of the
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
vc-command
\end_layout
\end_inset
function \SpecialChar LyX
power users are allowed to create their own commands for revision control.
\end_layout
\begin_layout Standard
As an example you can see how two TortoiseSVN commands could be integrated directly:
\end_layout
\begin_layout Description
Commit:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
vc-command DR "." "TortoiseProc /command:commit /path:$$p"
\end_layout
\end_inset
\end_layout
\begin_layout Description
Revert:
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
vc-command DR "." "TortoiseProc /command:revert /path:$$p"
\end_layout
\end_inset
\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 \SpecialChar LyX
files,
which have more a complicated structure.
Hence we provide binding to the Document comparison feature.
There are two ways of calling this feature – either by direct call of
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
vc-compare
\end_layout
\end_inset
\SpecialChar LyX
function (for details see \SpecialChar LyX
functions manual) or by the toolbar icon
\begin_inset Info
type "icon"
arg "vc-compare"
\end_inset
or the menu item
\begin_inset Info
type "menu"
arg "vc-compare"
\end_inset
,
respectively.
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 Noun
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'.
We don't currently support GIT addressing of revisions,
one can just compare edited document with its revision X steps backs,
where X is addressed as
\begin_inset Flex Code
status collapsed
\begin_layout Plain Layout
HEAD~X
\end_layout
\end_inset
.
\end_layout
\begin_layout Section
\begin_inset CommandInset label
LatexCommand label
name "sec:Literate-Programming"
\end_inset
Literate Programming
\end_layout
\begin_layout Standard
Updated by
\noun on
Kayvan Sylvan
\noun default
(kayvan@sylvan.com)
\noun on
,
\noun default
original documentation written by
\noun on
Edmar Wienskoski Jr.
\noun default
(edmar-w-jr@technologist.com)
\end_layout
\begin_layout Subsection
Introduction
\end_layout
\begin_layout Standard
The main purpose of this documentation is to show you how to use \SpecialChar LyX
for literate programming,
where it is assumed that you are familiar with this programming technique,
and know what
\begin_inset Quotes eld
\end_inset
tangling
\begin_inset Quotes erd
\end_inset
and
\begin_inset Quotes eld
\end_inset
weaving
\begin_inset Quotes erd
\end_inset
means.
If that is not the case,
please follow the web links provided in the following sections.
There is a lot of good documentation out there covering old development history to the latest tools tips.
\end_layout
\begin_layout Standard
It is also assumed that you are familiar with \SpecialChar LyX
itself to a point that you are comfortable changing your \SpecialChar LyX
preferences,
and X resources file.
If that is not the case please refer to other \SpecialChar LyX
documentation to cover your specific needs.
\end_layout
\begin_layout Subsection
Literate Programming
\end_layout
\begin_layout Standard
From the Literate Programming FAQ:
\end_layout
\begin_layout Quotation
Literate programming is the combination of documentation and source together in a fashion suited for reading by human beings.
In fact,
literate programs should be enjoyable reading,
even inviting!
(Sorry Bob,
I couldn't resist!) In general,
literate programs combine source and documentation in a single file.
Literate programming tools then parse the file to produce either readable documentation or compilable source.
The WEB style of literate programming was created by D.
\begin_inset space \thinspace{}
\end_inset
E.
Knuth during the development of his \SpecialChar TeX
typesetting software.
\end_layout
\begin_layout Standard
Another excerpt says:
\end_layout
\begin_layout Quotation
\emph on
How is literate programming different from verbose commenting?
\end_layout
\begin_layout Quotation
There are three distinguishing characteristics.
In order of importance,
they are:
\end_layout
\begin_deeper
\begin_layout Itemize
flexible order of elaboration
\end_layout
\begin_layout Itemize
automatic support for browsing
\end_layout
\begin_layout Itemize
typeset documentation,
especially diagrams and mathematics
\end_layout
\end_deeper
\begin_layout Standard
Now that I sparked your curiosity,
take a look in the references.
\end_layout
\begin_layout Subsubsection
References
\end_layout
\begin_layout Standard
The complete Literate Programming FAQ can be found at:
\end_layout
\begin_layout Quote
Literate Programming FAQ
\begin_inset Flex URL
status open
\begin_layout Plain Layout
http://www.literateprogramming.com/lpfaq.pdf
\end_layout
\end_inset
\end_layout
\begin_layout Standard
The FAQ lists 23 (twenty three!) different literate programming tools.
Where some are specialized or
\begin_inset Quotes eld
\end_inset
tailored
\begin_inset Quotes erd
\end_inset
for particular programming languages,
while other have general scope.
I selected
\noun on
Noweb
\noun default
for my own use for several reasons:
\end_layout
\begin_layout Itemize
It can generate the documentation either in \SpecialChar LaTeX
or HTML.
\end_layout
\begin_layout Itemize
It has a open architecture,
i.
\begin_inset space \thinspace{}
\end_inset
e.
\begin_inset space \space{}
\end_inset
it is easy to plug in new filters
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
\emph on
Filters
\emph default
are programs that read a given data stream and output a manipulated data stream.
That way,
a WEB file (consisting of literate code) can be turned into a file consisting only of C program code or \SpecialChar LaTeX
code.
\end_layout
\end_inset
and to perform special processing that you may need.
\end_layout
\begin_layout Itemize
There is a good selection of filters available already (the HTML is one of them).
\end_layout
\begin_layout Itemize
It is free.
\end_layout
\begin_layout Standard
The Noweb web page can be found at:
\end_layout
\begin_layout Quote
Noweb home page
\begin_inset Flex URL
status collapsed
\begin_layout Plain Layout
https://www.cs.tufts.edu/~nr/noweb/
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Starting from there you can reach many other interesting links and even some literate program examples.
\end_layout
\begin_layout Subsection
\SpecialChar LyX
and Literate Programming with Noweb
\end_layout
\begin_layout Standard
The \SpecialChar LyX
support for Literate Programming is provided by using the generic \SpecialChar LyX
converters mechanism.
This support is provided in a
\begin_inset Quotes eld
\end_inset
Noweb independent
\begin_inset Quotes erd
\end_inset
way,
i.
\begin_inset space \thinspace{}
\end_inset
e.
\begin_inset space \space{}
\end_inset
you will be able to use this new \SpecialChar LyX
feature with some other literate programming tool of your choice by just changing your \SpecialChar LyX
preferences.
\end_layout
\begin_layout Subsubsection
Generating documents and code (weaving and tangling)
\end_layout
\begin_layout Paragraph
Using the noweb module
\end_layout
\begin_layout Standard
If you have installed Noweb and \SpecialChar LyX
successfully,
whenever you open a new document,
after you have chosen its document class,
use the
\family sans
Document\SpecialChar menuseparator
Settings
\family default
menu to add the
\begin_inset Quotes eld
\end_inset
noweb
\begin_inset Quotes erd
\end_inset
module.
If Noweb is correctly installed,
when you click on the
\begin_inset Quotes eld
\end_inset
Modules
\begin_inset Quotes erd
\end_inset
link,
you will see the
\begin_inset Quotes eld
\end_inset
noweb
\begin_inset Quotes erd
\end_inset
module in the available list and you can add it to your document.
\end_layout
\begin_layout Paragraph
Typing code in
\end_layout
\begin_layout Standard
\SpecialChar LyX
enables you to write code with a custom inset named
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Chunk
\end_layout
\end_inset
.
Noweb delimits chunks like this:
\end_layout
\begin_layout LyX-Code
<<My code>>=
\end_layout
\begin_layout LyX-Code
code
\end_layout
\begin_layout LyX-Code
more code
\end_layout
\begin_layout LyX-Code
even more code
\end_layout
\begin_layout LyX-Code
@
\end_layout
\begin_layout Standard
The problem is that whatever is written in between the << and the
\family typewriter
@
\family default
must be taken literally,
i.
\begin_inset space \thinspace{}
\end_inset
e.
\begin_inset space \space{}
\end_inset
\SpecialChar LyX
should be prevented from making any special interpretation of what has been written.
This is also handled by
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Chunk
\end_layout
\end_inset
,
that works like a normal text inset but has a free spacing capability.
\end_layout
\begin_layout Standard
As a special note,
you can also use the
\begin_inset Quotes eld
\end_inset
%def
\begin_inset Quotes erd
\end_inset
construct of Noweb in your chunks to add items to Noweb's identifier cross-reference:
\end_layout
\begin_layout LyX-Code
<<My chunk>>=
\end_layout
\begin_layout LyX-Code
def some_function(args):
\end_layout
\begin_layout LyX-Code
"This is the doc string for this function."
\end_layout
\begin_layout LyX-Code
print "My args:
",
args
\end_layout
\begin_layout LyX-Code
@ %def some_function
\end_layout
\begin_layout Standard
For an example of this usage and the resulting cross-reference output,
look at the Literate python program in
\emph on
LIBDIR/examples/listerrors.lyx
\emph default
which should make this all clear.
\end_layout
\begin_layout Paragraph
Generating the documentation
\end_layout
\begin_layout Standard
At this point you already have a new document file with a proper document class,
and with some code and text on it.
How do I print it?
The answer is simple,
you select
\family sans
View\SpecialChar menuseparator
DVI,
\family default
etc.
Just like you would do for a plain document.
No special procedure is required.
\end_layout
\begin_layout Standard
To help orientate you,
I will now explain what happens inside \SpecialChar LyX
:
\end_layout
\begin_layout Enumerate
When the
\family sans
Update\SpecialChar menuseparator
DVI
\family default
menu option is chosen,
a \SpecialChar LaTeX
file is generated.
\end_layout
\begin_deeper
\begin_layout Standard
If the document is of any literate class the generated file will be named with an extension name defined by the
\begin_inset Quotes eld
\end_inset
literate
\begin_inset Quotes erd
\end_inset
format (defined in the Preferences panel),
otherwise the file will have the usual
\family typewriter
.tex
\family default
extension.
\end_layout
\end_deeper
\begin_layout Enumerate
Note that the only difference so far is in the name of the file,
no special processing is required by \SpecialChar LyX
.
Given that you formatted the code using the
\begin_inset Flex Noun
status collapsed
\begin_layout Plain Layout
Chunk
\end_layout
\end_inset
inset that,
by itself,
takes care of the business.
\end_layout
\begin_layout Enumerate
If the document is of any literate class \SpecialChar LyX
will then use the internal \SpecialChar LyX
to Noweb converter,
followed by the Noweb to \SpecialChar LaTeX
converter
\begin_inset Foot
status collapsed
\begin_layout Plain Layout
The converters are defined in the
\family sans
Tools\SpecialChar menuseparator
Preferences
\family default
panel,
under the
\begin_inset Quotes eld
\end_inset
Conversion
\begin_inset Quotes erd
\end_inset
tab.
See section
\emph on
Converters
\emph default
of the
\emph on
Customization
\emph default
manual for general information about converters.
\end_layout
\end_inset
to generate the \SpecialChar LaTeX
file.
\end_layout
\begin_deeper
\begin_layout Standard
Otherwise it will just skip this step.
\end_layout
\end_deeper
\begin_layout Enumerate
Finally,
\SpecialChar LaTeX
is invoked and the regular post processing continues as in a plain document.
\end_layout
\begin_layout Standard
Independence from a particular
\begin_inset Quotes eld
\end_inset
literate tool
\begin_inset Quotes erd
\end_inset
is easily achieved by changing the commands that are run by the various converters.
\end_layout
\begin_layout Paragraph
Generating the code
\end_layout
\begin_layout Standard
When the build menu option is chosen or the corresponding button in the toolbar is pressed,
a \SpecialChar LaTeX
file is generated just like step 1 above.
Next,
\SpecialChar LyX
invokes the
\family typewriter
Noweb->Program
\family default
converter.
This converter needs to be defined by the user and is not installed by default,
though the Program format is.
This converter (like any other converter) will have two parts:
\end_layout
\begin_layout Enumerate
The converter program itself.
This program performs the conversion from the one format to the other (in this case,
from the Noweb format to the Program pseudo-format).
\end_layout
\begin_layout Enumerate
The error log parser.
This is a program whose sole purpose is to rewrite error messages in a format that \SpecialChar LyX
understands.
This makes it possible for \SpecialChar LyX
to place error boxes in the right places in the file buffer.
\end_layout
\begin_layout Standard
The first part,
the
\begin_inset Quotes eld
\end_inset
Converter
\begin_inset Quotes erd
\end_inset
setting,
should be set to
\end_layout
\begin_layout LyX-Code
\family typewriter
build-script $$i
\family default
$$r
\end_layout
\begin_layout Standard
This basically means that \SpecialChar LyX
will call
\begin_inset Quotes eld
\end_inset
build-script
\begin_inset Quotes erd
\end_inset
(a program or script) with the name of the Noweb file (normally a file in the \SpecialChar LyX
temp directory) and the directory path of the original \SpecialChar LyX
file.
\end_layout
\begin_layout Standard
This is an implementation of
\begin_inset Quotes eld
\end_inset
build-script
\begin_inset Quotes erd
\end_inset
that you can place in a directory on your path:
\end_layout
\begin_layout LyX-Code
\family sans
#!/bin/sh
\end_layout
\begin_layout LyX-Code
\family sans
#
\end_layout
\begin_layout LyX-Code
\family sans
notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
\end_layout
\begin_layout Standard
The next part of the converter setting is the
\begin_inset Quotes eld
\end_inset
Flags
\begin_inset Quotes erd
\end_inset
which is to be set to
\end_layout
\begin_layout LyX-Code
\family typewriter
parselog=$$s/scripts/listerrors
\end_layout
\begin_layout Standard
This will run any errors that are generated by the
\begin_inset Quotes eld
\end_inset
build-script
\begin_inset Quotes erd
\end_inset
process through the
\begin_inset Quotes eld
\end_inset
listerrors
\begin_inset Quotes erd
\end_inset
program.
\end_layout
\begin_layout Standard
The build will normally take place in \SpecialChar LyX
's temporary directory,
so the files produced by the conversion will be in that directory.
\SpecialChar LyX
will copy out what it regards as the `main' file,
but the
\family typewriter
Noweb->Program
\family default
conversion may produce several files,
and so most of these would then be deleted when \SpecialChar LyX
was closed.
This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that the build-script chunk can place the generated files in that location.
\end_layout
\begin_layout Paragraph
Build instructions in the document
\end_layout
\begin_layout Standard
The last piece of the integration between \SpecialChar LyX
and noweb is the
\begin_inset Quotes eld
\end_inset
build-script
\begin_inset Quotes erd
\end_inset
chunk.
Generally,
the instructions for building your program should be embedded in a chunk of its own.
The noweb-specific
\begin_inset Quotes eld
\end_inset
build-script
\begin_inset Quotes erd
\end_inset
above uses the notangle command to look for this chunk (called
\begin_inset Quotes eld
\end_inset
build-script
\begin_inset Quotes erd
\end_inset
) and runs its contents through
\begin_inset Quotes eld
\end_inset
sh
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Standard
Typically,
such a chunk would look something like this:
\end_layout
\begin_layout LyX-Code
<<build-script>>=
\end_layout
\begin_layout LyX-Code
#!/bin/sh
\begin_inset Newline newline
\end_inset
if [ -z "${NOWEB_SOURCE}" ]
\begin_inset Newline newline
\end_inset
then
\end_layout
\begin_layout LyX-Code
NOWEB_SOURCE=myfile.nw
\begin_inset Newline newline
\end_inset
fi
\begin_inset Newline newline
\end_inset
[...
code to extract files ...
use NOWEB_OUTPUT_DIR here ...]
\begin_inset Newline newline
\end_inset
[...
code to compile files ...]
\begin_inset Newline newline
\end_inset
@
\end_layout
\begin_layout Standard
Look in
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Noweb Listerrors
\family default
or in
\family sans
File\SpecialChar menuseparator
Open Example\SpecialChar menuseparator
Modules\SpecialChar menuseparator
Noweb2LyX
\family default
which implement versions of the
\begin_inset Quotes eld
\end_inset
listerrors
\begin_inset Quotes erd
\end_inset
program for some illustrations of how all of these pieces go together
\emph on
.
\emph default
Interestingly,
these files show off the language independency of the \SpecialChar LyX
literate programming support since they are written in Python and Perl respectively.
\end_layout
\begin_layout Subsubsection
Configuring \SpecialChar LyX
\end_layout
\begin_layout Standard
All the Literate Programming support is configured by the
\family sans
Tools\SpecialChar menuseparator
Preferences
\family default
panel in the
\begin_inset Quotes eld
\end_inset
File Handling
\begin_inset Quotes erd
\end_inset
tab.
The important parts are:
\end_layout
\begin_layout Description
the
\begin_inset space ~
\end_inset
\begin_inset Quotes eld
\end_inset
NoWeb
\begin_inset Quotes erd
\end_inset
\begin_inset space ~
\end_inset
format Set up via the File Formats tab,
this is where the Noweb-specific pieces are set up.
The
\family sans
GUI Name
\family default
is set to
\family typewriter
NoWeb
\family default
,
the file extension is set to
\family typewriter
.nw
\family default
.
This tells \SpecialChar LyX
to create a file with a
\family typewriter
.nw
\family default
extension in the first step of the conversion process.
\end_layout
\begin_layout Description
the
\begin_inset space ~
\end_inset
\family sans
Program
\family default
\begin_inset space ~
\end_inset
format This is an empty format whose sole purpose is to be the endpoint of a conversion (which then allows us to set up a converter for it).
\end_layout
\begin_layout Description
\family sans
NoWeb
\family default
->
\family sans
\SpecialChar LaTeX
\family default
This converter performs the
\begin_inset Quotes eld
\end_inset
weaving
\begin_inset Quotes erd
\end_inset
of the literate document.
For Noweb,
it is set to
\begin_inset Quotes eld
\end_inset
\family typewriter
noweave -delay -index $$i > $$o
\family default
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Description
\family sans
NoWeb
\family default
->
\family sans
Program
\family default
This performs the
\begin_inset Quotes eld
\end_inset
tangling step
\begin_inset Quotes erd
\end_inset
.
As stated above,
the Converter is set to
\begin_inset Quotes eld
\end_inset
\family typewriter
build-script $$i
\family default
$$r
\begin_inset Quotes erd
\end_inset
,
with Flags set to
\begin_inset Newline newline
\end_inset
\begin_inset Quotes eld
\end_inset
\family typewriter
parselog=$$s/scripts/listerrors
\family default
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Subsubsection
Debug extensions
\end_layout
\begin_layout Standard
There is also a new function implemented in the \SpecialChar LyX
server,
the
\begin_inset Quotes eld
\end_inset
server-goto-file-row" function,
to be used with ddd/gdb or other debugger.
\end_layout
\begin_layout Standard
When debugging code with ddd/gdb,
it is possible to invoke a text editor at the current execution position with a single key stroke.
The default ddd configuration for that is shift-ctrl-V.
It happens that you can define the editor command line invocation in ddd by accessing the
\family sans
Edit\SpecialChar menuseparator
Preferences\SpecialChar menuseparator
Helpers
\family default
dialog and changing the "Edit Sources" entry.
\end_layout
\begin_layout Standard
I take advantage of the newly created \SpecialChar LyX
