-#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 243
+#LyX 1.5.0rc1 created this file. For more info see http://www.lyx.org/
+\lyxformat 271
\begin_document
\begin_header
\textclass book
\end_preamble
\language english
\inputencoding latin1
-\fontscheme default
+\font_roman default
+\font_sans default
+\font_typewriter default
+\font_default_family default
+\font_sc false
+\font_osf false
+\font_sf_scale 100
+\font_tt_scale 100
\graphics default
\paperfontsize default
\spacing single
\papersize default
\use_geometry false
\use_amsmath 0
+\use_esint 0
\cite_engine basic
\use_bibtopic false
\paperorientation portrait
\paragraph_separation indent
\defskip medskip
\quotes_language english
-\quotes_times 2
\papercolumns 1
\papersides 2
\paperpagestyle headings
\tracking_changes false
-\output_changes true
+\output_changes false
+\author "usti"
+\author "Richard Heck"
\end_header
\begin_body
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \tableofcontents{}
+\begin_inset LatexCommand tableofcontents
\end_inset
\begin_layout Standard
If you haven't read the
\emph on
-Introduction
+Introduction
\emph default
-yet, you are definitely in the wrong manual.
+ yet, you are definitely in the wrong manual.
The
\emph on
Introduction
\begin_layout Standard
Since all the topics in this manual depend heavily on LyX's interaction
- with LaTeX, this first chapter covers
-\emph on
-
-\emph default
-the inner workings of LyX and how to direct LyX to generate exactly the
- LaTeX code you want.
+ with LaTeX, this first chapter covers the inner workings of LyX and how
+ to direct LyX to generate exactly the LaTeX code you want.
It is obviously for more seasoned LyX users.
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:lyxandlatex}
+\begin_inset LatexCommand label
+name "sec:lyxandlatex"
\end_inset
\family typewriter
xdvi
\family default
- on the Dvi file.
+ on the DVI-file.
If you've used
\family sans
View\InsetSpace ~
\family typewriter
dvips
\family default
- to convert the Dvi file to PostScript®:
+ to convert the DVI file to PostScript:
\end_layout
\begin_deeper
\family typewriter
ghostview
\family default
- or send the PostScript® file to the printer.
+ or send the PostScript file to the printer.
\end_layout
\begin_layout Section
aTeX
\family default
command in LyX.
- This will call a Perl script named
+ This will call a program named
\family typewriter
-reLyX
+tex2lyx
\family default
---which will create a file
\family typewriter
foo.tex
\family default
---and then open that file.
- If the translation doesn't work, you can try calling
-\family typewriter
-reLyX
-\family default
- from the command line, possibly using fancier options.
\end_layout
\begin_layout Standard
\family typewriter
-reLyX
+tex2lyx
\family default
will translate most legal LaTeX, but not everything.
It will leave things it doesn't understand in TeX mode, so after translating
a file with
\family typewriter
-reLyX
+tex2lyx
\family default
, you can look for red text and hand-edit it to look right.
\end_layout
\begin_layout Standard
-
-\family typewriter
-reLyX
-\family default
- has its own section in the
-\emph on
-Extended Features
-\emph default
- manual (as well as a Unix manpage equivalent), which you should read to
- find out about what LaTeX isn't supported, bugs (and how to get around
- them), and how to use the various options.
-\end_layout
-
-\begin_layout Standard
-If you can't get
-\family typewriter
-reLyX
-\family default
- to work, or you just want to put a piece of LaTeX code into a LyX file,
- see Section
-\begin_inset LatexCommand \ref{sec:latexcodes}
+If you just want to put a piece of LaTeX code into a LyX file, see Section
+\begin_inset LatexCommand ref
+reference "sec:latexcodes"
\end_inset
\begin_layout Section
Inserting LaTeX Code into LyX Documents
-\begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
+\begin_inset LatexCommand label
+name "sec:Inserting-LaTeX-Code"
\end_inset
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:latexcodes}
+\begin_inset LatexCommand label
+name "sec:latexcodes"
\end_inset
\family default
.
The ERT box comes in three forms: collapsed, open, and inlined.
- The first two are used just like any other collapsable (foldable) box (such
+ The first two are used just like any other collapsible (foldable) box (such
as footnotes), and are useful for significant amounts of LaTeX commands.
An
\begin_inset Quotes eld
status inlined
\begin_layout Standard
+
% like this
\end_layout
\begin_layout Standard
+
\backslash
begin{tabular}{ll}
\end_layout
\begin_layout Standard
+
\backslash
begin{minipage}{5cm}
\end_layout
\begin_layout Standard
+
This is an example for a minipage environment.
You can put nearly everything in it, even (non-floating) figures and tables.
\begin_layout Standard
+
\backslash
end{minipage}
\end_layout
\begin_layout Standard
+
&
\end_layout
\begin_layout Standard
+
\backslash
begin{minipage}{5cm}
\end_layout
\begin_layout Standard
+
\backslash
begin{verbatim}
\end_layout
\begin_layout Standard
+
\backslash
begin{minipage}{5cm}
\end_layout
\begin_layout Standard
+
This ...
\end_layout
\begin_layout Standard
+
\backslash
end{minipage}
\end_layout
\begin_layout Standard
+
\backslash
end{verbatim}
\end_layout
\begin_layout Standard
+
\backslash
end{minipage}
\end_layout
\begin_layout Standard
+
\backslash
end{tabular}
\end_layout
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \label{sec:preamble}
+\begin_inset LatexCommand label
+name "sec:preamble"
\end_inset
\begin_layout Standard
The LaTeX preamble comes at the very beginning of a document,
\emph on
-before
+before
\emph default
-the text.
+ the text.
It serves to:
\end_layout
declare the usage of packages.
LaTeX packages provide special commands, which are only available within
a document when the package has been declared in the preamble.
- For example, the
-\family typewriter
-
-\family default
-package
+ For example, the package
\family typewriter
indentfirst
\family default
\family typewriter
\backslash
-newcommand
+newcommand
\family default
-or
+ or
\family typewriter
\backslash
\begin_layout Standard
First, make sure you're using the
\family sans
-article
+article
\family default
-document class.
+ document class.
Next, you need to put the following in your preamble:
\end_layout
\end_layout
\begin_layout Standard
-This sets things up for Avery® label sheets, stock #5360.
+This sets things up for Avery® label sheets, stock #5360.
You're now ready to print labels, but you'll need to insert LaTeX code,
placing the commands
\family typewriter
given in Chapter\InsetSpace ~
-\begin_inset LatexCommand \ref{cha:secrets}
+\begin_inset LatexCommand ref
+reference "cha:secrets"
\end_inset
\end_layout
\begin_layout Standard
-Some folks also like to look at the log file directly, accessible from
+Some folks also like to look at the log file directly, accessible from
\family sans
-
\bar under
D
\bar default
Do you have long sections of text where LaTeX cannot find a place to break
a line? By default, LaTeX is rather strict about how much extra inter-word
spacing it will add in order to break a line.
- Preferrably, you should rework the paragraph to avoid the problem.
+ Preferably, you should rework the paragraph to avoid the problem.
If this isn't an option, you can wrap your text in
\family typewriter
\begin_layout Section
Preparing a Bibliography with BibTeX
-\begin_inset LatexCommand \label{sec:Preparing-a-Bibliography}
+\begin_inset LatexCommand label
+name "sec:Preparing-a-Bibliography"
\end_inset
\noun default
and
\noun on
-Jürgen Spitzmüller
+Jürgen Spitzmüller
\end_layout
\begin_layout Standard
STOP! If you don't know what BibTeX is, or have a reasonably good idea of
how to use it (
\emph on
-e.g.
-
+e.\InsetSpace \thinspace{}
+g.
\emph default
- setting up your own bibliographic databases),
+\InsetSpace ~
+setting up your own bibliographic databases),
\emph on
run
\emph default
\bar default
VI
\family default
-, for example, you should see that BibTex and LaTeX are invoked as needed,
+, for example, you should see that BibTeX and LaTeX are invoked as needed,
including multiple invocations of LaTeX.
\end_layout
\end_layout
\begin_layout Standard
-Standard BibTeX uses numbers (e.\InsetSpace \,
-g.\InsetSpace \space
+Standard BibTeX uses numbers (e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
\begin_inset Quotes eld
\end_inset
) to refer to a cited work.
However, in many scientific disciplines, other citation styles are in use.
- The most common one is the author-year style (e.\InsetSpace \,
-g.\InsetSpace \space
+ The most common one is the author-year style (e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
\begin_inset Quotes eld
\end_inset
\bar under
S
\bar default
-ettings
+ettings
\family default
-and select the
+ and select the
\family sans
Bibliography
\family default
\begin_layout Standard
See
-\begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/}
+\begin_inset LatexCommand url
+target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/"
\end_inset
\begin_layout Subsection
Sectionated Bibliographies
-\begin_inset LatexCommand \label{sub:Sectionated-Bibliographies}
+\begin_inset LatexCommand label
+name "sub:Sectionated-Bibliographies"
\end_inset
\begin_layout Standard
Available from
-\begin_inset LatexCommand \url{ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/}
+\begin_inset LatexCommand url
+target "ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/"
\end_inset
\begin_inset Quotes erd
\end_inset
-, you first need to create two bibliographic databases, e.\InsetSpace \,
-g.\InsetSpace \space
+, you first need to create two bibliographic databases, e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
\family typewriter
sources.bib
\bar under
S
\bar default
-ettings
+ettings
\family default
-and select the
+ and select the
\family sans
Bibliography
\family default
.
Now you can insert multiple BibTeX references (as described in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:Preparing-a-Bibliography}
+\begin_inset LatexCommand ref
+reference "sec:Preparing-a-Bibliography"
\end_inset
\end_layout
\begin_layout Standard
-Multiple bibliographies, e.\InsetSpace \,
-g.\InsetSpace \space
+Multiple bibliographies, e.\InsetSpace \thinspace{}
+g.\InsetSpace \space{}
a bibliography for each section or chapter of
the document, are not supported by BibTeX itself.
But the
LyX (cf.\InsetSpace ~
section\InsetSpace ~
-\begin_inset LatexCommand \ref{sub:Sectionated-Bibliographies}
+\begin_inset LatexCommand ref
+reference "sub:Sectionated-Bibliographies"
\end_inset
LaTeX-Code (ERT, cf.\InsetSpace ~
section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
+\begin_inset LatexCommand ref
+reference "sec:Inserting-LaTeX-Code"
\end_inset
\bar under
S
\bar default
-ettings
+ettings
\family default
-and select the
+ and select the
\family sans
Bibliography
\family default
(those commands have to be inserted as ERT).
The bibliography will contain all references which have been cited in the
current btUnit.
- N.\InsetSpace
+ N.\InsetSpace \thinspace{}
B.: If you are using this approach, then
\emph on
every
\bar no
\noun off
\color none
-In the
-\family sans
+In the
+\family default
\series default
\shape default
-\size default
\emph default
\bar default
+
+\family sans
+\size default
\noun default
-\color default
Outputs\SpecialChar \menuseparator
LaT\SpecialChar \textcompwordmark{}
eX
\emph off
\bar no
\noun off
-\color none
section of the preferences dialog, however, you can customize the index
- command, if you prefer an alternative program like
-\family typewriter
+ command, if you prefer an alternative program like
+\family default
\series default
\shape default
-\size default
\emph default
\bar default
+
+\family typewriter
+\size default
\noun default
-\color default
xindy
\family roman
\series medium
\emph off
\bar no
\noun off
-\color none
.
\end_layout
\end_layout
\begin_layout Section
-Multipart Documents
+Glossaries
\end_layout
-\begin_layout Subsection
-General Operation
+\begin_layout Standard
+by
+\noun on
+Özgür Ug̃raş Baran
\end_layout
\begin_layout Standard
-When you are working on a large file with many sections, it is often convenient
- to break up the document into several files, or perhaps you have something
- where a table may change from time to time, but the preceding text does
- not.
- In these cases, you should seriously consider using multipart documents.
- For example, scientific papers often have five major sections: the introduction
-, observations, results, discussion, and conclusion.
- Each of these could be its own separate LyX file, with one
-\begin_inset Quotes eld
-\end_inset
-
-master
-\begin_inset Quotes erd
-\end_inset
-
- file which contains the title, authors, abstract, references, etc., plus
- the five included files.
- It is important to note that each of these files is a full LyX file which
- can be formatted and printed on its own, as well as included in a master
- file.
- Each of these files must have the same document class, however--- don't
- attempt to mix book classes with article classes.
- You may also include LaTeX files; however, these files must not have their
- own preamble
-\emph on
-(i.e.
-
-\emph default
- everything up to and including the
+Sometimes you need to compile a list of symbols that are mentioned in your
+ document with a brief explanation of them.
+ A LaTeX package named
\family typewriter
-
-\backslash
-begin{document}
+nomencl
\family default
- line as well as the
+ provides an easy way of compiling such lists.
+
\family typewriter
-
-\backslash
-end{document}
+nomencl
\family default
- line must be deleted) or else errors will be generated when you try to
- make a DVI file.
+ is included in most standard Linux distributions.
+ If your distribution doesn't contain it, you should download it from a
+ CTAN mirror and install the package in order to use this feature of LyX.
\end_layout
\begin_layout Standard
-LyX allows you to include files quite easily with
+A glossary entry is created if you place the cursor after a symbol entry
+ and then use the menu
\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-ChiI
-\bar under
-d
-\bar default
-\InsetSpace ~
-Document
+Insert\SpecialChar \menuseparator
+Glossary\InsetSpace ~
+Entry
\family default
.
- When you click on this selection a small box is inserted into the file
- at the current cursor location.
- Clicking on the box raises a dialog which allows you to select the file
- to be included, and the method of its inclusion.
-
-\end_layout
-
-\begin_layout Standard
-The file selection box should by now be obvious.
- The three inclusion methods are
+ A gray box labeled
\begin_inset Quotes eld
\end_inset
-include
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Not
+\family default
-input
\begin_inset Quotes erd
\end_inset
-, and
-\begin_inset Quotes eld
+ is inserted and a window pops up asking for the glossary entry.
+ A glossary entry consists of two main entries.
+ The first is the symbol that you want to refer to.
+ You should enter a valid LaTeX code for the corresponding field in the
+ glossary dialog.
+ The second is the description of the symbol.
+ You should fill the corresponding field to complete the glossary entry.
+\end_layout
+
+\begin_layout Subsection
+Sort Order of Glossary Entries
+\end_layout
+
+\begin_layout Standard
+Suppose you have two glossary entries for the symbols
+\begin_inset Formula $a$
\end_inset
-verbatim
-\begin_inset Quotes erd
+ and
+\begin_inset Formula $\sigma$
\end_inset
.
- The difference between
-\begin_inset Quotes eld
+ The
+\family typewriter
+nomencl
+\family default
+ package automatically sorts these two entries considering the symbol entry,
+ while printing the Glossary.
+ However, this can lead to an undesired sort order.
+ For the example given, the first entry appears as
+\family typewriter
+$a$
+\family default
+, while the second is
+\family typewriter
+$
+\backslash
+sigma$
+\family default
+.
+ Note that, in this case
+\begin_inset Formula $\sigma$
\end_inset
-include
-\begin_inset Quotes erd
+ is located in front of the
+\begin_inset Formula $a$
\end_inset
- and
+, since the character
\begin_inset Quotes eld
\end_inset
-input
-\begin_inset Quotes erd
-\end_inset
- is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
-\begin_inset Quotes eld
-\end_inset
+\backslash
-included
\begin_inset Quotes erd
\end_inset
- are typeset beginning on a new page, while files which are
-\begin_inset Quotes eld
+ is considered in sorting.
+ In order to control the sort order, you can edit the
+\family sans
+Sort\InsetSpace ~
+as
+\family default
+ field of the glossary dialog.
+ For the given example, you can edit this field as
+\family typewriter
+a
+\family default
+ and
+\family typewriter
+sigma
+\family default
+ correspondingly.
+ Then, these entries will be effective in the sort ordering and
+\begin_inset Formula $a$
\end_inset
-inputted
-\begin_inset Quotes erd
+ will be located before
+\begin_inset Formula $\sigma$
\end_inset
- are typeset starting on the current page.
- Perhaps the labeling in LyX will be changed someday to reflect this.
+.
\end_layout
\begin_layout Standard
-Generally, the master file is converted into a full LaTeX file before typesettin
-g, while the included files are converted to LaTeX files which do not have
- all the preamble information.
- Checking the
-\family sans
-Don't
-\family default
-\InsetSpace ~
+This feature provides exciting ways of ordering the entries.
+ For subgrouping and tips for using sort entries see the official nomencl
+ documentation.
+\end_layout
-\family sans
-typeset
-\family default
- button prevents this conversion.
+\begin_layout Subsection
+Referencing
\end_layout
\begin_layout Standard
-A
+You can turn on referencing to the equations and pages in the glossary entries.
+ For this purpose, you should add referencing options commands at the end
+ of description field.
+ There are six referencing options in nomencl package:
+\end_layout
+
+\begin_layout Paragraph*
+
+\backslash
+refeq:
+\end_layout
+
+\begin_layout Standard
+Adds reference to the equation by adding the phrase
\begin_inset Quotes eld
\end_inset
-verbatim
+, see equation (#)
\begin_inset Quotes erd
\end_inset
- included file allows you to include a file typeset exactly as it appears
- in the file, i.e.\InsetSpace ~
-verbatim mode, with the characters set in a fixed-width
- typewriter font.
- Normally, spaces in this file are invisible, though two consecutive spaces
- are conserved, unlike LyX's normal treatment of spaces.
- However, setting the
-\family sans
-\bar under
-M
-\bar default
-ark\InsetSpace ~
-spaces\InsetSpace ~
-in\InsetSpace ~
-output
-\family default
- checkbox typesets a mark to unambiguously define the presence of a space.
-\emph on
-
\end_layout
-\begin_layout Subsection
-Cross-References Between Files
+\begin_layout Paragraph*
+
+\backslash
+refpage:
\end_layout
\begin_layout Standard
-It is possible to set up cross-references between the different files.
- First, open all the files in question: let's call them A and B in a two
- file example, where B is included in A.
- Let's say you insert a label in A, then want to reference it in B.
- Open the cross-reference dialog in whilst in document B, and you can select
- the
+Adds reference to the page by adding the phrase
\begin_inset Quotes eld
\end_inset
-buffer
+, page (#)
\begin_inset Quotes erd
\end_inset
- to use.
+
\end_layout
-\begin_layout Section
-Algorithms
+\begin_layout Paragraph*
+
+\backslash
+refeqpage:
\end_layout
\begin_layout Standard
-The package
-\family sans
-algorithm
-\family default
- is needed by LyX to be able to output algorithm floats.
- These are useful in placing short algorithms across page breaks and support
- an index of algorithms too.
+Is the short notation of
+\backslash
+refeq
+\backslash
+refpage.
\end_layout
-\begin_layout Section
-Subfigures
-\end_layout
+\begin_layout Paragraph*
-\begin_layout Standard
-The package
-\family sans
- subfigure
-\family default
-is used by LyX when you select ``subfigure'' in the graphics dialog and
- enter the subfigure caption.
- Several figures marked in this way can be packed into a single float with
- individual sub-captions.
+\backslash
+norefeq,
+\backslash
+norefpag,
+\backslash
+norefeqpage:
\end_layout
-\begin_layout Section
-Fancy Headers and Footers
+\begin_layout Standard
+Turns off corresponding referencing options if they are turned on globally
+ (see reference documentation of nomencl).
+\end_layout
+
+\begin_layout Subsection
+Printing Glossary
\end_layout
\begin_layout Standard
-The default page layout is rather plain; for an article document class,
- all you get is a centered page number at the bottom of the page.
- This document is the book class, so it appears to be a bit fancier, but
- to really put on a show, you need to set the document page style to
+You can insert the glossary with the menu
+\family sans
+Insert\SpecialChar \menuseparator
+Lists\InsetSpace ~
+&TOC\SpecialChar \menuseparator
+Glossary
+\family default
+.
+ A light blue box labeled
\begin_inset Quotes eld
\end_inset
-fancy
-\begin_inset Quotes erd
-\end_inset
-, as mentioned in the
\family sans
-User\InsetSpace ~
-Guide
+Glossary
\family default
-.
- This section describes the LaTeX codes you need to insert in your LaTeX
- preamble or the text in order to get the desired effects.
-\end_layout
-
-\begin_layout Standard
-The page header is divided into three fields, not surprisingly labeled
-\begin_inset Quotes eld
-\end_inset
-left
\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+ will show the place where the index is printed in the output.
+ The index list box is not clickable like other LyX-boxes.
+ In the printed output the title of the glossary appears as
+\series bold
+Nomenclature
+\series default
-center
-\begin_inset Quotes erd
-\end_inset
+\begin_inset Foot
+status collapsed
-, and
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+This is translated to the document language for a small number of languages,
+ amongst others French and German
+\end_layout
-right
-\begin_inset Quotes erd
\end_inset
.
- The footer is also divided into these three fields.
- The LaTeX commands to set these fields in the simplest manner are
+ If you are not happy with the title, you can change it by re-defining the
+ command
\family typewriter
\backslash
-lhead
+nomname
\family default
-,
-\family typewriter
+ in the preamble.
+ For example, in order to change the title
+\emph on
+List of Symbols
+\emph default
+ for the
+\emph on
+Glossary
+\emph default
+ add the following line to the preamble.
+\end_layout
-\backslash
-chead
-\family default
-,
-\family typewriter
+\begin_layout LyX-Code
\backslash
-rhead
-\family default
-,
-\family typewriter
-
+renewcommand{
\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:
+nomname}{List of Symbols}
\end_layout
\begin_layout Standard
+ If you're unhappy with the amount of space for symbols, you can alter it
+ by adding following line to the preamble.
+\end_layout
-\family typewriter
+\begin_layout LyX-Code
\backslash
-lhead{John Q.
- DocWriter}
+renewcommand{
+\backslash
+nomlabelwidth}{3.0cm}
\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.g.
+\begin_layout Section
+Multipart Documents
\end_layout
-\begin_layout Standard
-
-\family typewriter
-
-\backslash
-cfoot{}
+\begin_layout Subsection
+General Operation
\end_layout
\begin_layout Standard
-Let's get really fancy: lets put the section number with the word
+When you are working on a large file with many sections, it is often convenient
+ to break up the document into several files, or perhaps you have something
+ where a table may change from time to time, but the preceding text does
+ not.
+ In these cases, you should seriously consider using multipart documents.
+ For example, scientific papers often have five major sections: the introduction
+, observations, results, discussion, and conclusion.
+ Each of these could be its own separate LyX file, with one
\begin_inset Quotes eld
\end_inset
-Section
+master
\begin_inset Quotes erd
\end_inset
- (e.g.
- Section 3) in the upper left, the page number (e.g.
- Page 4) in the upper right, your name in the lower left, and the date in
- the lower right.
- The following commands should now appear in the preamble:
-\end_layout
-
-\begin_layout Standard
+ file which contains the title, authors, abstract, references, etc., plus
+ the five included files.
+ It is important to note that each of these files is a full LyX file which
+ can be formatted and printed on its own, as well as included in a master
+ file.
+ Each of these files must have the same document class, however--- don't
+ attempt to mix book classes with article classes.
+ You may also include LaTeX files; however, these files must not have their
+ own preamble
+\emph on
+(i.e.
+\emph default
+ everything up to and including the
\family typewriter
\backslash
-lhead{Section
+begin{document}
+\family default
+ line as well as the
+\family typewriter
+
\backslash
-thesection}
+end{document}
+\family default
+ line must be deleted) or else errors will be generated when you try to
+ make a DVI file.
\end_layout
\begin_layout Standard
-
-\family typewriter
-
-\backslash
-chead{}
+LyX allows you to include files quite easily with
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+ChiI
+\bar under
+d
+\bar default
+\InsetSpace ~
+Document
+\family default
+.
+ When you click on this selection a small box is inserted into the file
+ at the current cursor location.
+ Clicking on the box raises a dialog which allows you to select the file
+ to be included, and the method of its inclusion.
+
\end_layout
\begin_layout Standard
+The file selection box should by now be obvious.
+ The three inclusion methods are
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+include
+\begin_inset Quotes erd
+\end_inset
-\backslash
-rhead{Page
-\backslash
-thepage}
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+input
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+, and
+\begin_inset Quotes eld
+\end_inset
-\backslash
-lfoot{John Q.
- DocWriter}
-\end_layout
+verbatim
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+.
+ The difference between
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+include
+\begin_inset Quotes erd
+\end_inset
-\backslash
-cfoot{}
-\end_layout
+ and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+input
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+ is really only meaningful to LaTeXperts, but the practical difference is
+ that files which are
+\begin_inset Quotes eld
+\end_inset
-\backslash
-rfoot{
-\backslash
-today}
+included
+\begin_inset Quotes erd
+\end_inset
+
+ are typeset beginning on a new page, while files which are
+\begin_inset Quotes eld
+\end_inset
+
+inputted
+\begin_inset Quotes erd
+\end_inset
+
+ are typeset starting on the current page.
+ Perhaps the labeling in LyX will be changed someday to reflect this.
\end_layout
\begin_layout Standard
-The codes
-\family typewriter
-
-\backslash
-thesection
+Generally, the master file is converted into a full LaTeX file before typesettin
+g, while the included files are converted to LaTeX files which do not have
+ all the preamble information.
+ Checking the
+\family sans
+Don't
\family default
- and
-\family typewriter
+\InsetSpace ~
-\backslash
-thepage
-\family default
+\family sans
+typeset
+\family default
+ button prevents this conversion.
+\end_layout
+
+\begin_layout Standard
+A
+\begin_inset Quotes eld
+\end_inset
+
+verbatim
+\begin_inset Quotes erd
+\end_inset
+
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.e.\InsetSpace ~
+verbatim mode, with the characters set in a fixed-width
+ typewriter font.
+ Normally, spaces in this file are invisible, though two consecutive spaces
+ are conserved, unlike LyX's normal treatment of spaces.
+ However, setting the
+\family sans
+\bar under
+M
+\bar default
+ark\InsetSpace ~
+spaces\InsetSpace ~
+in\InsetSpace ~
+output
+\family default
+ checkbox typesets a mark to unambiguously define the presence of a space.
+
+\end_layout
+
+\begin_layout Subsection
+Cross-References Between Files
+\end_layout
+
+\begin_layout Standard
+It is possible to set up cross-references between the different files.
+ First, open all the files in question: let's call them A and B in a two
+ file example, where B is included in A.
+ Let's say you insert a label in A, then want to reference it in B.
+ Open the cross-reference dialog in whilst in document B, and you can select
+ the
+\begin_inset Quotes eld
+\end_inset
+
+buffer
+\begin_inset Quotes erd
+\end_inset
+
+ to use.
+\end_layout
+
+\begin_layout Section
+Fancy Headers and Footers
+\end_layout
+
+\begin_layout Standard
+The default page layout is rather plain; for an article document class,
+ all you get is a centered page number at the bottom of the page.
+ This document is the book class, so it appears to be a bit fancier, but
+ to really put on a show, you need to set the document page style to
+\begin_inset Quotes eld
+\end_inset
+
+fancy
+\begin_inset Quotes erd
+\end_inset
+
+, as mentioned in the
+\family sans
+User\InsetSpace ~
+Guide
+\family default
+.
+ This section describes the LaTeX codes you need to insert in your LaTeX
+ preamble or the text in order to get the desired effects.
+\end_layout
+
+\begin_layout Standard
+The page header is divided into three fields, not surprisingly labeled
+\begin_inset Quotes eld
+\end_inset
+
+left
+\begin_inset Quotes erd
+\end_inset
+
+,
+\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 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 Standard
+
+\family typewriter
+
+\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.\InsetSpace \thinspace{}
+g.
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+cfoot{}
+\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.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+Section 3) in the upper left, the page number (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+Page 4) in the upper
+ right, your name in the lower left, and the date in the lower right.
+ The following commands should now appear in the preamble:
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lhead{Section
+\backslash
+thesection}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+chead{}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+rhead{Page
+\backslash
+thepage}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lfoot{John Q.
+ DocWriter}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+cfoot{}
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+rfoot{
+\backslash
+today}
+\end_layout
+
+\begin_layout Standard
+The codes
+\family typewriter
+
+\backslash
+thesection
+\family default
+ and
+\family typewriter
+
+\backslash
+thepage
+\family default
access LaTeX's section and page counters, and so print out the current
section and page numbers.
the footer can also be modified.
If you don't want one of the headers, set its thickness to 0.
The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
- Use the commands, e.g.
+ Use the commands, e.\InsetSpace \thinspace{}
+g.
\family typewriter
\end_layout
\begin_layout Standard
-As a final example, it is possible to include an Encapsulated PostScript®
+As a final example, it is possible to include an Encapsulated PostScript
file in the header or footer.
Suppose you want to put a company logo in the upper lefthand corner.
You might try something like
\end_layout
\begin_layout Section
-Minipages
+Itemize Bullet Selection
+\begin_inset LatexCommand label
+name "sec:bullet"
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-LaTeX provides a mechanism to produce essentially a page within a page,
- called minipages.
- Within a minipage, all the usual rules of indentation, line wrapping, etc.\InsetSpace ~
-apply.
- LyX also provides some of the minipage capability.
+by
+\noun on
+ Allan Rae
+\end_layout
+
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-Minipages in LyX have their own collapsable box; insert one via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Mini
-\bar under
-p
-\bar default
-age
-\family default
-.
- Right-clicking on the box allows you to alter the minipage's width and
- alignment within the page.
- Warning: if the minipage is too long to fit on a page, it is truncated,
- not wrapped onto the next page.
-\end_layout
-
-\begin_layout Standard
-If you place two minipages side-by-side, you can use
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-pecial\InsetSpace ~
-Character
-\family default
- to insert a special instruction known in the LaTeX world as an
-\family typewriter
-hfill
-\family default
- to put a maximum amount of space between them; it forces one minipage to
- the left edge, the other to the right edge.
- The examples below show the difference.
-\end_layout
-
-\begin_layout Standard
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "c"
-use_parbox 0
-width "1.5in"
-special "none"
-height "1pt"
-height_special "totalheight"
-status open
-
-\begin_layout Standard
-This is a minipage which does not use hfill.
- This is the second sentence of a minipage which does not use hfill.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "c"
-use_parbox 0
-width "1.5in"
-special "none"
-height "1pt"
-height_special "totalheight"
-status open
-
-\begin_layout Standard
-This is a second minipage which does not use hfill.
- This is the second sentence of a second minipage which does not use hfill.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Here is some normal text to separate the two examples.
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "c"
-use_parbox 0
-width "1.5in"
-special "none"
-height "1pt"
-height_special "totalheight"
-status open
-
-\begin_layout Standard
-This is a minipage which does use hfill.
- This is the second sentence of a minipage which does use hfill.
-\end_layout
-
-\end_inset
-
-
-\hfill
-
-\begin_inset Box Frameless
-position "t"
-hor_pos "c"
-has_inner_box 1
-inner_pos "c"
-use_parbox 0
-width "1.5in"
-special "none"
-height "1pt"
-height_special "totalheight"
-status open
-
-\begin_layout Standard
-This is a second minipage which does use hfill.
- This is the second sentence of a second minipage which does use hfill.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Section
-Wrapping Text Around Figures
-\begin_inset LatexCommand \label{sec:floatflt}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset Wrap figure
-placement r
-width "6cm"
-status open
+LyX provides 216 bullet shapes that can be accessed from a simple dialog.
+ Using this dialog you can easily specify what bullet shape to use at each
+ level of an itemized list.
+ These settings are document-wide so you won't be able to specify different
+ sets of bullets for different paragraphs
+\begin_inset Foot
+status collapsed
\begin_layout Standard
-\begin_inset Graphics
- filename mobius.eps
- display color
- width 40col%
- rotateOrigin center
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Caption
-This is a wrapped figure, and this is the brilliant caption that describes
- it
+Well, actually you can but you'll have to do it by hand.
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout Standard
-A very frequently asked question is whether text can be made to
-\begin_inset Quotes eld
-\end_inset
-
-wrap
-\begin_inset Quotes erd
-\end_inset
-
- around figures so that a figure occupies some fraction of the column width
- and text fills the rest.
- If you have the LaTeX package
-\family typewriter
-floatflt
-\family default
- installed (you can find out about it in the
-\emph on
-LaTeX Configuration
-\emph default
- manual) you can do this.
+\begin_layout Subsection
+How it looks
\end_layout
\begin_layout Standard
-At the right is a figure of a mobius strip---you should have already seen
- this in the
-\emph on
-User's Guide
-\emph default
-.
- To wrap the text like this insert a wrap box via
+Open the dialog by selecting the
\family sans
\bar under
-I
+D
\bar default
-nsert\SpecialChar \menuseparator
-Flo
+ocument\SpecialChar \menuseparator
+
\bar under
-a
+S
\bar default
-ts\SpecialChar \menuseparator
-Floatflt Figure
-\family default
-.
-\end_layout
-
-\begin_layout Standard
-Note: this package is very fragile! For example, having a figure too close
- to the bottom of the page will mess things up, as will having two figures
- close together.
- Use this package sparingly and do read the documentation that came with
- it (which will also tell you how to wrap text around tables).
-\end_layout
-
-\begin_layout Section
-Extra Table Options
-\end_layout
-
-\begin_layout Standard
-While the standard table layout will suffice in 99% of all tables you generate,
- occasionally you will run into one which requires a bit of extra tweaking.
- The table dialog which appears on a right-click of a table allows these
- tweaks to be made.
- It will give you access to some extra column alignment parameters.
- A little bit of LaTeX background is useful here: when you set up a table
- in LaTeX, each column is given an alignment type.
- For example, you would give it
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-l
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-,
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-c
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, or
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-r
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- for left-aligned, centered, and right-aligned columns respectively (which
- appear as the left/center/right radio buttons in LyX).
- A fourth type is
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-p
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, which will make a column of a specified width (the width box in LyX),
- and will wrap text within that box.
- A fifth type is
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-|
+ettings
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- (vertical bar) which rather than making a column will make a vertical rule
- at that point; this manifests itself in LyX as the
-\begin_inset Quotes eld
-\end_inset
-
-borders
-\begin_inset Quotes erd
-\end_inset
-
- buttons.
- Finally, there is a type
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-@
+ menu item and then select the
+\family sans
+\bar under
+B
+\bar default
+ullets
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, which allows you to use whatever is enclosed in the accompanying braces
- as the column separator, including a null argument.
- The reasons for doing this may not be obvious, but they can be very powerful.
- They are best demonstrated by example.
+ tab.
\end_layout
-\begin_layout Subsection
-Removing Extra Column Space
+\begin_layout Standard
+The dialog provides you with a table of bullet shapes.
+ A column of buttons on the left of the table provides access to the six
+ different panels of bullet shapes.
+ The row of buttons across the top is used to select which bullet depth
+ you are changing.
+ A text entry under the table shows the currently selected bullet shape's
+ LaTeX equivalent and this can be edited if desired.
+ If you do modify the text you will also need to specify any needed packages
+ in the LaTeX preamble.
\end_layout
\begin_layout Standard
-Here is a standard table:
+The six panels are divided up by the packages they require.
+ The following table shows the mappings from button name to LaTeX packages.
\end_layout
\begin_layout Standard
\align center
\begin_inset Tabular
-<lyxtabular version="3" rows="3" columns="2">
+<lyxtabular version="3" rows="7" columns="2">
<features>
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" leftline="true" width="0pt">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
+<column alignment="center" valignment="top" leftline="true" width="0pt">
+<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\bar no
\noun off
\color none
-Type
+Button
\end_layout
\end_inset
</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
\bar no
\noun off
\color none
-Example
+Packages Required
\end_layout
\end_inset
</cell>
</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Rock
+Standard
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Granite
+base LaTeX
\end_layout
\end_inset
</cell>
</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Mineral
+Maths
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Quartz
+amssymb.sty
\end_layout
\end_inset
</cell>
</row>
-</lyxtabular>
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-Notice that the horizontal rule extends a bit past the text on both sides.
- If you wanted the line to end even with the text, we can put a null separator
- on the ends to get rid of the bit of extra space LaTeX adds by default.
- Here is the example:
-\end_layout
-
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="3" columns="2">
-<features>
-<column alignment="left" valignment="top" width="0pt" special="@{} l">
-<column alignment="left" valignment="top" leftline="true" width="0pt" special="l @{}">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Type
+Ding1
\end_layout
\end_inset
</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Example
+pifont.sty
\end_layout
\end_inset
</cell>
</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Rock
+Ding2
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Granite
+pifont.sty
\end_layout
\end_inset
</cell>
</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Mineral
+Ding3
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Quartz
+pifont.sty
\end_layout
\end_inset
</cell>
</row>
-</lyxtabular>
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-In this case, the column specifier for the left column was set to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-@{} l
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, while the right column was set to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-l @{}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-, in order to put the null characters on the edges.
-
-\end_layout
-
-\begin_layout Subsection
-Changing the Column Separator Character
-\end_layout
-
-\begin_layout Standard
-Now suppose you really wanted, for reasons that are completely opaque, to
- use
-\begin_inset Formula $\sqrt{\pi}$
-\end_inset
-
- with some space around it for the column separator.
- Simply turn off the vertical border, then set the right column specifier
- to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-@{~$
-\backslash
-sqrt{
-\backslash
-pi}$~} l
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
- You could now make a table like this:
-\end_layout
-
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="3" columns="2">
-<features>
-<column alignment="left" valignment="top" width="0pt">
-<column alignment="left" valignment="top" width="0in" special="@{~$\sqrt{\pi}$~}l">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Type
+Ding4
\end_layout
\end_inset
</cell>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
\begin_layout Standard
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Example
+pifont.sty
\end_layout
\end_inset
</cell>
</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+</lyxtabular>
-\begin_layout Standard
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
-\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\end_layout
\begin_layout Standard
+LyX doesn't stop you using bullets from packages you don't have.
+ If you get errors from LaTeX when you try to view or print the file then
+ its likely you are missing a package.
+ LyX doesn't restrict your use since you may be editing locally and exporting
+ elsewhere.
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
+\begin_layout Subsection
+How to use it
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+Select which bullet depth you want to change then select the bullet shape
+ and size.
+ Any changes will not be visible in LyX, but are visible when viewing the
+ document using xdvi or ghostview.
+\end_layout
\begin_layout Standard
+You can reset a bullet shape to the default simply by clicking your right
+ mouse button on the appropriate bullet depth button.
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
+\begin_layout Standard
+If you
+\emph on
+really
+\emph default
+ want to have multiple sets of paragraphs with different sets of bullets
+ in each then you're going to have to get your hands dirty.
+ The itemize bullet selection dialog can help though because it provides
+ you with the LaTeX code for a wide range of bullet shapes.
+ To make your own custom paragraphs you have the following options:
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_layout
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\end_layout
\end_inset
\end_layout
-\begin_layout Subsection
-Making a Decimal Point Aligned Column
-\end_layout
-
\begin_layout Standard
-Okay, that last example was very silly, but here is one that is not.
- Suppose you want to make a table that has a column which is aligned on
- a decimal point.
- A standard LaTeX trick to do this is to set the whole number part in a
- right-aligned column, use a decimal point for the column separator, then
- set the fractional part as a left-aligned column.
- A variation on this is to include the decimal point explicitly with the
- whole part, then use just a null separator in between.
- The latter variation is demonstrated here:
-\end_layout
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="5" columns="3">
-<features>
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="right" valignment="top" leftline="true" width="0pt">
-<column alignment="center" valignment="top" width="0pt" special="@{} l">
-<row bottomline="true">
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Expression
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
\end_layout
\end_inset
-</cell>
-<cell multicolumn="1" alignment="center" valignment="top" bottomline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Value
\end_layout
-\end_inset
-</cell>
-<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Standard
-
-\end_layout
-
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Itemize
+Use the LaTeX command
+\family typewriter
-\begin_layout Standard
+\backslash
+renewcommand{}{}
+\family default
+ to specify a new bullet shape for a given depth.
+ You'll also need to save the current bullet shape so you can restore it
+ again afterwards.
+ In this itemized list the following LaTeX code was used to change the bullet
+ used for the first depth.
+\newline
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-\begin_inset Formula $\pi$
-\end_inset
+\family typewriter
+\backslash
+let
+\backslash
+savelabelitemi=
+\backslash
+labelitemi
+\family default
+
+\family typewriter
-\end_layout
+\newline
-\end_inset
-</cell>
-<cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+small
+\backslash
+(
+\backslash
+sharp
+\backslash
+)}
+\newline
-\begin_layout Standard
+\family default
+Note that the itemize depth is specified in Roman numerals as part of the
+
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-3.
+\backslash
+labelitem
+\family default
+ command.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Itemize
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-1416
+[
+\backslash
+(
+\backslash
+star
+\backslash
+)]
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-\begin_inset Formula $\pi^{\pi}$
-\end_inset
-
+ Specify each individual entry by starting each item with the bullet shape
+ enclosed in square brackets and set as TeX.
+ For example, this item was started with
+\family typewriter
+[
+\backslash
+(
+\backslash
+star
+\backslash
+)]
+\family default
+.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-36.
+
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-462
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+You'll also need to revert the labelitem back to its previous setting for
+ the global bullet shape settings to remain in effect.
+ The way used here was:
+\newline
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-\begin_inset Formula $(\pi^{\pi})^{\pi}$
-\end_inset
+\family typewriter
+\backslash
+renewcommand
+\backslash
+labelitemi[0]{
+\backslash
+savelabelitemi}
+\end_layout
+\begin_layout Chapter
+Special Document Classes
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Section
+AMS LaTeX
+\end_layout
\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-80663.
+by
+\noun on
+David Johnson
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+\noindent
+The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
+ papers to be submitted to American Mathematical Society publications.
+ The layouts are not tailored to a specific journal, but easily can be.
+ You should refer to the AMS documentation for specific instructions for
+ each journal (usually it will entail only changing a single line in the
+ TeX output).
+ That documentation is available on the Web at
+\begin_inset LatexCommand url
+target "http://www.ams.org"
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-\begin_inset Formula $\pi^{\pi^{\pi}}$
\end_inset
-
-\end_layout
+ or by ftp at
+\begin_inset LatexCommand url
+target "ftp://ftp.ams.org/pub/tex/amslatex/"
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-1.
+.These layouts are appropriate, and useful, for any mathematical writing.
+ There are currently 4 distinct AMS LaTeX layouts:
\end_layout
+\begin_layout Enumerate
+amsart: The standard AMS-article format.
+ All results and similar statements are numbered as
+\begin_inset Formula $(n.m)$
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-3402
-\begin_inset Formula $\times10^{18}$
-\end_inset
+, where the first number refers to the section, and the second refers to
+ the total number of results (Theorems, Corollaries, Propositions, Definitions
+ and Remarks, etc.) in that section.
+ There are also many (but not all) environments available unnumbered, which
+ is occasionally needed.
+ Unnumbered environments indicated by an asterisk at the end.
+\end_layout
+\begin_layout Enumerate
+amsart-seq: Here, numbering for each type of statement is in its own sequence,
+ with no reference to the section number.
+ There are also many (but not all) environments available unnumbered, which
+ is occasionally needed.
+ Unnumbered environments indicated by an asterisk at the end.
+\end_layout
+\begin_layout Enumerate
+amsart-plain: This one is even more terse, since all the environments are
+ unnumbered.
\end_layout
+\begin_layout Enumerate
+amsbook: the standard AMS book (really, monograph) format.
+ Numbering is similar to the amsart layout, except that all numbering is
+ by
+\begin_inset Formula $(n.m.p)$
\end_inset
-</cell>
-</row>
-</lyxtabular>
-\end_inset
+, where the first number refers to the chapter, the second to the section,
+ and the third is the number of the results (Theorems, Corollaries, Propositions
+, Definitions and Remarks, etc.) in that section.
+ There are also many (but not all) environments available unnumbered, which
+ is occasionally needed.
+ Unnumbered environments indicated by an asterisk at the end.
+\end_layout
+\begin_layout Standard
+Any AMS LyX file can be converted to either of the numbering schemes by
+ simply changing the document class in the
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
+\bar under
+S
+\bar default
+ettings
+\family default
+ dialog.
+
\end_layout
-\begin_layout Standard
-Though it appears a bit funny in LyX, on paper it will produce what appears
- to be a 2-column table in which the right column is aligned on the decimal
- point and the header appears to be centered over it.
+\begin_layout Subsection
+What these layouts provide
\end_layout
\begin_layout Standard
-Perhaps it is best if I described just what I did: first, create a 3
-\begin_inset Formula $\times$
-\end_inset
-
-3 table and remove all the borders.
- Then re-add a bottom border to the top row, and a right border to the first
- column.
- Type in the values for the first column and set its alignment to
+There is a long list of included environments provided by these layouts.
+ Most mathematical papers or books will set as special statements most of
+ these environments, in AMS-LaTeX there is an opportunity to define an unlimited
+ variety of such declarations.
+ However, the AMS recommends the environments that are available in LyX.
+ The list of environments (not counting the standard environments such as
+
\family sans
-center
-\family default
-.
- Type in the
-\family typewriter
-3.
-\family default
-,
-\family typewriter
-36.
-\family default
-,
-\family typewriter
-80663.
+sections, bibliography, title, author, date
\family default
-, and
-\family typewriter
-1.
+), is:
+\end_layout
-\family default
- and set that column's alignment to
-\family sans
-right
-\family default
-.
- Type in the
-\family typewriter
-1416
-\family default
-,
-\family typewriter
-462
-\family default
-, and
-\family typewriter
-3402
-\begin_inset Formula $\times10^{18}$
+\begin_layout Description
+Theorem This is typically used for the statements of major results.
+ The word
+\begin_inset Quotes eld
\end_inset
+\family sans
+Theorem
\family default
- and set the extra column alignment to
-\family typewriter
-@{} l
-\family default
-.
- Finally type in the word
-\family typewriter
-Value
-\family default
- in the middle column, highlight it and the blank entry to its right, and
- check the
+
+\begin_inset Quotes erd
+\end_inset
+
+ appears in bold type, along with an automatically-determined number (an
+ unnumbered version,
\family sans
-Special Cell
+Theorem*
\family default
- entry
+, is also available).
+ The text is italicized.
+\end_layout
+
+\begin_layout Description
+Corollary This is used for statements which follow fairly directly from
+ previous statements.
+ Again, these can be major results.
+ Unnumbered version
\family sans
-multicolumn
+Corollary*
\family default
-.
- Easy, right?
+ is available.
\end_layout
-\begin_layout Subsection
-A Better Decimal-Alignment Solution
+\begin_layout Description
+Lemma These are smaller results needed to prove other statements.
\end_layout
-\begin_layout Standard
-An alternative way to have decimal alignment in tables is through the
-\family typewriter
-dcolumn
-\family default
- package.
- Add the following to the LateX preamble:
+\begin_layout Description
+Proposition These are less major results which (hopefully) add to the general
+ theory being discussed.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+Conjecture These are statements provided without justification, which the
+ author does not know how to prove, but which seem to be true (to the author,
+ at least).
+\end_layout
-\backslash
-usepackage{dcolumn}
+\begin_layout Description
+Criterion A required condition.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Description
+Algorithm A general procedure to be used.
+\end_layout
-\backslash
-newcolumntype{d}[1]{D{.}{.}{#1}}
+\begin_layout Description
+Axiom This is a property or statement taken as true within the system being
+ discussed.
\end_layout
-\begin_layout Standard
-To have a column decimally aligned, enter in the
-\family sans
-Special Column Alignment
-\family default
- box of the
-\family sans
-Table
-\family default
- dialog the following:
+\begin_layout Description
+Definition Guess what this is for.
+ The font, both on-screen and in the output, is different for this environment
+ than for the previous ones.
+ The heading (
+\begin_inset Quotes eld
+\end_inset
+
+definition
+\begin_inset Quotes erd
+\end_inset
+
+) is still set in boldface, along with the number, if any, but the rest
+ is set upright.
\end_layout
-\begin_layout LyX-Code
-d{number of decimals of the data}
+\begin_layout Description
+Example Typeset similarly to Definition.
\end_layout
-\begin_layout Standard
-To create extra column space just increase the number of decimals in
-\family typewriter
-d{}
-\family default
-.
- Setting the multicolumn attribute for a single cell makes it insensitive
- to the decimal alignment which comes in handy as well.
- A drawback of this method is that math mode is not allowed in a column
- with decimal alignment except if the multicolumn attribute is set.
+\begin_layout Description
+Condition
\end_layout
-\begin_layout Standard
-This method offers the same flexibility as the
-\family typewriter
-dcolumn
-\family default
- package.
- One could, for example, change the alignment separator, and have different
- alignment separators for different columns by defining multiple column
- types in the preamble.
- The syntax is as follows:
+\begin_layout Description
+Problem
\end_layout
-\begin_layout LyX-Code
-D{inputsep}{outputsep}{decimal places}
+\begin_layout Description
+Exercise
\end_layout
-\begin_layout Standard
-The interested reader is directed towards the
-\family typewriter
-dcolumn
-\family default
- package documentation for more details.
+\begin_layout Description
+Remark This environment is also a new type of theorem.
+ This is set with the word Remark in italics, and the rest upright.
\end_layout
-\begin_layout Section
-Itemize Bullet Selection
-\begin_inset LatexCommand \label{sec:bullet}
+\begin_layout Description
+Note Set similarly to the Remark environment.
+\end_layout
-\end_inset
+\begin_layout Description
+Notation
+\end_layout
+\begin_layout Description
+Claim
+\end_layout
+\begin_layout Description
+Summary
\end_layout
-\begin_layout Standard
-by
-\noun on
- Allan Rae
+\begin_layout Description
+Acknowledgement
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Description
+Case Generally, these are used to break up long arguments, using specific
+ instances of some condition.
+ The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
\end_layout
-\begin_layout Standard
-LyX provides 216 bullet shapes that can be accessed from a simple dialog.
- Using this dialog you can easily specify what bullet shape to use at each
- level of an itemized list.
- These settings are document-wide so you won't be able to specify different
- sets of bullets for different paragraphs
-\begin_inset Foot
-status collapsed
+\begin_layout Description
+Conclusion
+\end_layout
-\begin_layout Standard
-Well, actually you can but you'll have to do it by hand.
+\begin_layout Description
+Fact
\end_layout
+\begin_layout Description
+Proof The word
+\begin_inset Quotes eld
\end_inset
-.
-\end_layout
-\begin_layout Subsection
-How it looks
-\end_layout
+\shape italic
+Proof
+\shape default
-\begin_layout Standard
-Open the dialog by selecting the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\begin_inset Quotes erd
+\end_inset
-\bar under
-S
-\bar default
-ettings
-\family default
- menu item and then select the
-\family sans
-\bar under
-B
-\bar default
-ullets
-\family default
- tab.
+ is set in italics, but the rest is set upright.
+ At the end of this environment (other environments can be nested within
+ this one, of course) a QED symbol (usually a square, but it can vary with
+ different styles) is placed.
\end_layout
-\begin_layout Standard
-The dialog provides you with a table of bullet shapes.
- A column of buttons on the left of the table provides access to the six
- different panels of bullet shapes.
- The row of buttons across the top is used to select which bullet depth
- you are changing.
- A text entry under the table shows the currently selected bullet shape's
- LaTeX equivalent and this can be edited if desired.
- If you do modify the text you will also need to specify any needed packages
- in the LaTeX preamble.
+\begin_layout Description
+Address This should be the author's permanent address.
\end_layout
-\begin_layout Standard
-The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
+\begin_layout Description
+Current\InsetSpace ~
+Address This should be the author's temporary address at the time
+ of submission, if different from the Address.
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="7" columns="2">
-<features>
-<column alignment="center" valignment="top" leftline="true" width="0pt">
-<column alignment="center" valignment="top" leftline="true" rightline="true" width="0pt">
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Description
+Email Author's e-mail address
+\end_layout
-\begin_layout Standard
+\begin_layout Description
+URL Author's Web address, if desired.
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Button
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\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 Standard
+\begin_layout Description
+Thanks
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Packages Required
+\begin_layout Description
+Dedicatory
\end_layout
-\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Description
+Translator
+\end_layout
\begin_layout Standard
+In addition, these environments automatically provide the AMS LaTeX and
+ AMS fonts packages.
+ They need to be available on your system in order to use these environments.
+\end_layout
+
+\begin_layout Section
+Dinbrief
+\end_layout
+\begin_layout Standard
+The document class
\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Standard
+dinbrief
+\family default
+ can be used to type letters according to German conventions.
+ A template file is included in
+\family typewriter
+.../lyx/share/templates
+\family default
+ for you to use as a starting point.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Section
+Paper
+\end_layout
\begin_layout Standard
-
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-base LaTeX
+The document class
+\family sans
+paper
+\family default
+ provides an alternative to the standard
+\family sans
+article
+\family default
+ class.
+ It provides similar functionality, but you might prefer this layout with
+ sans serif sections, headings, and more.
\end_layout
-\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Section
+A&A Paper
+\end_layout
\begin_layout Standard
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Maths
+by
+\noun on
+Peter Sütterlin
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Subsection
+Introduction
+\end_layout
\begin_layout Standard
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (
+\begin_inset LatexCommand url
+name "www.edpsciences.fr/aa/"
+target "http://www.edpsciences.fr/aa/"
+\end_inset
+
+) using Version 5.01 of the document class
\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-amssymb.sty
+aa.cls
+\family default
+.
+ This package can be downloaded from the ftp site
\end_layout
+\begin_layout Standard
+\begin_inset VSpace medskip
\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding1
\end_layout
+\begin_layout Standard
+\align center
+\begin_inset LatexCommand url
+target "ftp://ftp.edpsciences.org/pub/aa/readme.html"
+
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
\end_layout
+\begin_layout Standard
+\begin_inset VSpace medskip
\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding2
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+A manual comes together with that package, and this text is not meant to
+ replace the original manual but merely a short guide how to realize the
+ correct form of your paper.
+
\end_layout
-\end_inset
-</cell>
-</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-
+Please note that the publisher of the journal was changed from Springer
+ to EDP Sciences starting January 1, 2001.
+ That change implicated also some slight changes of the style files, namely
+ the removal of the thesaurus command.
+ The LyX class aa supports the newest version of these style files, V 5.01.
+ If you have an older version installed, please upgrade.
+ For compatibility, the old (version 4) layout has been kept as
\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding3
+article (A&A V4)
+\family default
+.
+ Please refer to the comments in
+\family typewriter
+LyXDir/layouts/aapaper.layout
+\family default
+.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Subsection
+Getting started
+\end_layout
\begin_layout Standard
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+It is recommended you start from the example template distributed with LyX.
+ If you are not using a template, note the following settings:
\end_layout
-\end_inset
-</cell>
-</row>
-<row topline="true" bottomline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout Itemize
+Select
+\family sans
+article (A&A)
+\family default
+ in the
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
-\begin_layout Standard
+\bar under
+S
+\bar default
+ettings
+\family default
+ dialog (OK, that one was obvious).
+\end_layout
+\begin_layout Itemize
+Don't change the option
\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding4
+Page\InsetSpace ~
+style
+\family default
+: Leave it set to
+\family sans
+default
+\family default
+.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
+\begin_layout Subsection
+The header block
+\end_layout
\begin_layout Standard
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
+\end_layout
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\begin_layout Itemize
+
+\family sans
+Title
+\family default
+: [required]
\end_layout
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+\begin_layout Itemize
-\end_inset
+\family sans
+Subtitle
+\family default
+: [optional]
+\end_layout
+\begin_layout Itemize
+\family sans
+Author
+\family default
+: [required]
\end_layout
-\begin_layout Standard
-LyX doesn't stop you using bullets from packages you don't have.
- If you get errors from LaTeX when you try to view or print the file then
- its likely you are missing a package.
- LyX doesn't restrict your use since you may be editing locally and exporting
- elsewhere.
+\begin_layout Itemize
+
+\family sans
+Address
+\family default
+: [required]
\end_layout
-\begin_layout Subsection
-How to use it
+\begin_layout Itemize
+
+\family sans
+Offprints
+\family default
+: [optional] if more than one author: whom to contact for offprint requests.
\end_layout
-\begin_layout Standard
-Select which bullet depth you want to change then select the bullet shape
- and size.
+\begin_layout Itemize
\family sans
-
+Mail
\family default
-Any changes will not be visible in LyX, but are visible when viewing the
- document using xdvi or ghostview.
+: [optional] mail address for contacts.
\end_layout
-\begin_layout Standard
-You can reset a bullet shape to the default simply by clicking your right
- mouse button on the appropriate bullet depth button.
+\begin_layout Itemize
+
+\family sans
+Date
+\family default
+: [required].
+ Suggested format is
+\family typewriter
+Received: <date>; Accepted <date>
\end_layout
\begin_layout Standard
-If you
-\emph on
-really
-\emph default
- want to have multiple sets of paragraphs with different sets of bullets
- in each then you're going to have to get your hands dirty.
- The itemize bullet selection dialog can help though because it provides
- you with the LaTeX code for a wide range of bullet shapes.
- To make your own custom paragraphs you have the following options:
+There is no need to issue the
+\family typewriter
+
+\backslash
+maketitle
+\family default
+ command, this is done automatically by LyX when the header is finished.
+ Although the order of the single header entries doesn't matter it is advised
+ to keep the above sequence, just to get the best optics and meets the layout
+ of the real document.
\end_layout
\begin_layout Standard
+If you want to place footnotes in the header block, e.\InsetSpace \thinspace{}
+g.
\begin_inset ERT
-status inlined
+status collapsed
\begin_layout Standard
+
\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
+
\end_layout
\end_inset
+to state your present address, just use the standard footnote via
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+
+\bar under
+F
+\bar default
+ootnote.
+
+\family default
+ LyX will automagically use the term
+\family typewriter
+\backslash
+thanks{}
+\family default
+ in that case.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
+In addition to these topics, the macros use three additional LaTeX commands
+ that have no counterpart in LyX:
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+
+\family typewriter
\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
-\end_layout
-
-\end_inset
-
-
+and
+\family default
+ to separate different names for more than one author and institute, respectivel
+y.
\end_layout
\begin_layout Itemize
-Use the LaTeX command
-\family typewriter
-
-\backslash
-renewcommand{}{}
-\family default
- to specify a new bullet shape for a given depth.
- You'll also need to save the current bullet shape so you can restore it
- again afterwards.
- In this itemized list the following LaTeX code was used to change the bullet
- used for the first depth.
-\newline
\family typewriter
\backslash
-let
-\backslash
-savelabelitemi=
-\backslash
-labelitemi
+inst{<nr>}
\family default
-
-\family typewriter
-
-\newline
+to mark corresponding author/institute pairs.
+ The institutes are numbered sequentially as they appear in the
+\family sans
+Address
+\family default
+ field, so you have to put a marker to each author.
+\end_layout
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-small
-\backslash
-(
-\backslash
-sharp
-\backslash
-)}
-\newline
+\begin_layout Itemize
-\family default
-Note that the itemize depth is specified in Roman numerals as part of the
-
\family typewriter
\backslash
-labelitem
+email{address}
\family default
- command.
+ to supply an email address for fast contact.
\end_layout
-\begin_layout Itemize
-\begin_inset ERT
-status inlined
-
\begin_layout Standard
-[
-\backslash
-(
-\backslash
-star
-\backslash
-)]
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
+
\end_layout
-\end_inset
+\begin_layout Subsection
+The abstract
+\end_layout
- Specify each individual entry by starting each item with the bullet shape
- enclosed in square brackets and set as TeX.
- For example, this item was started with
+\begin_layout Standard
+The abstract should immediately follow the header block.
+ With version 5 the abstract environment was changed to a command, and there
+ is now a resctriction to only one paragraph.
+ In addition, it should contain an entry with the keywords.
+ This is not yet implemented for LyX, therefore you have to enter the LaTeX
+ command
\family typewriter
-[
-\backslash
-(
-\backslash
-star
+
\backslash
-)]
+keywords{}
\family default
-.
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_layout Subsection
+Supported environments
+\end_layout
\begin_layout Standard
-
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+The A&A paper layout supports the following environments for structuring
+ your text:
\end_layout
-\end_inset
-
+\begin_layout Itemize
+\family sans
+Standard
\end_layout
-\begin_layout Standard
-You'll also need to revert the labelitem back to its previous setting for
- the global bullet shape settings to remain in effect.
- The way used here was:
-\newline
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-renewcommand
-\backslash
-labelitemi[0]{
-\backslash
-savelabelitemi}
+\family sans
+Section
\end_layout
-\begin_layout Chapter
-Special Document Classes
-\end_layout
+\begin_layout Itemize
-\begin_layout Section
-AMS LaTeX
+\family sans
+Subsection
\end_layout
-\begin_layout Standard
-by
-\noun on
-David Johnson
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
+\family sans
+Subsubsection
+\end_layout
+\begin_layout Itemize
+\family sans
+Itemize
\end_layout
-\begin_layout Standard
-\noindent
-The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
- papers to be submitted to American Mathematical Society publications.
- The layouts are not tailored to a specific journal, but easily can be.
- You should refer to the AMS documentation for specific instructions for
- each journal (usually it will entail only changing a single line in the
- TeX output).
- That documentation is available on the Web at
-\begin_inset LatexCommand \url{http://www.ams.org}
-
-\end_inset
+\begin_layout Itemize
- or by ftp at
-\begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
+\family sans
+Enumerate
+\end_layout
-\end_inset
+\begin_layout Itemize
-.These layouts are appropriate, and useful, for any mathematical writing.
- There are currently 4 distinct AMS LaTeX layouts:
+\family sans
+Description
\end_layout
-\begin_layout Enumerate
-amsart: The standard AMS-article format.
- All results and similar statements are numbered as
-\begin_inset Formula $(n.m)$
-\end_inset
+\begin_layout Itemize
-, where the first number refers to the section, and the second refers to
- the total number of results (Theorems, Corollaries, Propositions, Definitions
- and Remarks, etc.) in that section.
- There are also many (but not all) environments available unnumbered, which
- is occasionally needed.
- Unnumbered environments indicated by an asterisk at the end.
+\family sans
+Caption
\end_layout
-\begin_layout Enumerate
-amsart-seq: Here, numbering for each type of statement is in its own sequence,
- with no reference to the section number.
- There are also many (but not all) environments available unnumbered, which
- is occasionally needed.
- Unnumbered environments indicated by an asterisk at the end.
-\end_layout
+\begin_layout Itemize
-\begin_layout Enumerate
-amsart-plain: This one is even more terse, since all the environments are
- unnumbered.
+\family sans
+Abstract
\end_layout
-\begin_layout Enumerate
-amsbook: the standard AMS book (really, monograph) format.
- Numbering is similar to the amsart layout, except that all numbering is
- by
-\begin_inset Formula $(n.m.p)$
-\end_inset
+\begin_layout Itemize
-, where the first number refers to the chapter, the second to the section,
- and the third is the number of the results (Theorems, Corollaries, Propositions
-, Definitions and Remarks, etc.) in that section.
- There are also many (but not all) environments available unnumbered, which
- is occasionally needed.
- Unnumbered environments indicated by an asterisk at the end.
+\family sans
+Acknowledgment
\end_layout
-\begin_layout Standard
-Any AMS LyX file can be converted to either of the numbering schemes by
- simply changing the document class in the
+\begin_layout Itemize
+
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+Bibliography
+\end_layout
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-
+\begin_layout Itemize
+
+\family sans
+LaTeX
\end_layout
\begin_layout Subsection
-What these layouts provide
+Commands not supported by LyX
\end_layout
\begin_layout Standard
-There is a long list of included environments provided by these layouts.
- Most mathematical papers or books will set as special statements most of
- these environments, in AMS-LaTeX there is an opportunity to define an unlimited
- variety of such declarations.
- However, the AMS recommends the environments that are available in LyX.
- The list of environments (not counting the standard environments such as
-
+Some commands are not yet supported by the
\family sans
-sections, bibliography, title, author, date
+paper (A&A)
\family default
-), is:
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
\end_layout
-\begin_layout Description
-Theorem This is typically used for the statements of major results.
- The word
-\begin_inset Quotes eld
-\end_inset
-
-
-\family sans
-Theorem
-\family default
-
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- appears in bold type, along with an automatically-determined number (an
- unnumbered version,
-\family sans
-Theorem*
-\family default
-, is also available).
- The text is italicized.
-\end_layout
+\family typewriter
-\begin_layout Description
-Corollary This is used for statements which follow fairly directly from
- previous statements.
- Again, these can be major results.
- Unnumbered version
-\family sans
-Corollary*
-\family default
- is available.
+\backslash
+and
\end_layout
-\begin_layout Description
-Lemma These are smaller results needed to prove other statements.
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Proposition These are less major results which (hopefully) add to the general
- theory being discussed.
-\end_layout
+\family typewriter
-\begin_layout Description
-Conjecture These are statements provided without justification, which the
- author does not know how to prove, but which seem to be true (to the author,
- at least).
+\backslash
+email
\end_layout
-\begin_layout Description
-Criterion A required condition.
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Algorithm A general procedure to be used.
-\end_layout
+\family typewriter
-\begin_layout Description
-Axiom This is a property or statement taken as true within the system being
- discussed.
+\backslash
+appendix
\end_layout
-\begin_layout Description
-Definition Guess what this is for.
- The font, both on-screen and in the output, is different for this environment
- than for the previous ones.
- The heading (
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-definition
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
-) is still set in boldface, along with the number, if any, but the rest
- is set upright.
+\backslash
+authorrunning
\end_layout
-\begin_layout Description
-Example Typeset similarly to Definition.
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Condition
-\end_layout
+\family typewriter
-\begin_layout Description
-Problem
+\backslash
+inst{}
\end_layout
-\begin_layout Description
-Exercise
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Remark This environment is also a new type of theorem.
- This is set with the word Remark in italics, and the rest upright.
-\end_layout
+\family typewriter
-\begin_layout Description
-Note Set similarly to the Remark environment.
+\backslash
+keywords{}
\end_layout
-\begin_layout Description
-Notation
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Claim
-\end_layout
+\family typewriter
-\begin_layout Description
-Summary
+\backslash
+object{}
\end_layout
-\begin_layout Description
-Acknowledgement
-\end_layout
+\begin_layout Itemize
-\begin_layout Description
-Case Generally, these are used to break up long arguments, using specific
- instances of some condition.
- The numbering scheme for cases is on its own, not together with other numbered
- statements.
-
-\end_layout
+\family typewriter
-\begin_layout Description
-Conclusion
+\backslash
+titlerunning{}
\end_layout
-\begin_layout Description
-Fact
+\begin_layout Standard
+If you want to use any of these commands, you have to enter them yourself.
+
+\series bold
+Do not forget to mark them as LaTeX code!
\end_layout
-\begin_layout Description
-Proof The word
-\begin_inset Quotes eld
-\end_inset
-
-
-\shape italic
-Proof
-\shape default
-
-\begin_inset Quotes erd
-\end_inset
-
- is set in italics, but the rest is set upright.
- At the end of this environment (other environments can be nested within
- this one, of course) a QED symbol (usually a square, but it can vary with
- different styles) is placed.
+\begin_layout Subsection
+Figure and Table Floats
\end_layout
-\begin_layout Description
-Address This should be the author's permanent address.
-\end_layout
+\begin_layout Standard
+LyX provides support for the necessary float environments
+\family sans
+figure, figure*, table
+\family default
+ and
+\family sans
+table*
+\family default
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's\InsetSpace ~
+Guide
+\emph default
+.
+ Just remember that tables should be left-aligned.
+ For that, select the table and change the alignment in
+\family sans
+\bar under
+E
+\bar default
+dit\SpecialChar \menuseparator
-\begin_layout Description
-Current\InsetSpace ~
-Address This should be the author's temporary address at the time
- of submission, if different from the Address.
+\bar under
+P
+\bar default
+aragraph\InsetSpace ~
+Settings.
\end_layout
-\begin_layout Description
-Email Author's e-mail address
+\begin_layout Standard
+There is only one special thing: the figures with caption besides the figure.
+ To create such a figure, you have to do the following:
\end_layout
-\begin_layout Description
-URL Author's Web address, if desired.
+\begin_layout Enumerate
+Create a wide figure float:
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+Flo
+\bar under
+a
+\bar default
+t\SpecialChar \menuseparator
+Figure
+\family default
+, then right click in the figure and select
+\family sans
+\bar under
+S
+\bar default
+pan\InsetSpace ~
+columns
+\family default
+.
\end_layout
-\begin_layout Description
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
+\begin_layout Enumerate
+Enter your caption text.
\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.
+\begin_layout Enumerate
+Press
+\family sans
+Return
+\family default
+ to move the cursor above the caption.
\end_layout
-\begin_layout Description
-Thanks
+\begin_layout Enumerate
+Insert your figure
\end_layout
-\begin_layout Description
-Dedicatory
+\begin_layout Enumerate
+Position the cursor behind the figure and insert a horizontal fill:
+\family sans
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+
+\bar under
+S
+\bar default
+pecial\InsetSpace ~
+Character
+\bar under
+\SpecialChar \menuseparator
+H
+\bar default
+orizontal\InsetSpace ~
+Fill
+\family default
+.
\end_layout
-\begin_layout Description
-Translator
+\begin_layout Enumerate
+Switch to LaTeX mode:
+\family sans
+M-c\InsetSpace ~
+t
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Enter
+\family typewriter
+
+\backslash
+parbox[b]{55mm}{
+\family default
+.
+
+\series bold
+Do not close the brace!
+\end_layout
+
+\begin_layout Enumerate
+Position the cursor behind the caption text, switch to LaTeX mode and insert
+ the closing brace:
+\family sans
+M-c\InsetSpace ~
+t
+\family default
+
+\family typewriter
+}
+\family default
+.
\end_layout
\begin_layout Standard
-In addition, these environments automatically provide the AMS LaTeX and
- AMS fonts packages.
- They need to be available on your system in order to use these environments.
+Also, refer to the figures in the example paper.
\end_layout
-\begin_layout Section
-Dinbrief
+\begin_layout Subsection
+Referee layout
\end_layout
\begin_layout Standard
-The document class
+For submission, the paper has to be formated in a special double-spacing
+ layout.
+ For this purpose, you have to give the option
+\family typewriter
+referee
+\family default
+ to the documentclass.
+ This must be done using the extra class options field in the
\family sans
-dinbrief
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
+
+\bar under
+S
+\bar default
+ettings
\family default
- can be used to type letters according to German conventions.
- A template file is included in
+ dialog.
+ Just enter the string
\family typewriter
-.../lyx/share/templates
+referee
\family default
- for you to use as a starting point.
+ there.
\end_layout
-\begin_layout Section
-Paper
+\begin_layout Subsection
+The example paper
\end_layout
\begin_layout Standard
-The document class
-\family sans
-paper
-\family default
- provides an alternative to the standard
+The
\family sans
-article
+Examples
\family default
- class.
- It provides similar functionality, but you might prefer this layout with
- sans serif sections, headings, and more.
+ directory contains an example paper written with LyX.
+ It is the example paper from the original macro package, translated to
+ LyX.
+ Use it for inspiration, and compare the original LaTeX code with LyX way
+ of writing.
\end_layout
\begin_layout Section
-A&A Paper
+AASTeX
\end_layout
\begin_layout Standard
by
\noun on
-Peter Sütterlin
+Mike Ressler
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-This section describes how LyX can be used to write articles for submission
- to the scientific journal
-\emph on
-Astronomy and Astrophysics
-\emph default
- (
-\begin_inset LatexCommand \url[www.edpsciences.fr/aa/]{http://www.edpsciences.fr/aa/}
-
-\end_inset
-
-)
-\emph on
-
-\emph default
-using
-\emph on
-
-\emph default
-Version 5.01 of the document class
-\family typewriter
-aa.cls
-\family default
-.
- This package can be downloaded from the ftp site
+AASTeX is a set of macros produced by the American Astronomical Society
+ to facilitate electronic manuscript submission to the three journals they
+ publish: the Astrophysical Journal (including the Letters and Supplement),
+ the Astronomical Journal, and the Publications of the Astronomical Society
+ of the Pacific.
+ LyX has proven to be an excellent tool for generating these documents,
+ especially given its equation, citation, and figure handling capabilities.
+ LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
+ is the version described here, or higher.
+ Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
+ incompatible with LyX.
+ The AASTeX package may be downloaded from the AASTeX Web site
\end_layout
\begin_layout Standard
\begin_layout Standard
\align center
-\begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
+\begin_inset LatexCommand url
+target "http://www.journals.uchicago.edu/AAS/AASTeX"
\end_inset
\end_layout
\begin_layout Standard
-A manual comes together with that package, and this text is not meant to
- replace the original manual but merely a short guide how to realize the
- correct form of your paper.
-
-\end_layout
-
-\begin_layout Standard
-Please note that the publisher of the journal was changed from Springer
- to EDP Sciences starting January 1, 2001.
- That change implicated also some slight changes of the style files, namely
- the removal of the thesaurus command.
- The LyX class aa supports the newest version of these style files, V 5.01.
- If you have an older version installed, please upgrade.
- For compatibility, the old (version 4) layout has been kept as
-\family sans
-article (A&A V4)
-\family default
-.
- Please refer to the comments in
-\family typewriter
-LyXDir/layouts/aapaper.layout
-\family default
-.
+A complete user guide is contained in that package and you should familiarize
+ yourself with it thoroughly before embarking on writing a paper in LyX.
+ LyX will not reduce the need to figure out all the AASTeX commands, it
+ will only reduce the drudgery of typing everything in.
+ It is your responsibility to ensure that the final exported LaTeX document
+ conforms completely to the requirements of the journal to which you are
+ submitting your paper.
\end_layout
\begin_layout Subsection
-Getting started
+Starting a New Paper
\end_layout
\begin_layout Standard
-It is recommended you start from the example template distributed with LyX.
- If you are not using a template, note the following settings:
-\end_layout
-
-\begin_layout Itemize
-Select
-\family sans
-article (A&A)
-\family default
- in the
+I strongly suggest that you start with the AASTeX template file.
+ Click on
\family sans
\bar under
-D
+F
\bar default
-ocument\SpecialChar \menuseparator
-
+ile\SpecialChar \menuseparator
+New from
+\family default
+
+\family sans
\bar under
-S
+T
\bar default
-ettings
+emplate
\family default
- dialog (OK, that one was obvious).
-\end_layout
+, enter the new file name, then choose the
+\family typewriter
+aastex.lyx
+\family default
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
+\family typewriter
+<>
+\family default
+) with the correct information.
+ Many of the AASTeX commands and environments can be implemented directly
+ in LyX, but some cannot: most noticeably
+\family typewriter
-\begin_layout Itemize
-Don't change the option
-\family sans
-Page\InsetSpace ~
-style
+\backslash
+altaffilmark
\family default
-: Leave it set to
-\family sans
-default
+ and
+\family typewriter
+
+\backslash
+altaffiltext
\family default
-.
- The whole layout is done by the macros, you shouldn't change anything.
+, which should stick out like a sore thumb if you actually just opened the
+ template file.
+ For commands such as these, the LaTeX code must be entered directly and
+ marked as such.
+ Such commands are referred to as ERT, or Evil Red Text.
+ I tried to minimize the amount of ERT needed in an AASTeX document, but
+ there is still a bit more required than any of us would like.
\end_layout
\begin_layout Subsection
-The header block
+Finishing Your Paper
\end_layout
\begin_layout Standard
-First thing to enter is the header information.
- It consists of seven entries, of which some are optional.
- They are
-\end_layout
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-
-\family sans
-Title
-\family default
-: [required]
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Subtitle
-\family default
-: [optional]
-\end_layout
-
-\begin_layout Itemize
+postprocessing
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Author
-\family default
-: [required]
+ actions which need to be done before you submit it to the journals.
+
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+Export your paper as a LaTeX file (
\family sans
-Address
-\family default
-: [required]
-\end_layout
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\begin_layout Itemize
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
-\family sans
-Offprints
+\bar under
+L
+\bar default
+aTeX
\family default
-: [optional] if more than one author: whom to contact for offprint requests.
+).
+
\end_layout
-\begin_layout Itemize
-
-\family sans
-Mail
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
\family default
-: [optional] mail address for contacts.
+ file with your favorite text editor
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
+\family typewriter
-\family sans
-Date
+\backslash
+documentclass
\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+ command
\end_layout
-\begin_layout Standard
-There is no need to issue the
+\begin_layout Enumerate
+remove the
\family typewriter
\backslash
-maketitle
+usepackage...{fontenc}
\family default
- command, this is done automatically by LyX when the header is finished.
- Although the order of the single header entries doesn't matter it is advised
- to keep the above sequence, just to get the best optics and meets the layout
- of the real document.
-\end_layout
-
-\begin_layout Standard
-If you want to place footnotes in the header block, e.g.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
+ line if it appears (usually just after
+\family typewriter
\backslash
-
-\end_layout
-
-\end_inset
-
-to state your present address, just use the standard footnote via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-F
-\bar default
-ootnote.
-
+documentclass
\family default
-LyX will automagically use the term
+}; also remove the
\family typewriter
\backslash
-thanks{}
+secnumdepth
\family default
- in that case.
-\end_layout
-
-\begin_layout Standard
-In addition to these topics, the macros use three additional LaTeX commands
- that have no counterpart in LyX:
+ line if it appears.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+remove everything between (and including) the
\family typewriter
\backslash
-and
+makeatletter
\family default
- to separate different names for more than one author and institute, respectivel
-y.
-\end_layout
-
-\begin_layout Itemize
-
+ and
\family typewriter
\backslash
-inst{<nr>}
-\family default
-to mark corresponding author/institute pairs.
- The institutes are numbered sequentially as they appear in the
-\family sans
-Address
+makeatother
\family default
- field, so you have to put a marker to each author.
-\end_layout
+ commands, except for any commands you specifically put into the LaTeX preamble
+ (which should appear immediately after the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+User specified LaTeX commands
+\begin_inset Quotes erd
+\end_inset
+ comment in the
\family typewriter
-
-\backslash
-email{address}
+.tex
\family default
- to supply an email address for fast contact.
+ file).
\end_layout
-\begin_layout Standard
-In all cases, the appropriate command has to be entered in LyX an marked
- as LaTeX code.
- See the examples.
-
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through LaTeX to make sure it still processes correctly.
\end_layout
-\begin_layout Subsection
-The abstract
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
\end_layout
-\begin_layout Standard
-The abstract should immediately follow the header block.
- With version 5 the abstract environment was changed to a command, and there
- is now a resctriction to only one paragraph.
- In addition, it should contain an entry with the keywords.
- This is not yet implemented for LyX, therefore you have to enter the LaTeX
- command
-\family typewriter
-
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
+\begin_layout Enumerate
+Submit it.
\end_layout
\begin_layout Subsection
-Supported environments
+Comments On Specific Commands
\end_layout
\begin_layout Standard
-The A&A paper layout supports the following environments for structuring
- your text:
-\end_layout
-
-\begin_layout Itemize
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
+\family typewriter
+aasguide.tex
+\family default
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar \ldots{}
-\family sans
-Standard
\end_layout
-\begin_layout Itemize
-
-\family sans
-Section
+\begin_layout Subsubsection
+Things that work as expected
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\begin_inset ERT
+status inlined
-\family sans
-Subsection
-\end_layout
+\begin_layout Standard
-\begin_layout Itemize
-\family sans
-Subsubsection
+\backslash
+begin{sloppypar}
\end_layout
-\begin_layout Itemize
-
-\family sans
-Itemize
-\end_layout
+\end_inset
-\begin_layout Itemize
-\family sans
-Enumerate
\end_layout
-\begin_layout Itemize
-
-\family sans
-Description
-\end_layout
+\begin_layout Standard
+Because they work as you might expect, I simply list them and the section
+ they are found in:
+\family typewriter
-\begin_layout Itemize
+\backslash
+documentclass
+\family default
+ (2.1.1),
+\family typewriter
-\family sans
-Caption
-\end_layout
+\backslash
+begin{document}
+\family default
+ (2.2),
+\family typewriter
-\begin_layout Itemize
+\backslash
+title
+\family default
+ (2.3),
+\family typewriter
-\family sans
-Abstract
-\end_layout
+\backslash
+author
+\family default
+ (2.3),
+\family typewriter
-\begin_layout Itemize
+\backslash
+affil
+\family default
+ (2.3),
+\family typewriter
-\family sans
-Acknowledgment
-\end_layout
+\backslash
+abstract
+\family default
+ (2.4),
+\family typewriter
-\begin_layout Itemize
+\backslash
+keywords
+\family default
+ (2.5),
+\family typewriter
-\family sans
-Bibliography
-\end_layout
+\backslash
+section
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Itemize
+\backslash
+subsection
+\family default
+ (2.7),
+\family typewriter
-\family sans
-LaTeX
-\end_layout
+\backslash
+subsubsection
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Subsection
-Commands not supported by LyX
-\end_layout
+\backslash
+paragraph
+\family default
+ (2.7),
+\family typewriter
-\begin_layout Standard
-Some commands are not yet supported by the
-\family sans
-paper (A&A)
+\backslash
+facility
\family default
- layout for LyX.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
-\end_layout
+ (2.10),
+\family typewriter
-\begin_layout Itemize
+\backslash
+begin{displaymath}
+\family default
+ (2.12),
+\family typewriter
+\backslash
+begin{equation}
+\family default
+ (2.12),
\family typewriter
\backslash
-and
-\end_layout
+begin{eqnarray}
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Itemize
+\backslash
+begin{mathletters}
+\family default
+ (2.12),
+\family typewriter
+\backslash
+begin{thebibliography}
+\family default
+ (2.13.1),
\family typewriter
\backslash
-email
-\end_layout
+bibitem
+\family default
+ (2.13.2), all the cite commands and their variations (2.13.2), the generic
+ graphicx figure commands (2.14.1),
+\family typewriter
-\begin_layout Itemize
+\backslash
+begin{table}
+\family default
+ (2.15.4),
+\family typewriter
+\backslash
+begin{tabular}
+\family default
+ (2.15.4),
\family typewriter
\backslash
-appendix
-\end_layout
+caption
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Itemize
+\backslash
+label
+\family default
+ (2.15.4, amongst other places),
+\family typewriter
+\backslash
+tablerefs
+\family default
+ (2.15.5),
\family typewriter
\backslash
-authorrunning
-\end_layout
+tablecomments
+\family default
+ (2.15.5),
+\family typewriter
-\begin_layout Itemize
+\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 Standard
+\begin_inset ERT
+status inlined
+
+\begin_layout Standard
+
\backslash
-inst{}
+end{sloppypar}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsubsection
+Things that work, but require more comment
+\end_layout
+
+\begin_layout Standard
+The following items work, but require a little more discussion:
\end_layout
\begin_layout Itemize
+These items are reserved for use by the journal editors, but you can put
+ them into the LaTeX preamble if you feel compelled to do so:
+\family typewriter
+\backslash
+received
+\family default
+,
\family typewriter
\backslash
-keywords{}
-\end_layout
+revised
+\family default
+,
+\family typewriter
-\begin_layout Itemize
+\backslash
+accepted
+\family default
+,
+\family typewriter
+\backslash
+ccc
+\family default
+,
\family typewriter
\backslash
-object{}
+cpright
+\family default
+ (all from 2.1.3)
\end_layout
\begin_layout Itemize
+These items may be placed in the LaTeX preamble, and are included as blanks
+ in the template file:
+\family typewriter
+\backslash
+slugcomment
+\family default
+ (2.1.4),
\family typewriter
\backslash
-titlerunning{}
-\end_layout
+shorttitle
+\family default
+ (2.1.5),
+\family typewriter
-\begin_layout Standard
-If you want to use any of these commands, you have to enter them yourself.
-
-\series bold
-Do not forget to mark them as LaTeX code!
+\backslash
+shortauthors
+\family default
+ (2.1.5)
\end_layout
-\begin_layout Subsection
-Figure and Table Floats
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-LyX provides support for the necessary float environments
-\family sans
-figure, figure*, table
-\family default
-and
-\family sans
-table*
+\family typewriter
+
+\backslash
+email
\family default
-, therefore we won't tell much about it here.
- Refer to the
-\emph on
-User's\InsetSpace ~
-Guide
-\emph default
-.
- Just remember that tables should be left-aligned.
- For that, select the table and change the alignment in
-\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
+ (2.3) -- can only be used
+\begin_inset Quotes eld
+\end_inset
-\bar under
-P
-\bar default
-aragraph\InsetSpace ~
-Settings.
+standalone
+\begin_inset Quotes erd
+\end_inset
+
+, not in the middle of a paragraph.
+ Use ERT if you need to embed it.
\end_layout
-\begin_layout Standard
-There is
-\family sans
-
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+and
\family default
-only one special thing: the figures with caption besides the figure.
- To create such a figure, you have to do the following:
+ (2.3) -- will have extra {} after it.
+ This should not cause an error.
\end_layout
-\begin_layout Enumerate
-Create a wide figure float:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Flo
-\bar under
-a
-\bar default
-t\SpecialChar \menuseparator
-Figure
-\family default
-, then right click in the figure and select
-\family sans
-
-\bar under
-S
-\bar default
-pan\InsetSpace ~
-columns
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+notetoeditor
\family default
-.
-\end_layout
+ (2.6) -- can only be used
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Enumerate
-Enter your caption text.
+standalone
+\begin_inset Quotes erd
+\end_inset
+
+, not in the middle of a paragraph.
+ Use ERT if you need to embed it.
\end_layout
-\begin_layout Enumerate
-Press
-\family sans
-Return
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+placetable
\family default
- to move the cursor above the caption.
+ (2.8) -- can't insert a cross-reference tag, you must type the tag name
+ by hand
\end_layout
-\begin_layout Enumerate
-Insert your figure
+\begin_layout Itemize
+
+\family typewriter
+
+\backslash
+placefigure
+\family default
+ (2.8) -- same as for
+\family typewriter
+
+\backslash
+placetable
\end_layout
-\begin_layout Enumerate
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+\begin_layout Itemize
-\bar under
-S
-\bar default
-pecial\InsetSpace ~
-Character
-\bar under
-\SpecialChar \menuseparator
-H
-\bar default
-orizontal\InsetSpace ~
-Fill
+\family typewriter
+
+\backslash
+acknowledgements
\family default
-.
+ (2.9) -- will have extra {} after it.
+ This should not cause an error.
\end_layout
-\begin_layout Enumerate
-Switch to LaTeX mode:
-\family sans
-M-c\InsetSpace ~
-t
+\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 Enumerate
-Enter
+\begin_layout Itemize
+
\family typewriter
\backslash
-parbox[b]{55mm}{
+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
.
-\series bold
-Do not close the brace!
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Enumerate
-Position the cursor behind the caption text, switch to LaTeX mode and insert
- the closing brace:
-\family sans
-M-c\InsetSpace ~
-t
+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 Standard
-Also, refer to the figures in the example paper.
-\end_layout
-
-\begin_layout Subsection
-Referee layout
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-For submission, the paper has to be formated in a special double-spacing
- layout.
- For this purpose, you have to give the option
\family typewriter
-referee
-\family default
- to the documentclass.
- This must be done using the extra class options field in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-\bar under
-S
-\bar default
-ettings
+\backslash
+objectname
\family default
- dialog.
- Just enter the string
+ (2.17.1) -- same as
\family typewriter
-referee
+
+\backslash
+figcaption
\family default
- there.
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Subsection
-The example paper
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-The
-\family sans
-Examples
+\family typewriter
+
+\backslash
+dataset
\family default
- directory contains an example paper written with LyX.
- It is the example paper from the original macro package, translated to
- LyX.
- Use it for inspiration, and compare the original LaTeX code with LyX way
- of writing.
+ (2.17.1) -- same as
+\family typewriter
+
+\backslash
+figcaption
+\family default
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Section
-AASTeX
+\begin_layout Subsubsection
+Things not implemented, use ERT
\end_layout
\begin_layout Standard
-by
-\noun on
-Mike Ressler
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-AASTeX is a set of macros produced by the American Astronomical Society
- to facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- LyX has proven to be an excellent tool for generating these documents,
- especially given its equation, citation, and figure handling capabilities.
- LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
- incompatible with LyX.
- The AASTeX package may be downloaded from the AASTeX Web site
-\end_layout
-
-\begin_layout Standard
-\begin_inset VSpace medskip
-\end_inset
-
-
-\end_layout
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\align center
-\begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
-
-\end_inset
+\backslash
+begin{sloppypar}
\end_layout
-\begin_layout Standard
-\begin_inset VSpace medskip
\end_inset
\end_layout
\begin_layout Standard
-A complete user guide is contained in that package and you should familiarize
- yourself with it thoroughly before embarking on writing a paper in LyX.
- LyX will not reduce the need to figure out all the AASTeX commands, it
- will only reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported LaTeX document
- conforms completely to the requirements of the journal to which you are
- submitting your paper.
-\end_layout
-\begin_layout Subsection
-Starting a New Paper
-\end_layout
+\family typewriter
-\begin_layout Standard
-I strongly suggest that you start with the AASTeX template file.
- Click on
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New from
-\bar under
-T
-\bar default
-emplate
+\backslash
+altaffilmark
\family default
-, enter the new file name, then choose the
+ (2.3),
\family typewriter
-aastex.lyx
+
+\backslash
+altaffiltext
\family default
- template.
- This will show the most common fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
+ (2.3),
\family typewriter
-<>
+
+\backslash
+eqnum
\family default
-) with the correct information.
- Many of the AASTeX commands and environments can be implemented directly
- in LyX, but some cannot: most noticeably
+ (2.12),
\family typewriter
\backslash
-altaffilmark
+setcounter{equation}
\family default
- and
+ (2.12), Journal name abbreviations (2.13.4),
\family typewriter
\backslash
-altaffiltext
+figurenum
\family default
-, which should stick out like a sore thumb if you actually just opened the
- template file.
- For commands such as these, the LaTeX code must be entered directly and
- marked as such.
- Such commands are referred to as ERT, or Evil Red Text.
- I tried to minimize the amount of ERT needed in an AASTeX document, but
- there is still a bit more required than any of us would like.
-\end_layout
-
-\begin_layout Subsection
-Finishing Your Paper
-\end_layout
-
-\begin_layout Standard
-When the paper is finished to your satisfaction and previews/prints correctly,
- there are a few
-\begin_inset Quotes eld
-\end_inset
-
-postprocessing
-\begin_inset Quotes erd
-\end_inset
-
- actions which need to be done before you submit it to the journals.
-
-\end_layout
-
-\begin_layout Enumerate
-Export your paper as a LaTeX file (
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+ (2.14.1),
+\family typewriter
-\bar under
-L
-\bar default
-aTeX
+\backslash
+epsscale
\family default
-).
-
-\end_layout
+ (2.14.1),
+\family typewriter
-\begin_layout Enumerate
-Edit the resulting
+\backslash
+plotone
+\family default
+ (2.14.1),
\family typewriter
-.tex
+
+\backslash
+plottwo
\family default
- file with your favorite text editor
-\end_layout
+ (2.14.1),
+\family typewriter
-\begin_deeper
-\begin_layout Enumerate
-remove the comment lines before the
+\backslash
+tablenum
+\family default
+ (2.15.4),
\family typewriter
\backslash
-documentclass
+tableline
\family default
- command
-\end_layout
+ (2.15.4, insert it as the first element in the lefthand cell after where
+ you want it.
+ Don't use any of LyX's rules in the table),
+\family typewriter
-\begin_layout Enumerate
-remove the
+\backslash
+tablenotemark
+\family default
+ (2.15.5),
\family typewriter
\backslash
-usepackage...{fontenc}
+tablenotetext
\family default
- line if it appears (usually just after
+ (2.15.5), much of Misc (2.17, except
\family typewriter
\backslash
-documentclass
+objectname
\family default
-}; also remove the
+,
\family typewriter
\backslash
-secnumdepth
+dataset
\family default
- line if it appears.
-\end_layout
+,
+\family typewriter
-\begin_layout Enumerate
-remove everything between (and including) the
+\backslash
+url
+\family default
+, and
\family typewriter
\backslash
-makeatletter
+email
\family default
- and
+; see above),
\family typewriter
\backslash
-makeatother
+singlespace
\family default
- commands, except for any commands you specifically put into the LaTeX preamble
- (which should appear immediately after the
-\begin_inset Quotes eld
-\end_inset
+ (3.1),
+\family typewriter
-User specified LaTeX commands
-\begin_inset Quotes erd
-\end_inset
+\backslash
+doublespace
+\family default
+ (3.1),
+\family typewriter
- comment in the
+\backslash
+onecolumn
+\family default
+ (3.2),
\family typewriter
-.tex
+
+\backslash
+twocolumn
\family default
- file).
+ (3.2)
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
-\end_layout
+\begin_layout Standard
+\begin_inset ERT
+status inlined
-\begin_layout Enumerate
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+\begin_layout Standard
+
+
+\backslash
+end{sloppypar}
\end_layout
-\begin_layout Enumerate
-Submit it.
+\end_inset
+
+
\end_layout
-\begin_layout Subsection
-Comments On Specific Commands
+\begin_layout Subsubsection
+Things that cannot be implemented
\end_layout
\begin_layout Standard
-I will not describe the detailed usage of the individual AASTeX commands:
- the AASTeX User Guide (
-\family typewriter
-aasguide.tex
-\family default
-) gives a good description of each.
- Thus it's probably easiest for me to go down the list as found in the guide
- and offer comments where necessary.
- So let's begin \SpecialChar \ldots{}
+\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
+\bar under
+I
+\bar default
+nsert\SpecialChar \menuseparator
+Chil
+\bar under
+d
+\bar default
+\InsetSpace ~
+Document
+\family default
+ to include it in your LyX document.
+ See the
+\family typewriter
+aas_sample.lyx
+\family default
+ file to see an example of this.
+\end_layout
+\begin_layout Subsection
+FAQs, Tips, Tricks, and Other Ruminations
\end_layout
\begin_layout Subsubsection
-Things that work as expected
+Getting LyX and AASTeX to cooperate
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
+It can be a bit tricky to get LyX to recognize a new layout and document
+ class.
+ When all else fails, do this:
+\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
+Make certain that LaTeX can find AASTeX.
+ Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
+ a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
+\family typewriter
+sample.tex
+\family default
+.
+\end_layout
-\backslash
-begin{sloppypar}
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
+\family default
+ appears in
+\family typewriter
+/usr/.../share/lyx/layouts
+\family default
+ or
+\family typewriter
+~/.lyx/layouts
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Rerun
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+R
+\bar default
+econfigure
+\family default
+ in LyX, then restart LyX.
+\end_layout
+
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AASTeX appear in the class list in
+\family sans
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
+
+\bar under
+S
+\bar default
+ettings
+\family default
+?
\end_layout
+\begin_layout Standard
+If you get a warning from an existing AASTeX document about not being able
+ to find the AASTeX layout or a message about
+\begin_inset Quotes eld
+\end_inset
+
+You should not mix title layouts with normal ones
+\begin_inset Quotes erd
\end_inset
+, things haven't been installed correctly.
+\end_layout
+\begin_layout Subsubsection
+LaTeX error processing a table
\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
+LyX, by default, attempts to center the table caption/title.
+ This seems to produce a bad interaction in AASTeX so you should click somewhere
+ in the caption/title, then select
+\family sans
+\bar under
+E
+\bar default
+dit\SpecialChar \menuseparator
-\backslash
-documentclass
+\bar under
+P
+\bar default
+aragraph\InsetSpace ~
+Settings
\family default
- (2.1.1),
-\family typewriter
-
-\backslash
-begin{document}
+, then set the
+\family sans
+Alignment
\family default
- (2.2),
-\family typewriter
-
-\backslash
-title
+ to
+\family sans
+\bar under
+B
+\bar default
+lock
\family default
- (2.3),
-\family typewriter
+.
+ This took care of it for me.
+\end_layout
-\backslash
-author
-\family default
- (2.3),
-\family typewriter
+\begin_layout Subsubsection
+References
+\begin_inset LatexCommand label
+name "cite"
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
+\end_inset
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
+\end_layout
-\backslash
-section
-\family default
- (2.7),
-\family typewriter
+\begin_layout Standard
+A couple of things: 1) I have noticed some funny spacing in the reference
+ entries in the text.
+ When you enter the bibliography item data, make sure their is
+\emph on
+no
+\emph default
+ space between the last author and the parenthesis setting off the year;
+
+\emph on
+e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
-\backslash
-subsection
-\family default
- (2.7),
+\emph default
+type
\family typewriter
-
-\backslash
-subsubsection
+Ressler(1992)
\family default
- (2.7),
+, not
\family typewriter
-
-\backslash
-paragraph
+Ressler (1992)
\family default
- (2.7),
-\family typewriter
-
-\backslash
-facility
+.
+ 2) Entering the references at all is not obvious.
+ The easiest thing is to start typing your first reference at the end of
+ the document, then mark it as type
+\family sans
+References
\family default
- (2.10),
-\family typewriter
+.
+ That will put a small gray box in front of what you just typed.
+ Click on the box to fill in the rest of the information.
+ For new references, go to the end of an existing reference and press return.
+ That will create a new line with its own box, etc.
+\end_layout
-\backslash
-begin{displaymath}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Subsubsection
+Including EPS files
+\end_layout
-\backslash
-begin{equation}
-\family default
- (2.12),
+\begin_layout Standard
+Even though AASTeX provides its own figure commands (
\family typewriter
\backslash
-begin{eqnarray}
+plotone
\family default
- (2.12),
+, for example), I much prefer LaTeX's standard figure commands (with the
+ default graphicx).
+ You can insert the
\family typewriter
\backslash
-begin{mathletters}
+plotone
\family default
- (2.12),
+, etc.\InsetSpace ~
+commands as ERT into a Figure Float box if you desire, but I never
+ have much luck getting the layout right.
+ With the standard graphics, LyX will insert a
\family typewriter
\backslash
-begin{thebibliography}
+usepackage{graphicx}
\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
+ command into the LaTeX preamble and handle the figures in the standard
+ LaTeX2e way, interspersing the figures in the text.
+ I believe ApJ accepts figures exactly this way now; AJ might still use
+ the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-url
-\family default
- (2.17.4),
-\family typewriter
+stack everything at the end
+\begin_inset Quotes erd
+\end_inset
-\backslash
-end{document}
-\family default
- (2.18).
+ technique.
\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
-.
+\begin_layout Subsubsection
+Things I could have done, but didn't
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-end{sloppypar}
-\end_layout
-
+There are a few
+\begin_inset Quotes eld
\end_inset
+pretty
+\begin_inset Quotes erd
+\end_inset
+ things I could have implemented, but chose not to.
+ For instance, I saw no point in double-spacing the text in the LyX window,
+ even though it is double-spaced in the paper manuscript.
+ Also, I chose not to make separate layouts for the preprint and preprint2
+ styles.
+ Since I assume you will spend most of your time in the plain manuscript
+ mode anyway, I decided not to chew up more disk space with this.
+
\end_layout
-\begin_layout Subsubsection
-Things that work, but require more comment
+\begin_layout Subsection
+Final Caveat
\end_layout
\begin_layout Standard
-The following items work, but require a little more discussion:
+Your mileage may vary.
+ I've now had papers published by both ApJ and AJ that have had 98% of the
+ effort done in LyX; the last 2% was the LaTeX post-processing and a few
+ cleanups.
+ I have had no trouble with the submission process, and I'm sure the journals
+ were never aware that there might be a difference.
+ So, go forth and publish!
\end_layout
-\begin_layout Itemize
-These items are reserved for use by the journal editors, but you can put
- them into the LaTeX preamble if you feel compelled to do so:
-\family typewriter
-
-\backslash
-received
-\family default
-,
-\family typewriter
-
-\backslash
-revised
-\family default
-,
-\family typewriter
-
-\backslash
-accepted
-\family default
-,
-\family typewriter
+\begin_layout Section
+qijmpc and ijmpd
+\end_layout
-\backslash
-ccc
-\family default
-,
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
-\backslash
-cpright
-\family default
- (all from 2.1.3)
+\begin_layout Subsection
+Overview
\end_layout
-\begin_layout Itemize
-These items may be placed in the LaTeX preamble, and are included as blanks
- in the template file:
+\begin_layout Standard
+The ijmpc package is a set of macros that facilitates electronic manuscript
+ submission to the
+\emph on
+International Journal of Modern Physics C
+\emph default
+.
+ Similarly, the ijmpd package is for creating manuscripts to be submitted
+ to the
+\emph on
+International Journal of Modern Physics D
+\emph default
+.
+ Both journals are published by World Scientific.
+ The corresponding document classes are named
\family typewriter
-
-\backslash
-slugcomment
+ws-ijmpc.cls
\family default
- (2.1.4),
+ and
\family typewriter
-
-\backslash
-shorttitle
+ws-ijmpd.cls
\family default
- (2.1.5),
-\family typewriter
+, respectively.
+ These files, together with instructions for the authors, can be downloaded
+ from the sites
+\begin_inset LatexCommand url
+target "http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml"
-\backslash
-shortauthors
-\family default
- (2.1.5)
-\end_layout
+\end_inset
-\begin_layout Itemize
+ and
+\begin_inset LatexCommand url
+target "http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml"
-\family typewriter
+\end_inset
-\backslash
-email
-\family default
- (2.3) -- can only be used
+.
+ Both packages are modified versions of the standard
\begin_inset Quotes eld
\end_inset
-standalone
+article
\begin_inset Quotes erd
\end_inset
-, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+ package, and they are almost (but not exactly) identical.
+ Most of their features are supported by LyX.
+ I have used LyX successfully to write articles submitted to both journals
+ without any problem.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Writing a paper
+\end_layout
+\begin_layout Standard
+As usual, the easiest way to write a paper is to start with a template.
+ Click on
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+New from
+\family default
+
+\family sans
+\bar under
+T
+\bar default
+emplate
+\family default
+, then choose the
\family typewriter
-
-\backslash
-and
+ijmpc.lyx
\family default
- (2.3) -- will have extra {} after it.
- This should not cause an error.
+ or
+\family typewriter
+ijmpd.lyx
+\family default
+ template.
+ This will give an (almost) empty document that includes the most common
+ fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
+\family typewriter
+<>
+\family default
+) with your text.
+ You should keep in mind the following remarks.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\begin_layout Enumerate
+LyX won't let you change the font size and the page style of the document,
+ because such modifications are not allowed by both packages.
+\end_layout
-\backslash
-notetoeditor
+\begin_layout Enumerate
+The language of the document should not be changed.
+ Before previewing your paper, be sure that the babel package is not used.
+ To do this, click on
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references
\family default
- (2.6) -- can only be used
+, select the
+\family sans
+Lang Opts
+\family default
+ tab, deselect the
+\family sans
+\bar under
+U
+\bar default
+se babel
+\family default
+ checkbox in the language settings, and click on
+\family sans
+\bar under
+A
+\bar default
+pply
+\family default
+ (or
+\family sans
+Save
+\family default
+, if you wish to make this change permanent).
+\end_layout
+
+\begin_layout Enumerate
+The
\begin_inset Quotes eld
\end_inset
-standalone
+Keywords
\begin_inset Quotes erd
\end_inset
-, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+ style must be used to define keywords.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
+The ijmpc package provides a style named
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+Classification Codes
+\begin_inset Quotes erd
+\end_inset
-\backslash
-placetable
-\family default
- (2.8) -- can't insert a cross-reference tag, you must type the tag name
- by hand
+, which can be used to define classification codes, such as PACS numbers.
+ Note that this facility is not supported by the ijmpd package.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
-
-\backslash
-placefigure
-\family default
- (2.8) -- same as for
-\family typewriter
+\begin_layout Enumerate
+Several new environments are available:
+\begin_inset Quotes eld
+\end_inset
-\backslash
-placetable
-\end_layout
+Definition
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+Step
+\begin_inset Quotes erd
+\end_inset
-\backslash
-acknowledgements
-\family default
- (2.9) -- will have extra {} after it.
- This should not cause an error.
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Example
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-appendix
-\family default
- (2.11) -- will have extra {} after it.
- This should not cause an error.
-\end_layout
+Remark
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+Notation
+\begin_inset Quotes erd
+\end_inset
-\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
+Theorem
\begin_inset Quotes erd
\end_inset
- inserts an optional argument of the type needed by
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-figcaption
-\family default
-.
- Hopefully it will be renamed someday.
-\end_layout
+Proof
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+Corollary
+\begin_inset Quotes erd
+\end_inset
-\backslash
-objectname
-\family default
- (2.17.1) -- same as
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
-\end_layout
+Lemma
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+,
+\begin_inset Quotes eld
+\end_inset
-\family typewriter
+Proposition
+\begin_inset Quotes erd
+\end_inset
-\backslash
-dataset
-\family default
- (2.17.1) -- same as
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
-\end_layout
+Prop
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsubsection
-Things not implemented, use ERT
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+Question
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{sloppypar}
-\end_layout
+Claim
+\begin_inset Quotes erd
+\end_inset
+, and
+\begin_inset Quotes eld
\end_inset
+Conjecture
+\begin_inset Quotes erd
+\end_inset
+.
+ Their use is more or less obvious.
+ LyX supports all these environments; it will use the proper label, text
+ style, and numbering scheme for each of them.
\end_layout
-\begin_layout Standard
-
+\begin_layout Enumerate
+Both packages use basic citations; the natbib package should not be used.
+ In LyX, citation references are shown as usual; in the output, citations
+ are shown as superscripts.
+ If you want to use a citation as normal text, you should use the
\family typewriter
-
-\backslash
-altaffilmark
+refcite
\family default
- (2.3),
-\family typewriter
+ command, e.\InsetSpace \thinspace{}
+g.,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-altaffiltext
-\family default
- (2.3),
-\family typewriter
+See Ref.\InsetSpace ~
-\backslash
-eqnum
-\family default
- (2.12),
\family typewriter
\backslash
-setcounter{equation}
+refcite{key}
\family default
- (2.12), Journal name abbreviations (2.13.4),
-\family typewriter
-\backslash
-figurenum
-\family default
- (2.14.1),
-\family typewriter
+\begin_inset Quotes erd
+\end_inset
-\backslash
-epsscale
-\family default
- (2.14.1),
-\family typewriter
+.
+\end_layout
-\backslash
-plotone
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Enumerate
+There is no
+\begin_inset Quotes eld
+\end_inset
-\backslash
-plottwo
-\family default
- (2.14.1),
-\family typewriter
+Acknowledgments
+\begin_inset Quotes erd
+\end_inset
-\backslash
-tablenum
-\family default
- (2.15.4),
-\family typewriter
+ section in both packages.
+ To put acknowledgments, just use the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-tableline
-\family default
- (2.15.4, insert it as the first element in the lefthand cell after where
- you want it.
- Don't use any of LyX's rules in the table),
-\family typewriter
+Section*
+\begin_inset Quotes erd
+\end_inset
-\backslash
-tablenotemark
-\family default
- (2.15.5),
-\family typewriter
+ environment.
+\end_layout
-\backslash
-tablenotetext
-\family default
- (2.15.5), much of Misc (2.17, except
-\family typewriter
+\begin_layout Enumerate
+Appendices may be added to the paper,
+\emph on
+after
+\emph default
+ the Acknowledgments and
+\shape italic
+before
+\shape default
+ the References.
+ LyX provides a special environment, called
+\begin_inset Quotes eld
+\end_inset
+
+Appendices Section
+\begin_inset Quotes erd
+\end_inset
+
+ which marks the beginning of the appendices.
+ This environment should be left blank; it just sends a LaTeX command, but
+ nothing is really printed.
+ In LyX, the word
+\begin_inset Quotes eld
+\end_inset
+
+Appendix
+\begin_inset Quotes erd
+\end_inset
+
+ is printed with blue letters, as a signal that all sections after that
+ point are appendices.
+ To write an appendix, use the
+\begin_inset Quotes eld
+\end_inset
+
+Appendix
+\begin_inset Quotes erd
+\end_inset
+
+ environment.
+ LyX will number each appendix with capital letters, as required by both
+ journals.
+ Note that
+\begin_inset Quotes eld
+\end_inset
+
+Appendices Section
+\begin_inset Quotes erd
+\end_inset
-\backslash
-objectname
-\family default
-,
-\family typewriter
-
-\backslash
-dataset
-\family default
-,
-\family typewriter
-\backslash
-url
-\family default
-, and
-\family typewriter
+\emph on
+must
+\emph default
+ be present before the first appendix; if not, all appendices will be numbered
+ as normal sections in the output.
+\end_layout
-\backslash
-email
-\family default
-; see above),
+\begin_layout Enumerate
+The ijmpc and the ijmpd packages use the
\family typewriter
-
-\backslash
-singlespace
+tbl
\family default
- (3.1),
+ command to implement table captions.
+ As a result, a table created by LyX is printed correctly, but its caption
+ is ignored.
+ However, you can use some ERT to overpass this problem, so that captions
+ are printed as expected.
+ To do so, create a float table as usual, remove the caption, and replace
+ it with the ERT
\family typewriter
\backslash
-doublespace
+tbl{
+\emph on
+your table caption
+\emph default
+}{
\family default
- (3.1),
+ (sic); you must also the ERT
\family typewriter
-
-\backslash
-onecolumn
+}
\family default
- (3.2),
+ immediately after the tabular material.
+ Study the example table included in the template files to see how this
+ trick is implemented.
+ Alternatively, If you need table captions, you should implement the whole
+ table float in a
\family typewriter
-
-\backslash
-twocolumn
+.tex
\family default
- (3.2)
-\end_layout
-
-\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-end{sloppypar}
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Things that cannot be implemented
-\end_layout
-
-\begin_layout Standard
-\SpecialChar \ldots{}
- at least in any meaningful sort of way, so I suggest ignoring them.
- They are the references environment (2.13.3), and the deluxetable environment
- (2.15).
- If you really, really need to use deluxetable, I suggest editing it in
- a separate file with a text editor, then using
+ file, then include this file to the LyX document (
\family sans
\bar under
I
\bar default
nsert\SpecialChar \menuseparator
+Fil
+\bar under
+e
+\bar default
+\SpecialChar \menuseparator
Chil
\bar under
d
\InsetSpace ~
Document
\family default
- to include it in your LyX document.
- See the
+).
+ Details on how to create a table float can be found in the files
\family typewriter
-aas_sample.lyx
+ws-ijmpc.tex
\family default
- file to see an example of this.
+ and
+\family typewriter
+ws-ijmpd.tex
+\family default
+, included in the corresponding packages.
\end_layout
\begin_layout Subsection
-FAQs, Tips, Tricks, and Other Ruminations
+Preparing a paper for submission
\end_layout
-\begin_layout Subsubsection
-Getting LyX and AASTeX to cooperate
-\end_layout
+\begin_layout Standard
+Before you submit your paper you must export the LyX document as a LaTeX
+ file (
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
+
+\bar under
+L
+\bar default
+a
+\family default
+T
+\family sans
+eX
+\family default
+)
+\begin_inset Foot
+status open
\begin_layout Standard
-It can be a bit tricky to get LyX to recognize a new layout and document
- class.
- When all else fails, do this:
+Actually you have the choice between LaTeX (plain) and pdflatex.
+ If you intend to use pdflatex to prepare the paper, you should use the
+ pdflatex option so that included graphics are converted to PDF format,
+ ready for use by pdflatex.
\end_layout
-\begin_layout Enumerate
-Make certain that LaTeX can find AASTeX.
- Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
- a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
+\end_inset
+
+, then make the following changes to the resulting
\family typewriter
-sample.tex
+.tex
\family default
-.
+ file.
\end_layout
\begin_layout Enumerate
-Make certain that
-\family typewriter
-aastex.layout
-\family default
- appears in
-\family typewriter
-/usr/.../share/lyx/layouts
-\family default
- or
+Remove the comment lines before the
\family typewriter
-~/.lyx/layouts
+
+\backslash
+documentclass
\family default
-.
+ command.
\end_layout
\begin_layout Enumerate
-Rerun
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+Remove everything between (and including) the
+\family typewriter
-\bar under
-R
-\bar default
-econfigure
+\backslash
+makeatletter
\family default
- in LyX, then restart LyX.
-\end_layout
-
-\begin_layout Enumerate
-Open a regular new file, not from a template.
- Does AASTeX appear in the class list in
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ and
+\family typewriter
-\bar under
-S
-\bar default
-ettings
+\backslash
+makeatother
\family default
-?
+ commands, except for any commands you specifically put into the LaTeX preamble.
\end_layout
\begin_layout Standard
-If you get a warning from an existing AASTeX document about not being able
- to find the AASTeX layout or a message about
-\begin_inset Quotes eld
-\end_inset
-
-You should not mix title layouts with normal ones
-\begin_inset Quotes erd
-\end_inset
-
-, things haven't been installed correctly.
+The modified
+\family typewriter
+.tex
+\family default
+ file should be saved and processed through LaTeX as many times as necessary.
+ You may also want to check the resulting
+\family typewriter
+.dvi
+\family default
+ document.
\end_layout
-\begin_layout Subsubsection
-LaTeX error processing a table
+\begin_layout Subsection
+Use of ERT
\end_layout
\begin_layout Standard
-LyX, by default, attempts to center the table caption/title.
- This seems to produce a bad interaction in AASTeX so you should click somewhere
- in the caption/title, then select
-\family sans
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-aragraph\InsetSpace ~
-Settings
+The use of ERT is reduced to two commands, which must be placed at the top
+ of the document.
+ If you started writing your paper by using the
+\family typewriter
+ijmpc.lyx
\family default
-, then set the
-\family sans
-Alignment
+ or the
+\family typewriter
+ijmpd.lyx
\family default
- to
-\family sans
-\bar under
-B
-\bar default
-lock
+ template, the ERT needed is already in its place; you usually don't need
+ to delete it.
+ You may only modify the first ERT to specify the information printed to
+ the top of odd and even pages (authors' names and short paper's title,
+ respectively).
+ This ERT must have the form
+\family typewriter
+
+\backslash
+markboth{Authors' Names}{Short Paper's Title}
\family default
.
- This took care of it for me.
\end_layout
-\begin_layout Subsubsection
-References
-\begin_inset LatexCommand \label{cite}
+\begin_layout Section
+iopart
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Uwe Stöhr
+\end_layout
+
+\begin_layout Subsection
+Overview
+\end_layout
+
+\begin_layout Standard
+The iopart package provides a document class to create electronic manuscript
+ submission to the journals published by the Institute of Physics.
+ Instructions for the authors how to create a paper using the iopart class
+ can be downloaded together with the iopart package from the site
+\begin_inset LatexCommand url
+target "ftp://ftp.iop.org/pub/journals/latex2e"
\end_inset
+.
+\end_layout
+\begin_layout Subsection
+Writing a paper
\end_layout
\begin_layout Standard
-A couple of things: 1) I have noticed some funny spacing in the reference
- entries in the text.
- When you enter the bibliography item data, make sure their is
-\emph on
-no
-\emph default
- space between the last author and the parenthesis setting off the year;
-
+The easiest way to write a paper is to start with the file
\emph on
-e.g.
-
+IOP-article.lyx
\emph default
-type
-\family typewriter
- Ressler(1992)
+ that is available in LyX's examples files folder.
+ Open this file, save it under a new name, and start writing.
+ The example file explains how to use the special text environments.
+ Here are the most important advices:
+\end_layout
+
+\begin_layout Itemize
+To be able to compile your document to a PDF, PS, or DVI, assure that the
+ two options
+\family sans
+Use AMS math package
\family default
-, not
-\family typewriter
-Ressler (1992)
+ in the document settings under
+\family sans
+Math Options
\family default
-.
- 2) Entering the references at all is not obvious.
- The easiest thing is to start typing your first reference at the end of
- the document, then mark it as type
+ are not used!
+\end_layout
+
+\begin_layout Itemize
+
+\size normal
+The title environment defines the kind of your paper.
+ So use one of the following environments for the title:
+\end_layout
+
+\begin_deeper
+\begin_layout Itemize
+
\family sans
-References
+\size normal
+Title
\family default
-.
- That will put a small gray box in front of what you just typed.
- Click on the box to fill in the rest of the information.
- For new references, go to the end of an existing reference and press return.
- That will create a new line with its own box, etc.
+ for a Paper
\end_layout
-\begin_layout Subsubsection
-Including EPS files
+\begin_layout Itemize
+
+\family sans
+\size normal
+Review
+\family default
+ for a Review
\end_layout
-\begin_layout Standard
-Even though AASTeX provides its own figure commands (
-\family typewriter
+\begin_layout Itemize
-\backslash
-plotone
+\family sans
+\size normal
+Topical
\family default
-, for example), I much prefer LaTeX's standard figure commands (with the
- default graphicx).
- You can insert the
-\family typewriter
+ for a Topical review
+\end_layout
-\backslash
-plotone
+\begin_layout Itemize
+
+\family sans
+\size normal
+Comment
\family default
-, etc.\InsetSpace ~
-commands as ERT into a Figure Float box if you desire, but I never
- have much luck getting the layout right.
- With the standard graphics, LyX will insert a
-\family typewriter
+ for a Comment
+\end_layout
-\backslash
-usepackage{graphicx}
+\begin_layout Itemize
+
+\family sans
+\size normal
+Note
\family default
- command into the LaTeX preamble and handle the figures in the standard
- LaTeX2e way, interspersing the figures in the text.
- I believe ApJ accepts figures exactly this way now; AJ might still use
- the
-\begin_inset Quotes eld
-\end_inset
+ for a Note
+\end_layout
-stack everything at the end
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- technique.
+\family sans
+\size normal
+Paper
+\family default
+ for a Paper (same as Title)
\end_layout
-\begin_layout Subsubsection
-Things I could have done, but didn't
+\begin_layout Itemize
+
+\family sans
+\size normal
+Prelim
+\family default
+ for a Preliminary communication
\end_layout
-\begin_layout Standard
-There are a few
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-pretty
-\begin_inset Quotes erd
-\end_inset
+\family sans
+\size normal
+Rapid
+\family default
+ for a Rapid communication
+\end_layout
- things I could have implemented, but chose not to.
- For instance, I saw no point in double-spacing the text in the LyX window,
- even though it is double-spaced in the paper manuscript.
- Also, I chose not to make separate layouts for the preprint and preprint2
- styles.
- Since I assume you will spend most of your time in the plain manuscript
- mode anyway, I decided not to chew up more disk space with this.
-
+\begin_layout Itemize
+
+\family sans
+\size normal
+Letter
+\family default
+ for a Letter to the editor
\end_layout
-\begin_layout Subsection
-Final Caveat
+\end_deeper
+\begin_layout Itemize
+
+\size normal
+All title environments except of
+\family sans
+Letter
+\family default
+ can have an optional short title.
+\end_layout
+
+\begin_layout Itemize
+There is a general title environment
+\family sans
+Article
+\family default
+ which is not directly supported by the LyX.
+ This can be used as ERT when your document doesn't fit into one of the
+ other title types.
\end_layout
\begin_layout Standard
-Your mileage may vary.
- I've now had papers published by both ApJ and AJ that have had 98% of the
- effort done in LyX; the last 2% was the LaTeX post-processing and a few
- cleanups.
- I have had no trouble with the submission process, and I'm sure the journals
- were never aware that there might be a difference.
- So, go forth and publish!
+For more informations like hints for special table and formula formatting,
+ look at the IOP author guidelines.
\end_layout
\begin_layout Section
-ijmpd
+Kluwer
\end_layout
\begin_layout Standard
\end_layout
\begin_layout Standard
-The ijmpd package is a set of macros that facilitates electronic manuscript
- submission to the
+The Kluwer package is a set of macros produced by Kluwer Academic Publishers
+ that facilitates electronic manuscript submission to the journals they
+ publish.
+ Most known of them (at least in my domain of interest) are
\emph on
-International Journal of Modern Physics D
+Astrophysics and Space Science
\emph default
- published by World Scientific.
- The name of the document class is
-\family typewriter
-ws-ijmpd.cls
-\family default
-.
- This file, together with instructions for the authors, can be downloaded
- from the site
-\begin_inset LatexCommand \url{http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml}
+ and
+\emph on
+Solar Physics
+\emph default
+, but there are many others (see a complete list at
+\begin_inset LatexCommand url
+target "http://www.wkap.nl/jrnllist.htm/JRNLHOME"
\end_inset
-.
- The ijmpd package is a modified version of the standard
-\begin_inset Quotes eld
-\end_inset
+).
+ The Kluwer package may be downloaded from the site
+\begin_inset LatexCommand url
+target "http://www.wkap.nl/kaphtml.htm/STYLEFILES"
-article
-\begin_inset Quotes erd
\end_inset
- package.
- Most of its features are supported by LyX.
- I have recently used LyX successfully to write an article submitted to
- the
-\emph on
-International Journal of Modern Physics D
-\emph default
.
+ A complete user guide is contained in that package (but it can also be
+ downloaded separately).
+\end_layout
+
+\begin_layout Standard
+LyX supports many features of the package but not everything.
+ However, the ERT needed is reduced to some
+\begin_inset Quotes eld
+\end_inset
+
+peculiar
+\begin_inset Quotes erd
+\end_inset
+
+ commands of the package (see\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "subsec:kluwer_peculiarities"
+
+\end_inset
+
+).
+ I have recently used LyX to write an article submitted to the
+\emph on
+Astrophysics and Space Science
+\emph default
+ without any problem.
\end_layout
\begin_layout Subsection
\end_layout
\begin_layout Standard
-As usual, the easiest way to write a paper is to start with a template.
+The easiest way to write a paper is to start with the Kluwer template file.
Click on
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New from
+File\SpecialChar \menuseparator
+New from
+\family default
+
+\family sans
\bar under
T
\bar default
\family default
, then choose the
\family typewriter
-ijmpd.lyx
+kluwer.lyx
\family default
template.
This will give an (almost) empty document that includes the most common
- fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
+ fields found in a manuscript and a short description of their use.
+ As in most templates, simply overwrite the existing text (including the
+ brackets,
\family typewriter
<>
\family default
) with the correct information.
- You should keep in mind the following remarks.
-\end_layout
-
-\begin_layout Enumerate
-LyX won't let you change the font size and the page style of the document,
- because the ijmpd package does not allow such modifications.
-\end_layout
-
-\begin_layout Enumerate
-The ijmpd package requires that the language of the document should not
- be changed.
- Before previewing your paper, be sure that the babel package is not used.
- To do this, click on
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
-\family default
-, deselect the
-\family sans
-\bar under
-U
-\bar default
-se babel
-\family default
- checkbox in the language settings, and click on
-\family sans
-\bar under
-A
-\bar default
-pply
-\family default
- (or
-\family sans
-Save
-\family default
-, if you wish to make this change permanent).
\end_layout
-\begin_layout Enumerate
-Two new environments, named
-\begin_inset Quotes eld
-\end_inset
-
-Theorem
-\begin_inset Quotes erd
-\end_inset
-
- and
-\begin_inset Quotes eld
-\end_inset
-
-Proof
-\begin_inset Quotes erd
-\end_inset
-
- are available (their use is obvious).
+\begin_layout Subsection
+Preparing a paper for submission
\end_layout
-\begin_layout Enumerate
-Appendices may be added to the paper.
- LyX offers a special environment, called
+\begin_layout Standard
+As in the AASTeX package, before you submit your paper to a journal you
+ must
\begin_inset Quotes eld
\end_inset
-Appendix
+postprocess
\begin_inset Quotes erd
\end_inset
- which marks the beginning of the appendix.
- An appendix can contain normal sections, subsections, or subsubsections.
+ it as follows.
\end_layout
\begin_layout Enumerate
-The ijmpd package implements table captions quite differently than LyX does.
- As a result, a table created by LyX is printed correctly, but its caption
- is ignored.
- If you need table captions, you should implement the whole table float
- in a
-\family typewriter
-.tex
-\family default
- file, then include this file to the LyX document (
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-\InsetSpace ~
-Document
-\family default
-).
- Details on how to create an ijmpd table float can be found in the file
-
-\family typewriter
-ws-ijmpd.tex
-\family default
-, which is included in the ijmpd package.
-\end_layout
-
-\begin_layout Subsection
-Preparing a paper for submission
-\end_layout
-
-\begin_layout Standard
-Before you submit your paper you must export the LyX document as a LaTeX
- file (
+Export your paper as a LaTeX file.
+ To do this, click on
\family sans
\bar under
F
\bar under
L
\bar default
-ateX
+aTeX
\family default
-), then make the following changes to the resulting
+.
+
+\end_layout
+
+\begin_layout Enumerate
+Edit the resulting
\family typewriter
.tex
\family default
- file.
+ file with a text editor and make the following changes
\end_layout
+\begin_deeper
\begin_layout Enumerate
-Remove the comment lines before the
+remove the comment lines before the
\family typewriter
\backslash
documentclass
\family default
- command.
+ command,
\end_layout
\begin_layout Enumerate
-Remove everything between (and including) the
+remove everything between (and including) the
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-The modified
+Save the resulting
\family typewriter
.tex
\family default
- file should be saved and processed through LaTeX as many times as necessary.
- You may also want to check the resulting
-\family typewriter
-.dvi
-\family default
- document.
+ file.
\end_layout
-\begin_layout Subsection
-Use of ERT
+\end_deeper
+\begin_layout Enumerate
+Run the
+\family typewriter
+.tex
+\family default
+ file through LaTeX as many times as necessary (usually up to three).
\end_layout
-\begin_layout Standard
-The use of ERT is optional, and is reduced to three commands, which affect
- the look of the page.
- If you started writing your paper by using the
+\begin_layout Enumerate
+View the resulting
\family typewriter
-ijmpd.lyx
+.dvi
\family default
- template, the ERT needed is already in its place; you usually don't need
- to delete it.
- You may only change the first ERT to specify the information printed to
- the top of odd and even pages (authors' names and short paper's title,
- respectively).
- This ERT must have the form
-\family typewriter
-
-\backslash
-markboth{Authors' Names}{Short Paper's Title}
+ document using, e.\InsetSpace \thinspace{}
+g.,
+\family sans
+xdvi
\family default
-.
-\end_layout
-
-\begin_layout Section
-Kluwer
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Panayotis Papasotiriou
+, and check if everything is OK (it should, if you didn't make any mistake).
\end_layout
\begin_layout Subsection
-Overview
-\end_layout
-
-\begin_layout Standard
-The Kluwer package is a set of macros produced by Kluwer Academic Publishers
- that facilitates electronic manuscript submission to the journals they
- publish.
- Most known of them (at least in my domain of interest) are
-\emph on
-Astrophysics and Space Science
-\emph default
- and
-\emph on
-Solar Physics
-\emph default
-, but there are many others (see a complete list at
-\begin_inset LatexCommand \url{http://www.wkap.nl/jrnllist.htm/JRNLHOME}
+\begin_inset Quotes eld
+\end_inset
+Peculiarities
+\begin_inset Quotes erd
\end_inset
-).
- The Kluwer package may be downloaded from the site
-\begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
+ of the Kluwer package
+\begin_inset LatexCommand label
+name "subsec:kluwer_peculiarities"
\end_inset
-.
- A complete user guide is contained in that package (but it can also be
- downloaded separately).
+
\end_layout
\begin_layout Standard
-LyX supports many features of the package but not everything.
- However, the ERT needed is reduced to some
+The Kluwer package has the following
\begin_inset Quotes eld
\end_inset
-peculiar
+peculiarities
\begin_inset Quotes erd
\end_inset
- commands of the package (see\InsetSpace ~
-
-\begin_inset LatexCommand \ref{subsec:kluwer_peculiarities}
-
-\end_inset
-
-).
- I have recently used LyX to write an article submitted to the
-\emph on
-Astrophysics and Space Science
-\emph default
- without any problem.
+.
\end_layout
-\begin_layout Subsection
-Writing a paper
-\end_layout
-
-\begin_layout Standard
-The easiest way to write a paper is to start with the Kluwer template file.
- Click on
-\family sans
-File\SpecialChar \menuseparator
-New from
-\bar under
-T
-\bar default
-emplate
-\family default
-, then choose the
-\family typewriter
-kluwer.lyx
-\family default
- template.
- This will give an (almost) empty document that includes the most common
- fields found in a manuscript and a short description of their use.
- As in most templates, simply overwrite the existing text (including the
- brackets,
-\family typewriter
-<>
-\family default
-) with the correct information.
-\end_layout
-
-\begin_layout Subsection
-Preparing a paper for submission
-\end_layout
-
-\begin_layout Standard
-As in the AASTeX package, before you submit your paper to a journal you
- must
-\begin_inset Quotes eld
-\end_inset
-
-postprocess
-\begin_inset Quotes erd
-\end_inset
-
- it as follows.
-\end_layout
-
-\begin_layout Enumerate
-Export your paper as a LaTeX file.
- To do this, click on
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-ateX
-\family default
-.
-
-\end_layout
-
-\begin_layout Enumerate
-Edit the resulting
-\family typewriter
-.tex
-\family default
- file with a text editor and make the following changes
-\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 everything between (and including) the
-\family typewriter
-
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
-
-\backslash
-makeatother
-\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
-\end_layout
-
-\begin_layout Standard
-Save the resulting
-\family typewriter
-.tex
-\family default
- file.
-\end_layout
-
-\end_deeper
-\begin_layout Enumerate
-Run the
-\family typewriter
-.tex
-\family default
- file through LaTeX as many times as necessary (usually up to three).
-\end_layout
-
-\begin_layout Enumerate
-View the resulting
-\family typewriter
-.dvi
-\family default
- document using, e.g.,
-\family sans
-xdvi
-\family default
-, and check if everything is ok (it should, if you didn't make any mistake).
-\end_layout
-
-\begin_layout Subsection
-\begin_inset Quotes eld
-\end_inset
-
-Peculiarities
-\begin_inset Quotes erd
-\end_inset
-
- of the Kluwer package
-\begin_inset LatexCommand \label{subsec:kluwer_peculiarities}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-The Kluwer package has the following
-\begin_inset Quotes eld
-\end_inset
-
-peculiarities
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Enumerate
-It is possible to write multiple articles in the same LaTeX file
-\begin_inset Foot
-status collapsed
+\begin_layout Enumerate
+It is possible to write multiple articles in the same LaTeX file
+\begin_inset Foot
+status collapsed
\begin_layout Standard
I can't imagine any good reason to do this.
\end_inset
.
- This is not implemented in LyX, so you must enter title, subtitle etc.
- between two ERT lines (
+ This is not implemented in LyX, so you must enter title, subtitle etc.\InsetSpace ~
+between
+ two ERT lines (
\family typewriter
\backslash
\end_layout
\begin_layout Standard
-The LyX document classes
+The LyX document classes
\emph on
- article (koma-script)
+article (koma-script)
\emph default
,
\emph on
\family typewriter
scrlettr.cls
\family default
-, resp.
- of the Koma-Script family.
+, resp.\InsetSpace ~
+of the Koma-Script family.
They are replacements for the standard document classes
\family typewriter
article.cls
Headings, labels of the description environment, and a number of elements
of the
\emph on
-letter (koma-script)
+letter (koma-script)
\emph default
-document class are set in a bold sans serif font.
+ document class are set in a bold sans serif font.
\begin_inset Foot
status collapsed
In comparison, the ec bold sans serif fonts look a bit thin.
Here the LaTeX package
\family typewriter
-cmsd.sty by
+cmsd.sty by
\family default
+
\shape smallcaps
Walter Schmidt
\shape default
, resp., additionally inserting an entry in the table of contents.
\family sans
-Addpart
+Addpart
\family default
-and
+ and
\family sans
- Addchap
+Addchap
\family default
are not contained in
\emph on
Addsec
\family default
, resp., additionally clearing running heads.
-
+
\family sans
- Addchap*
+Addchap*
\family default
is not contained in
\emph on
\family default
and
\family sans
-Captionbelow
+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
+ 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
\begin_layout Standard
+
\backslash
,
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
\begin_layout Standard
+
\backslash
begin{sloppypar}
\end_layout
\begin_layout Standard
+
\backslash
end{sloppypar}
\end_layout
\begin_layout Standard
The types
\family sans
-Letter
+Letter
\family default
-and
+ and
\family sans
Opening
\family default
\shape italic
O
\shape default
-, resp.
- in the left margin.
+, resp.\InsetSpace ~
+in the left margin.
It is possible to write any number of letters in one file.
An
\family sans
\family sans
Address
\family default
-,
+,
\family sans
- Telephone
+Telephone
\family default
,
\family sans
are input types provided with a label to enter information, which will
be processed by the document class.
\begin_inset Foot
-status collapsed
+status open
\begin_layout Standard
It could be seen as a matter of inconsequence, that the types
\begin_layout Standard
The input types can also be used as empty paragraphs.
- This makes sense e.\InsetSpace ~
-g.
- for the
+ This makes sense e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+for the
\family sans
Signature
\family default
\begin_layout Standard
by
\noun on
-Jürgen Spitzmüller
+Jürgen Spitzmüller
\end_layout
\begin_layout Standard
\family typewriter
scrlttr2
\family default
- which superceeds the now unsupported
+ which supersedes the now unsupported
\family typewriter
scrlettr
\family default
\begin_layout Standard
+
\backslash
,
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
D
\bar default
ocument\SpecialChar \menuseparator
-Extra Options
+Extra Options
\family default
-field.
+ field.
\end_layout
\end_inset
\begin_layout Standard
These are the layout files for some of the journal formats used by Springer
Verlag and listed on
-\begin_inset LatexCommand \url{http://www.springer.de/author/tex/help-journals.html}
+\begin_inset LatexCommand url
+target "http://www.springer.de/author/tex/help-journals.html"
\end_inset
\family typewriter
svjour.inc
\family default
-, which journal-specific layout files (such as, e.g.,
+, which journal-specific layout files (such as, e.\InsetSpace \thinspace{}
+g.,
\family typewriter
svjog.layout
\family default
\emph default
:
\family typewriter
-svjog.layout
+svjog.layout
\family default
---- Martin Vermeer
+ --- Martin Vermeer
\end_layout
\begin_layout Itemize
\end_layout
\begin_layout Standard
-Limitations e.g.: does not display the number for theorem-like layouts, just
+Limitations e.\InsetSpace \thinspace{}
+g.: does not display the number for theorem-like layouts, just
#.
\end_layout
Society.
It is assumed that you have both the AGU's own class files and AGUplus
installed (everything to be found at
-\begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
+\begin_inset LatexCommand url
+target "ftp://ftp.agu.org/journals/latex/journals"
\end_inset
\emph default
:
\family typewriter
-jgrga.layout
+jgrga.layout
\family default
---- Martin Vermeer
+ --- Martin Vermeer
\end_layout
\begin_layout Standard
egs.cls
\family default
can be downloaded from the web site of the EGS under
-\begin_inset LatexCommand \url{www.copernicus.org}
+\begin_inset LatexCommand url
+target "www.copernicus.org"
\end_inset
Sli
\noun default
TeX]
-\begin_inset LatexCommand \label{sec:slitex}
+\begin_inset LatexCommand label
+name "sec:slitex"
\end_inset
, check out section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:foiltex}
+\begin_inset LatexCommand ref
+reference "sec:foiltex"
\end_inset
.
The
\family sans
-foils
+foils
\family default
-class [
+ class [
\begin_inset Quotes eld
\end_inset
\begin_layout Subsection
Getting Started
-\begin_inset LatexCommand \label{sec:slidesetup}
+\begin_inset LatexCommand label
+name "sec:slidesetup"
\end_inset
s.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideNote}
+\begin_inset LatexCommand ref
+reference "sec:slideNote"
\end_inset
to automatically set up a document to use the
\family sans
-slides
+slides
\family default
-class [using
+ class [using
\family sans
\bar under
F
\begin_layout Standard
The first thing you'll notice when you start up a new
\family sans
-slides
+slides
\family default
-document is the font size and type: it's the equivalent of the size
+ document is the font size and type: it's the equivalent of the size
\begin_inset Quotes eld
\end_inset
\begin_layout Subsubsection
Quirks of the New Environments
-\begin_inset LatexCommand \label{sec:slideQuirk}
+\begin_inset LatexCommand label
+name "sec:slideQuirk"
\end_inset
\family sans
Slide
\family default
-,
+,
\family sans
- Overlay
+Overlay
\family default
and
\family sans
\family default
environment [in the manner described in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideQuirk}
+\begin_inset LatexCommand ref
+reference "sec:slideQuirk"
\end_inset
\family default
environments work the same way as the
\family sans
-Slide
+Slide
\family default
-environment.
+ environment.
They both create an
\begin_inset Quotes eld
\end_inset
invisible and visible, respectively.
Note from section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideQuirk}
+\begin_inset LatexCommand ref
+reference "sec:slideQuirk"
\end_inset
visible
\family default
command].
- If you don't know how to mark text as TeX, see the apprpriate section of
- the
+ If you don't know how to mark text as TeX, see the appropriate section
+ of the
\emph on
User's Guide
\emph default
Slide
\family default
-\begin_inset LatexCommand \label{sec:slideNote}
+\begin_inset LatexCommand label
+name "sec:slideNote"
\end_inset
[see section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slidesetup}
+\begin_inset LatexCommand ref
+reference "sec:slidesetup"
\end_inset
\family sans
Overlay
\family default
- --
+ --
\family sans
- Note
+Note
\family default
triplet.
The
\family default
class [see section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:foiltex}
+\begin_inset LatexCommand ref
+reference "sec:foiltex"
\end_inset
TeX
\noun default
]
-\begin_inset LatexCommand \label{sec:foiltex}
+\begin_inset LatexCommand label
+name "sec:foiltex"
\end_inset
, check out section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slitex}
+\begin_inset LatexCommand ref
+reference "sec:slitex"
\end_inset
.
If your machine doesn't have the
\family sans
-foils
+foils
\family default
-class [
+ class [
\begin_inset Quotes eld
\end_inset
logo.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:foilfoot}
+\begin_inset LatexCommand ref
+reference "sec:foilfoot"
\end_inset
\begin_layout Standard
+
\backslash
begin{multicols}{2}
\end_layout
\begin_layout Standard
+
\backslash
end{multicols}
\end_layout
\begin_layout Standard
+
\backslash
begin{multicols}{2}
\end_layout
\begin_layout Standard
+
\backslash
end{multicols}
\end_layout
\begin_layout Standard
+
\backslash
begin{multicols}{2}
\end_layout
\begin_layout Standard
+
\backslash
end{multicols}
\end_layout
TeX that aren't directly supported by LyX but I'll tell you what they do
and how to use them in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:unsuppfoils}
+\begin_inset LatexCommand ref
+reference "sec:unsuppfoils"
\end_inset
\family typewriter
dvips
\family default
- driver to generate the PostScript® output otherwise the foils won't be
- rotated.
+ 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
dialog described above in section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:bullet}
+\begin_inset LatexCommand ref
+reference "sec:bullet"
\end_inset
\begin_layout Standard
The two new list styles,
\family sans
-TickList
+TickList
\family default
-and
+ and
\family sans
CrossList
\family default
\begin_layout Subsubsection
Page Headers and Footers
-\begin_inset LatexCommand \label{sec:foilfoot}
+\begin_inset LatexCommand label
+name "sec:foilfoot"
\end_inset
While the second is meant to provide a classification for the audience,
\emph on
-e.g.
-
+e.\InsetSpace \thinspace{}
+g.
\emph default
- Confidential.
+\InsetSpace ~
+Confidential.
It is empty by default.
\end_layout
\begin_layout Standard
-The remaining page corners can be filled by
+The remaining page corners can be filled by
\family sans
- Right\InsetSpace ~
+Right\InsetSpace ~
Footer
\family default
(which defaults to page numbers),
Foil
\family default
TeX Goodies
-\begin_inset LatexCommand \label{sec:unsuppfoils}
+\begin_inset LatexCommand label
+name "sec:unsuppfoils"
\end_inset
\family typewriter
\backslash
-abovefloatskip
+abovefloatskip
\family default
-Separation between the text and the top of the float
+ Separation between the text and the top of the float
\end_layout
\begin_layout List
\family typewriter
\backslash
-abovecaptionskip
+abovecaptionskip
\family default
-Separation between the float and the caption
+ Separation between the float and the caption
\end_layout
\begin_layout List
\family typewriter
\backslash
-belowcaptionskip
+belowcaptionskip
\family default
-Separation between the caption and the following text
+ Separation between the caption and the following text
\end_layout
\begin_layout List
\begin_layout Standard
The last length related command affects all the list environments.
- If you place
+ If you place
\family typewriter
-
+
\backslash
zerolistvertdimens
\family default
\family default
Camera movement instruction.
- e.g.
- CUT TO:
+ e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+CUT TO:
\end_layout
\begin_layout Itemize
Subtitle for
\family sans
ACT.
-
+
\family default
-It is just centered text.
+ It is just centered text.
\end_layout
\begin_layout Itemize
\begin_layout Standard
All you need to do is install RevTeX 4, as described in the package's README
file.
- the package can be found at
-\begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
+ The package can be found at
+\begin_inset LatexCommand url
+name "The RevTeX 4 Web Site"
+target "http://publish.aps.org/revtex4/"
\end_inset
\backslash
draft
\family default
- etc.
- goes in the
+ etc.\InsetSpace ~
+goes in the
+\family sans
+La
+\family default
+T
\family sans
-Latex\InsetSpace ~
+eX\InsetSpace ~
Preamble
\family default
dialog, also as usual.
to the Section layouts either.) This means that after you export that file
to LaTeX (which you'll need to do eventually to send it in to APS), you'll
need to edit the LaTeX file with a text editor to add the optional arguments
- to set, e.g., the running title for the page headers.
+ to set, e.\InsetSpace \thinspace{}
+g., the running title for the page headers.
Lacking these layouts makes the
\family typewriter
\end_layout
\begin_layout Standard
-The LyX document classes
+The LyX document classes
\emph on
- article (mwart)
+article (mwart)
\emph default
,
\emph on
\family default
) for submitting articles to their various journals.
The style file can be downloaded directly from their web site:
-\begin_inset LatexCommand \url{http://authors.elsevier.com/}
+\begin_inset LatexCommand url
+target "http://authors.elsevier.com/"
\end_inset
\begin_layout Standard
+
\backslash
LaTeX
\end_layout
\begin_layout Standard
By
\noun on
-Jürgen Spitzmüller
+Jürgen Spitzmüller
\end_layout
\begin_layout Subsection
\begin_layout Standard
You are invited to send suggestions to
-\begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
+\begin_inset LatexCommand url
+target "lyx-devel@lists.lyx.org"
\end_inset
\begin_layout Standard
+
\backslash
\end_layout
section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
+\begin_inset LatexCommand ref
+reference "sec:Inserting-LaTeX-Code"
\end_inset
\begin_layout Standard
+
\backslash
\end_layout
\end_inset
-\begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
+\begin_inset LatexCommand url
+target "CTAN:/macros/latex/memoir/memman.pdf"
\end_inset
\begin_layout Standard
+
\backslash
,
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
\begin_layout Standard
+
\backslash
,
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
\family typewriter
\backslash
-aliaspagestyle{title}{empty}
+aliaspagestyle{title}{empty}
\family default
-in the preamble.
+ in the preamble.
\end_layout
\begin_layout Description
Article: With the class option
\emph on
-article
+article
\emph default
-(to be inserted in
+ (to be inserted in
\family sans
Layout\SpecialChar \menuseparator
Document\SpecialChar \menuseparator
\begin_layout Standard
+
\backslash
,
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
\end_inset
-\begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
+\begin_inset LatexCommand url
+target "CTAN:/macros/latex/memoir/memman.pdf"
\end_inset
Well, it is in book class.
Usually books don't have abstracts.
Memoir, however, has.
- You can use it whereever and how often you like.
+ You can use it wherever and how often you like.
\end_layout
\begin_layout Description
\begin_layout Standard
+
\backslash
,
\end_layout
\begin_layout Standard
+
\backslash
\end_layout
\begin_layout Description
Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
complex figurative poems).
- Lyx can only support a few of them.
+ LyX can only support a few of them.
One is poemtitle, which is a centered title for poems, which will also
be added to the table of contents (verse is the standard environment for
poems.
line, LyX will call it automatically when a LaTeX document is imported.
See section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:reLyX}
+\begin_inset LatexCommand ref
+reference "sec:reLyX"
\end_inset
Exporting Other Formats
\end_layout
+\begin_layout Standard
+The output formats listed here in the following are also explained concerning
+ possible graphics formats in the
+\emph on
+Embedded Objects
+\emph default
+ manual.
+\end_layout
+
\begin_layout Subsection
LaTeX
\end_layout
\end_layout
\begin_layout Subsection
-PostScript®
+PostScript
\end_layout
\begin_layout Standard
-The next step in the conversion chain is converting a DVI file into Postscript®.
+The next step in the conversion chain is converting a DVI file into Postscript.
You can either use
\family sans
\bar under
\begin_layout Standard
LyX documents can be converted to hypertext markup, usually by converting
to LaTeX first, then converting that to HTML\SpecialChar \@.
- Three LaTeX
+ Four LaTeX
\begin_inset Formula $\rightarrow$
\end_inset
\family typewriter
latex2html
\family default
-, and
+,
\family typewriter
hevea
+\family default
+ and
+\family typewriter
+htlatex
\family default
.
Though they are autodetected, you can overide the selection in preferences.
\begin_layout Standard
The fastest way to generate a basic PDF file (no tags, links, etc.) with
- any version of LyX is to save the document as a Postscript® file, then
- run the
+ any version of LyX is to save the document as a Postscript file, then run
+ the
\family typewriter
ps2pdf
\family default
There are some issues with fonts that you need to pay attention to: see
Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:badfonts}
+\begin_inset LatexCommand ref
+reference "sec:badfonts"
\end_inset
\end_layout
\begin_layout Standard
-With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:pdfeps}
-
-\end_inset
-
-), and you cannot use pstricks.
+With pdfLaTeX you cannot use pstricks.
On the other hand, with pdfLaTeX it is possible to insert directly images
- in JPEG or PNG format, use TrueType fonts, and more.
+ in JPEG, PDF or PNG format, use TrueType fonts, and more.
\end_layout
\begin_layout Subsubsection
Why does the text look so bad when viewed with Acrobat Reader?
-\begin_inset LatexCommand \label{sec:badfonts}
+\begin_inset LatexCommand label
+name "sec:badfonts"
\end_inset
When creating a PDF from the LyX file, you need to use outline font instead
of the default bitmap fonts (in fact, you should also use outline fonts
for Postscript files).
- Recent LaTeX distributions come with Postscript® Type 1 version of the
- standard (Computer Modern) fonts.
+ Recent LaTeX distributions come with Postscript Type 1 version of the standard
+ (Computer Modern) fonts.
pdfLaTeX uses these font by default.
Dvips doesn't use these fonts by default, so to make it use them, add the
following to lines to your
usepackage{ae,aecompl}
\family default
to the preamble of the LyX file.
- However, some glyphs are missing from the CM fonts (e.g.
- eth, thorn), and they are taken from the EC fonts.
+ However, some glyphs are missing from the CM fonts (e.\InsetSpace \thinspace{}
+g.\InsetSpace ~
+eth, thorn), and
+ they are taken from the EC fonts.
Therefore you get these glyphs as bitmaps.
\end_layout
\end_layout
\begin_layout Standard
-An alternate option is to use the standard Postscript® fonts instead of
- the Computer Modern fonts.
+An alternate option is to use the standard Postscript fonts instead of the
+ Computer Modern fonts.
To do that, you need to select
\family sans
pslatex
\family default
as the global font in the document layout dialog.
- When using the Postscript® fonts, the result PDF file is smaller as the
+ When using the Postscript fonts, the result PDF file is smaller as the
fonts are not saved into the file.
- Furthermore, the Postscript® fonts include all T1 glyphs.
- On the other hand, the Postscript® fonts have no bold symbol font, so poor
+ Furthermore, the Postscript fonts include all T1 glyphs.
+ On the other hand, the Postscript fonts have no bold symbol font, so poor
man's bold must be used (see Section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:pdfbold}
+\begin_inset LatexCommand ref
+reference "sec:pdfbold"
\end_inset
).
- The Postscript® fonts also look different from the Computer Modern fonts.
+ The Postscript fonts also look different from the Computer Modern fonts.
\end_layout
\begin_layout Standard
-To sum up, both the Computer Modern and the Postscript® fonts gives good
+To sum up, both the Computer Modern and the Postscript fonts gives good
results (with few exceptions).
The decision of which one to use is a matter of taste.
\end_layout
Why doesn't the
\backslash
boldsymbol{} command work when I use pslatex?
-\begin_inset LatexCommand \label{sec:pdfbold}
+\begin_inset LatexCommand label
+name "sec:pdfbold"
\end_inset
\end_layout
\begin_layout Standard
-The Postscript® fonts do not have a bold symbol font.
+The Postscript fonts do not have a bold symbol font.
The solution is to use the
\family typewriter
\end_layout
\begin_layout Subsubsection
-Is it possible to do write latex code which is processed only when running
+Is it possible to do write LaTeX-code which is processed only when running
pdfLaTeX?
\begin_inset OptArg
status collapsed
\end_layout
\begin_layout Standard
-Yes.
+Yes you can do this with the
+\family typewriter
+ifpdf.sty
+\family default
+ package.
Here is an example:
\end_layout
\begin_layout LyX-Code
-\backslash
-newif
-\backslash
-ifpdf
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-ifx
-\backslash
-pdfoutput
-\backslash
-undefined
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-pdffalse
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-else
-\end_layout
-
-\begin_layout LyX-Code
-
-\backslash
-pdftrue
\end_layout
\begin_layout LyX-Code
\backslash
-fi
-\end_layout
-
-\begin_layout LyX-Code
-
+usepackage{ifpdf}
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout Subsubsection
-How can I make URLs clickable ?
+How can I make URLs clickable?
\end_layout
\begin_layout Standard
-See the references here :
+See the references here:
\end_layout
\begin_layout Standard
-\begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
+\begin_inset LatexCommand url
+target "http://wiki.lyx.org/pmwiki.php/FAQ/PDF"
\end_inset
\bar under
C
\bar default
-ustom
+ustom
\family default
-dialog; LyX will automatically convert the file to this point, then feed
+ dialog; LyX will automatically convert the file to this point, then feed
it to your custom converter.
The possible values are all formats that LyX can produce from its own documents.
\end_layout
\begin_layout Standard
-The converter command is also specified in the dialog.It should be a completely
- qualified command line which uses the variable
+The converter command is also specified in the dialog.
+ It should be a completely qualified command line which uses the variable
+
\family typewriter
$$FName
\family default
\begin_layout Standard
While it is not possible to save this command using the
\family sans
-Preferences
+Preferences
\family default
-dialog, you can manually edit your
+ dialog, you can manually edit your
\family typewriter
.lyx/preferences
\family default
custom_export_command "mycommand $$FName"
\end_layout
+\begin_layout Chapter
+LyX Features needing Extra Software
+\end_layout
+
\begin_layout Section
-The Complete reLyX Description
-\begin_inset LatexCommand \label{sec:reLyX}
+Using LyX with SGML-Tools (aka LinuxDoc)
+\end_layout
-\end_inset
+\begin_layout Standard
+by
+\noun on
+Paul Evans
+\end_layout
+
+\begin_layout Subsection
+Overview
+\end_layout
+
+\begin_layout Standard
+LinuxDoc is a document class available in LyX if you have the
+\family typewriter
+sgml-tools
+\family default
+ package installed.
+ You can use it to produce documents in the so-called Standardized General
+ Mark-up Language (SGML) in the particular format used by the Linux Documentatio
+n Project.
+ That is obviously helpful if you are contributing to that project.
+ You can use the SGML format with the
+\family typewriter
+sgml-tools
+\family default
+ package of scripts and programs (to produce other formats, including LaTeX,
+ HTML, plain text, man pages and\SpecialChar \ldots{}
+).
+ You may therefore prefer to use this document class if you want to write
+ something that can be easily translated into other formats.
+\end_layout
+
+\begin_layout Standard
+You will find that LinuxDoc has fewer layout options than the other text
+ classes in LyX.
+ This is mainly so that the translations into other formats have a chance
+ of making some sense.
+ In this section we describe:
+\end_layout
+
+\begin_layout Itemize
+how to setup and use a document in LinuxDoc
+\end_layout
+
+\begin_layout Itemize
+how to use the tags in LinuxDoc to layout your document
+\end_layout
+\begin_layout Itemize
+how to use the SGML packages to produce the various formats
+\end_layout
+\begin_layout Itemize
+how to sort out some problems.
\end_layout
\begin_layout Subsection
-Synopsis
+Preparing and using a LinuxDoc document
+\end_layout
+
+\begin_layout Subsubsection
+Getting started
\end_layout
\begin_layout Standard
-The simplest way to use reLyX is via the
+You start by selecting the LinuxDoc class using the
\family sans
\bar under
-F
+D
\bar default
-ile\SpecialChar \menuseparator
+ocument\SpecialChar \menuseparator
\bar under
-I
+S
\bar default
-mport
+ettings
\family default
- command in LyX.
- That runs reLyX on the given file and loads the resulting file into LyX.
- You should try that first, and call it from the command line only if you
- need to use more complicated options.
-\end_layout
+ dialog.
+ Then you will find that there are fewer paragraph environments than for
+ most other classes.
+ You can see them on the pull down box on the left of the tool bar.
+ How to use them is described in section\InsetSpace ~
-\begin_layout Standard
+\begin_inset LatexCommand ref
+reference "sec:sgmlparas"
-\series bold
-reLyX
-\series default
- [
-\series bold
--c
-\series default
-
-\shape italic
-textclass
-\shape default
- ] [
-\series bold
--df
-\series default
- ] [
-\series bold
--o
-\series default
-
-\shape italic
-outputdir
-\shape default
- ] [
-\series bold
- -r
-\series default
-\shape italic
- renv1
-\shape default
-[,
-\shape italic
-renv2
-\shape default
-...]] [
-\series bold
- -s
-\series default
-\shape italic
- sfile1
-\shape default
-[,
-\shape italic
-sfile2
-\shape default
-...]]
-\emph on
-inputfile
+\end_inset
+
+.
\end_layout
\begin_layout Standard
-
-\series bold
-reLyX
-\series default
-
-\series bold
--p
-\series default
-
-\series bold
--c
-\series default
-
-\shape italic
-textclass
-\shape default
- [
-\series bold
--df
-\series default
- ] [
-\series bold
--o
-\series default
-
-\shape italic
-outputdir
-\shape default
- ] [
-\series bold
- -r
-\series default
-\shape italic
- renv1
-\shape default
-[,
-\shape italic
-renv2
-\shape default
-...]] [
-\series bold
- -s
-\series default
-\shape italic
- sfile1
-\shape default
-[,
-\shape italic
-sfile2
-\shape default
-...]]
+You
\emph on
-inputfiles
+must
+\emph default
+ enter a title for the document, followed by an author, marking each with
+ the appropriate paragraph environment.
+ If you don't do this, you will get errors when you try to print the file.
+ You can then enter the date and an abstract.
+ The document proper must start with a Section paragraph environment rather
+ than any standard layout.
\end_layout
\begin_layout Standard
+After that you can prepare a document as usual using the available range
+ of paragraph environments.
+ See section\InsetSpace ~
-\series bold
-reLyX
-\series default
-
-\series bold
--h
+\begin_inset LatexCommand ref
+reference "sec:sgmlparas"
+
+\end_inset
+
+ for the full list and their uses.
\end_layout
-\begin_layout Subsection
-Options
+\begin_layout Subsubsection
+Output from LinuxDoc
\end_layout
-\begin_layout Description
+\begin_layout Standard
+You can print and save these documents in the normal way.
+ To use the other features of the SGML package you need to save your document
+ as LinuxDoc; this is a version in which the document is translated into
+ the basic sgml tags.
+ Use
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\series bold
--c
-\series default
- Class.
- By default, when reLyX sees a
-\family typewriter
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
+Linu
+\bar under
+x
+\bar default
+Doc.
-\backslash
-documentclass{foo}
\family default
- command, it creates a file of textclass
-\begin_inset Quotes eld
-\end_inset
+ You will get a file with the same name and a
+\family typewriter
+.sgml
+\family default
+ extension rather than a
+\family typewriter
+.lyx
+\family default
+ extension.
+ See\InsetSpace ~
+
+\begin_inset LatexCommand ref
+reference "sec:sgmloperate"
-foo
-\begin_inset Quotes erd
\end_inset
- and reads the LyX layout file for that class.
- Use
-\series bold
--c
-\series default
- to declare a different textclass (and read a different layout file).
+ on how you than make use of this file.
\end_layout
-\begin_layout Description
-
-\series bold
--d
-\series default
- Debug.
- By default, reLyX gives sparse output and deletes the temporary files which
- were created during translation.
- Using the
-\series bold
--d
-\series default
- flag will create much more output (both to stdout and stderr) and leave
- the temporary files around.
+\begin_layout Subsection
+Using the paragraph environments in LinuxDoc
\end_layout
-\begin_layout Description
+\begin_layout Subsubsection
+The Structure of a LinuxDoc Document
+\end_layout
-\series bold
--f
-\series default
- Force.
- reLyX will not run if the
-\family typewriter
-.lyx
-\family default
- file it would generate already exists Use the
-\series bold
--f
-\series default
- option (carefully) to clobber any existing files.
-\end_layout
-
-\begin_layout Description
-
-\series bold
--h
-\series default
- Help.
- Print out usage information and quit
+\begin_layout Standard
+There is a formal structure for LinuxDoc which limits how you can place
+ tags.
+ There are two parts to all documents:
\end_layout
\begin_layout Description
-
-\series bold
--o
-\series default
- Output directory.
- With this option, all temporary files and LyX output files (for the given
- input file, for any included files, or for any file fragments given with
- the
-\series bold
--p
-\series default
- option) will be put into
-\shape italic
-outputdir
-\shape default
-.
- Otherwise, for each file
-\emph on
-dir/foo.tex
-\emph default
-, the temporary files and the LyX output file will be created in
-\emph on
-dir
-\emph default
-.
- This can be useful if a file includes files from other directories which
- you want to consolidate in one directory, or if you don't have write permission
- on the directory the LaTeX files are in.
+Header: this is everything up to the first time you insert a Section layout
+ marker.
+ It can include title, author, date, abstract and ToC.
+ You must include the first two.
\end_layout
\begin_layout Description
-
-\series bold
--p
-\series default
- Partial file.
- The input files are LaTeX fragments, with no preamble matter or
-\family typewriter
-
-\backslash
-begin{document}
-\family default
- commands.
- This option requires the
-\series bold
--c
-\series default
- option, since there are no
-\family typewriter
-
-\backslash
-documentclass
-\family default
- commands in the files reLyX is translating.
- When using this option, you can translate more than one file, as long as
- all files are the same class.
- The LyX file created by reLyX can be included in an existing LyX file using
+Body: from the beginning of the first section onwards.
+ All other tags are allowed.
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Fil
-\bar under
-e
-\bar default
-\SpecialChar \menuseparator
-Ly
-\bar under
-X
-\bar default
-\InsetSpace ~
-Document
-\family default
-.
\end_layout
-\begin_layout Description
-
-\series bold
--r
-\series default
- Regular environments (see the Section\InsetSpace ~
+\begin_layout Subsubsection
+The LinuxDoc Paragraph Environments
+\end_layout
-\begin_inset LatexCommand \ref{sub:relyx-syntax}
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:sgmlparas"
\end_inset
-).
- If you give more than one environment, separate them with commas (not
- spaces).
- You'll probably need to quote the environment list, especially if it has
- asterisk environments (foo*) in it.
- If you use this command often, considering creating a personal syntax file.
+Here is a list of all the tags you will find listed on the layout bar in
+ the order they come there, with some comments where the purpose or use
+ is not obvious:
\end_layout
-\begin_layout Description
-
-\series bold
--s
-\series default
- Syntax files.
- Input (one or more quoted, comma-separated) syntax files to read in addition
- to the default.
- (see the section Section\InsetSpace ~
+\begin_layout Itemize
-\begin_inset LatexCommand \ref{sub:relyx-syntax}
+\family sans
+Standard:
+\family default
+
+\family roman
+works as described in [cross reference]
+\end_layout
-\end_inset
+\begin_layout Itemize
- for details).
+\family sans
+Title
+\family default
+: This will appear at the top left of the document when printed, above a
+ heavy horizontal rule, although you will not see this on the LyX screen.
\end_layout
-\begin_layout Subsection
-Description
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsubsection
-Introduction
+\family sans
+Section, Subsection, Subsubsection, Paragraph and Subparagraph:
+\family default
+ all do what you would expect and in the usual order.
+ Whether they are numbered or not is controlled by the
+\family sans
+Section\InsetSpace ~
+number\InsetSpace ~
+depth
+\family default
+ setting.
+ You cannot get the equivalent number free versions in any other way; there
+ is no
+\family sans
+Section*
+\family default
+ or similar
\end_layout
-\begin_layout Standard
-reLyX will create a LyX file
-\emph on
-dir/foo.lyx
-\emph default
- from the LaTeX file
+\begin_layout Itemize
+
+\family sans
+Enumerate:
+\family default
+ As usual this produces a numbered and indented list as described in the
+
\emph on
-dir/foo.tex
+User's Guide
\emph default
- (unless the
-\series bold
--o
-\series default
- option is used).
+.
\end_layout
-\begin_layout Standard
-Suffixes
-\family typewriter
-.tex
-\family default
-,
-\family typewriter
-.ltx
+\begin_layout Itemize
+
+\family sans
+Itemize:
\family default
- and
-\family typewriter
-.latex
+
+\family roman
+Again much the same as in the other classes: see the
\family default
- are supported.
- If
+
+\family roman
\emph on
-inputfile
+User's Guide
\emph default
- does not exist and does not have one of these suffixes, reLyX will try
- to translate
+.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Description
+\family default
+: As explained in the
\emph on
-inputfile.tex
+User's Guide
\emph default
.
- (This is similar to the behavior of LaTeX.)
+ Remember that if you want the bold element at the start of a description
+ to be more than one word then you need to put protected spaces between
+ the words.
+
\end_layout
-\begin_layout Standard
-The purpose of reLyX is to translate
-\shape italic
-well-behaved
-\shape default
- LaTeX2e into LyX.
- If your LaTeX file doesn't compile---or if you do weird things, like redefining
- standard LaTeX commands---it may choke.
- LaTeX209 will often be translated correctly, but it's not guaranteed.
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-reLyX has some bugs and lacks a few features.
- However, its main goals are:
+\family sans
+Verbatim:
+\family default
+ As usual.
\end_layout
\begin_layout Itemize
-Get through a well-behaved LaTeX2e file without crashing
+
+\family sans
+Code: similar to the LyX-Code
+\family default
+
+\family roman
+environment
\end_layout
\begin_layout Itemize
-Translate a lot of that file.
+
+\family sans
+Author
+\family default
+: Anything you mark with this will appear on the left of the heading of
+ the document, under the heavy rule.
\end_layout
\begin_layout Itemize
-Localize the parts that can't be translated and copy them in TeX mode
-\end_layout
-\begin_layout Standard
-It achieves these main goals pretty well on most files.
+\family sans
+Date:
+\family default
+ Anything you mark with this will appear on the right of the heading under
+ the rule.
+ You do not have to make this a date.
+ Any text can be entered, e.\InsetSpace ~
+g.
+ a version number.
\end_layout
-\begin_layout Standard
-There are many improvements that can and will be made to reLyX in the future.
- However, we wanted to get reLyX out there early on, to make it easier for
- new LyX users to read in their existing LaTeX files.
-\end_layout
+\begin_layout Itemize
-\begin_layout Subsubsection
-Usage
-\end_layout
+\family sans
+Abstract
+\family default
+: You can use this to produce a free standing paragraph after the author
+ and date, and before the first section.
+ You are only allowed one such paragraph.
+\begin_inset Foot
+status collapsed
\begin_layout Standard
-Here's a more lengthy description of what you should do to translate a LaTeX
- document into LyX.
-\end_layout
-\begin_layout Itemize
-Run reLyX.
+\emph on
+Author's note.
+
+\emph default
+ This needs checking ---
+\emph on
+pe.
\end_layout
-\begin_deeper
-\begin_layout Standard
-reLyX will inform you of its progress and give any warnings to stderr, so
- if you don't want any output at all, try (in csh)
-\begin_inset Quotes eld
\end_inset
-\family typewriter
-reLyX foo.tex >& /dev/null
-\family default
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- or (in bash)
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Displaymath
+\family default
+:
+\begin_inset Foot
+status collapsed
+\begin_layout Standard
-\family typewriter
-reLyX foo.tex
-\family default
-
-\family typewriter
-2>&1 >/dev/null
-\family default
+\emph on
+Author's note:
+\emph default
+ I have not yet checked this ---
+\emph on
+pe.
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
- You should NOT redirect standard output to
-\family typewriter
-foo.lyx
-\family default
-.
-
+
\end_layout
-\end_deeper
-\begin_layout Itemize
-Run LyX on the resulting .lyx file.
+\begin_layout Subsubsection
+Other document features
\end_layout
-\begin_deeper
\begin_layout Standard
-In theory, most of the file will have been translated, and anything that's
- untranslatable will be highlighted in red (TeX mode).
- In theory, LyX will be able to read in the file, and to create printed
- documents from it, because all that untranslated red stuff will be passed
- directly back to LaTeX, which LyX uses as a backend.
- Unfortunately, reality doesn't always reflect theory.
- If reLyX crashes, or LyX cannot read the generated LyX file, see Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sub:relyx-bugs}
-
-\end_inset
-
- or the
-\family typewriter
-BUGS
+You can also use the
+\family sans
+Layout
\family default
- file.
-\end_layout
-
-\end_deeper
-\begin_layout Itemize
-Change things that are in ERT boxes (TeX code) by hand in LyX.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-As mentioned above, you should be able to print out the LyX file even without
- doing this.
- However, changing a command in TeX mode to the corresponding LyX object
- will allow you to take advantage of LyX's WYSIWYM editing.
-\end_layout
+ menu to set fonts or to emphasis words.
+ You can also use the table of contents as usual; see the corresponding
+ section of the
+\emph on
+User's Guide
+\emph default
+.
+ Although you will find some some other features on the menus e.\InsetSpace ~
+g.
+ inserting footnotes.
+ There is some doubt about whether these will work correctly.
+\begin_inset Foot
+status collapsed
\begin_layout Standard
-reLyX is not guaranteed to create a LyX file which generates exactly the
- same output as the LaTeX file, but it should come close.
- reLyX will generally err on the side of translating less to ensure that
- dvi or ps files are accurate, even though this leads to more
-\begin_inset Quotes eld
-\end_inset
-
-evil red text
-\begin_inset Quotes erd
-\end_inset
- and less WYSIWYM.
-\end_layout
-
-\end_deeper
-\begin_layout Itemize
-PROOFREAD THE DOCUMENT!!
+\emph on
+Author's note:
+\emph default
+ Again still checking to see whether this is my system
+\emph on
+---pe.
\end_layout
-\begin_deeper
-\begin_layout Standard
-I'm sure you were planning on doing this anyway, but it's particularly important
- after translating a LaTeX document.
- reLyX is, at least now, better at
-\begin_inset Quotes eld
-\end_inset
-
-macro-translating
-\begin_inset Quotes erd
-\end_inset
-
- (translating the whole document) than
-\begin_inset Quotes eld
\end_inset
-micro-translating
-\begin_inset Quotes erd
-\end_inset
- (translating every little detail).
- For example, you may see extra spaces or deleted spaces.
- Space handling has improved, but it's not perfect.
\end_layout
-\end_deeper
\begin_layout Subsubsection
-What reLyX Can Handle
+Cross references and HTML
\end_layout
\begin_layout Standard
-reLyX understands many LaTeX commands.
- It will translate:
+On the
+\family sans
+Insert
+\family default
+ menu you will find two new options relating to the inclusion of URL addresses.
+ If you use either option you will find some highlighted TeX code inserted
+ into your document in three separate blocks with spaces available between.
+ The blocks will be:
\end_layout
-\begin_layout Itemize
-regular text, including mini-commands like ~, '',
-\family typewriter
+\begin_layout Quote
-\backslash
-@
-\family default
-,
\family typewriter
\backslash
-TeX
+htmlurl{
\family default
-, as well as accented characters like
+ or
\family typewriter
\backslash
-'{a}
-\family default
-, and the special cases ?` and !`
-\end_layout
-
-\begin_layout Itemize
-title commands like
-\family typewriter
+url{
+\family roman
-\backslash
-author
+\hfill
+space
\family default
-,
+
\family typewriter
-\backslash
-date
-\family default
-,
-\family typewriter
+\hfill
+}{
+\family roman
-\backslash
-title
-\family default
-,
-\family typewriter
+\hfill
+space
+\hfill
-\backslash
-thanks
-\family default
- and the abstract environment
+\family typewriter
+}
\end_layout
-\begin_layout Itemize
-heading commands like
-\family typewriter
+\begin_layout Standard
+You insert a full HTML tag between the first and second blocks.
+ This can be
+\begin_inset LatexCommand url
+target "http://any.address"
-\backslash
-section
-\family default
- including starred commands (
-\family typewriter
+\end_inset
+
+ or other valid tags such as
+\begin_inset LatexCommand url
+target "mailto:me@my.address"
+
+\end_inset
-\backslash
-section*
-\family default
-)
-\end_layout
-\begin_layout Itemize
-Environments:
-\family typewriter
-quote
-\family default
-,
-\family typewriter
-quotation
-\family default
-, and
-\family typewriter
-verse
-\family default
-;
\family typewriter
-center
+.
\family default
-,
-\family typewriter
-flushright
+Then y
+\family roman
+ou
\family default
-, and
-\family typewriter
-flushleft
+ insert some description between the second and third blocks.
+ The differences are:
\end_layout
\begin_layout Itemize
-\family typewriter
-itemize
-\family default
-,
-\family typewriter
-enumerate
-\family default
-, and
-\family typewriter
-description
-\family default
- environments, and their
-\family typewriter
-
-\backslash
-item
+\family sans
+URL:
\family default
- commands.
- Also, well-behaved nested lists
+
+\family roman
+both the HTML tag and the description will appear in the document
\end_layout
\begin_layout Itemize
-cross-referencing commands:
-\family typewriter
-
-\backslash
-ref
-\family default
-,
-\family typewriter
-\backslash
-pageref
+\family sans
+HTML\InsetSpace ~
+URL:
\family default
-,
-\family typewriter
+
+\family roman
+only the description appears in the printed version
+\end_layout
-\backslash
-label
-\family default
-, and
-\family typewriter
+\begin_layout Subsection
+Using the LinuxDoc Sgml scripts
+\begin_inset Note Note
+status collapsed
-\backslash
-cite
+\begin_layout Standard
+This section is completely outdated.
\end_layout
-\begin_layout Itemize
-
-\family typewriter
+\end_inset
-\backslash
-footnote
-\family default
- and
-\family typewriter
-\backslash
-margin
\end_layout
-\begin_layout Itemize
-font-changing commands including
-\family typewriter
+\begin_layout Standard
+\begin_inset LatexCommand label
+name "sec:sgmloperate"
-\backslash
-em
-\family default
-,
-\family typewriter
+\end_inset
+
+You can use LinuxDoc as a text class without any additional scripts or programs,
+ but there is not much point in doing this.
+ All you will get is a document that looks like a
+\emph on
+Linux Documentation Project Howto
+\family sans
+\emph default
+.
-\backslash
-emph
\family default
-,
+ To do the document translation you need to get and install the
\family typewriter
+sgml-tools-1.0.x.tar.gz
+\family default
+ (with
+\begin_inset Formula $x\geq3$
+\end_inset
-\backslash
-textit
+) package from
+\family roman
+the SGML-Tools WWW Page
\family default
-, and corresponding commands to change family, size, series, and shape
+ at
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
-\family typewriter
+\family roman
+\begin_inset LatexCommand url
+target "http://pobox.com/~cg/sgmltools"
+
+\end_inset
-\backslash
-input{foo}
-\family default
- (or
-\family typewriter
-\backslash
-input{foo.blah}
\family default
-) and
+
+\end_layout
+
+\begin_layout Standard
+Alternatively, you can go to the
\family typewriter
+sunsite
+\family default
+ archive at
+\begin_inset Foot
+status collapsed
-\backslash
-include{foo}
+\begin_layout Standard
+Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
+ has not yet been made available at
+\family typewriter
+sunsite
\family default
.
- Plain TeX
-\family typewriter
+\end_layout
-\backslash
-input
-\family default
- command
-\begin_inset Quotes erd
\end_inset
-\family typewriter
-
-\backslash
-input foo.tex
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- is also supported.
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
-\family typewriter
-tabular
-\family default
- environment, and commands that go inside it like
-\family typewriter
+\family roman
+\begin_inset LatexCommand url
+target "ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz"
-\backslash
-hline
-\family default
-,
-\family typewriter
+\end_inset
-\backslash
-cline
-\family default
-, and
-\family typewriter
-\backslash
-multicolumn
-\family default
- (but see below)
\end_layout
-\begin_layout Itemize
-float environments
-\family typewriter
-table
+\begin_layout Standard
+
+\family roman
+The
\family default
- and
+ file
\family typewriter
-table*
+sgml-tools-1.0.x.tar.gz
\family default
-, as well as
-\family typewriter
+ contains everything that you need to write SGML documents and convert them
+ to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
-\backslash
-caption
-\family default
- commands within them
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+This package was renamed from
\family typewriter
-thebibliography
+linuxdoc-sgml-1.5.tar.gz
\family default
- environment and
-\family typewriter
+ in January 1997.
+\end_layout
-\backslash
-bibitem
-\family default
- command, as well as BibTeX's
-\family typewriter
+\begin_layout Standard
+Follow the instructions in that package on how to install it and how to
+ use it.
+ All this has to be done outside of LyX, before you can use the
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\backslash
-bibliography
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
+as\InsetSpace ~
+LinuxDoc
\family default
- and
-\family typewriter
+
+\family roman
+option.
+\end_layout
-\backslash
-bibliographystyle
-\family default
- commands
+\begin_layout Subsection
+Troubleshooting LinuxDoc
\end_layout
-\begin_layout Itemize
-miscellaneous commands:
-\family typewriter
+\begin_layout Standard
+When you print or preview a LinuxDoc document some checking is done of the
+ tags before LaTeX is run.
+ Some errors are trapped here, especially those concerning the structure
+ of the document.
+ LyX may produce an error message, but not leave an error box in the document
+ for you to open.
+ You may have to look at the files directly to discover what is wrong.
+ Most problems seem to come from the use of options that are not fully available
+ in the text class.
+\end_layout
-\backslash
-hfill
-\family default
-,
-\family typewriter
+\begin_layout Section
+Checking TeX
+\end_layout
-\backslash
+\begin_layout Standard
+by
+\noun on
+Asger Alstrup
+\end_layout
-\backslash
+\begin_layout Subsection
+Introduction
+\end_layout
+\begin_layout Standard
+Under the
+\family sans
+\bar under
+T
+\bar default
+ools
\family default
-,
-\family typewriter
-
-\backslash
-noindent
+ menu, you'll find a
+\family sans
+\bar under
+C
+\bar default
+heck\InsetSpace ~
+TeX
\family default
-,
+ command.
+ This feature requires you to have the
\family typewriter
-
-\backslash
-ldots
+chktex
\family default
-...
-\end_layout
-
-\begin_layout Itemize
-documentclass-specific environments (and some commands) which can be translated
- to LyX layouts
-\end_layout
-
-\begin_layout Itemize
-arguments to certain untranslatable commands (e.g.
-
-\family typewriter
+ program installed, and is grayed out if you don't have it.
+ You can get it from your nearest CTAN mirror, or over the Web from
+\begin_inset LatexCommand url
+target "http://www.ifi.uio.no/~jensthi/chktex/"
-\backslash
-mbox
-\family default
-)
-\end_layout
+\end_inset
-\begin_layout Standard
-Some of this support may not be 100% yet.
- See below for details
+.
\end_layout
\begin_layout Standard
-reLyX copies math (almost) verbatim from your LaTeX file.
- Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
- by LyX should work just fine.
- A few math commands which are not supported by LyX will be replaced with
- their equivalents, e.g.,
-\family typewriter
-
-\backslash
-to
+The
+\family sans
+ChkTeX
\family default
- is converted to
+ package is a program that was written by
+\noun on
+Jens T.
+ Berger Thielemann
+\noun default
+ in frustration because some constructs in LaTeX are sometimes non-intuitive,
+ and easy to forget.
+ The program runs over your LaTeX file and checks the integrity of the file,
+ and flags some common errors.
+ In other technical words, it is
\family typewriter
-
-\backslash
-rightarrow
+Lint
\family default
-.
- See the section on
-\shape italic
-Syntax Files
-\shape default
- for more details.
+ for LaTeX.
\end_layout
\begin_layout Standard
-reLyX will also copy any preamble commands (i.e., anything before
+Well, what is a syntax checker doing in LyX which is supposed to produce
+ correct LaTeX anyways? The answer is simple: Just as
\family typewriter
-
-\backslash
-begin{document}
+Lint
+\family default
+ not only checks the
+\emph on
+syntax
+\emph default
+ of C programs, but also does
+\emph on
+semantic
+\emph default
+ checks for type-errors,
+\family sans
+ChkTeX
\family default
-) verbatim, so fancy stuff you've got in your preamble should be conserved
- in dvi and printed documents, although it will not of course show up in
- the LyX window.
- Check the preamble to make sure.
+ catches some common
+\emph on
+typographic
+\emph default
+ errors, in addition to the syntactical ones.
+ Specifically,
+\family sans
+ChkTeX
+\family default
+ is capable of detecting several common errors, such as
\end_layout
-\begin_layout Subsubsection
-What reLyX Can't Handle --- But it's OK
+\begin_layout Itemize
+Ellipsis detection:
+\newline
+Use \SpecialChar \ldots{}
+ instead of ...
\end_layout
\begin_layout Itemize
-figures and
-\family typewriter
-tabular*
-\family default
- tables
+No space in front of/after parenthesis:
+\newline
+( wrong spacing )
\end_layout
\begin_layout Itemize
-minipages
+Enforcement of normal space after common abbreviations:
+\newline
+e.
+ g.
+ is too wide spacing.
\end_layout
\begin_layout Itemize
-spacing commands (
-\family typewriter
+Enforcement of end-of-sentence space when the last sentence ends with a
+ capital letter:
+\newline
+This is a TEST.
+ And this is wrong spacing.
+\end_layout
-\backslash
-vspace
-\family default
-,
-\family typewriter
+\begin_layout Itemize
+Space in front of labels and similar commands:
+\newline
+The label should stick right
+ up to the text to avoid falling to a wrong page.
+
+\begin_inset LatexCommand label
+name "sec:chktex"
-\backslash
-pagebreak
-\family default
-,
-\family typewriter
+\end_inset
-\backslash
-par
-\family default
-)
+
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+This footnote is in danger of falling off to a wrong page
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
-
-\backslash
-centering
-\family default
-,
-\family typewriter
-
-\backslash
-raggedleft
-\family default
-,
-\family typewriter
-
-\backslash
-raggedright
-\end_layout
+ The label is separated too much.
+\end_layout
\begin_layout Itemize
+Space in front of references, instead of hard spaces:
+\newline
+In you are in bad luck,
+ the text will break right between the referenced text and reference number,
+ and that's a pity.
+ See section
+\begin_inset LatexCommand ref
+reference "sec:chktex"
-\family typewriter
+\end_inset
-\backslash
-verb
-\family default
- and
-\family typewriter
-verbatim
-\family default
- environment.
- reLyX is careful to copy
-\shape italic
-exactly
-\shape default
- in this case, including comments and whitespace.
+.
\end_layout
\begin_layout Itemize
-some unknown (e.g., user-defined) environments and commands
-\end_layout
-
-\begin_layout Standard
-reLyX copies unknown commands, along with their arguments, verbatim into
- the LyX file.
- Also, if it sees a
-\family typewriter
-
-\backslash
-begin{foo}
-\family default
- where it doesn't recognize the
+Use of
\begin_inset Quotes eld
\end_inset
-foo
+x
\begin_inset Quotes erd
\end_inset
- environment, it will copy verbatim until it sees
-\family typewriter
-
-\backslash
-end{foo}
-\family default
- (unless you use the
-\series bold
--r
-\series default
- option).
- Hopefully, then, most of these unknown commands won't cause reLyX to break;
- they'll merely require you to do some editing once you've loaded the file
- up in LyX.
- That should be less painful than editing either the
-\family typewriter
-.tex
-\family default
- or the
-\family typewriter
-.lyx
-\family default
- file using a text editor.
-\end_layout
-
-\begin_layout Subsubsection
-What reLyX Handles Badly --- a.\InsetSpace ~
-k.\InsetSpace ~
-a.
- BUGS
-\begin_inset LatexCommand \label{sub:relyx-bugs}
-
+ instead of
+\begin_inset Formula $\times$
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Since reLyX is relatively new, it's got a number of problems.
- As it matures, these bugs will be squished.
- A number of bugs and missing features can be found listed on the LyX bug
- tracker,
-\begin_inset LatexCommand \url[LyX Bugzilla]{http://bugzilla.lyx.org/}
-
+ between numbers:
+\newline
+2x2 looks cheap compared to
+\begin_inset Formula $2\times2$
\end_inset
.
\end_layout
\begin_layout Standard
-If reLyX is choking on something, or LyX can't read it after reLyX translates
- it, the best thing to do is to put
-\family typewriter
-
-\backslash
-begin{reLyXskip}
-\family default
- before the offending text, and
-\family typewriter
-
-\backslash
-end{reLyXskip}
-\family default
- after it.
- I call this a
+and more \SpecialChar \ldots{}
+ It is an invaluable tool when you are
\begin_inset Quotes eld
\end_inset
-skip
+finishing up
\begin_inset Quotes erd
\end_inset
- block.
- reLyX will copy this block exactly, in TeX mode.
- Then edit the resulting LyX file, and translate the unknown stuff by hand.
- The
-\family typewriter
-reLyXskip
-\family default
- environment is magical; the
-\family typewriter
-
-\backslash
-begin
-\family default
- and
-\family typewriter
+ 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
-\backslash
-end
-\family default
- commands will not be put into the LyX file.
+\begin_layout Subsection
+How to use it
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+If you have the program installed, usage is as simple as choosing
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+C
+\bar default
+heck\InsetSpace ~
+TeX
+\family default
+.
+ This will make LyX generate a LaTeX file of your document, start
+\family sans
+ChkTeX
+\family default
+ to check it, and then make LyX insert
\begin_inset Quotes eld
\end_inset
-Exact
+error boxes
\begin_inset Quotes erd
\end_inset
- copying of unknown environments and commands isn't quite exact.
- Specifically, newlines and comments may be lost.
- This will yield ugly LyX, but in almost all cases the output will be the
- same.
- However, certain parts of the file will be copied perfectly, including
- whitespace and comments.
- This includes: the LaTeX preamble,
-\family typewriter
-verbatim
-\family default
- environments and
-\family typewriter
-
-\backslash
-verb
-\family default
- commands, and skip blocks.
-\end_layout
-
-\begin_layout Itemize
-reLyX translates only a few options to the
-\family typewriter
-
-\backslash
-documentclass
+ with the warnings from
+\family sans
+ChkTeX
\family default
- command.
- (Specifically 1[012]pt, [letter|legal|executive|a4|a5|b5]paper, [one|two]side,
- landscape, and [one|two]column.) Other options are placed in the extra class
- options field in the
+, if there were any.
+ The warnings will be placed close to the point of the mistake, and you
+ can quickly find them by using the
\family sans
\bar under
-D
+N
\bar default
-ocument\SpecialChar \menuseparator
+avigate\SpecialChar \menuseparator
\bar under
-S
+E
\bar default
-ettings
+rror
\family default
- dialog.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-More importantly, reLyX doesn't translate
-\family typewriter
-
-\backslash
-usepackage
+ menu item, or the shortcut key
+\family sans
+C-g
\family default
- commands, margin commands,
+ from the default
\family typewriter
-
-\backslash
-newcommand
+cua
\family default
-s, or, in fact, anything else from the preamble.
- It simply copies them into the LaTeX preamble.
- If you have margin commands in your preamble, then the LyX file will generate
- the right margins.
- However, these margins will override any margins you set in the LyX
+ bind file.
+ Open the error boxes by clicking on them with the mouse, or use the shortcut
+ key
\family sans
-\bar under
-D
-\bar default
-ocument
-\bar under
-\SpecialChar \menuseparator
-S
-\bar default
-ettings
+C-i
\family default
- dialog.
- So you should remove the options from the preamble to be safe.
- The same goes for setting your language with babel,
+ from
\family typewriter
-
-\backslash
-inputencoding
+cua
\family default
-,
-\family typewriter
-
-\backslash
-pagestyle
+ bindings, or the corresponding
+\family sans
+C-o
\family default
-, etc.
-\end_layout
-
-\end_deeper
-\begin_layout Itemize
-The foil class has a couple bugs.
- reLyX may do weird things with optional arguments to
+ for the alternate
\family typewriter
-
-\backslash
-foilhead
+emacs
\family default
- commands.
- Also, it may handle
-\family typewriter
-
-\backslash
-begin{dinglist}
+ bind file.
+ Read the warning and correct the mistake, if it is a mistake.
+ If you have trouble understanding what the warning is about, you can safely
+ ignore it.
+ Remember that there is a hidden layer between the document on screen and
+ the technical details in invoking
+\family sans
+ChkTeX
\family default
- incorrectly (although the stuff in the environment should translate normally).
+, and this gap can make some warnings seem arcane or just right down plain
+ silly.
\end_layout
\begin_layout Standard
-reLyX is hopefully rather robust.
- As mentioned above, it may not translate your file perfectly, but it shouldn't
- crash.
- If it does crash---and the problem is not one of those mentioned above
- or in the
-\emph on
-BUGS
-\emph default
- file---see Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sub:relyx-bug-reports}
-
-\end_inset
-
-.
+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 Subsubsection
-What LyX Can't Handle
+\begin_layout Subsection
+How to fine tune it
\end_layout
\begin_layout Standard
-LyX itself is missing a couple features, such that even if reLyX translates
- things perfectly, LyX may still have trouble reading it.
- If you really need these features, you can export your final document as
- LaTeX, and put them back in.
- See
-\emph on
-BUGS
-\emph default
- for more details on these bugs.
-\end_layout
-
-\begin_layout Itemize
-For a number of commands, LyX does not support the optional argument.
- Examples include
-\family typewriter
-
-\backslash
-sqrt
+Sometimes, you'll find that
+\family sans
+ChkTeX
\family default
-,
-\family typewriter
-
-\backslash
-chapter
+ makes more noise than suits your mood.
+ Then you can choose not to use it, wait until your mood changes, or try
+ to customize
+\family sans
+ChkTeX
\family default
- (and other sectioning commands), and
-\family typewriter
-
-\backslash
-
-\backslash
-
-\family default
-.
- reLyX will automatically discard the optional arguments with a warning
- to stdout.
- LyX also ignores the width argument for the
-\family typewriter
-thebibliography
-\family default
- environment.
-\end_layout
-
-\begin_layout Itemize
-Centering (or right or left justifying) works on full paragraphs.
-\end_layout
-
-\begin_layout Itemize
-LyX support for tables isn't perfect.
- For complicated tables, use a
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\begin_inset Quotes erd
-\end_inset
-
- block, so that they will be copied in TeX mode.
-\end_layout
-
-\begin_layout Itemize
-The LyX math editor can't handle the AMS-LaTeX math environments align,
- split, etc.
- So those environments will be copied in TeX mode.
- You can change
-\family typewriter
-equation*
-\family default
- environments to the exactly equivalent displaymath, and then they will
- be translated correctly.
-\end_layout
-
-\begin_layout Subsection
-Examples
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-reLyX -df -o
-\begin_inset Quotes eld
-\end_inset
-
-my/dir
-\begin_inset Quotes erd
-\end_inset
-
- -r
-\begin_inset Quotes eld
-\end_inset
-
-myenv
-\begin_inset Quotes erd
-\end_inset
-
- foo.tex > foo.debug
-\end_layout
-
-\begin_layout Standard
-The above will create a file my/dir/foo.lyx from foo.tex, overwriting if necessary.
- When it finds a
-\family typewriter
-
-\backslash
-begin{myenv} ...
-
-\backslash
-end{myenv}
-\family default
- block, it will translate the stuff within the block, but copy the
-\family typewriter
-
-\backslash
-begin
-\family default
- and
-\family typewriter
-
-\backslash
-end
-\family default
- commands in TeX mode.
- Finally, I'm going to keep the temporary files around (they will also
- be in my/dir/) and output lots of debugging information into the file foo.debug.
-\end_layout
-
-\begin_layout Subsection
-Notes
-\end_layout
-
-\begin_layout Subsubsection
-Bug Reports
-\begin_inset LatexCommand \label{sub:relyx-bug-reports}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-If reLyX is crashing or otherwise acting strangely---in ways other than
- those described in Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sub:relyx-bugs}
-
-\end_inset
-
- or the bug tracker---then please run reLyX
-\series bold
- -d
-\series default
-.
- That will allow you to figure out where in the reLyXing process it crashed.
- That, in turn, will allow you to write a better bug report, which will
- allow the developers to fix it more quickly and easily.
-\end_layout
-
-\begin_layout Standard
-Bug reports should be sent to the LyX developers' mailing list.
- Its address is currently
-\family typewriter
-lyx-devel@lists.lyx.org
-\family default
-.
- If you are running reLyX on a huge file, please do not send all of the
- output in your bug report.
- Just include the last ten or twenty lines of output, along with the piece
- of the LaTeX file it crashed on.
- Or, even better, attach a small but complete file which causes the same
- problem as your original file.
-\end_layout
-
-\begin_layout Subsubsection
-Implementation Details:
-\end_layout
-
-\begin_layout Standard
-reLyX makes several
-\begin_inset Quotes eld
-\end_inset
-
-passes
-\begin_inset Quotes erd
-\end_inset
-
- in order to translate a TeX file.
- On each pass, it creates one or two files.
-\end_layout
-
-\begin_layout Description
-Pass\InsetSpace ~
-0 \InsetSpace ~
-
-\newline
-Before doing anything, read the syntax file (or files).
-\end_layout
-
-\begin_layout Description
-Pass\InsetSpace ~
-1a \InsetSpace ~
-
-\newline
-Split preamble (anything before a
-\family typewriter
-
-\backslash
-begin{document}
-\family default
- command) off the rest of the file.
- It saves the two pieces in separate files.
- This is necessary because there may be very strange stuff in a preamble.
- It also ignores anything after the
-\family typewriter
-
-\backslash
-end{document}
-\family default
-, on the assumption that it isn't LaTeX.
-\end_layout
-
-\begin_layout Description
-Pass\InsetSpace ~
-1b \InsetSpace ~
-
-\newline
-Translate the preamble.
- Currently, that just means translating the
-\family typewriter
-
-\backslash
-documentclass
-\family default
- command and copying the rest exactly into the LyX preamble.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-Once you know what class the document is, read the LyX layout file for that
- class.
-\end_layout
-
-\end_deeper
-\begin_layout Description
-Pass\InsetSpace ~
-2 \InsetSpace ~
-
-\newline
-
-\begin_inset Quotes eld
-\end_inset
-
-Clean
-\begin_inset Quotes erd
-\end_inset
-
- the TeX file, generating slightly stricter LaTeX.
- This includes:
-\end_layout
-
-\begin_deeper
-\begin_layout Itemize
-Change, e.g.,
-\family typewriter
-x^2
-\family default
- to the equivalent but clearer
-\family typewriter
-x^{2}
-\end_layout
-
-\begin_layout Itemize
-Removing optional arguments that LyX can't handle (e.g., from
-\family typewriter
-
-\backslash
-sqrt
-\family default
-)
-\end_layout
-
-\begin_layout Itemize
-Changing
-\family typewriter
-{
-\backslash
-em foo}
-\family default
- to
-\family typewriter
-
-\backslash
-emph{foo}
-\family default
-, etc.
- This is necessary because LyX always writes out the non-local forms anyway.
- This should very rarely make a difference.
-\end_layout
-
-\end_deeper
-\begin_layout Description
-Pass\InsetSpace ~
-3 \InsetSpace ~
-
-\newline
-Translate LaTeX text, commands, and environments to LyX.
-\end_layout
-
-\begin_layout Description
-Pass\InsetSpace ~
-4 \InsetSpace ~
-
-\newline
-Put the two pieces back together, and do some final tweaking, to generate
- the LyX file
-\end_layout
-
-\begin_layout Standard
-If there are any
-\family typewriter
-
-\backslash
-input
-\family default
- or
-\family typewriter
-
-\backslash
-include
-\family default
- commands, reLyX will loop back to the beginning and translate those.
- It assumes that the included files are the same class as the main file,
- and that they have no preamble matter.
- (If you have an
-\family typewriter
-
-\backslash
-input
-\family default
- command in the preamble of a file, the command will be copied exactly into
- the LaTeX preamble portion of the LyX file, so the included file won't
- be translated.) So when translating included files, it skips passes 0 and
- 1.
-\end_layout
-
-\begin_layout Standard
-If reLyX doesn't find a file you wanted to include, it will give a warning,
- but will continue to translate any files it does find.
-\end_layout
-
-\begin_layout Subsubsection
-Layout Files
-\end_layout
-
-\begin_layout Standard
-reLyX reads a LyX layout file to know how to handle LaTeX environments and
- commands which get translated to LyX layouts.
- This file will include all
-\begin_inset Quotes eld
-\end_inset
-
-normal
-\begin_inset Quotes erd
-\end_inset
-
- non-math environments (i.e., including quote and itemize, but not tabular,
- minipage, and some other fancy environments), and commands like
-\family typewriter
-
-\backslash
-section
-\family default
- and
-\family typewriter
-
-\backslash
-title
-\family default
-.
- If you want to reLyX a class that doesn't have an existing layout file,
- then you'll have to create a layout file.
- But you have to do this anyway, in order to LyX the file, since LyX depends
- on layout files to know how to display and process its files.
- Check the LyX documentation for help with this task (which can be hard
- or easy, depending on the class you want to create a layout file for.) If
- your class is quite similar to a class that has a layout file, then consider
- using the
-\series bold
--c
-\series default
- option.
-\end_layout
-
-\begin_layout Subsubsection
-Syntax Files
-\begin_inset LatexCommand \label{sub:relyx-syntax}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-reLyX always reads at least one syntax file, called the default syntax file.
- reLyX will read your personal syntax file if it exists; otherwise it will
- read the system-wide file.
- reLyX will read additional syntax files if you specify them with the
-\series bold
--s
-\series default
- option.
- (These extra files should have the same format as the default file, but
- will tend to be shorter, since they only have to specify extra commands
- not found in the default file.) A syntax file tells reLyX a few things.
-\end_layout
-
-\begin_layout Standard
-First, it describes the syntax of each command, that is, how many required
- arguments and how many optional arguments the command takes.
- Knowing this makes it easier for reLyX to copy (in TeX mode) commands that
- it doesn't know how to translate.
- The syntax file simply has a command, followed by braces or brackets describing
- its arguments in the correct order.
- For example, a syntax file entry
-\family typewriter
-
-\backslash
-bibitem[]{}
-\family default
- means that the
-\family typewriter
-
-\backslash
-bibitem
-\family default
- command takes an optional argument followed by a required one, while the
- entry
-\family typewriter
-
-\backslash
-bf
-\family default
- means that the
-\family typewriter
-
-\backslash
-bf
-\family default
- command takes no arguments at all.
- When reLyX encounters a token that it doesn't know how to translate into
- LyX, it will copy the token---along with the correct number of arguments---exac
-tly.
- If the token is not in the syntax file, then reLyX just copies as many
- arguments as it finds.
- This means that it may copy too much.
- But since the user can specify additional syntax files, that shouldn't
- happen often.
-\end_layout
-
-\begin_layout Standard
-Some commands that cannot be translated to LyX, like
-\family typewriter
-
-\backslash
-mbox
-\family default
-, have as one of their arguments regular LaTeX text.
- If the string
-\begin_inset Quotes eld
-\end_inset
-
-translate
-\begin_inset Quotes erd
-\end_inset
-
- is put into an argument of an (untranslatable) command in the syntax file,
- then reLyX will translate that argument instead of copying it verbatim.
- So, for example, the default syntax file has
-\family typewriter
-
-\backslash
-raisebox{}[][]{translate}
-\family default
-.
- This means that the
-\family typewriter
-
-\backslash
-raisebox
-\family default
- command and the first argument (and optional arguments if they exist) are
- copied in TeX mode, but the last argument (which may contain math, complicated
- LaTeX, other untranslatable commands, etc.) will be translated into LyX.
- You can't use
-\begin_inset Quotes eld
-\end_inset
-
-translate
-\begin_inset Quotes erd
-\end_inset
-
- on optional arguments.
-\end_layout
-
-\begin_layout Standard
-User-defined syntax files are allowed to define new commands and their syntax,
- or override the number of arguments for a command given in the default
- syntax file.
- (E.g., if you're using a style that gives an extra argument to some command...)
- However, this will only be useful for commands copied in TeX mode.
- Commands which are actually translated by reLyX (like
-\family typewriter
-
-\backslash
-item
-\family default
-) have their argument syntax hard-coded.
- The hard-coded commands are identified in the default syntax file.
-\end_layout
-
-\begin_layout Standard
-Second, the syntax file describes any
-\begin_inset Quotes eld
-\end_inset
-
-regular environments
-\begin_inset Quotes erd
-\end_inset
-
-.
- Usually, an entire unknown environment will be copied in TeX mode.
- If you define a regular environment
-\begin_inset Quotes eld
-\end_inset
-
-foo
-\begin_inset Quotes erd
-\end_inset
-
-, though, then only the
-\family typewriter
-
-\backslash
-begin{foo}
-\family default
- and
-\family typewriter
-
-\backslash
-end{foo}
-\family default
- commands will be copied in TeX mode; the text within the environment will
- be treated (i.e., translated) by reLyX as regular LaTeX, rather than being
- copied into TeX mode.
- Don't try to declare
-\family typewriter
-tabbing
-\family default
- and
-\family typewriter
-picture
-\family default
- as regular environments, as the text within those environments will confuse
- reLyX; use this capability for new environments you create that have plain
- text or math or simple commands in them.
- You also can't declare unknown math environments (like
-\family typewriter
-equation*
-\family default
-) as regular environments, either, since the LyX math editor won't understand
- them.
- The names of regular environments appear, whitespace-separated, between
-
-\family typewriter
-
-\backslash
-begin{reLyXre}
-\family default
- and
-\family typewriter
-
-\backslash
-end{reLyXre}
-\family default
- statements in the syntax file.
- (If you have a regular environment which you won't use very often, you
- can use the
-\series bold
--r
-\series default
- option rather than writing a syntax file.)
-\end_layout
-
-\begin_layout Standard
-Third, the syntax file describes a math translation table.
- The LyX math editor doesn't support a few commands.
- For example,
-\family typewriter
-_
-\family default
- is supported, but the equivalent
-\family typewriter
-
-\backslash
-sb
-\family default
- is not.
- Put any commands you'd like translate between
-\family typewriter
-
-\backslash
-begin{reLyXmt}
-\family default
- and
-\family typewriter
-
-\backslash
-end{reLyXmt}
-\family default
- statements.
- The statement
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-| {
-\backslash
-Vert}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- means that any
-\family typewriter
-
-\backslash
-|
-\family default
- in math mode will be converted to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-Vert
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\family typewriter
-
-\family default
-(in cases where a token made up of a backslash and a non-letter is translated
- to something with letters at the end, a space is added by reLyX.
- That way,
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-|a
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- is correctly translated to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-
-\backslash
-Vert a
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Subsubsection
-Miscellaneous
-\end_layout
-
-\begin_layout Standard
-You need Perl version 5.002 or later to run reLyX.
- <plug> If you don't have Perl, you should get it anyway (at
-\begin_inset LatexCommand \url[Perl]{http://www.perl.com/}
-
-\end_inset
-
-), because it's a really useful tool for pretty much anything.
- </plug>
-\end_layout
-
-\begin_layout Subsection
-Diagnostics
-\end_layout
-
-\begin_layout Standard
-reLyX should always explain why it crashes, if it crashes.
- Some diagnostics may be very technical, though, if they come from the guts
- of the code.
- reLyX gives much more information while running if you use the
-\series bold
--d
-\series default
- option, but you shouldn't need that unless something goes wrong.
-\end_layout
-
-\begin_layout Standard
-When it's finished, reLyX will tell you if it finished successfully or died
- due to some error.
-\end_layout
-
-\begin_layout Subsection
-Warnings
-\end_layout
-
-\begin_layout Standard
-Always keep a copy of your original LaTeX files either under a different
- name or in a different directory.
- There are a couple ways in which using LyX could lead to overwriting the
- original LaTeX file.
-\end_layout
-
-\begin_layout Standard
-If you import
-\family typewriter
-foo.tex
-\family default
- to create
-\family typewriter
-foo.lyx
-\family default
-, then edit
-\family typewriter
-foo.lyx
-\family default
- and want to re-export it, note that it will overwrite the original
-\family typewriter
-foo.tex
-\family default
-.
- (LyX will
-\emph on
-not
-\emph default
- ask you if you want to overwrite it.)
-\end_layout
-
-\begin_layout Standard
-If you have chosen not to use a temporary directory in the preferences,
- then LyX will create its temporary files in your current directory, which
- means your LaTeX original may be overwritten (without a warning from LyX)
- when you
-\begin_inset Quotes eld
-\end_inset
-
-view dvi
-\begin_inset Quotes erd
-\end_inset
-
- or print the LyX document.
-\end_layout
-
-\begin_layout Subsection
-Files
-\end_layout
-
-\begin_layout Description
-
-\family typewriter
-\series medium
-MY_LYXDIR/layouts/*.layout
-\family default
-\series default
- \InsetSpace ~
-
-\newline
-User's personal layout files for document classes
-\end_layout
-
-\begin_layout Description
-
-\family typewriter
-\series medium
-MY_LYXDIR/reLyX/syntax.default
-\family default
-\series default
- \InsetSpace ~
-
-\newline
-User's personal syntax file
-\end_layout
-
-\begin_layout Description
-
-\family typewriter
-\series medium
-LIBDIR/layouts/*.layout
-\family default
-\series default
- \InsetSpace ~
-
-\newline
-System-wide layout files for document classes
-\end_layout
-
-\begin_layout Description
-
-\family typewriter
-\series medium
-LIBDIR/reLyX/syntax.default
-\family default
-\series default
- \InsetSpace ~
-
-\newline
-System-wide LaTeX syntax file
-\end_layout
-
-\begin_layout Standard
-
-\family typewriter
-LIBDIR
-\family default
- is the system-wide LyX directory, usually something like
-\family typewriter
-/usr/local/share/lyx/
-\family default
-.
-
-\family typewriter
-MY_LYXDIR
-\family default
- is your personal LyX directory, something like
-\family typewriter
-.lyx/
-\family default
- in your home directory.
- You can see their actual values in the
-\family sans
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-About\InsetSpace ~
-Ly
-\bar under
-X
-\family default
-\bar default
- dialog.
-\end_layout
-
-\begin_layout Subsection
-See also
-\end_layout
-
-\begin_layout Standard
-
-\shape italic
-lyx
-\shape default
-(1),
-\shape italic
-latex
-\shape default
-(1)
-\end_layout
-
-\begin_layout Subsection
-Authors
-\end_layout
-
-\begin_layout Standard
-Copyright (c) 1998--9
-\noun on
-Amir Karger
-\noun default
- (
-\family typewriter
-karger@voth.chem.utah.edu
-\family default
-)
-\end_layout
-
-\begin_layout Standard
-Code contributors:
-\end_layout
-
-\begin_layout Itemize
-
-\noun on
-John Weiss
-\noun default
- wrote the original CleanTeX pass.
-\end_layout
-
-\begin_layout Itemize
-
-\noun on
-Etienne Grossmann
-\end_layout
-
-\begin_layout Itemize
-
-\noun on
-Jos\i \'{e}
- Ab\i \'{\i}
-lio Oliveira Matos
-\end_layout
-
-\begin_layout Itemize
-
-\noun on
-David Suarez de Lis
-\end_layout
-
-\begin_layout Standard
-Other contributors:
-\end_layout
-
-\begin_layout Itemize
-
-\noun on
-Jean-Marc Lasgouttes
-\noun default
- worked on the wrapper script and offered lots of bug reports, advice, and
- feature suggestions.
-\end_layout
-
-\begin_layout Itemize
-
-\noun on
-Asger K.
- Alstrup Nielsen
-\noun default
- and
-\noun on
-Marc Pavese
-\noun default
- provided advice.
-\end_layout
-
-\begin_layout Itemize
-Various members of the LyX developers' and users' lists provided bug reports
- and feature suggestions.
-\end_layout
-
-\begin_layout Standard
-reLyX uses a modified version the Perl TeX parser
-\family typewriter
-Text::TeX
-\family default
- package written by
-\noun on
-Ilya Zakharevich
-\noun default
- (
-\family typewriter
-ilya@math.ohio-state.edu
-\family default
-), available on CPAN.
-\end_layout
-
-\begin_layout Chapter
-LyX Features needing Extra Software
-\end_layout
-
-\begin_layout Section
-Using LyX with SGML-Tools (aka LinuxDoc)
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Paul Evans
-\end_layout
-
-\begin_layout Subsection
-Overview
-\end_layout
-
-\begin_layout Standard
-LinuxDoc is a document class available in LyX if you have the
-\family typewriter
-sgml-tools
-\family default
- package installed.
- You can use it to produce documents in the so-called Standardized General
- Mark-up Language (SGML) in the particular format used by the Linux Documentatio
-n Project.
- That is obviously helpful if you are contributing to that project.
- You can use the SGML format with the
-\family typewriter
-sgml-tools
-\family default
- package of scripts and programs (to produce other formats, including Latex,
- HTML, plain text, man pages and\SpecialChar \ldots{}
-).
- You may therefore prefer to use this document class if you want to write
- something that can be easily translated into other formats.
-\end_layout
-
-\begin_layout Standard
-You will find that LinuxDoc has fewer layout options than the other text
- classes in LyX.
- This is mainly so that the translations into other formats have a chance
- of making some sense.
- In this section we describe:
-\end_layout
-
-\begin_layout Itemize
-how to setup and use a document in LinuxDoc
-\end_layout
-
-\begin_layout Itemize
-how to use the tags in LinuxDoc to layout your document
-\end_layout
-
-\begin_layout Itemize
-how to use the SGML packages to produce the various formats
-\end_layout
-
-\begin_layout Itemize
-how to sort out some problems.
-\end_layout
-
-\begin_layout Subsection
-Preparing and using a LinuxDoc document
-\end_layout
-
-\begin_layout Subsubsection
-Getting started
-\end_layout
-
-\begin_layout Standard
-You start by selecting the LinuxDoc class using the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-
-\family sans
-
-\family default
-Then you will find that there are fewer paragraph environments than for
- most other classes.
- You can see them on the pull down box on the left of the tool bar.
- How to use them is described in section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:sgmlparas}
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-You
-\emph on
-must
-\emph default
- enter a title for the document, followed by an author, marking each with
- the appropriate paragraph environment.
- If you don't do this, you will get errors when you try to print the file.
- You can then enter the date and an abstract.
- The document proper must start with a Section paragraph environment rather
- than any standard layout.
-\end_layout
-
-\begin_layout Standard
-After that you can prepare a document as usual using the available range
- of paragraph environments.
- See section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:sgmlparas}
-
-\end_inset
-
- for the full list and their uses.
-\end_layout
-
-\begin_layout Subsubsection
-Output from LinuxDoc
-\end_layout
-
-\begin_layout Standard
-You can print and save these documents in the normal way.
- To use the other features of the SGML package you need to save your document
- as LinuxDoc; this is a version in which the document is translated into
- the basic sgml tags.
- Use
-\family sans
-
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-Linu
-\bar under
-x
-\bar default
-Doc.
-
-\family default
- You will get a file with the same name and a
-\family typewriter
-.sgml
-\family default
- extension rather than a
-\family typewriter
-.lyx
-\family default
- extension.
- See\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:sgmloperate}
-
-\end_inset
-
- on how you than make use of this file.
-\end_layout
-
-\begin_layout Subsection
-Using the paragraph environments in LinuxDoc
-\end_layout
-
-\begin_layout Subsubsection
-The Structure of a LinuxDoc Document
-\end_layout
-
-\begin_layout Standard
-There is a formal structure for LinuxDoc which limits how you can place
- tags.
- There are two parts to all documents:
-\end_layout
-
-\begin_layout Description
-Header: this is everything up to the first time you insert a Section layout
- marker.
- It can include title, author, date, abstract and ToC.
- You must include the first two.
-\end_layout
-
-\begin_layout Description
-Body: from the beginning of the first section onwards.
- All other tags are allowed.
-
-\end_layout
-
-\begin_layout Subsubsection
-The LinuxDoc Paragraph Environments
-\end_layout
-
-\begin_layout Standard
-\begin_inset LatexCommand \label{sec:sgmlparas}
-
-\end_inset
-
-Here is a list of all the tags you will find listed on the layout bar in
- the order they come there, with some comments where the purpose or use
- is not obvious:
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Standard:
-\family roman
- works as described in [cross reference]
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Title
-\family default
-: This will appear at the top left of the document when printed, above a
- heavy horizontal rule, although you will not see this on the LyX screen.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Section, Subsection, Subsubsection, Paragraph and Subparagraph:
-\family default
- all do what you would expect and in the usual order.
- Whether they are numbered or not is controlled by the
-\family sans
-Section\InsetSpace ~
-number\InsetSpace ~
-depth
-\family default
- setting.
- You cannot get the equivalent number free versions in any other way; there
- is no
-\family sans
-Section*
-\family default
- or similar
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Enumerate:
-\family default
- As usual this produces a numbered and indented list as described in the
-
-\emph on
-User's Guide
-\emph default
-.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Itemize:
-\family roman
-Again much the same as in the other classes: see the
-\emph on
-User's Guide
-\emph default
-.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Description
-\family default
-: As explained in the
-\emph on
-User's Guide
-\emph default
-.
- Remember that if you want the bold element at the start of a description
- to be more than one word then you need to put protected spaces between
- the words.
-
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Verbatim:
-\family default
-As usual.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Code: similar to the Lyx-Code
-\family roman
- environment
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Author
-\family default
-: Anything you mark with this will appear on the left of the heading of
- the document, under the heavy rule.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Date:
-\family default
- Anything you mark with this will appear on the right of the heading under
- the rule.
- You do not have to make this a date.
- Any text can be entered, e.\InsetSpace ~
-g.
- a version number.
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Abstract
-\family default
-: You can use this to produce a free standing paragraph after the author
- and date, and before the first section.
- You are only allowed one such paragraph.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-\emph on
-Author's note.
-
-\emph default
-This needs checking ---
-\emph on
-pe.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-Displaymath
-\family default
-:
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-\emph on
-Author's note:
-\emph default
-I have not yet checked this ---
-\emph on
-pe.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Other document features
-\end_layout
-
-\begin_layout Standard
-You can also use the
-\family sans
-Layout
-\family default
-menu to set fonts or to emphasis words.
- You can also use the table of contents as usual; see the corresponding
- section of the
-\emph on
-User's Guide
-\emph default
-.
- Although you will find some some other features on the menus e.\InsetSpace ~
-g.
- inserting footnotes.
- There is some doubt about whether these will work correctly.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-\emph on
-Author's note:
-\emph default
-Again still checking to see whether this is my system
-\emph on
- ---pe.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsubsection
-Cross references and HTML
-\end_layout
-
-\begin_layout Standard
-On the
-\family sans
- Insert
-\family default
- menu you will find two new options relating to the inclusion of URL addresses.
- If you use either option you will find some highlighted TeX code inserted
- into your document in three separate blocks with spaces available between.
- The blocks will be:
-\end_layout
-
-\begin_layout Quote
-
-\family typewriter
-
-\backslash
-htmlurl{
-\family default
- or
-\family typewriter
-
-\backslash
-url{
-\family roman
-
-\hfill
-space
-\family default
-
-\family typewriter
-
-\hfill
-}{
-\family roman
-
-\hfill
-space
-\hfill
-
-\family typewriter
-}
-\end_layout
-
-\begin_layout Standard
-You insert a full HTML tag between the first and second blocks.
- This can be
-\begin_inset LatexCommand \url{http://any.address}
-
-\end_inset
-
- or other valid tags such as
-\begin_inset LatexCommand \url{mailto:me@my.address}
-
-\end_inset
-
-
-\family typewriter
-.
-\family default
-Then y
-\family roman
-ou
-\family default
-insert some description between the second and third blocks.
- The differences are:
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-URL:
-\family roman
- both the HTML tag and the description will appear in the document
-\end_layout
-
-\begin_layout Itemize
-
-\family sans
-HTML\InsetSpace ~
-URL:
-\family roman
-only the description appears in the printed version
-\end_layout
-
-\begin_layout Subsection
-Using the LinuxDoc Sgml scripts
-\begin_inset Note Note
-status collapsed
-
-\begin_layout Standard
-This section is completely outdated.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-\begin_inset LatexCommand \label{sec:sgmloperate}
-
-\end_inset
-
-You can use LinuxDoc as a text class without any additional scripts or programs,
- but there is not much point in doing this.
- All you will get is a document that looks like a
-\emph on
-Linux Documentation Project Howto
-\family sans
-\emph default
-.
-
-\family default
-To do the document translation you need to get and install the
-\family typewriter
-sgml-tools-1.0.x.tar.gz
-\family default
-(with
-\begin_inset Formula $x\geq3$
-\end_inset
-
-) package from
-\family roman
-the SGML-Tools WWW Page
-\family default
- at
-\end_layout
-
-\begin_layout LyX-Code
-
-\family roman
-\begin_inset LatexCommand \url{http://pobox.com/~cg/sgmltools}
-
-\end_inset
-
-
-\family default
-
-\end_layout
-
-\begin_layout Standard
-Alternatively, you can go to the
-\family typewriter
-sunsite
-\family default
- archive at
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-Note that, at the time of this writing (01/1998), version 1.0.3 of sgml-tools
- has not yet been made available at
-\family typewriter
-sunsite
-\family default
-.
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout LyX-Code
-
-\family roman
-\begin_inset LatexCommand \url{ftp://sunsite.unc.edu/pub/Linux/utils/text/sgml-tools-1.0.x.tar.gz}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-
-\family roman
-The
-\family default
- file
-\family typewriter
-sgml-tools-1.0.x.tar.gz
-\family default
- contains everything that you need to write SGML documents and convert them
- to groff, LaTeX, HTML, GNU info, LyX, and RTF\SpecialChar \@.
-
-\end_layout
-
-\begin_layout Standard
-This package was renamed from
-\family typewriter
-linuxdoc-sgml-1.5.tar.gz
-\family default
- in January 1997.
-\end_layout
-
-\begin_layout Standard
-Follow the instructions in that package on how to install it and how to
- use it.
- All this has to be done outside of LyX, before you can use the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-as\InsetSpace ~
-LinuxDoc
-\family roman
-option.
-\end_layout
-
-\begin_layout Subsection
-Troubleshooting LinuxDoc
-\end_layout
-
-\begin_layout Standard
-When you print or preview a LinuxDoc document some checking is done of the
- tags before LaTeX is run.
- Some errors are trapped here, especially those concerning the structure
- of the document.
- LyX may produce an error message, but not leave an error box in the document
- for you to open.
- You may have to look at the files directly to discover what is wrong.
- Most problems seem to come from the use of options that are not fully available
- in the text class.
-\end_layout
-
-\begin_layout Section
-Checking TeX
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
-Asger Alstrup
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-Under the
-\family sans
-\bar under
-T
-\bar default
-ools
-\family default
- menu, you'll find a
-\family sans
-\bar under
-C
-\bar default
-heck\InsetSpace ~
-TeX
-\family default
- command.
- This feature requires you to have the
-\family typewriter
-chktex
-\family default
- program installed, and is grayed out if you don't have it.
- You can get it from your nearest CTAN mirror, or over the Web from
-\begin_inset LatexCommand \url{http://www.ifi.uio.no/~jensthi/chktex/}
-
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Standard
-The
-\family sans
-ChkTeX
-\family default
- package is a program that was written by
-\noun on
-Jens T.
- Berger Thielemann
-\noun default
- in frustration because some constructs in LaTeX are sometimes non-intuitive,
- and easy to forget.
- The program runs over your LaTeX file and checks the integrity of the file,
- and flags some common errors.
- In other technical words, it is
-\family typewriter
-Lint
-\family default
- for LaTeX.
-\end_layout
-
-\begin_layout Standard
-Well, what is a syntax checker doing in LyX which is supposed to produce
- correct LaTeX anyways? The answer is simple: Just as
-\family typewriter
-Lint
-\family default
- not only checks the
-\emph on
-syntax
-\emph default
- of C programs, but also does
-\emph on
-semantic
-\emph default
- checks for type-errors,
-\family sans
-ChkTeX
-\family default
- catches some common
-\emph on
-typographic
-\emph default
- errors, in addition to the syntactical ones.
- Specifically,
-\family sans
-ChkTeX
-\family default
- is capable of detecting several common errors, such as
-\end_layout
-
-\begin_layout Itemize
-Ellipsis detection:
-\newline
-Use \SpecialChar \ldots{}
- instead of ...
-\end_layout
-
-\begin_layout Itemize
-No space in front of/after parenthesis:
-\newline
-( wrong spacing )
-\end_layout
-
-\begin_layout Itemize
-Enforcement of normal space after common abbreviations:
-\newline
-e.
- g.
- is too wide spacing.
-\end_layout
-
-\begin_layout Itemize
-Enforcement of end-of-sentence space when the last sentence ends with a
- capital letter:
-\newline
-This is a TEST.
- And this is wrong spacing.
-\end_layout
-
-\begin_layout Itemize
-Space in front of labels and similar commands:
-\newline
-The label should stick right
- up to the text to avoid falling to a wrong page.
-
-\begin_inset LatexCommand \label{sec:chktex}
-
-\end_inset
-
-
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-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:
-\newline
-In you are in bad luck,
- the text will break right between the referenced text and reference number,
- and that's a pity.
- See section
-\begin_inset LatexCommand \ref{sec:chktex}
-
-\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:
-\newline
-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
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-heck\InsetSpace ~
-TeX
-\family default
-.
- This will make LyX generate a LaTeX file of your document, start
-\family sans
-ChkTeX
-\family default
- to check it, and then make LyX insert
-\begin_inset Quotes eld
-\end_inset
-
-error boxes
-\begin_inset Quotes erd
-\end_inset
-
- with the warnings from
-\family sans
-ChkTeX
-\family default
-, if there were any.
- The warnings will be placed close to the point of the mistake, and you
- can quickly find them by using the
-\family sans
-\bar under
-N
-\bar default
-avigate\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-rror
-\family default
- menu item, or the shortcut key
-\family sans
-C-g
-\family default
- from the default
-\family typewriter
-cua
-\family default
- bind file.
- Open the error boxes by clicking on them with the mouse, or use the shortcut
- key
-\family sans
-C-i
-\family default
- from
-\family typewriter
-cua
-\family default
- bindings, or the corresponding
-\family sans
-C-o
-\family default
- for the alternate
-\family typewriter
-emacs
-\family default
- bind file.
- Read the warning and correct the mistake, if it is a mistake.
- If you have trouble understanding what the warning is about, you can safely
- ignore it.
- Remember that there is a hidden layer between the document on screen and
- the technical details in invoking
-\family sans
-ChkTeX
-\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
-\end_layout
-
-\begin_layout Standard
-This document is an excellent testing bed for the feature, and it should
- provide quite a few warnings for you to fiddle with.
- Since computers are only so smart, expect most of the warnings to be false
- alarms, though.
-\end_layout
-
-\begin_layout Subsection
-How to fine tune it
-\end_layout
-
-\begin_layout Standard
-Sometimes, you'll find that
-\family sans
-ChkTeX
-\family default
- makes more noise than suits your mood.
- Then you can choose not to use it, wait until your mood changes, or try
- to customize
-\family sans
-ChkTeX
-\family default
- to get better along with you.
- Another choice in the most desperate situations is to use
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-emove\InsetSpace ~
-All\InsetSpace ~
-Error\InsetSpace ~
-Boxes
-\family default
-, which will get rid of all warnings instantly.
-\end_layout
-
-\begin_layout Standard
-Although
-\family sans
-ChkTeX
-\family default
-
-\emph on
-is
-\emph default
- very configurable and extensible, you shouldn't expect to solve all problems
- with
-\family sans
-ChkTeX
-\family default
- in LyX this way.
- Since LyX has to generate a somewhat special LaTeX file to be able to match
- the line numbers from the
-\family sans
-ChkTeX
-\family default
- output
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-You can inspect the specific output from
-\family sans
-chktex
-\family default
- by using
-\family sans
-Edit\SpecialChar \menuseparator
-View\InsetSpace ~
-LaTeX\InsetSpace ~
-Log
-\family default
- right after a
-\family sans
-chktex
-\family default
- run.
-\end_layout
-
-\end_inset
-
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
- There are two things you can do about this:
-\end_layout
-
-\begin_layout Itemize
-Fine tune the
-\family sans
-ChkTeX
-\family default
- invocation command line in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Outputs
-\family default
-,
-\family sans
-Misc
-\family default
-), or the global
-\family sans
-ChkTeX
-\family default
- installation configuration file (usually with the file
-\family typewriter
-/usr/local/share/chktexrc
-\family default
-).
- See below to learn what warnings can be enabled and disabled on the command
- line.
-
-\end_layout
-
-\begin_layout Itemize
-Export your document as a raw LaTeX file using
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-L
-\bar default
-aTeX
-\family default
- and run
-\family typewriter
-chktex
-\family default
- manually on that.
- Invoked in this way, it can be a hassle to find the corresponding place
- in the document inside LyX, but with a little patience, you should be able
- to do it.
-\end_layout
-
-\begin_layout Standard
-Here follows the warning messages that can be enabled and disabled in
-\family sans
-Preferences
-\family default
-.
- Use
-\family typewriter
--n#
-\family default
- to disable a warning, and
-\family typewriter
--w#
-\family default
- to enable a warning.
- The emphasized entries are disabled by default, because the default is
- "
-\family typewriter
-chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
-\family default
-".
-\end_layout
-
-\begin_layout Standard
-Notice that you should only use the options that enable and disable warnings,
- because LyX relies on some of the other command line parameters to be set
- in a specific way to have a chance to communicate with
-\family typewriter
-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 LaTeX file.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Number of
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-char
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- doesn't match the number of
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-char
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You should use either
-\family typewriter
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\family default
- or
-\family typewriter
-
-\begin_inset Quotes erd
-\end_inset
-
-
-\family default
- as an alternative to
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-"
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You should use "
-\family typewriter
-'
-\family default
-" (ASCII 39) instead of "
-\family typewriter
-´
-\family default
-" (ASCII 180).
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-User-specified pattern found.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-This command might not be intended.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-\emph on
-Comment displayed.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Either
-\family typewriter
-''
-\backslash
-,'
-\family default
- or
-\family typewriter
-'
-\backslash
-,''
-\family default
- will look better.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Delete this space to maintain correct page references.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-\emph on
-You might wish to put this between a pair of
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-{}
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You ought to remove spaces in front of punctuation.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Could not execute LaTeX command.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-Don't use
-\family typewriter
-
-\backslash
-/
-\family default
- in front of small punctuation.
-\end_layout
-
-\begin_layout Enumerate
-
-\family typewriter
-\size small
-$
-\backslash
-times$
-\family default
- may look prettier here.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-\emph on
-Multiple spaces detected in output.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-This text may be ignored.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-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 TeX in LaTeX code.
-\end_layout
-
-\begin_layout Enumerate
-
-\size small
-You should remove spaces in front of
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-%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 LyX, we hope to provide a more complete interface to
- this tool (and it's smaller cousin
-\family typewriter
-lacheck
-\family default
-) to exploit the full power of it.
- But it's not exactly useless as it is now: go try it on one of your existing
- documents of a certain length and be surprised.
-\end_layout
-
-\begin_layout Section
-Version Control in LyX
-\end_layout
-
-\begin_layout Standard
-by
-\noun on
- Lars Gullik Bjønnes
-\end_layout
-
-\begin_layout Subsection
-Introduction
-\end_layout
-
-\begin_layout Standard
-A friend of mine wanted to try LyX for a group project.
- When he didn't find support for version control or file locking, he dropped
- it.
- This angered me a bit, so I thought that I should at least make support
- for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
- This has now been done.
- LyX now supports some of the most basic RCS commands.
- If you need to something a bit more sophisticated you will have to do that
- manually in an xterm.
-\end_layout
-
-\begin_layout Standard
-Before you begin to use the version control features in LyX, you should
- read
-\begin_inset Quotes eld
-\end_inset
-
-rcsintro
-\begin_inset Quotes erd
-\end_inset
-
- (a man file, read it with
-\family typewriter
-man rcsintro
-\family default
-).
- This file describes all the basic features of RCS.
- You should especially notice the comment about a RCS directory, and the
- notion of a master RCS file (the file ending in
-\family typewriter
-,v
-\family default
-).
-\end_layout
-
-\begin_layout Standard
-The implementation in LyX assumes a recent version of the GNU RCS package---no
- guarantees are made for older versions.
-\end_layout
-
-\begin_layout Subsection
-RCS commands in LyX
-\end_layout
-
-\begin_layout Standard
-The following sections describe the RCS commands supported by LyX.
- You can find them in the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+ to get better along with you.
+ Another choice in the most desperate situations is to use
+\family sans
+\bar under
+V
+\bar default
+iew\SpecialChar \menuseparator
\bar under
-V
+R
\bar default
-ersion\InsetSpace ~
-Control
+emove\InsetSpace ~
+All\InsetSpace ~
+Error\InsetSpace ~
+Boxes
\family default
- submenu.
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Register
+, which will get rid of all warnings instantly.
\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
+Although
\family sans
-\bar under
-R
-\bar default
-egister
+ChkTeX
\family default
- item is grayed out.
-\end_layout
-
-\begin_layout Standard
-This command registers your document with RCS\SpecialChar \@.
- You are asked interactively
- to supply an initial description of the document.
- The document is now set in Read-Only mode and you have to
+\emph on
+is
+\emph default
+ very configurable and extensible, you shouldn't expect to solve all problems
+ with
\family sans
-Check\InsetSpace ~
-Out\InsetSpace ~
-For\InsetSpace ~
-Edit
+ChkTeX
\family default
-, before making any changes to it.
- A document under revision control has a
-\begin_inset Quotes eld
-\end_inset
-
-[RCS:<version> <locker>]
-\begin_inset Quotes erd
-\end_inset
-
- item tagged to the filename in the minibuffer.
-\end_layout
-
-\begin_layout Standard
-RCS command that is run:
-\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
-\end_layout
+ in LyX this way.
+ Since LyX has to generate a somewhat special LaTeX file to be able to match
+ the line numbers from the
+\family sans
+ChkTeX
+\family default
+ output
+\begin_inset Foot
+status collapsed
\begin_layout Standard
-Read
-\family typewriter
-man ci
+You can inspect the specific output from
+\family sans
+chktex
\family default
- to understand the switches.
-
-\end_layout
-
-\begin_layout Subsubsection
-
+ by using
\family sans
-Check In Changes
-\end_layout
-
-\begin_layout Standard
-When you are finished editing a file, you check in your changes.
- When you do this, you are asked for a description of the changes.
- This is stored in the history log.
- The version number is bumped, your changes are applied to the master RCS
- file, the document is unlocked and set to Read-Only mode.
-
-\end_layout
-
-\begin_layout Standard
-RCS command:
-\family typewriter
-ci -q -u -m"<description>" <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
+Edit\SpecialChar \menuseparator
+View\InsetSpace ~
+LaTeX\InsetSpace ~
+Log
+\family default
+ right after a
\family sans
-Check Out For Edit
+chktex
+\family default
+ run.
\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
+\end_inset
-\begin_layout Standard
-RCS command:
-\family typewriter
-co -q -l <file-name>
+ to the internal document structure, some of the warnings will not seen
+ to appear correctly.
+ There are two things you can do about this:
\end_layout
-\begin_layout Subsubsection
-
+\begin_layout Itemize
+Fine tune the
\family sans
-Revert To Last Version
-\end_layout
-
-\begin_layout Standard
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
-\end_layout
-
-\begin_layout Standard
-RCS command:
+ChkTeX
+\family default
+ invocation command line in
+\family sans
+Preferences
+\family default
+ (tabs
+\family sans
+Outputs
+\family default
+,
+\family sans
+Misc
+\family default
+), or the global
+\family sans
+ChkTeX
+\family default
+ installation configuration file (usually with the file
\family typewriter
-co -f -u<version> <file-name>
+/usr/local/share/chktexrc
+\family default
+).
+ See below to learn what warnings can be enabled and disabled on the command
+ line.
+
\end_layout
-\begin_layout Subsubsection
-
+\begin_layout Itemize
+Export your document as a raw LaTeX file using
\family sans
-Undo Last Checkin
-\end_layout
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\begin_layout Standard
-This makes as if the last check in never happened.
- No changes are made to the document loaded into LyX, but the last version
- is removed from the master RCS file.
-
-\end_layout
+\bar under
+E
+\bar default
+xport\SpecialChar \menuseparator
-\begin_layout Standard
-RCS command:
+\bar under
+L
+\bar default
+aTeX
+\family default
+ and run
\family typewriter
-rcs -o<version> <file-name>
-\end_layout
-
-\begin_layout Subsubsection
-
-\family sans
-Show History
+chktex
+\family default
+ manually on that.
+ Invoked in this way, it can be a hassle to find the corresponding place
+ in the document inside LyX, but with a little patience, you should be able
+ to do it.
\end_layout
\begin_layout Standard
-This show the complete history of the RCS document.
- The output of
+Here follows the warning messages that can be enabled and disabled in
+\family sans
+Preferences
+\family default
+.
+ Use
\family typewriter
-rlog <file-name>
+-n#
\family default
- is shown in a browser.
- See
+ to disable a warning, and
\family typewriter
-man rlog
+-w#
\family default
- for more info.
-\end_layout
-
-\begin_layout Section
-Literate Programming
+ 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
-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)
+
+\begin_layout Standard
+Notice that you should only use the options that enable and disable warnings,
+ because LyX relies on some of the other command line parameters to be set
+ in a specific way to have a chance to communicate with
+\family typewriter
+chktex
+\family default
+.
\end_layout
-\begin_layout Subsection
-Introduction
+\begin_layout Enumerate
+
+\size small
+\emph on
+Command terminated with space.
\end_layout
-\begin_layout Standard
-The main purpose of this documentation is to show you how to use LyX for
- literate programming.
- Where it is assumed that you are familiar with this programming technique,
- and know what
+\begin_layout Enumerate
+
+\size small
+Non-breaking space (
\begin_inset Quotes eld
\end_inset
-tangling
-\begin_inset Quotes erd
-\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
+~
+\family default
-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 LyX itself to a point that
- you are comfortable changing your LyX preferences, and X resources file.
- If that is not the case please refer to other LyX documentation to cover
- your specific needs.
+) should have been used.
\end_layout
-\begin_layout Subsection
-Literate Programming
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
-From the Literate Programming FAQ:
-\end_layout
+\size small
+\emph on
+You should enclose the previous parenthesis with
+\begin_inset Quotes eld
+\end_inset
-\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.E.
- Knuth during the development of his TeX typesetting software.
-
-\end_layout
-\begin_layout Standard
-Another excerpt says:
-\end_layout
+\family typewriter
+{}
+\family default
-\begin_layout Quotation
+\begin_inset Quotes erd
+\end_inset
-\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_layout Enumerate
-\begin_deeper
-\begin_layout Itemize
-flexible order of elaboration
-\end_layout
+\size small
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-automatic support for browsing
-\end_layout
-\begin_layout Itemize
-typeset documentation, especially diagrams and mathematics
-\end_layout
+\family typewriter
-\end_deeper
-\begin_layout Standard
-Now that I sparked your curiosity, take a look in the references.
-\end_layout
+\backslash
+/
+\family default
-\begin_layout Subsubsection
-References
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-The complete Literate Programming FAQ can be found at:
+) found in non-italic buffer.
\end_layout
-\begin_layout Quote
-\begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
+\begin_layout Enumerate
+\size small
+Italic correction (
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\family typewriter
-\begin_layout Standard
-The FAQ lists 23 (twenty three!) different literate programming tools.
- Where some are specialized or
-\begin_inset Quotes eld
-\end_inset
+\backslash
+/
+\family default
-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 latex or html.
+) found more than once.
\end_layout
-\begin_layout Itemize
-It has a open architecture, i.e., it is easy to plug in new filters and to
- perform special processing that you may need.
-
-\end_layout
+\begin_layout Enumerate
-\begin_layout Itemize
-There is a good selection of filters available already (the html is one
- of them).
-\end_layout
+\size small
+\emph on
+No italic correction (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-It is free.
-\end_layout
-\begin_layout Standard
-The Noweb web page can be found at:
-\end_layout
+\family typewriter
-\begin_layout Quote
-\begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
+\backslash
+/
+\family default
+\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-Starting from there you can reach many other interesting links and even
- some literate program examples.
+) found.
\end_layout
-\begin_layout Subsection
-LyX and Literate Programming
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
-The LyX support for Literate Programming is provided by using the generic
- LyX convertors mechanism.
- This support is provided in a
+\size small
+Accent command
\begin_inset Quotes eld
\end_inset
-Noweb independent
+
+\family typewriter
+cmd
+\family default
+
\begin_inset Quotes erd
\end_inset
- way, i.e., you will be able to use this new LyX feature with some other literate
- programming tool of your choice by just changing your LyX preferences.
-\end_layout
+ needs use of
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsubsection
-Generating documents and code (weaving and tangling)
-\end_layout
-\begin_layout Paragraph
-Selecting the document class
-\end_layout
+\family typewriter
+cmd
+\family default
-\begin_layout Standard
-If you have installed Noweb and LyX successfully, whenever you open a new
- document or try to change the document class of an existing one, you will
- find that there are three new document classes available:
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
-Article (Noweb)
+.
\end_layout
-\begin_layout Itemize
-Book (Noweb)
-\end_layout
+\begin_layout Enumerate
-\begin_layout Itemize
-Report (Noweb)
+\size small
+Wrong length of dash may have been used.
\end_layout
-\begin_layout Standard
-You must select one of them to create your literate documents from.
-
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
-Note that literate documents are not limited to these three classes.
- New classes can be generated from other styles like letter or in combination
- with other class variations like Article (AMS).
- If you have special needs that cannot be covered by one of the existing
- classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
- will arrange to insert a new entry, or teach you how to do it.
-\begin_inset Foot
-status collapsed
+\size small
+\emph on
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-It is very simple, it involves the creation of a file with four lines, and
- re-running of the auto configuration.
-\end_layout
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
+
+ expected, found
+\begin_inset Quotes eld
\end_inset
- Moreover, if you use a literate tool other than Noweb you may need to create
- a new set of document classes for it.
-\end_layout
-\begin_layout Paragraph
-Typing code in
-\end_layout
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-LyX enables you to write code with a layout named
-\noun on
-Scrap
-\noun default
.
-\begin_inset Foot
-status collapsed
+\end_layout
-\begin_layout Standard
-The equivalent Noweb term is
+\begin_layout Enumerate
+
+\size small
+Solo
\begin_inset Quotes eld
\end_inset
-Chunk
+
+\family typewriter
+%s
+\family default
+
\begin_inset Quotes erd
\end_inset
-.
- For historical reasons, I got used to the term
+ found.
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
+You should use
\begin_inset Quotes eld
\end_inset
-scrap
+
+\family typewriter
+%s
+\family default
+
\begin_inset Quotes erd
\end_inset
- introduced by other literate tool named Nuweb, which I used for many years
- before rendering myself to Noweb.
+ to achieve an ellipsis.
\end_layout
+\begin_layout Enumerate
+
+\size small
+Inter-word spacing (
+\begin_inset Quotes eld
\end_inset
- Noweb delimits scraps like this:
-\end_layout
-\begin_layout LyX-Code
-<<My scrap>>=
-\end_layout
+\family typewriter
-\begin_layout LyX-Code
- code
-\end_layout
+\backslash
-\begin_layout LyX-Code
- more code
-\end_layout
+\family default
+
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
- even more code
+) should perhaps be used.
\end_layout
-\begin_layout LyX-Code
- @
-\end_layout
+\begin_layout Enumerate
+
+\size small
+Inter-sentence spacing (
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Standard
-The problem is that whatever is written in between the << and the
\family typewriter
+
+\backslash
@
\family default
- must be taken literally, i.e., LyX should be prevented from making any special
- interpretation of what has been written.
- This is handled by a special layout named Scrap, that works like a normal
- paragraph but has a free spacing capability.
+
+\begin_inset Quotes erd
+\end_inset
+
+) should perhaps be used.
\end_layout
-\begin_layout Standard
-The down side of the Scrap paragraph layout is that consecutive paragraphs
- of code will be spaced with one empty line in the source code and also
- in the printed documentation.
- The work around is to enter each line of code within a single Scrap, with
- a newline (ctrl-return).
- The example above will look like this:
-\begin_inset Foot
-status collapsed
+\begin_layout Enumerate
-\begin_layout Standard
-If you have a printed version of this document you will not see any difference
- between the previous example and this one.
+\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 LyX-Code
-<<My scrap>>=
-\newline
- code
-\newline
- more code
-\newline
- even more code
-\newline
- @
+\begin_layout Enumerate
+
+\size small
+Math mode still on at end of LaTeX file.
\end_layout
-\begin_layout Standard
-This layout works fine.
- The only real inconvenience is that you have to type ctrl-return instead
- of a plain return.
-\begin_inset Foot
-status collapsed
+\begin_layout Enumerate
-\begin_layout Standard
-It is in my list of
+\size small
+Number of
\begin_inset Quotes eld
\end_inset
-improvements
+
+\family typewriter
+char
+\family default
+
\begin_inset Quotes erd
\end_inset
- to fix that.
-\end_layout
-
+ 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 Standard
-As a special note, you can also use the
+\begin_layout Enumerate
+
+\size small
+You should use either
+\family typewriter
+
\begin_inset Quotes eld
\end_inset
-%def
+
+\family default
+ or
+\family typewriter
+
\begin_inset Quotes erd
\end_inset
- construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
-rence:
-\end_layout
-\begin_layout LyX-Code
-<<My scrap>>=
-\newline
- def some_function(args):
-\newline
- "This is the doc string for this
- function."
-\newline
- print "My args: ", args
-\end_layout
+\family default
+ as an alternative to
+\begin_inset Quotes eld
+\end_inset
-\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
+\family typewriter
+"
+\family default
-\begin_layout Paragraph
-Generating the documentation
+\begin_inset Quotes erd
+\end_inset
+
+.
\end_layout
-\begin_layout Standard
-At this point you already have a new document file with a proper document
- class, and with some code and text on it.
- How do I print it? The answer is simple, you select
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
+\begin_layout Enumerate
-\bar under
-D
-\bar default
-VI,
+\size small
+You should use "
+\family typewriter
+'
\family default
- etc.
- Just like you would do for a plain document.
- No special procedure is required.
+" (ASCII 39) instead of "
+\family typewriter
+´
+\family default
+" (ASCII 180).
\end_layout
-\begin_layout Standard
-To help orientate you, I will now explain what happens inside LyX:
+\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
-When the
-\family sans
-\bar under
-U
-\bar default
-pdate\SpecialChar \menuseparator
-\bar under
-D
-\bar default
-VI
-\family default
-menu option is chosen, a latex file is generated.
-
+\size small
+\emph on
+Comment displayed.
\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
+\begin_layout Enumerate
- format (defined in the Preferences panel), otherwise the file will have
- the usual
+\size small
+Either
+\family typewriter
+''
+\backslash
+,'
+\family default
+ or
\family typewriter
-.tex
+'
+\backslash
+,''
\family default
-extension.
+ will look better.
\end_layout
-\end_deeper
\begin_layout Enumerate
-Note that the only difference so far is in the name of the file, no special
- processing is required by LyX.
- Given that you formatted the code using the Scrap layout that, by itself,
- takes care of the business.
+
+\size small
+Delete this space to maintain correct page references.
\end_layout
\begin_layout Enumerate
-If the document is of any literate class LyX will then use the internal
- LyX to Noweb converter, followed by the Noweb to LaTeX converter
-\begin_inset Foot
-status open
-
-\begin_layout Standard
-The converters are defined in the
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-\bar under
-P
-\bar default
-references
-\family default
- panel, under the
+\size small
+\emph on
+You might wish to put this between a pair of
\begin_inset Quotes eld
\end_inset
-Conversion
-\begin_inset Quotes erd
-\end_inset
- tab.
-\end_layout
+\family typewriter
+{}
+\family default
+\begin_inset Quotes erd
\end_inset
- to generate the LaTeX file.
+.
\end_layout
-\begin_deeper
-\begin_layout Standard
-Otherwise it will just skip this step.
+\begin_layout Enumerate
+
+\size small
+You ought to remove spaces in front of punctuation.
\end_layout
-\end_deeper
\begin_layout Enumerate
-Finally, LaTeX is invoked and the regular post processing continues as in
- a plain document.
+
+\size small
+Could not execute LaTeX command.
\end_layout
-\begin_layout Standard
-Independence from a particular
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
-literate tool
-\begin_inset Quotes erd
-\end_inset
+\size small
+Don't use
+\family typewriter
- is easily achieved by changing the commands that are run by the various
- converters.
+\backslash
+/
+\family default
+ in front of small punctuation.
\end_layout
-\begin_layout Paragraph
-Generating the code
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
-When the build menu option is chosen or the corresponding button in the
- toolbar is pressed, a latex file is generated just like step 1 above.
- Next, LyX invokes the
\family typewriter
- Noweb->Program
+\size small
+$
+\backslash
+times$
\family default
- converter.
- Typically, this converter (like any other converter), has two parts:
+ may look prettier here.
\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).
+
+\size small
+\emph on
+Multiple spaces detected in output.
\end_layout
\begin_layout Enumerate
-The error log parser.
- This is a program whose sole purpose is to rewrite error messages in a
- format that LyX understands.
- This makes it possible for LyX to place error boxes in the right places
- in the file buffer.
+
+\size small
+This text may be ignored.
\end_layout
-\begin_layout Standard
-The first part, the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Enumerate
-Converter
-\begin_inset Quotes erd
-\end_inset
+\size small
+Use
+\family typewriter
- setting, should be set to
\begin_inset Quotes eld
\end_inset
+\family default
+ to begin quotation, not
\family typewriter
-build-script $$i
+'
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
.
- This basically means that LyX will call
-\begin_inset Quotes eld
-\end_inset
+\end_layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
- (a program or script) with the name of the Noweb file (generally a file
- in the LyX temp directory).
-
-\end_layout
+\size small
+Use
+\family typewriter
+'
+\family default
+ to end quotation, not
+\family typewriter
-\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
-#!/bin/sh
+\family default
+.
\end_layout
-\begin_layout LyX-Code
-#
-\end_layout
+\begin_layout Enumerate
-\begin_layout LyX-Code
-notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
+\size small
+Don't mix quotes.
\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
+\begin_layout Enumerate
- which is to be set to
+\size small
+You should perhaps use
\begin_inset Quotes eld
\end_inset
\family typewriter
-originaldir,parselog=listerrors
+cmd
\family default
\begin_inset Quotes erd
\end_inset
-.
- This will run any errors that are generated by the
-\begin_inset Quotes eld
-\end_inset
+ instead.
+\end_layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
- process through the
-\begin_inset Quotes eld
-\end_inset
+\size small
+You should put a space in front of/after parenthesis.
+\end_layout
-listerrors
-\begin_inset Quotes erd
-\end_inset
+\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
- program.
+\size small
+You ought to not use primitive TeX in LaTeX code.
\end_layout
-\begin_layout Standard
-The converter code looks in
-\emph on
-MYLYXDIR/scripts
-\emph default
-first, then in
-\emph on
- LIBDIR/scripts
-\emph default
-then on the path for the
+\begin_layout Enumerate
+
+\size small
+You should remove spaces in front of
\begin_inset Quotes eld
\end_inset
-listerrors
+
+\family typewriter
+%s
+\family default
+
\begin_inset Quotes erd
\end_inset
- program.
-\end_layout
-\begin_layout Paragraph
-Build instructions in the document
\end_layout
-\begin_layout Standard
-The last piece of the integration between LyX and noweb is the
+\begin_layout Enumerate
+
+\size small
\begin_inset Quotes eld
\end_inset
-build-script
-\begin_inset Quotes erd
-\end_inset
- scrap.
- Generally, the instructions for building your program should be embedded
- in a scrap of its own.
- The noweb-specific
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
+%s
+\family default
-build-script
\begin_inset Quotes erd
\end_inset
- above uses the notangle command to look for this scrap (called
+ is normally not followed by
\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
+\family typewriter
+%c
+\family default
-sh
\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
-Typically, such a scrap would look something like this:
+In later versions of LyX, we hope to provide a more complete interface to
+ this tool (and it's smaller cousin
+\family typewriter
+lacheck
+\family default
+) to exploit the full power of it.
+ But it's not exactly useless as it is now: go try it on one of your existing
+ documents of a certain length and be surprised.
\end_layout
-\begin_layout LyX-Code
-<<build-script>>=
-\newline
-#!/bin/sh
-\newline
-
-\newline
-if [ -z "${NOWEB_SOURCE}" ]
-\newline
-then
-\newline
- NOWEB_SOURCE=myfile.nw
-\newline
-
-fi
-\newline
-[...
- code to extract files ...]
-\newline
-[...
- code to compile files ...]
-\newline
-@
+\begin_layout Section
+Version Control in LyX
\end_layout
\begin_layout Standard
-Look in
-\emph on
-LIBDIR/examples/listerrors.lyx
-\emph default
-or in
-\emph on
-LIBDIR/examples/Literate.lyx
-\emph default
- which implement two 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 or
- in
-\emph on
-LIBDIR/examples/noweb2lyx.lyx.
-
-\emph default
-Interestingly, these three files show off the language-indepence of the
- LyX literate programming support since they are written in Python, C and
- Perl respectively.
+by
+\noun on
+ Lars Gullik Bjønnes
\end_layout
-\begin_layout Subsubsection
-Configuring LyX
+\begin_layout Subsection
+Introduction
\end_layout
\begin_layout Standard
-All the Literate Programming support is configured by the
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
-\family default
- panel in the
-\begin_inset Quotes eld
-\end_inset
-
-Conversion
-\begin_inset Quotes erd
-\end_inset
-
- tab.
- The important parts are:
+A friend of mine wanted to try LyX for a group project.
+ When he didn't find support for version control or file locking, he dropped
+ it.
+ This angered me a bit, so I thought that I should at least make support
+ for RCS (with the possibility of CVS and/or SCCS as a future improvement.)
+ This has now been done.
+ LyX now supports some of the most basic RCS commands.
+ If you need to something a bit more sophisticated you will have to do that
+ manually in an xterm.
\end_layout
-\begin_layout Description
-the\InsetSpace ~
-
+\begin_layout Standard
+Before you begin to use the version control features in LyX, you should
+ read
\begin_inset Quotes eld
\end_inset
-literate
+rcsintro
\begin_inset Quotes erd
\end_inset
-\InsetSpace ~
-format Set up via the 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
+ (a man file, read it with
\family typewriter
-.nw
+man rcsintro
\family default
-.
- This tells LyX to create a file with a
+).
+ 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
-.nw
+,v
\family default
- extension in the first step of the conversion process.
+).
\end_layout
-\begin_layout Description
-the\InsetSpace ~
-
-\family sans
-Program
-\family default
-\InsetSpace ~
-format This is an empty format whose sole purpose is to be the endpoint
- of a conversion (which then allows us to set up a converter for it).
+\begin_layout Standard
+The implementation in LyX assumes a recent version of the GNU RCS package---no
+ guarantees are made for older versions.
\end_layout
-\begin_layout Description
+\begin_layout Subsection
+RCS commands in LyX
+\end_layout
+\begin_layout Standard
+The following sections describe the RCS commands supported by LyX.
+ You can find them in the
\family sans
-NoWeb
-\family default
-->
-\family sans
-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
-
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
-\family typewriter
-noweave -delay -index $$i > $$o
+\bar under
+V
+\bar default
+ersion\InsetSpace ~
+Control
\family default
+ submenu.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
+\begin_layout Subsubsection
+\family sans
+Register
\end_layout
-\begin_layout Description
-
+\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
-NoWeb
+\bar under
+R
+\bar default
+egister
\family default
-->
+ item is grayed out.
+
+\end_layout
+
+\begin_layout Standard
+This command registers your document with RCS\SpecialChar \@.
+ You are asked interactively
+ to supply an initial description of the document.
+ The document is now set in Read-Only mode and you have to
\family sans
-Program
+Check\InsetSpace ~
+Out\InsetSpace ~
+For\InsetSpace ~
+Edit
\family default
- This performs the
+, before making any changes to it.
+ A document under revision control has a
\begin_inset Quotes eld
\end_inset
-tangling step
+[RCS:<version> <locker>]
\begin_inset Quotes erd
\end_inset
-.
- As stated above, the Converter is set to
-\begin_inset Quotes eld
-\end_inset
+ item tagged to the filename in the minibuffer.
+\end_layout
+\begin_layout Standard
+RCS command that is run:
+\family typewriter
+ci -q -u -i -t-"<initial description>" <file-name>
+\end_layout
+\begin_layout Standard
+Read
\family typewriter
-build-script $$i
+man ci
\family default
+ to understand the switches.
+
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
-, with Flags set to
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Check In Changes
+\end_layout
+\begin_layout Standard
+When you are finished editing a file, you check in your changes.
+ When you do this, you are asked for a description of the changes.
+ This is stored in the history log.
+ The version number is bumped, your changes are applied to the master RCS
+ file, the document is unlocked and set to Read-Only mode.
+
+\end_layout
+\begin_layout Standard
+RCS command:
\family typewriter
-originaldir,parselog=listerrors
-\family default
+ci -q -u -m"<description>" <file-name>
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
-.
+\family sans
+Check Out For Edit
\end_layout
-\begin_layout Subsubsection
-Debug extensions
+\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 Standard
-There is also a new function implemented in the LyX server, the
-\begin_inset Quotes eld
-\end_inset
+RCS command:
+\family typewriter
+co -q -l <file-name>
+\end_layout
-server-goto-file-row" function, to be used with ddd/gdb or other debugger.
-
+\begin_layout Subsubsection
+
+\family sans
+Revert To Last Version
\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
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -f -u<version> <file-name>
+\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 LyX, but the last version
+ is removed from the master RCS file.
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
+\end_layout
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
+\begin_layout Standard
+RCS command:
+\family typewriter
+rcs -o<version> <file-name>
+\end_layout
-\bar under
-H
-\bar default
-elpers
+\begin_layout Subsubsection
+
+\family sans
+Show History
+\end_layout
+
+\begin_layout Standard
+This show the complete history of the RCS document.
+ The output of
+\family typewriter
+rlog <file-name>
+\family default
+ is shown in a browser.
+ See
+\family typewriter
+man rlog
\family default
-dialog and changing the "Edit Sources" entry.
+ for more info.
+\end_layout
+
+\begin_layout Section
+Literate Programming
\end_layout
\begin_layout Standard
-I take advantage of the new created LyX server function and this ddd feature,
- and set
+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 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
-Edit Sources
+tangling
\begin_inset Quotes erd
\end_inset
- to:
+ 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 LyX-Code
-echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
+\begin_layout Standard
+It is also assumed that you are familiar with LyX itself to a point that
+ you are comfortable changing your LyX preferences, and X resources file.
+ If that is not the case please refer to other LyX documentation to cover
+ your specific needs.
+\end_layout
+
+\begin_layout Subsection
+Literate Programming
\end_layout
\begin_layout Standard
-With this, whenever you are using ddd and find a point in the program that
- you want to edit, you just press shift-ctrl-V (in the ddd window), and
- ddd you forward this information to LyX through the LyX server and then
- the LyX window will show the same file with the cursor at the same position
- ddd was pointing to.
- No more guessing or long scrolling to locate a point in the program back
- from debugging !
+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.E.
+ Knuth during the development of his TeX typesetting software.
+
\end_layout
\begin_layout Standard
-Note however that you must enable the LyX server to get this feature working
- (it is disabled by default).
- You can enable it in
-\family sans
-Preferences
-\family default
- (tabs
-\family sans
-Inputs
-\family default
-,
-\family sans
-Paths
-\family default
-) by entering in the
-\family sans
-LyXserver pipe
-\family default
- a path like
-\begin_inset Quotes eld
-\end_inset
+Another excerpt says:
+\end_layout
+\begin_layout Quotation
-\family typewriter
-/home/<your-home-directory>/.lyx/lyxpipe
-\family default
+\emph on
+How is literate programming different from verbose commenting?
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\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
-Read the LyX server documentation in the
-\emph on
-Customization Manual
-\emph default
- for further information.
+Now that I sparked your curiosity, take a look in the references.
\end_layout
\begin_layout Subsubsection
-Toolbar extensions
+References
\end_layout
\begin_layout Standard
-There are six new buttons that can be added to your LyX toolbar.
- Five of these buttons are short cuts to layout styles:
-\family sans
-Standard
-\family default
-,
-\family sans
-Section
-\family default
-,
-\family sans
-LaTeX
-\family default
-,
-\family sans
-LyX-Code
-\family default
-, and
-\family sans
-Scrap
-\family default
-.
- The last one is a short cut to the
-\begin_inset Quotes eld
-\end_inset
+The complete Literate Programming FAQ can be found at:
+\end_layout
+
+\begin_layout Quote
+\begin_inset LatexCommand url
+name "Literate Programming FAQ"
+target "http://shelob.ce.ttu.edu/daves/lpfaq/faq.html"
-Build Program
-\begin_inset Quotes erd
\end_inset
- File menu entry.
-
+
\end_layout
\begin_layout Standard
-LyX has a range of buttons that are available for tool bar customization.
- In my toolbar I like to combine the six short cuts above with two more:
- One for
-\family sans
-\bar under
-V
-\bar default
-iew
-\family default
-\SpecialChar \menuseparator
-
-\family sans
-\bar under
-U
-\bar default
-pdate
-\family default
-\SpecialChar \menuseparator
+The FAQ lists 23 (twenty three!) different literate programming tools.
+ Where some are specialized or
+\begin_inset Quotes eld
+\end_inset
-\family sans
-\bar under
-D
-\bar default
-VI
-\family default
- and the other for
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
+tailored
+\begin_inset Quotes erd
+\end_inset
-\bar under
-D
-\bar default
-VI
-\family default
- File menu entries.
- Here is how it looks like:
+ 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 LyX-Code
-Toolbar
+\begin_layout Itemize
+It can generate the documentation either in LaTeX or HTML.
\end_layout
-\begin_layout LyX-Code
- Layouts
+\begin_layout Itemize
+It has a open architecture, i.e., it is easy to plug in new filters and to
+ perform special processing that you may need.
+
\end_layout
-\begin_layout LyX-Code
- Icon "layout Standard"
+\begin_layout Itemize
+There is a good selection of filters available already (the HTML is one
+ of them).
\end_layout
-\begin_layout LyX-Code
- Icon "layout Section"
+\begin_layout Itemize
+It is free.
\end_layout
-\begin_layout LyX-Code
- Icon "layout LaTeX"
+\begin_layout Standard
+The Noweb web page can be found at:
\end_layout
-\begin_layout LyX-Code
- Icon "layout LyX-Code"
-\end_layout
+\begin_layout Quote
+\begin_inset LatexCommand url
+name "Noweb home page"
+target "http://www.cs.virginia.edu/~nr/noweb/"
-\begin_layout LyX-Code
- Icon "layout Scrap"
-\end_layout
+\end_inset
-\begin_layout LyX-Code
- Separator
-\end_layout
-\begin_layout LyX-Code
- Icon "buffer-view"
\end_layout
-\begin_layout LyX-Code
- Icon "buffer-typeset"
+\begin_layout Standard
+Starting from there you can reach many other interesting links and even
+ some literate program examples.
\end_layout
-\begin_layout LyX-Code
- Icon "build-program"
-\end_layout
+\begin_layout Subsection
+\begin_inset LatexCommand label
+name "sub:LyX-and-Literate"
-\begin_layout LyX-Code
- Separator
-\end_layout
+\end_inset
-\begin_layout LyX-Code
-.
+LyX and Literate Programming
\end_layout
-\begin_layout LyX-Code
-.
-\end_layout
+\begin_layout Standard
+The LyX support for Literate Programming is provided by using the generic
+ LyX convertors mechanism.
+ This support is provided in a
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
-.
-\end_layout
+Noweb independent
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
-End
+ way, i.e., you will be able to use this new LyX feature with some other literate
+ programming tool of your choice by just changing your LyX preferences.
\end_layout
\begin_layout Subsubsection
-Colors customization
+Generating documents and code (weaving and tangling)
\end_layout
-\begin_layout Standard
-There are a number of colors in LyX that can be customized in
-\family sans
-Preferences
-\family default
-.
- One of the things that bothers people is the LaTeX font color.
- The default color is red, since the scraps uses LaTeX font, and there is
- a lot of scraps in literate documents, you may get tired of seeing everything
- in red.
- You can change it by going to the tabs
-\family sans
-Look&Feel
-\family default
-,
-\family sans
-Colors.
+\begin_layout Paragraph
+Selecting the document class
\end_layout
\begin_layout Standard
-The next thing is the visible presence of the newline character in the screen.
- You can choose the color of this particular character and make it blend
- in the background.
- I recommend you choosing a color that is close to the background but not
- equal, that way you still can see it is there, but it is not bothering
- you anymore.
-
+If you have installed Noweb and LyX successfully, whenever you open a new
+ document or try to change the document class of an existing one, you will
+ find that there are three new document classes available:
\end_layout
-\begin_layout Chapter
-Secrets of the LaTeX Masters
-\begin_inset LatexCommand \label{cha:secrets}
-
-\end_inset
+\begin_layout Itemize
+Article (Noweb)
+\end_layout
+\begin_layout Itemize
+Book (Noweb)
+\end_layout
+\begin_layout Itemize
+Report (Noweb)
\end_layout
\begin_layout Standard
-Though LyX is a powerful tool, it cannot hope to support everything that
- can be done with pure TeX/LaTeX.
- However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
- as long as you are not afraid to use that
-\begin_inset Quotes eld
-\end_inset
-
-TeX
-\begin_inset Quotes erd
-\end_inset
-
- button on the toolbar or add things to the LaTeX preamble.
- This section lists some tips, tricks, and otherwise cool ideas to give
- your document that extra little flair.
+You must select one of them to create your literate documents from.
-\emph on
-Do try this at home
-\emph default
-, just start with something a little smaller and less important than your
- dissertation!
\end_layout
\begin_layout Standard
-Most ideas in this section require less common files in your LaTeX installation.
- If you have a system like teTeX, most will already be available.
- A few, however, will need to be downloaded from one of the CTAN archives.
- Often, there are several ways to do something, or several LaTeX style files
- which do the same thing.
- We do not endorse one choice over another, we simply claim that we have
- done a particular task with a particular file.
- Put on your wizard hat, keep an eye out for dragons, and let us begin.
+Note that literate documents are not limited to these three classes.
+ New classes can be generated from other styles like letter or in combination
+ with other class variations like Article (AMS).
+ If you have special needs that cannot be covered by one of the existing
+ classes, let the LyX developers list (lyx-devel@lists.lyx.org) know and we
+ will arrange to insert a new entry, or teach you how to do it.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+It is very simple, it involves the creation of a file with four lines, and
+ re-running of the auto configuration.
+\end_layout
+
+\end_inset
+
+ Moreover, if you use a literate tool other than Noweb you may need to create
+ a new set of document classes for it.
\end_layout
-\begin_layout Section
-Tricks for Footnotes and Margin Notes
+\begin_layout Paragraph
+Typing code in
\end_layout
\begin_layout Standard
-suggested by
+LyX enables you to write code with a layout named
\noun on
-Robin Socha
-\end_layout
-
-\begin_layout Subsection
-Footnotes
-\end_layout
+Scrap
+\noun default
+.
+\begin_inset Foot
+status collapsed
\begin_layout Standard
-LyX cannot yet take care of setting the footnote numbering back to 1 after
- each section in the
+The equivalent Noweb term is
\begin_inset Quotes eld
\end_inset
+Chunk
+\begin_inset Quotes erd
+\end_inset
-\family sans
-article
-\family default
+.
+ For historical reasons, I got used to the term
+\begin_inset Quotes eld
+\end_inset
+scrap
\begin_inset Quotes erd
\end_inset
+ introduced by other literate tool named Nuweb, which I used for many years
+ before rendering myself to Noweb.
+\end_layout
-\family roman
- document class or changing the counter style.
- You'll need to insert LaTeX commands like the following to achieve that:
+\end_inset
+
+ Noweb delimits scraps like this:
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_layout LyX-Code
+<<My scrap>>=
+\end_layout
-\begin_layout Standard
+\begin_layout LyX-Code
+ code
+\end_layout
-\backslash
-setcounter{footnote}{0}
+\begin_layout LyX-Code
+ more code
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ even more code
+\end_layout
+
+\begin_layout LyX-Code
+ @
+\end_layout
- Using
+\begin_layout Standard
+The problem is that whatever is written in between the << and the
\family typewriter
+@
+\family default
+ must be taken literally, i.e., LyX should be prevented from making any special
+ interpretation of what has been written.
+ This is handled by a special layout named Scrap, that works like a normal
+ paragraph but has a free spacing capability.
+\end_layout
-\backslash
-setcounter{footnote}{0}
-\family roman
- will set the counter back to 1
+\begin_layout Standard
+The down side of the Scrap paragraph layout is that consecutive paragraphs
+ of code will be spaced with one empty line in the source code and also
+ in the printed documentation.
+ The work around is to enter each line of code within a single Scrap, with
+ a newline (ctrl-return).
+ The example above will look like this:
\begin_inset Foot
status collapsed
\begin_layout Standard
-The counter has been set back to 1.
+If you have a printed version of this document you will not see any difference
+ between the previous example and this one.
\end_layout
\end_inset
-.
+
+\end_layout
+
+\begin_layout LyX-Code
+<<My scrap>>=
+\newline
+ code
+\newline
+ more code
+\newline
+ even more code
+\newline
+ @
\end_layout
\begin_layout Standard
-The following command will change the numbering to small letters.
- Take a look at the next footnote in your xdvi or ghostview
-\begin_inset ERT
-status inlined
+This layout works fine.
+ The only real inconvenience is that you have to type ctrl-return instead
+ of a plain return.
+\begin_inset Foot
+status collapsed
\begin_layout Standard
+It is in my list of
+\begin_inset Quotes eld
+\end_inset
-\backslash
-renewcommand{
-\backslash
-thefootnote}{
-\backslash
-alph{footnote}}
+improvements
+\begin_inset Quotes erd
+\end_inset
+
+ to fix that.
\end_layout
\end_inset
-:
-\begin_inset Foot
-status collapsed
-\begin_layout Standard
-This is an example for a footnote with alphabetic numbering.
-\newline
-Use
-\family typewriter
-
-\backslash
-renewcommand{
-\backslash
-thefootnote {
-\backslash
-alph{footnote}}
-\family roman
-to get this.
\end_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 scraps to add items to Noweb's identifier cross-refe
+rence:
\end_layout
-\begin_layout Standard
-The next command sets the counter style back to default, i.e.
-
-\family typewriter
-
-\backslash
-arabic
-\family default
+\begin_layout LyX-Code
+<<My scrap>>=
+\newline
+ def some_function(args):
+\newline
+ "This is the doc string for this
+ function."
+\newline
+ print "My args: ", args
+\end_layout
-\begin_inset Foot
-status collapsed
+\begin_layout LyX-Code
+@ %def some_function
+\end_layout
\begin_layout Standard
-Use
-\family typewriter
-
-\backslash
-renewcommand{
-\backslash
-thefootnote}{
-\backslash
-arabic{footnote}}
-\family roman
- to set the counter--style back to LyX's default, i.e.
-
-\backslash
-arabic.
-\family default
+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_inset ERT
-status collapsed
+\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
+\bar under
+V
+\bar default
+iew\SpecialChar \menuseparator
-\backslash
-renewcommand {
-\backslash
-thefootnote} {
-\backslash
-arabic{footnote}}
+\bar under
+D
+\bar default
+VI,
+\family default
+ etc.
+ Just like you would do for a plain document.
+ No special procedure is required.
\end_layout
-\end_inset
+\begin_layout Standard
+To help orientate you, I will now explain what happens inside LyX:
+\end_layout
+\begin_layout Enumerate
+When the
+\family sans
+\bar under
+U
+\bar default
+pdate\SpecialChar \menuseparator
+\bar under
+D
+\bar default
+VI
+\family default
+ menu option is chosen, a 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
-.
-\end_layout
+literate
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-You can use
+ format (defined in the Preferences panel), otherwise the file will have
+ the usual
\family typewriter
-
-\backslash
-arabic
+.tex
\family default
-,
-\family typewriter
+ extension.
+\end_layout
-\backslash
-roman
-\family default
-,
-\family typewriter
+\end_deeper
+\begin_layout Enumerate
+Note that the only difference so far is in the name of the file, no special
+ processing is required by LyX.
+ Given that you formatted the code using the Scrap layout that, by itself,
+ takes care of the business.
+\end_layout
-\backslash
-Roman
+\begin_layout Enumerate
+If the document is of any literate class LyX will then use the internal
+ LyX to Noweb converter, followed by the Noweb to LaTeX converter
+\begin_inset Foot
+status open
+
+\begin_layout Standard
+The converters are defined in the
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
+
+\bar under
+P
+\bar default
+references
\family default
-,
-\family typewriter
+ panel, under the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-alph
-\family default
- or
-\family typewriter
+Conversion
+\begin_inset Quotes erd
+\end_inset
-\backslash
-Alph
-\family default
- and others as counter styles.
- Just replace the LaTeX command in the above example and rerun TeX to see
- what those styles can do.
-
+ tab.
\end_layout
-\begin_layout Subsection
-Margin Notes
+\end_inset
+
+ to generate the LaTeX file.
\end_layout
+\begin_deeper
\begin_layout Standard
-Here are two examples of neat things you can do to margin notes using LaTeX
- commands.
+Otherwise it will just skip this step.
+\end_layout
+
+\end_deeper
+\begin_layout Enumerate
+Finally, LaTeX is invoked and the regular post processing continues as in
+ a plain document.
\end_layout
\begin_layout Standard
-The following command will make a vertical line appear alongside your text---gre
-at for
+Independence from a particular
\begin_inset Quotes eld
\end_inset
-thumbing
+literate tool
\begin_inset Quotes erd
\end_inset
-:
-\family typewriter
-
-\backslash
-marginpar{
-\backslash
-rule[-10mm]{30mm}{5mm}}
-\family roman
-.
-\family default
+ is easily achieved by changing the commands that are run by the various
+ converters.
+\end_layout
-\begin_inset ERT
-status inlined
+\begin_layout Paragraph
+Generating the code
+\end_layout
\begin_layout Standard
-
-\backslash
-marginpar{
-\backslash
-rule[-10mm]{30mm}{5mm}}
+When the build menu option is chosen or the corresponding button in the
+ toolbar is pressed, a LaTeX file is generated just like step 1 above.
+ Next, LyX invokes the
+\family typewriter
+Noweb->Program
+\family default
+ converter.
+ Typically, this converter (like any other converter), has two parts:
\end_layout
-\end_inset
-
+\begin_layout Enumerate
+The converter program itself.
+ This program performs the conversion from the one format to the other (in
+ this case, from the Noweb format to the Program pseudo-format).
+\end_layout
+\begin_layout Enumerate
+The error log parser.
+ This is a program whose sole purpose is to rewrite error messages in a
+ format that LyX understands.
+ This makes it possible for LyX to place error boxes in the right places
+ in the file buffer.
\end_layout
\begin_layout Standard
-Check your dvi- or ghostview-output to see what the
-\family typewriter
+The first part, the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-reversemarginpar
-\family default
-command does to the following margin note.
-\end_layout
+Converter
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+ setting, should be set to
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-\backslash
-reversemarginpar
-\end_layout
+\family typewriter
+build-script $$i
+\family default
+\begin_inset Quotes erd
\end_inset
+.
+ This basically means that LyX will call
+\begin_inset Quotes eld
+\end_inset
-\begin_inset Marginal
-status collapsed
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-This is a
-\newline
-margin note.
+ (a program or script) with the name of the Noweb file (generally a file
+ in the LyX temp directory).
+
\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 Section
-Multiple Columns
+\begin_layout LyX-Code
+#!/bin/sh
\end_layout
-\begin_layout Standard
-by
-\noun on
-Lars Gullik Bjønnes
+\begin_layout LyX-Code
+#
\end_layout
-\begin_layout Subsection
-Purpose
+\begin_layout LyX-Code
+notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
\end_layout
\begin_layout Standard
-The aim for this chapter
-\begin_inset Foot
-status collapsed
+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
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Standard
-Editor's note: Lars' original chapter was a masterful description of how
- to use the
-\family typewriter
-multicol
-\family default
- package.
- However, it was too long to flow smoothly in this document.
- I have therefore chosen to excerpt the most important sections here (sorry,
- Lars); you can read the original chapter (and more of the story!) in the
- example file
\family typewriter
-examples/multicol.lyx
+originaldir,parselog=listerrors
\family default
+
+\begin_inset Quotes erd
+\end_inset
+
.
- --- mer
-\end_layout
+ This will run any errors that are generated by the
+\begin_inset Quotes eld
+\end_inset
+build-script
+\begin_inset Quotes erd
\end_inset
- is to show how the LaTeX package
-\family typewriter
-multicol
-\family default
- can be used in a LyX document.
- As LyX doesn't support the
-\family typewriter
-multicol
-\family default
- package natively yet, we have to use some small hacks.
- By reading this section it should be obvious how to do this.
-\end_layout
+ process through the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Limitations
+listerrors
+\begin_inset Quotes erd
+\end_inset
+
+ program.
\end_layout
\begin_layout Standard
-The
-\family typewriter
-multicol
-\family default
- package allows switching between one and multicolumn format on the same
- page.
- Footnotes are handled correctly (for the most part), but will be placed
- at the bottom of the page and not under each column.
- LaTeX's float mechanism, however, is partly disabled in the current implementat
-ion.
- At the moment only page-wide floats can be used within the scope of the
- environment.
-\end_layout
+The converter code looks in
+\emph on
+MYLYXDIR/scripts
+\emph default
+ first, then in
+\emph on
+LIBDIR/scripts
+\emph default
+ then on the path for the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-Examples
+listerrors
+\begin_inset Quotes erd
+\end_inset
+
+ program.
\end_layout
-\begin_layout Subsubsection
-Two columns
+\begin_layout Paragraph
+Build instructions in the document
\end_layout
\begin_layout Standard
-If you want to have two columns in your text, you have use LaTeX mode to
- insert
-\family typewriter
-
-\backslash
-begin{multicols}{2}
-\family default
- at the point where you want the two column layout to start, and then
-\family typewriter
+The last piece of the integration between LyX and noweb is the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-end{multicols}
-\family default
- where you want it to end.
- Like this:
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+ scrap.
+ Generally, the instructions for building your program should be embedded
+ in a scrap of its own.
+ The noweb-specific
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+build-script
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+ above uses the notangle command to look for this scrap (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
-\noindent
-
-\series bold
-\size small
-The Adventure of the Empty House
-\series default
+Typically, such a scrap would look something like this:
+\end_layout
+\begin_layout LyX-Code
+<<build-script>>=
+\newline
+#!/bin/sh
\newline
-by
-\noun on
-Sir Arthur Conan Doyle
-\end_layout
-\begin_layout Standard
+\newline
+if [ -z "${NOWEB_SOURCE}" ]
+\newline
+then
+\newline
+ NOWEB_SOURCE=myfile.nw
+\newline
-\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 increduli
-ty 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.
+fi
+\newline
+[...
+ code to extract files ...]
+\newline
+[...
+ code to compile files ...]
+\newline
+@
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-end{multicols}
-\end_layout
+Look in
+\emph on
+LIBDIR/examples/listerrors.lyx
+\emph default
+ or in
+\emph on
+LIBDIR/examples/Literate.lyx
+\emph default
+ which implement two 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 or
+ in
+\emph on
+LIBDIR/examples/noweb2lyx.lyx.
+\emph default
+ Interestingly, these three files show off the language-indepence of the
+ LyX literate programming support since they are written in Python, C and
+ Perl respectively.
\end_layout
\begin_layout Subsubsection
-Multiple columns
+Configuring LyX
\end_layout
\begin_layout Standard
-The same pattern is used when you want more than two columns:
-\end_layout
+All the Literate Programming support is configured by the
+\family sans
+\bar under
+T
+\bar default
+ools\SpecialChar \menuseparator
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\bar under
+P
+\bar default
+references
+\family default
+ panel in the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Conversion
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{multicols}{3}
+ tab.
+ The important parts are:
\end_layout
+\begin_layout Description
+the\InsetSpace ~
+
+\begin_inset Quotes eld
\end_inset
+literate
+\begin_inset Quotes erd
+\end_inset
+\InsetSpace ~
+format Set up via the 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 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 Standard
+\begin_layout Description
+the\InsetSpace ~
-\size footnotesize
-It can be imagined that my close intimacy with Sherlock Holmes had interested
- me deeply in crime, and that after his disappearance I never failed to
- read with care the various problems which came before the public.
- 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.
+\family sans
+Program
+\family default
+\InsetSpace ~
+format This is an empty format whose sole purpose is to be the endpoint
+ of a conversion (which then allows us to set up a converter for it).
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_layout Description
-\begin_layout Standard
+\family sans
+NoWeb
+\family default
+->
+\family sans
+LaTeX
+\family default
+ This converter performs the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-end{multicols}
-\end_layout
+weaving
+\begin_inset Quotes erd
+\end_inset
+ of the literate document.
+ For Noweb, it is set to
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\family typewriter
+noweave -delay -index $$i > $$o
+\family default
-\begin_layout Standard
-You can have have more than 3 columns if you want to, but that might not
- be very pleasant for the eye.
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsubsection
-Columns inside columns
-\end_layout
-\begin_layout Standard
-You can even have columns inside columns:
\end_layout
-\begin_layout Standard
-\begin_inset ERT
-status inlined
+\begin_layout Description
-\begin_layout Standard
+\family sans
+NoWeb
+\family default
+->
+\family sans
+Program
+\family default
+ This performs the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+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
+
+\begin_inset Quotes erd
+\end_inset
+
+, with Flags set to
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+originaldir,parselog=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 LyX server, the
+\begin_inset Quotes eld
+\end_inset
-\size footnotesize
-The Honourable Ronald Adair was the second son of the Earl of Maynooth,
- at that time governor of one of the Australian colonies.
- Adair's mother had returned from Australia to undergo the operation for
- cataract, and she, her son Ronald, and her daughter Hilda were living together
- at 427 Park Lane.
+server-goto-file-row" function, to be used with ddd/gdb or other debugger.
+
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
+When debugging code with ddd/gdb, it is possible to invoke a text editor
+ at the current execution position with a single key stroke.
+ The default ddd configuration for that is shift-ctrl-V.
+ It happens that you can define the editor command line invocation in ddd
+ by accessing the
+\family sans
+\bar under
+E
+\bar default
+dit\SpecialChar \menuseparator
-\begin_layout Standard
+\bar under
+P
+\bar default
+references\SpecialChar \menuseparator
-\backslash
-begin{multicols}{2}
+\bar under
+H
+\bar default
+elpers
+\family default
+ dialog and changing the "Edit Sources" entry.
\end_layout
+\begin_layout Standard
+I take advantage of the new created LyX server function and this ddd feature,
+ and set
+\begin_inset Quotes eld
\end_inset
+Edit Sources
+\begin_inset Quotes erd
+\end_inset
+ to:
\end_layout
-\begin_layout Standard
-
-\size footnotesize
-The youth moved in the best society--had, so far as was known, no enemies
- and no particular vices.
- He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
- had been broken off by mutual consent some months before, and there was
- no sign that it had left any very profound feeling behind it.
- For the rest {sic} the man's life moved in a narrow and conventional circle,
- for his habits were quiet and his nature unemotional.
- Yet it was upon this easy-going young aristocrat that death came, in most
- strange and unexpected form, between the hours of ten and eleven-twenty
- on the night of March 30, 1894.
+\begin_layout LyX-Code
+echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-end{multicols}
+With this, whenever you are using ddd and find a point in the program that
+ you want to edit, you just press shift-ctrl-V (in the ddd window), and
+ ddd you forward this information to LyX through the LyX server and then
+ the LyX window will show the same file with the cursor at the same position
+ ddd was pointing to.
+ No more guessing or long scrolling to locate a point in the program back
+ from debugging !
\end_layout
+\begin_layout Standard
+Note however that you must enable the LyX server to get this feature working
+ (it is disabled by default).
+ You can enable it in
+\family sans
+Preferences
+\family default
+ (tabs
+\family sans
+Inputs
+\family default
+,
+\family sans
+Paths
+\family default
+) by entering in the
+\family sans
+LyXserver pipe
+\family default
+ a path like
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\family typewriter
+/home/<your-home-directory>/.lyx/lyxpipe
+\family default
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-\size footnotesize
-Ronald Adair was fond of cards--playing continually, but never for such
- stakes as would hurt him.
- He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
- It was shown that, after dinner on the day of his death, he had played
- a rubber of whist at the latter club.
- He had also played there in the afternoon.
-\size default
-
-\size footnotesize
-The evidence of those who had played with him-- Mr.
- Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
- and that there was a fairly equal fall of the cards.
- Adair might have lost five pounds, but not more.
- His fortune was a considerable one, and such a loss could not in any way
- affect him.
- He had played nearly every day at one club or other, but he was a cautious
- player, and usually rose a winner.
- It came out in evidence that, in partnership with Colonel Moran, he had
- actually won as much as four hundred and twenty pounds in a sitting, some
- weeks before, from Godfrey Milner and Lord Balmoral.
- So much for his recent history as it came out at the inquest.
\end_layout
\begin_layout Standard
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
+Read the LyX server documentation in the
+\emph on
+Customization Manual
+\emph default
+ for further information.
+\end_layout
-\backslash
-end{multicols}
+\begin_layout Subsubsection
+Toolbar extensions
\end_layout
+\begin_layout Standard
+There are six new buttons that can be added to your LyX toolbar.
+ Five of these buttons are short cuts to layout styles:
+\family sans
+Standard
+\family default
+,
+\family sans
+Section
+\family default
+,
+\family sans
+LaTeX
+\family default
+,
+\family sans
+LyX-Code
+\family default
+, and
+\family sans
+Scrap
+\family default
+.
+ The last one is a short cut to the
+\begin_inset Quotes eld
\end_inset
+Build Program
+\begin_inset Quotes erd
+\end_inset
+ File menu entry.
+
\end_layout
\begin_layout Standard
-Please do read the file
-\family typewriter
-examples/multicol.lyx
+LyX has a range of buttons that are available for tool bar customization.
+ In my toolbar I like to combine the six short cuts above with two more:
+ One for
+\family sans
+\bar under
+V
+\bar default
+iew
\family default
- for more advanced examples including column and header spacing, vertical
- separator lines, and more.
-\end_layout
+\SpecialChar \menuseparator
-\begin_layout Section
-Numbering in the
\family sans
-Enumerate
+\bar under
+U
+\bar default
+pdate
\family default
- Paragraph Environment
-\begin_inset OptArg
-status collapsed
+\SpecialChar \menuseparator
-\begin_layout Standard
-Numbering in Enumerate
+\family sans
+\bar under
+D
+\bar default
+VI
+\family default
+ and the other for
+\family sans
+\bar under
+V
+\bar default
+iew\SpecialChar \menuseparator
+
+\bar under
+D
+\bar default
+VI
+\family default
+ File menu entries.
+ Here is how it looks like:
\end_layout
-\end_inset
+\begin_layout LyX-Code
+Toolbar
+\end_layout
+\begin_layout LyX-Code
+ Layouts
+\end_layout
+\begin_layout LyX-Code
+ Icon "layout Standard"
\end_layout
-\begin_layout Standard
-by
-\noun on
-John Weiss
+\begin_layout LyX-Code
+ Icon "layout Section"
\end_layout
-\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
+\begin_layout LyX-Code
+ Icon "layout LaTeX"
+\end_layout
+\begin_layout LyX-Code
+ Icon "layout LyX-Code"
+\end_layout
+\begin_layout LyX-Code
+ Icon "layout Scrap"
\end_layout
-\begin_layout Standard
-\noindent
-The default numbering for the
-\family sans
-Enumerate
-\family default
- paragraph environment begins with Arabic numbers and ends with uppercase
- letters.
- Suppose, however, you wanted a different type of numbering scheme.
- Here's a quickie example of how to change the numbering scheme:
+\begin_layout LyX-Code
+ Separator
\end_layout
\begin_layout LyX-Code
+ Icon "buffer-view"
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-Roman{enumi}.}
+\begin_layout LyX-Code
+ Icon "buffer-typeset"
\end_layout
\begin_layout LyX-Code
+ Icon "build-program"
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumii}.}
+\begin_layout LyX-Code
+ Separator
\end_layout
\begin_layout LyX-Code
+.
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-arabic{enumiii}.}
+\begin_layout LyX-Code
+.
\end_layout
\begin_layout LyX-Code
+.
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumiv}{
-\backslash
-alph{enumiv}.)}
+\begin_layout LyX-Code
+End
\end_layout
-\begin_layout Standard
-\SpecialChar \ldots{}
- which changes the numbering scheme to uppercase Roman numerals, uppercase
- letters, Arabic numbers, and lowercase letter.
+\begin_layout Subsubsection
+Colors customization
\end_layout
\begin_layout Standard
-Additionally, the previous example also adds a little bit extra to the numbering
- scheme.
- For example, the first level label actually looks like:
-\begin_inset Quotes eld
-\end_inset
-
-I.
-\begin_inset Quotes erd
-\end_inset
-
+There are a number of colors in LyX that can be customized in
+\family sans
+Preferences
+\family default
.
- For ease of reading, we'll describe what the numbering schemes look like
- using a notation something like this: <
-\begin_inset Quotes eld
-\end_inset
-
-I.
-\begin_inset Quotes erd
-\end_inset
-
-,\InsetSpace ~
-
-\begin_inset Quotes erd
-\end_inset
+ One of the things that bothers people is the LaTeX font color.
+ The default color is red, since the scraps uses LaTeX font, and there is
+ a lot of scraps in literate documents, you may get tired of seeing everything
+ in red.
+ You can change it by going to the tabs
+\family sans
+Look&Feel
+\family default
+,
+\family sans
+Colors.
+\end_layout
-A.
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The next thing is the visible presence of the newline character in the screen.
+ You can choose the color of this particular character and make it blend
+ in the background.
+ I recommend you choosing a color that is close to the background but not
+ equal, that way you still can see it is there, but it is not bothering
+ you anymore.
+
+\end_layout
-,\InsetSpace ~
+\begin_layout Chapter
+Secrets of the LaTeX Masters
+\begin_inset LatexCommand label
+name "cha:secrets"
-\begin_inset Quotes erd
\end_inset
-1.
-\begin_inset Quotes erd
-\end_inset
-,\InsetSpace ~
+\end_layout
+\begin_layout Standard
+Though LyX is a powerful tool, it cannot hope to support everything that
+ can be done with pure TeX/LaTeX.
+ However, many familiar dirty TeX and LaTeX tricks can be done within LyX,
+ as long as you are not afraid to use that
\begin_inset Quotes eld
\end_inset
-a.)
+TeX
\begin_inset Quotes erd
\end_inset
->.
+ button on the toolbar or add things to the LaTeX preamble.
+ This section lists some tips, tricks, and otherwise cool ideas to give
+ your document that extra little flair.
+\emph on
+Do try this at home
+\emph default
+, just start with something a little smaller and less important than your
+ dissertation!
\end_layout
\begin_layout Standard
-As you can see in the example, there is a label command for each nesting
- level,
-\family typewriter
+Most ideas in this section require less common files in your LaTeX installation.
+ If you have a system like teTeX, most will already be available.
+ A few, however, will need to be downloaded from one of the CTAN archives.
+ Often, there are several ways to do something, or several LaTeX style files
+ which do the same thing.
+ We do not endorse one choice over another, we simply claim that we have
+ done a particular task with a particular file.
+ Put on your wizard hat, keep an eye out for dragons, and let us begin.
+\end_layout
-\backslash
-labelenumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
+\begin_layout Section
+Multiple Columns
+\end_layout
-\backslash
-labelenumiv
-\family default
-, as well as a counter,
+\begin_layout Standard
+by
+\noun on
+Lars Gullik Bjønnes
+\end_layout
+
+\begin_layout Subsection
+Purpose
+\end_layout
+
+\begin_layout Standard
+The aim for this chapter
+\begin_inset Foot
+status collapsed
+
+\begin_layout Standard
+Editor's note: Lars' original chapter was a masterful description of how
+ to use the
\family typewriter
-enumi
+multicol
\family default
- \SpecialChar \ldots{}
-
+ package.
+ However, it was too long to flow smoothly in this document.
+ I have therefore chosen to excerpt the most important sections here (sorry,
+ Lars); you can read the original chapter (and more of the story!) in the
+ example file
\family typewriter
-enumiv
+examples/multicol.lyx
\family default
.
- There are also five
-\begin_inset Quotes eld
-\end_inset
+ --- mer
+\end_layout
-number printing
-\begin_inset Quotes erd
\end_inset
- commands,
+ is to show how the LaTeX package
\family typewriter
-
-\backslash
-arabic{}
+multicol
\family default
-,
+ can be used in a LyX document.
+ As LyX doesn't support the
\family typewriter
+multicol
+\family default
+ package natively yet, we have to use some small hacks.
+ By reading this section it should be obvious how to do this.
+\end_layout
-\backslash
-roman{}
+\begin_layout Subsection
+Limitations
+\end_layout
+
+\begin_layout Standard
+The
+\family typewriter
+multicol
\family default
-,
+ package allows switching between one and multicolumn format on the same
+ page.
+ Footnotes are handled correctly (for the most part), but will be placed
+ at the bottom of the page and not under each column.
+ LaTeX's float mechanism, however, is partly disabled in the current implementat
+ion.
+ At the moment only page-wide floats can be used within the scope of the
+ environment.
+\end_layout
+
+\begin_layout Subsection
+Examples
+\end_layout
+
+\begin_layout Subsubsection
+Two columns
+\end_layout
+
+\begin_layout Standard
+If you want to have two columns in your text, you have use LaTeX mode to
+ insert
\family typewriter
\backslash
-Roman{}
+begin{multicols}{2}
\family default
-,
+ at the point where you want the two column layout to start, and then
\family typewriter
\backslash
-alph{}
+end{multicols}
\family default
-, and
-\family typewriter
+ where you want it to end.
+ Like this:
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status inlined
+
+\begin_layout Standard
+
\backslash
-Alph{}
-\family default
-, each of which take one counter as an argument.
- You can add characters before or after these, but there's no need to add
- spaces.
+begin{multicols}{2}
+\end_layout
+
+\end_inset
+
+
\end_layout
\begin_layout Standard
-You can get really fancy with these.
- For example:
-\end_layout
+\noindent
-\begin_layout LyX-Code
+\series bold
+\size small
+The Adventure of the Empty House
+\series default
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-#
-\backslash
-Alph{enumi}
-\backslash
-#}
+\newline
+by
+\noun on
+Sir Arthur Conan Doyle
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumi}.
-\backslash
-arabic{enumii}}
+\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 increduli
+ty 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
-\begin_layout LyX-Code
+\begin_layout Standard
+\begin_inset ERT
+status inlined
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-alph{enumiii}+}
-\end_layout
+\begin_layout Standard
-\begin_layout LyX-Code
\backslash
-renewcommand{
-\backslash
-labelenumiv}{(
-\backslash
-roman{enumiv})}
+end{multicols}
\end_layout
-\begin_layout Standard
-produces the somewhat out of hand numbering scheme: <
-\begin_inset Quotes eld
\end_inset
-#A#
-\begin_inset Quotes erd
-\end_inset
-,\InsetSpace ~
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
+Multiple columns
+\end_layout
-A.1
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+The same pattern is used when you want more than two columns:
+\end_layout
-,\InsetSpace ~
+\begin_layout Standard
+\begin_inset ERT
+status inlined
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
-a+
-\begin_inset Quotes erd
-\end_inset
-,\InsetSpace ~
+\backslash
+begin{multicols}{3}
+\end_layout
-\begin_inset Quotes eld
\end_inset
-(i)
-\begin_inset Quotes erd
-\end_inset
->.
-
\end_layout
-\begin_layout Section
-Extra Space Between Table Rows
+\begin_layout Standard
+
+\size footnotesize
+It can be imagined that my close intimacy with Sherlock Holmes had interested
+ me deeply in crime, and that after his disappearance I never failed to
+ 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
\begin_layout Standard
-by
-\noun on
-Mike Ressler
-\end_layout
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\begin_inset VSpace bigskip
-\end_inset
+\backslash
+end{multicols}
\end_layout
-\begin_layout Standard
-\noindent
-LaTeX allows you to put a bit of extra space between rows in a table by
- giving an optional argument to the end-of-row specifier (
-\family typewriter
+\end_inset
-\backslash
-\backslash
+\end_layout
-\family default
-).
- LyX has not yet implemented this in a formal way, so here are two dirty
- little tricks to do the same job.
-
+\begin_layout Standard
+You can have more than 3 columns if you want to, but that might not be very
+ pleasant for the eye.
+\end_layout
+
+\begin_layout Subsubsection
+Columns inside columns
\end_layout
\begin_layout Standard
-The first is the more formal, but longwinded way to do it.
- In the LaTeX preamble, add the following command definition:
+You can even have columns inside columns:
\end_layout
+\begin_layout Standard
+\begin_inset ERT
+status inlined
+
\begin_layout Standard
-\family typewriter
\backslash
-newcommand{
-\backslash
-extratablespace}[1]{
-\backslash
-noalign{vskip#1}}
-\family default
- This command takes a single argument---the amount of space you would like
- to insert.
- Insert the command in the first column of the row
-\emph on
-after
-\emph default
- where you would like the space to appear.
- Here is an example (I've removed all the borders using
-\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-Tabl
-\bar under
-e
-\family default
-\bar default
-):
+begin{multicols}{2}
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="4" columns="3">
-<features>
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\end_inset
+
+
+\end_layout
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Minerals
+\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
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+\begin_inset ERT
+status inlined
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Calcite
+
+\backslash
+begin{multicols}{2}
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+
+
+\end_layout
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Dolomite
+\size footnotesize
+The youth moved in the best society--had, so far as was known, no enemies
+ and no particular vices.
+ He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
+ had been broken off by mutual consent some months before, and there was
+ no sign that it had left any very profound feeling behind it.
+ For the rest {sic} the man's life moved in a narrow and conventional circle,
+ for his habits were quiet and his nature unemotional.
+ Yet it was upon this easy-going young aristocrat that death came, in most
+ strange and unexpected form, between the hours of ten and eleven-twenty
+ on the night of March 30, 1894.
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Standard
+\begin_inset ERT
+status inlined
\begin_layout Standard
+
+\backslash
+end{multicols}
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Graphite
-\end_layout
+\size footnotesize
+Ronald Adair was fond of cards--playing continually, but never for such
+ stakes as would hurt him.
+ He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
+ It was shown that, after dinner on the day of his death, he had played
+ a rubber of whist at the latter club.
+ He had also played there in the afternoon.
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\size default
+
+\size footnotesize
+The evidence of those who had played with him-- Mr.
+ Murray, Sir John Hardy, and Colonel Moran--showed that the game was whist,
+ and that there was a fairly equal fall of the cards.
+ Adair might have lost five pounds, but not more.
+ His fortune was a considerable one, and such a loss could not in any way
+ affect him.
+ He had played nearly every day at one club or other, but he was a cautious
+ player, and usually rose a winner.
+ It came out in evidence that, in partnership with Colonel Moran, he had
+ actually won as much as four hundred and twenty pounds in a sitting, some
+ weeks before, from Godfrey Milner and Lord Balmoral.
+ So much for his recent history as it came out at the inquest.
+\end_layout
\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
\begin_inset ERT
-status collapsed
+status inlined
\begin_layout Standard
+
\backslash
-extratablespace{2ex}
+end{multicols}
\end_layout
\end_inset
-Rocks
-\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\end_layout
\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Limestone
+Please do read the file
+\family typewriter
+examples/multicol.lyx
+\family default
+ for more advanced examples including column and header spacing, vertical
+ separator lines, and more.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Section
+Numbering in the
+\family sans
+Enumerate
+\family default
+ Paragraph Environment
+\begin_inset OptArg
+status collapsed
\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Sandstone
+Numbering in Enumerate
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
+by
+\noun on
+John Weiss
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Andesite
\end_layout
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+\begin_layout Standard
+\noindent
+The default numbering for the
+\family sans
+Enumerate
+\family default
+ paragraph environment begins with Arabic numbers and ends with uppercase
+ letters.
+ Suppose, however, you wanted a different type of numbering scheme.
+ Here's a quickie example of how to change the numbering scheme:
+\end_layout
-\end_inset
+\begin_layout LyX-Code
+
+\backslash
+renewcommand{
+\backslash
+labelenumi}{
+\backslash
+Roman{enumi}.}
+\end_layout
+\begin_layout LyX-Code
+\backslash
+renewcommand{
+\backslash
+labelenumii}{
+\backslash
+Alph{enumii}.}
\end_layout
-\begin_layout Standard
-The second method is faster, but will make typographers and TeXperts all
- over the world groan.
- Simply put an end of row specifier with optional argument at the same spot.
- No fancy definitions are needed as in the above example, but there will
- be more space inserted than you specified because you essentially added
- a blank row plus the extra space.
- If the space added is too much, simply use a negative number, like so:
+\begin_layout LyX-Code
+
+\backslash
+renewcommand{
+\backslash
+labelenumiii}{
+\backslash
+arabic{enumiii}.}
\end_layout
-\begin_layout Standard
-\align center
-\begin_inset Tabular
-<lyxtabular version="3" rows="4" columns="3">
-<features>
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<column alignment="center" valignment="top" width="0pt">
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout LyX-Code
-\begin_layout Standard
+\backslash
+renewcommand{
+\backslash
+labelenumiv}{
+\backslash
+alph{enumiv}.)}
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Minerals
+\begin_layout Standard
+\SpecialChar \ldots{}
+ which changes the numbering scheme to uppercase Roman numerals, uppercase
+ letters, Arabic numbers, and lowercase letter.
\end_layout
+\begin_layout Standard
+Additionally, the previous example also adds a little bit extra to the numbering
+ scheme.
+ For example, the first level label actually looks like:
+\begin_inset Quotes eld
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+I.
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Calcite
-\end_layout
+.
+ For ease of reading, we'll describe what the numbering schemes look like
+ using a notation something like this: <
+\begin_inset Quotes eld
+\end_inset
+I.
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,\InsetSpace ~
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Dolomite
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+A.
+\begin_inset Quotes erd
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,\InsetSpace ~
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+1.
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,\InsetSpace ~
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
-\end_layout
+\begin_inset Quotes eld
+\end_inset
+a.)
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+
+>.
+
+\end_layout
\begin_layout Standard
+As you can see in the example, there is a label command for each nesting
+ level,
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Graphite
-\end_layout
+\backslash
+labelenumi
+\family default
+ \SpecialChar \ldots{}
+
+\family typewriter
+\backslash
+labelenumiv
+\family default
+, as well as a counter,
+\family typewriter
+enumi
+\family default
+ \SpecialChar \ldots{}
+
+\family typewriter
+enumiv
+\family default
+.
+ There are also five
+\begin_inset Quotes eld
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+number printing
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-\begin_inset ERT
-status collapsed
+ commands,
+\family typewriter
-\begin_layout Standard
+\backslash
+arabic{}
+\family default
+,
+\family typewriter
\backslash
+roman{}
+\family default
+,
+\family typewriter
\backslash
-[-1ex]
-\end_layout
+Roman{}
+\family default
+,
+\family typewriter
-\end_inset
+\backslash
+alph{}
+\family default
+, and
+\family typewriter
- Rocks
+\backslash
+Alph{}
+\family default
+, each of which take one counter as an argument.
+ You can add characters before or after these, but there's no need to add
+ spaces.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Limestone
+You can get really fancy with these.
+ For example:
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout LyX-Code
-\begin_layout Standard
+\backslash
+renewcommand{
+\backslash
+labelenumi}{
+\backslash
+#
+\backslash
+Alph{enumi}
+\backslash
+#}
+\end_layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Sandstone
+\begin_layout LyX-Code
+
+\backslash
+renewcommand{
+\backslash
+labelenumii}{
+\backslash
+Alph{enumi}.
+\backslash
+arabic{enumii}}
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout LyX-Code
-\begin_layout Standard
+\backslash
+renewcommand{
+\backslash
+labelenumiii}{
+\backslash
+alph{enumiii}+}
+\end_layout
+
+\begin_layout LyX-Code
+\backslash
+renewcommand{
+\backslash
+labelenumiv}{(
+\backslash
+roman{enumiv})}
\end_layout
+\begin_layout Standard
+produces the somewhat out of hand numbering scheme: <
+\begin_inset Quotes eld
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+#A#
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
-\end_layout
+,\InsetSpace ~
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+A.1
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Andesite
-\end_layout
+,\InsetSpace ~
+\begin_inset Quotes erd
\end_inset
-</cell>
-</row>
-</lyxtabular>
+a+
+\begin_inset Quotes erd
+\end_inset
+
+,\InsetSpace ~
+
+\begin_inset Quotes eld
\end_inset
+(i)
+\begin_inset Quotes erd
+\end_inset
+>.
+
\end_layout
\begin_layout Standard
-It's short, sweet, and gets the job done quickly, even if it is really ugly.
- You may put away the rotten vegetables now! I promise I won't suggest anything
- else like that!
+
\end_layout
\begin_layout Section
\begin_layout Standard
+
\backslash
newfont{
\backslash
\begin_layout Standard
+
\backslash
hangindent=3.3em
\backslash
\begin_layout Standard
+
\backslash
verb+
\backslash
\begin_layout Standard
+
\backslash
begin{sloppypar}
\end_layout
\begin_layout Standard
+
\backslash
newdimen
\backslash
\begin_layout Standard
+
\backslash
setlength{
\backslash
\begin_layout Standard
+
\backslash
parshape 19 0.45
\backslash
\end_layout
\begin_layout Standard
+
0.40
\backslash
varunit 0.300
\end_layout
\begin_layout Standard
+
0.35
\backslash
varunit 0.293
\end_layout
\begin_layout Standard
+
0.30
\backslash
varunit 0.300
\end_layout
\begin_layout Standard
+
0.25
\backslash
varunit 0.317
\end_layout
\begin_layout Standard
+
0.20
\backslash
varunit 0.342
\end_layout
\begin_layout Standard
+
0.15
\backslash
varunit 0.373
\end_layout
\begin_layout Standard
+
0.10
\backslash
varunit 0.410
\end_layout
\begin_layout Standard
+
0.05
\backslash
varunit 0.453
\end_layout
\begin_layout Standard
+
0.00
\backslash
varunit 0.500
\end_layout
\begin_layout Standard
+
0.05
\backslash
varunit 0.453
\end_layout
\begin_layout Standard
+
0.10
\backslash
varunit 0.410
\end_layout
\begin_layout Standard
+
0.15
\backslash
varunit 0.373
\end_layout
\begin_layout Standard
+
0.20
\backslash
varunit 0.342
\end_layout
\begin_layout Standard
+
0.25
\backslash
varunit 0.317
\end_layout
\begin_layout Standard
+
0.30
\backslash
varunit 0.300
\end_layout
\begin_layout Standard
+
0.35
\backslash
varunit 0.293
\end_layout
\begin_layout Standard
+
0.40
\backslash
varunit 0.300
\end_layout
\begin_layout Standard
+
0.45
\backslash
varunit 0.332
\begin_layout Standard
+
\backslash
end{sloppypar}
\end_layout
projects / lyx.git / blobdiff