-#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 243
+#LyX 2.0.0svn created this file. For more info see http://www.lyx.org/
+\lyxformat 362
\begin_document
\begin_header
-\textclass book
+\textclass scrbook
\begin_preamble
+% DO NOT ALTER THIS PREAMBLE!!!
+%
+% This preamble is designed to ensure that the manual prints
+% out as advertised. If you mess with this preamble,
+% parts of the manual may not print out as expected. If you
+% have problems LaTeXing this file, please contact
+% the documentation team
+% email: lyx-docs@lists.lyx.org
+
+% if pdflatex is used
+\usepackage{ifpdf}
+\ifpdf
+
+ % set fonts for nicer pdf view
+ \IfFileExists{lmodern.sty}
+ {\usepackage{lmodern}}{}
+
+\fi % end if pdflatex is used
+
+% the pages of the TOC are numbered roman
+% and a PDF-bookmark for the TOC is added
+\pagenumbering{roman}
+\let\myTOC\tableofcontents
+\renewcommand{\tableofcontents}{%
+ \pdfbookmark[1]{\contentsname}{}
+ \myTOC
+ \cleardoublepage
+ \pagenumbering{arabic}}
+
+% redefine the \LyX macro for PDF bookmarks
+\def\LyX{\texorpdfstring{%
+ L\kern-.1667em\lower.25em\hbox{Y}\kern-.125emX\@}
+ {LyX}}
+
+% used for multi-column text
\usepackage{multicol}
+
+% extra space for tables
\newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
\end_preamble
+\options fleqn,liststotoc,bibtotoc,idxtotoc,BCOR7.5mm,titlepage,tablecaptionabove
+\use_default_options false
+\begin_modules
+logicalmkup
+theorems-ams
+theorems-ams-extended
+\end_modules
+\begin_local_layout
+Format 7
+InsetLayout CharStyle:MenuItem
+LyxType charstyle
+LabelString menu
+LatexType command
+LatexName menuitem
+Font
+Family Sans
+EndFont
+Preamble
+\newcommand*{\menuitem}[1]{{\sffamily #1}}
+EndPreamble
+End
+\end_local_layout
\language english
\inputencoding latin1
-\fontscheme default
+\font_roman default
+\font_sans default
+\font_typewriter default
+\font_default_family default
+\use_xetex false
+\font_sc false
+\font_osf false
+\font_sf_scale 100
+\font_tt_scale 100
+
\graphics default
-\paperfontsize default
+\default_output_format default
+\bibtex_command default
+\index_command default
+\paperfontsize 12
\spacing single
+\use_hyperref true
+\pdf_title "LyX's Extended manual"
+\pdf_author "LyX Team"
+\pdf_subject "LyX's extended documentation"
+\pdf_keywords "LyX, Documentation, Extended"
+\pdf_bookmarks true
+\pdf_bookmarksnumbered true
+\pdf_bookmarksopen false
+\pdf_bookmarksopenlevel 1
+\pdf_breaklinks false
+\pdf_pdfborder false
+\pdf_colorlinks true
+\pdf_backref false
+\pdf_pdfusetitle false
+\pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false, pdfpagelabels"
\papersize default
\use_geometry false
\use_amsmath 0
+\use_esint 0
\cite_engine basic
\use_bibtopic false
+\use_indices false
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
\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 ""
+\author ""
\end_header
\begin_body
\begin_layout Title
-
-Extended LyX Features
+Additional LyX Features
\end_layout
\begin_layout Author
-
by the LyX Team
\begin_inset Foot
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
\noindent
Principal maintainer of this file is
\noun on
- Mike Ressler
+ Richard Heck
\noun default
.
If you have comments or error corrections, please send them to the LyX
- Documentation mailing list, <lyx-docs@lists.lyx.org>.
+ Documentation mailing list,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\noindent
+<lyx-docs@lists.lyx.org>
\end_layout
\end_inset
-
+.
\end_layout
-\begin_layout Standard
+\end_inset
+
+\end_layout
-\begin_inset LatexCommand \tableofcontents{}
+\begin_layout Standard
+\begin_inset CommandInset toc
+LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Chapter
-
Introduction
\end_layout
\begin_layout Standard
-
-The
-\emph on
-Extended LyX Features
-\emph default
- manual, which you are now reading, is essentially Part II of the
+This manual is essentially Part II of the
\emph on
User's Guide\SpecialChar \@.
\emph default
- The reason for splitting this document is simple: the
+ The reason for separating this document out is simple: the
\emph on
User's Guide
\emph default
- is already huge, and it contains all of the basic features one needs to
- know in order to prepare most documents.
- However, the LyX Team has a long-term goal of making LyX extensible through
- various configuration files and external packages.
+ is already quite lengthy, and it contains information on all of the basic
+ features one needs to know in order to prepare most documents.
+ However, the LyX Team has worked to LyX extensible through various configuratio
+n files and external packages.
That means that if you want to support the Fizzwizzle LaTeX package, you
- can create a layout file for it without having to alter LyX itself.
+ can create a layout file (or module) for it without having to alter LyX
+ itself.
We've already had contributions of several new features this way.
- This is the place where all of that gets documented.
+ This is the place where all of those get documented.
\end_layout
\begin_layout Standard
-
This manual also documents some special features, like fax support, version
control, and SGML support, which require additional software to work properly.
Lastly, there's a chapter of LaTeX tools and tips, things you can use to
\emph on
is
\emph default
- only WYSIWYM, and will only ever interface to certain LaTeX features.
-\end_layout
-
-\begin_layout Standard
-
-Of course, with all of this extra documentation,
-\emph on
-Extended LyX Features
-\emph default
- may itself grow too big for its britches.
- In that case, you can just call it the
-\begin_inset Quotes eld
-\end_inset
-
-Overextended Manual
-\begin_inset Quotes erd
-\end_inset
-
- for fun!
+ only WYSIWYM and will only ever interface to some, not all, LaTeX features.
\end_layout
\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
\emph default
- is the first place to go, since it will direct you to the correct manual,
- and it also describes the notation and format of all of the manuals.
+ is the first place to go, since it describes the notation and format of
+ all of the manuals.
You should also be thoroughly familiar with the
\emph on
User's Guide
\emph default
- and all of the basic features of LyX.
-
+ and all of the basic features of LyX before attempting to read this one.
\end_layout
\begin_layout Standard
-
-In this document, many sections are independent articles contributed by
- an individual and are noted as such.
- This person is generally whoever wrote the layout file for the new document
- class or LaTeX package, or implemented the feature.
- If there is no mention of an author to a chapter [or chapter sections],
- that means it was written by the LyX Documentation Team.
-\end_layout
-
-\begin_layout Standard
-
Since all the topics in this manual depend heavily on LyX's interaction
- with LaTeX, this first chapter covers
-\emph on
-
-\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
\begin_layout Chapter
-
LyX and LaTeX
\end_layout
\begin_layout Section
-
How LyX Uses LaTeX
\end_layout
\begin_layout Standard
-
-
-\begin_inset LatexCommand \label{sec:lyxandlatex}
-
-\end_inset
-
This chapter is for both TeX-nicians and the LaTeX-curious.
In it, we'll explain how LyX and LaTeX work together to produce printable
output.
\end_layout
\begin_layout Standard
-
-At one time, we called LyX a
+At one time, LyX was called a
\begin_inset Quotes eld
\end_inset
but that's no longer true.
There are frontends to LaTeX out there.
- They are basically editors with the ability to run LaTeX and mark any errors
- in the file you're editing.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Some familar ones are TeXmaker and kile, on Linux, and TeXshop, OSX.
+ There are also the LaTeX modes for vi and emacs, of course.
+\end_layout
+
+\end_inset
+
+ These are basically text editors with the ability to run LaTeX and mark
+ any errors in the file you're editing.
Although LyX
\emph on
is
\emph on
does
\emph default
- run LaTeX, and it also marks errors in the file, it also does much, much
- more.
- Thanks to the WYSIWYM concept, you don't need LaTeX to use LyX effectively.
- LyX has also added a few extensions to LaTeX.
+ run LaTeX, and it also indicates errors in the file, it also does much,
+ much more.
+ For one thing, you don't need to know LaTeX to use LyX effectively.
+ And LyX has added its own extensions to LaTeX.
Try the following sometime: select
-\family sans
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
Export\SpecialChar \menuseparator
LaTeX
-\family default
+\end_layout
+
+\end_inset
+
from the
-\family sans
-\bar under
-F
-\bar default
-ile
-\family default
- menu, then look at the preamble of the resulting
-\family typewriter
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File
+\end_layout
+
+\end_inset
+
+ menu (or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Source
+\end_layout
+
+\end_inset
+
+), then look at the preamble of the resulting
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
file.
You'll notice a variety of new macros defined specifically by LyX.
These macros are defined automatically, according to the features you use
\end_layout
\begin_layout Standard
-
There are several commands that automatically invoke LaTeX.
They are:
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Format
+\end_layout
+
+\end_inset
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-View\InsetSpace ~
-\emph on
-Format
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Update\SpecialChar \menuseparator
+Format
+\end_layout
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
+\end_inset
-\bar under
-U
-\bar default
-pdate\SpecialChar \menuseparator
-\emph on
-Format
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Print
+\end_layout
+
+\end_inset
-\family sans
-\bar under
-F
-\bar default
-ile
-\bar under
-\SpecialChar \menuseparator
-P
-\bar default
-rint
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Fax
+\end_layout
+
+\end_inset
-\family sans
-\bar under
-F
-\bar default
-ile
-\bar under
-\SpecialChar \menuseparator
-F
-\bar default
-ax
\end_layout
\begin_layout Standard
-
They will only invoke LaTeX if the file has changed since the last time
LaTeX was run.
\end_layout
\begin_layout Standard
-
-When you run LaTeX on the file you're editing, LyX performs these steps:
+When LyX runs LaTeX on the file you're editing, it performs these steps:
\end_layout
\begin_layout Enumerate
-
Convert the document to LaTeX and save to a file with the extension
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
in place of
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.lyx
-\family default
+\end_layout
+
+\end_inset
+
.
\end_layout
\begin_layout Enumerate
-
Run LaTeX on the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
- file (maybe several times).
\end_layout
-\begin_layout Enumerate
+\end_inset
+
+ file (maybe several times), and run any other commands (such as
+\begin_inset Flex CharStyle:Code
+status collapsed
-If there are any errors, insert error boxes in the document to mark where
- they are.
- These boxes are transient and are not saved along with the document.
+\begin_layout Plain Layout
+bibtex
\end_layout
-\begin_layout Standard
+\end_inset
-If you've run LaTeX using
-\family sans
-View\InsetSpace ~
-DVI
-\family default
-, LyX then executes
-\family typewriter
-xdvi
-\family default
- on the Dvi file.
- If you've used
-\family sans
-View\InsetSpace ~
-PostScript
-\family default
or
-\family sans
-\bar under
-P
-\bar default
-rint
-\family default
-, LyX performs two more steps:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+makeindex
\end_layout
-\begin_layout Itemize
+\end_inset
-Run
-\family typewriter
-dvips
-\family default
- to convert the Dvi file to PostScript®:
+) needed to compile the LaTeX file.
\end_layout
-\begin_deeper
-\begin_layout Itemize
-
-For
-\family sans
-View\InsetSpace ~
-PostScript
-\family default
-, the output file has the extension
-\family typewriter
-.ps_tmp
+\begin_layout Enumerate
+If there are any errors, show the error log.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+If you've run LaTeX using
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-For
-\family sans
+\begin_layout Plain Layout
+View
\bar under
-P
+\SpecialChar \menuseparator
+
\bar default
-rint
-\family default
-\InsetSpace ~
-, the output file has the extension
-\family typewriter
-.ps
-\family default
-, as expected.
+DVI
\end_layout
-\end_deeper
-\begin_layout Itemize
-Execute
-\family typewriter
-ghostview
-\family default
- or send the PostScript® file to the printer.
-\end_layout
+\end_inset
-\begin_layout Section
+, LyX then runs a DVI viewer to display the DVI-file.
+ If you've used
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+View
+\bar under
+\SpecialChar \menuseparator
-\begin_inset Quotes eld
-\end_inset
+\bar default
+PostScript
+\end_layout
-Help! LyX generated an unreadable
-\family typewriter
-.tex
-\family default
- file!
-\begin_inset Quotes erd
\end_inset
+, LyX performs further steps:
+\end_layout
+
+\begin_layout Itemize
+Run
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+dvips
\end_layout
-\begin_layout Standard
+\end_inset
-Die-hard LaTeX users will scream and howl this into the night, then declare
- LyX useless, simply because they didn't RTFM.
+ to convert the DVI file to PostScript.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+Run a PostScript viewer, such as
+\begin_inset Flex CharStyle:Code
+status collapsed
-We're going to set the record straight.
- LyX produces two kinds of LaTeX files.
- One is human readable.
- The other is LyX readable.
- Every time LyX executes LaTeX, it produces a LaTeX file that it can easily
- scan for errors.
- The resulting
-\family typewriter
-.tex
-\family default
- file is not human readable.
- Don't even try to read it.
- If you want a
-\family typewriter
-.tex
-\family default
- file that you can send to a colleague, select
-\family sans
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+\begin_layout Plain Layout
+ghostview
+\end_layout
-\bar under
-L
-\bar default
-aTeX
-\family default
- from the
-\family sans
-\bar under
-F
-\bar default
-ile
-\family default
- menu.
+\end_inset
+
+, to display the PostScript file.
\end_layout
-\begin_layout Section
+\begin_layout Standard
+LyX does similar things when viewing, or exporting, other formats.
+\end_layout
+\begin_layout Section
Translating LaTeX files into LyX
\end_layout
\begin_layout Standard
-
You can import a LaTeX file into LyX by using the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-mport\SpecialChar \menuseparator
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-L
-\bar default
-aTeX
-\family default
- command in LyX.
- This will call a Perl script named
-\family typewriter
-reLyX
-\family default
----which will create a file
-\family typewriter
-foo.lyx
-\family default
- from the 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.
+\begin_layout Plain Layout
+File\SpecialChar \menuseparator
+Import\SpecialChar \menuseparator
+LaTeX
\end_layout
-\begin_layout Standard
+\end_inset
+ command in LyX.
+ This will call a program named
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
-reLyX
-\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
-\family default
-, you can look for red text and hand-edit it to look right.
+\begin_layout Plain Layout
+tex2lyx
\end_layout
-\begin_layout Standard
+\end_inset
+ which will create a file
+\begin_inset Flex CharStyle:Code
+status collapsed
-\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.
+\begin_layout Plain Layout
+foo.lyx
\end_layout
-\begin_layout Standard
+\end_inset
-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}
+ from the file
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+foo.tex
+\end_layout
\end_inset
.
+ LyX will then open that file.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+tex2lyx
\end_layout
-\begin_layout Section
+\end_inset
-Inserting LaTeX Code into LyX Documents
-\begin_inset LatexCommand \label{sec:Inserting-LaTeX-Code}
+ can also be run from the command line, of course.
+\end_layout
\end_inset
\end_layout
\begin_layout Standard
+\begin_inset Flex CharStyle:Code
+status collapsed
-
-\begin_inset LatexCommand \label{sec:latexcodes}
+\begin_layout Plain Layout
+tex2lyx
+\end_layout
\end_inset
- This is a rather important point: You can always insert LaTeX code into
- any LyX document.
- LyX simply cannot, and will probably never be able to, display every possible
- LaTeX construct.
- If ever you need to insert LaTeX commands into your LyX document, you can
- use the ERT box, which you can insert into your document with
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+ will translate most legal LaTeX, but not everything.
+ It will put things it doesn't understand into TeX code, so after translating
+ a file with
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+tex2lyx
+\end_layout
-\bar under
-T
-\bar default
-eX
-\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
- as footnotes), and are useful for significant amounts of LaTeX commands.
- An
-\begin_inset Quotes eld
\end_inset
-inlined
-\begin_inset Quotes erd
+, you can look for TeX code and hand-edit it until it looks right.
+\end_layout
+
+\begin_layout Standard
+If you don't know what TeX code is, read the next section.
+\end_layout
+
+\begin_layout Section
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:Inserting-TeX-Code"
+
\end_inset
- ERT box displays its content as part of the button, and is useful for very
- short sections of LaTeX commands.
-
-\begin_inset ERT
-status inlined
+Inserting TeX Code into LyX Documents
+\end_layout
\begin_layout Standard
-% like this
+Anything you can do in LaTeX you can do in LyX, for a very simple reason:
+ You can always insert TeX code into any LyX document.
+ LyX cannot, and will never be able to, display every possible LaTeX construct.
+ If ever you need to insert LaTeX commands into your LyX document, you can
+ use the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+TeX Code
\end_layout
\end_inset
+ box, which you can insert into your document with
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+TeX Code
\end_layout
-\begin_layout Standard
+\end_inset
-You can switch between all three by right-clicking on the ERT.
- Note that if you want more than one line of LaTeX commands, you cannot
- use the inlined mode.
+.
\end_layout
\begin_layout Standard
-
Here's an example of inserting LaTeX commands in a LyX document.
The code looks like this:
\end_layout
\begin_layout LyX-Code
-
\backslash
begin{tabular}{ll}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{minipage}{5cm}
-\newline
+\begin_inset Newline newline
+\end_inset
+
This is an example for a minipage environment.
You
-\newline
+\begin_inset Newline newline
+\end_inset
+
can put nearly everything in it, even (non-floating)
-\newline
+\begin_inset Newline newline
+\end_inset
+
figures and tables.
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{minipage}
-\newline
+\begin_inset Newline newline
+\end_inset
+
&
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{minipage}{5cm}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{verbatim}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
begin{minipage}{5cm}
-\newline
+\begin_inset Newline newline
+\end_inset
+
This ...
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{minipage}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{verbatim}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{minipage}
-\newline
+\begin_inset Newline newline
+\end_inset
+
\backslash
end{tabular}
\end_layout
\begin_layout Standard
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
-The ERT box containing this text is directly after this paragraph.
- Those of you reading the manual online will only see a bunch of funky text
- in red.
- Those reading a printed version of the manuals will see the actual results:
+\begin_layout Plain Layout
+TeX Code
\end_layout
-\begin_layout Standard
+\end_inset
+ box containing this text is directly after this paragraph.
+ Those of you reading the manual in LyX will only see the TeX code inset.
+ Those reading a printed version of the manuals will see the actual results:
+\end_layout
+\begin_layout Standard
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
begin{tabular}{ll}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\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 Plain Layout
+
+This is an example for a minipage environment.
+ You can put nearly everything in it, even (non-floating) figures and tables.
+
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
end{minipage}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
&
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
begin{minipage}{5cm}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
begin{verbatim}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
begin{minipage}{5cm}
\end_layout
-\begin_layout Standard
-This ...
+\begin_layout Plain Layout
+
+This ...
+
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
end{minipage}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
end{verbatim}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
end{minipage}
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
end{tabular}
\end_layout
\begin_layout Standard
+In addition to using TeX code, you can also create a separate file containing
+ some complex LaTeX structure and then use
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+Child
+\begin_inset space ~
+\end_inset
-In addition to these two methods, you can also create a separate file containing
- some complex LaTeX structure.
- You can then use
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Chil
-\bar under
-d
-\bar default
-\InsetSpace ~
Document
-\family default
+\end_layout
+
+\end_inset
+
to include your file (you should select the type
-\family sans
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
Input
-\family default
+\end_layout
+
+\end_inset
+
).
We recommend that you only do this if you have a
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
file which you
\emph on
know
\emph default
works already.
- Otherwise, you'll have a big job tracking down LaTeX errors\SpecialChar \ldots{}
-
+ Otherwise, you'll have a big job tracking down LaTeX errors.
\end_layout
\begin_layout Standard
-
-There are a few last notes to emphasize:
+There are a few last points to emphasize:
\end_layout
\begin_layout Itemize
-
-Inside of LyX, LaTeX code appears
-\emph on
-in red
-\end_layout
-
-\begin_layout Itemize
-
LyX
\emph on
does not
\end_layout
\begin_layout Itemize
-
Beware reinventing the wheel.
\end_layout
\begin_layout Standard
-
-That last note refers to two things.
- First, LyX does have quite a few features tucked into it, and more are
- coming.
+On that last point, LyX does have quite a few features tucked into it, and
+ more are coming.
Be sure to check the manuals to make sure that LyX doesn't have such-and-such
- feature before you go off merrily coding LaTeX.
- Second, there are numerous LaTeX packages out there to do all sorts of
+ feature before you decide you have to do it by hand.
+ Moreover, there are numerous LaTeX packages out there to do all sorts of
things, from labels to envelopes to fancy multipage tables.
- Check out a CTAN site for details (see Section
-\begin_inset Quotes eld
-\end_inset
+ Check out
+\begin_inset CommandInset href
+LatexCommand href
+name "CTAN"
+target "http://www.ctan.org/"
-Requirements
-\begin_inset Quotes erd
\end_inset
- of the
-\emph on
-User's Guide
-\emph default
-).
-\begin_inset Foot
-status open
-
-\begin_layout Standard
-
-Note from
-\noun on
-John Weiss
-\noun default
-: I seem to do this an awful lot.
- Sat down and merrily began coding something to print out labels, only to
- learn that there were already 2 different LaTeX packages to do this.
- Worse yet --- I had them already!
-\end_layout
-
-\end_inset
+ for details, and see chapter
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "cha:secrets"
+\end_inset
+.
\end_layout
\begin_layout Standard
-
If you do need to do some wild and fancy things within your document, be
sure to check out a good LaTeX book for assistance.
There are a number of them listed in the bibliography of the
.
\end_layout
-\begin_layout Standard
-
-There are a number of LaTeX commands which have to be placed before the
- beginning of the actual text.
- They go into the preamble, and this is explained in the next section.
-\end_layout
-
\begin_layout Section
-
LyX and the LaTeX Preamble
\end_layout
\begin_layout Subsection
-
About the LaTeX Preamble
\end_layout
\begin_layout Standard
-
-
-\begin_inset LatexCommand \label{sec:preamble}
-
-\end_inset
-
If you already know LaTeX, there is no need to explain here what the preamble
is good for.
- If you don't, the following will give you some ideas --- we recommend again
+ If you don't, the following will give you some ideas—we recommend again
that you consult a LaTeX book for further information.
In any case, you should read the points below, because they explain what
you can do and what you don't need to do in the LaTeX preamble of a LyX
\end_layout
\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
\begin_layout Itemize
+Declare the document class.
+
+\begin_inset Newline newline
+\end_inset
-declare the document class.
- LyX already does this for you.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
-If you're a seasoned LaTeX-nician, and you have some custom document class
+LyX already does this for you.
+ If you're a seasoned LaTeX-nician, and you have a custom document class
you want to use, check out the
\emph on
Customization Manual
\emph default
for information on how to make LyX interface to it.
- Be sure to submit your efforts to the LyX Team for inclusion in future
- versions!
\end_layout
-\end_deeper
+
\begin_layout Itemize
+Declare the usage of packages.
+
+\begin_inset Newline newline
+\end_inset
-declare the usage of packages.
- LaTeX packages provide special commands, which are only available within
+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
-\family typewriter
+ For example, the package
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
indentfirst
-\family default
+\end_layout
+
+\end_inset
+
forces all paragraphs to be indented.
There are other packages for labels, envelopes, margins, etc.
\end_layout
\begin_layout Itemize
+Set counters, variables, lengths and widths.
+
+\begin_inset Newline newline
+\end_inset
-set counters, variables, lengths and widths.
- There are several LaTeX counters and variables which
+There are several LaTeX counters and variables which
\emph on
must
\emph default
be set globally from within the preamble in order to have the desired effect.
- [There are other variables which you can set and reset inside the document,
- too.] Margins are a good example of something which must be set in the preamble.
+ (There are variables which you can set and reset inside the document, too.)
+ Margins are a good example of something which must be set in the preamble.
Another example is the label format for lists.
You can actually set these just about anywhere, but it's best to do it
just once, inside the preamble.
\end_layout
\begin_layout Itemize
+Declare user defined commands (with
+\begin_inset Flex CharStyle:Code
+status collapsed
-declare user defined commands [with
-\family typewriter
+\begin_layout Plain Layout
\backslash
-newcommand
-\family default
-or
-\family typewriter
+newcommand
+\end_layout
+
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
renewcommand
-\family default
-], mostly abbreviations for LaTeX commands which appear very often inside
+\end_layout
+
+\end_inset
+
+).
+\begin_inset Newline newline
+\end_inset
+
+These are abbreviations for LaTeX commands which appear very often inside
a document.
Although the preamble is a good place to declare such commands, they
\emph on
can
\emph default
- be declared anywhere else [but
-\emph on
-before
-\emph default
- they are used for the first time, of course\SpecialChar \ldots{}
-].
+ be declared anywhere (before they are used for the first time, of course).
This can be useful if there is a lot of raw LaTeX code in your document,
which normally should not be the case.
\end_layout
\begin_layout Standard
-
LyX adds its own set of definitions to the preamble of the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
.tex
-\family default
+\end_layout
+
+\end_inset
+
file it produces.
This makes LaTeX files generated by LyX portable.
\end_layout
\begin_layout Subsection
-
Changing the Preamble
\end_layout
\begin_layout Standard
-
The commands which LyX adds to the preamble of a LaTeX file are fixed; you
can't change them without patching LyX itself.
- You can, however, add your own stuff to the preamble.
- There are two ways to do this:
-\end_layout
+ You can, however, add your own stuff to the preamble by selecting
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Enumerate
+\begin_layout Plain Layout
+LaTeX
+\begin_inset space ~
+\end_inset
-Select
-\family sans
-\bar under
-L
-\bar default
-aTeX\InsetSpace ~
+Preamble
+\end_layout
-\bar under
-P
-\bar default
-reamble
-\family default
- from the
-\family sans
-\bar under
-D
-\bar default
-ocument
-\family default
- menu, or via the
-\family sans
-\bar under
-D
-\bar default
-ocument
-\family default
-\SpecialChar \menuseparator
+\end_inset
-\family sans
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog, depending on your frontend.
- Note that the LyX keybindings will not work in this dialog, alas.
-\end_layout
+ in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Enumerate
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
-Use the preamble contents you've added as your default template (see
-\begin_inset Quotes eld
\end_inset
-Basic LyX Setup
-\begin_inset Quotes erd
-\end_inset
+ dialog.
+ LyX adds anything in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
- in the
-\emph on
-User's Guide
-\emph default
-), so that it will be the default preamble for any file you create.
+\begin_layout Plain Layout
+Preamble
\end_layout
-\begin_layout Standard
+\end_inset
-LyX adds anything in the
-\family sans
-\bar under
-P
-\bar default
-reamble
-\family default
dialog to its own built-in preamble.
Before adding your own declarations in the preamble, you should make sure
- that LyX doesn't already support what you want to do (remember what we
- said about reinventing the wheel?).
- Also,
+ that LyX doesn't already support what you want to do.
+ (Remember what we said about reinventing the wheel?) Also,
\emph on
make sure your preamble code is correct
\emph default
.
- LyX doesn't check it.
+ LyX doesn't check it for you.
+ If there is an error, you're likely to get an error like
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Missing
+\backslash
+begin{document}
\end_layout
-\begin_layout Subsection
+\end_inset
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ If you see this error, check your preamble.
+\end_layout
+
+\begin_layout Subsection
Examples
\end_layout
\begin_layout Standard
-
Here are some examples of what you can add to a preamble, and what they
- do:
+ do.
\end_layout
\begin_layout Subsubsection
-
Example #1: Offsets
\end_layout
\begin_layout Standard
-
There are two variables under LaTeX that control page position:
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
+\end_layout
+
+\end_inset
+
.
Their names should be self-explanatory.
These variables are useful if you think for a moment about computer labels.
Sometimes, the size of a print medium and the area of the medium that you
can actually print on aren't the same.
This is where
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
+\end_layout
+
+\end_inset
+
come in.
\end_layout
\begin_layout Standard
-
The default values for
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
- are both 0 pt.,\InsetSpace ~
-i.\InsetSpace ~
-e.\InsetSpace ~
-the page isn't shifted.
\end_layout
-\begin_layout Standard
+\end_inset
+
+ are both 0
+\begin_inset space \thinspace{}
+\end_inset
+
+points, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
-Unfortunately, some DVI drivers always seem to shift the page.
+the page isn't shifted.
+ Unfortunately, some DVI drivers always seem to shift the page.
We have no idea why, or why the sysadmin hasn't fixed such behavior.
If you're using LyX on a system that you don't personally maintain, and
your sysadmin is a doofus,
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
hoffset
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
voffset
-\family default
+\end_layout
+
+\end_inset
+
can save the day.
- Suppose you're left and top margins are always 0.5 inches too big.
+ Suppose you're left and top margins are always 0.5
+\begin_inset space \thinspace{}
+\end_inset
+
+inches too big.
You can add this to the preamble:
\end_layout
\begin_layout LyX-Code
-
\backslash
setlength{
\backslash
\begin_layout LyX-Code
-
\backslash
setlength{
\backslash
\end_layout
\begin_layout Standard
-
-\SpecialChar \ldots{}
and your margins should now be correct.
\end_layout
\begin_layout Subsubsection
-
Example #2: Labels
\end_layout
\begin_layout Standard
-
Speaking of labels, suppose you wanted to print out a bunch of address labels.
There's a rather nice package, available at your nearest CTAN archive,
- for printing sheets of labels, called
-\family typewriter
+ for printing sheets of labels:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
labels.sty
-\family default
+\end_layout
+
+\end_inset
+
.
Now, your system may not have this package installed by default.
We leave that up to you to check.
\end_layout
\begin_layout Standard
-
First, make sure you're using the
-\family sans
-article
-\family default
-document class.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article
+\end_layout
+
+\end_inset
+
+ document class.
Next, you need to put the following in your preamble:
\end_layout
\begin_layout LyX-Code
-
\backslash
usepackage{labels}
\end_layout
\begin_layout LyX-Code
-
\backslash
LabelCols=3
\end_layout
\begin_layout LyX-Code
-
\backslash
LabelRows=7
\end_layout
\begin_layout LyX-Code
-
\backslash
LeftBorder=8mm
\end_layout
\begin_layout LyX-Code
-
\backslash
RightBorder=8mm
\end_layout
\begin_layout LyX-Code
-
\backslash
TopBorder=9mm
\end_layout
\begin_layout LyX-Code
-
\backslash
BottomBorder=2mm
\end_layout
\begin_layout Standard
-
-This sets things up for Avery® label sheets, stock #5360.
+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
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
begin{labels}
-\family default
+\end_layout
+
+\end_inset
+
and
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
end{labels}
-\family default
+\end_layout
+
+\end_inset
+
around each label text.
This and other special features of
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
labels.sty
-\family default
+\end_layout
+
+\end_inset
+
are explained in its documentation.
\end_layout
\begin_layout Standard
-
Someday, someone may write a LyX layout file to support this package directly.
Maybe that someone is you.
\end_layout
\begin_layout Subsubsection
-
Example #3: Paragraph Indentation
\end_layout
\begin_layout Standard
-
Americans are trained to indent the first line of
\emph on
every
paragraph.
As with all of their other weird quirks, most Americans will whine and
moan until they can have their way and indent the first line of all paragraphs.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-Note from
-\noun on
-John Weiss
-\noun default
-: This was written by an American ---
+ (Yes, we're joking.
+ (We are?)
\emph on
-me
+Yeah
\emph default
-! It's my perception of my fellow countrymen.
- Tough if you don't like it.
- Thpbpbpbpbpbpbpbp!
-\end_layout
-
-\end_inset
-
-
+, we are.)
\end_layout
\begin_layout Standard
-
Of course, this behavior isn't standard typography.
In books, you typically only indent the first line of a paragraph
\emph on
it follows another one.
The idea behind indenting the first line of a paragraph is to distinguish
neighboring paragraphs from one another.
- If there is no previous paragraph, for example, it follows a figure, or
- is the first paragraph in a section, then there is no special indentation.
+ If there is no previous paragraph—for example, if it follows a figure or
+ is the first paragraph in a section—then there is no need for indentation.
\end_layout
\begin_layout Standard
-
-If you're a typical American, though, you don't care about such esoteric
- things; you want your indentation! Add this to the preamble:
+If you're a typical American (we're still joking!), though, you don't care
+ about such esoteric things; you want your indentation! Add this to the
+ preamble:
\end_layout
\begin_layout LyX-Code
-
\backslash
usepackage{indentfirst}
\end_layout
\begin_layout Standard
-
-If your TeX distribution isn't a braindead one, you'll have this package,
- and all of your paragraphs will get the indentation you think they deserve.
+If your TeX distribution isn't braindead, you'll have this package, and
+ all of your paragraphs will get the indentation the Founding Fathers intended
+ they should have.
\end_layout
\begin_layout Subsubsection
-
Example #4: This Document
\end_layout
\begin_layout Standard
-
You can also check out the preamble of this document to get an idea of some
of the advanced things you can do.
- You'll probably need to make the
-\family sans
-\bar under
-P
-\bar default
-reamble\SpecialChar \ldots{}
-
-\family default
- dialog full-screen to see most of it.
Also, there are more examples and an assortment of LaTeX
\begin_inset Quotes eld
\end_inset
\begin_inset Quotes erd
\end_inset
- given in Chapter\InsetSpace ~
+ given in Chapter
+\begin_inset space ~
+\end_inset
+
-\begin_inset LatexCommand \ref{cha:secrets}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "cha:secrets"
\end_inset
\end_layout
\begin_layout Section
-
LyX and LaTeX Errors
\end_layout
\begin_layout Standard
-
When LyX calls LaTeX, it tells LaTeX to blithely ignore any errors and keep
going.
- It then uses the log-file from the LaTeX run to do a post-mortem.
- As we stated earlier in the chapter, LyX generates two kinds of
-\family typewriter
-.tex
-\family default
- files, one of which it uses to locate errors in the document.
- If there was an error someplace, LyX will put a box with the word
-\begin_inset Quotes eld
-\end_inset
-
-Error
-\begin_inset Quotes erd
-\end_inset
-
- at the appropriate place in the document.
+ It then uses the logfile from the LaTeX run to do a post-mortem.
+ After analyzing the logfile,LyX displays a dialog listing the errors.
+ Clicking on any one of them will take you to the position in your LyX file
+ where the error occurred.
\begin_inset Foot
status collapsed
-\begin_layout Standard
-
-LyX will occasionally misguess where the error was.
- This will typically happen with tables, figures, math, and the preamble.
+\begin_layout Plain Layout
+Well, usually.
+ Analyzing the logfile is a tough job, and LyX doesn't always go to the
+ right line.
+ There are also cases where LaTeX reports the error on one line, but the
+ actual error is earlier.
+ This is not unlike forgetting a closing brace in a program: You'll get
+ an error, but only later.
\end_layout
\end_inset
- It will also display a message alerting you to the fact that there were
- errors.
+
\end_layout
\begin_layout Standard
+Some folks also like to look at the log file directly: It is available from
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-You can navigate through the errors by using
-\family sans
-\bar under
-E
-\bar default
-rror
-\family default
- in the
-\family sans
+\begin_layout Plain Layout
+Document
\bar under
-N
-\bar default
-avigate
-\family default
- menu.
- You can
-\begin_inset Quotes eld
-\end_inset
+\SpecialChar \menuseparator
-open
-\begin_inset Quotes erd
+\bar default
+Latex
+\begin_inset space ~
\end_inset
- the error-boxes and view the error message LaTeX produced by clicking on
- it.
+Log
\end_layout
-\begin_layout Standard
-
-Some folks also like to look at the log file directly, accessible from
-\family sans
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+\end_inset
-\bar under
-L
-\bar default
-aTeX\InsetSpace ~
-Log\InsetSpace ~
-File
-\family default
.
There are some fairly common error messages and warnings.
We'll cover those here.
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+LaTeX Warning
+\end_layout
-\begin_inset Quotes eld
\end_inset
-\family typewriter
-LaTeX Warning:
-\family default
-
-\begin_inset Quotes eld
+\begin_inset Newline newline
\end_inset
-
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
-Anything beginning with these word is a warning message for the purpose
+Anything beginning with these words is a warning message for the purpose
of
\begin_inset Quotes eld
\end_inset
You'll get messages like this if you added or changed cross-references
or bibliography entries, in which case, LaTeX is trying to tell you that
you need to make another run.
+ You can by-and-large ignore these.
\end_layout
-\begin_layout Standard
-
-You can by-and-large ignore these.
-\end_layout
-\end_deeper
\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+LaTeX Font Warning
+\end_layout
-\begin_inset Quotes eld
\end_inset
-\family typewriter
-LaTeX Font Warning:
-\family default
-
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
-
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
Another warning message, this time about fonts which LaTeX couldn't find.
The rest of the message will often say something about a replacement font
that LaTeX used.
+ You can safely ignore these, too.
\end_layout
-\begin_layout Standard
-
-You can safely ignore these.
-\end_layout
-\end_deeper
\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
+\begin_layout Plain Layout
Overfull
\backslash
hbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
LaTeX absolutely
\emph on
loves
\emph default
to spew these out.
- They are warning you about lines that were too long and run past the right
+ They are warnings about lines that were too long and run past the right
margin.
Almost always, this is unnoticeable in the final output.
- Or, only one or two characters extend past the margin.
+ (It can be just a point or two.) Or, only one or two characters extend past
+ the margin.
LaTeX seems to generate at least one of these messages for just about any
document you write.
-\end_layout
-
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
-You can ignore these stupid messages.
+You can ignore these messages.
Your eyes will tell you if there's a problem with something that's too
wide; just look at the output.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+You can also enable the `draft' option in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document
+\bar under
+\SpecialChar \menuseparator
+
+\bar default
+Settings
\end_layout
-\end_deeper
-\begin_layout Itemize
+\end_inset
+
+, and then LaTeX will draw a black box in the margin of lines that are overfull.
+\end_layout
-\begin_inset Quotes eld
\end_inset
-\family typewriter
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
Underfull
\backslash
hbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
Not quite as common as its cousin.
LaTeX seems to like to print lines that are a bit too wide as opposed to
We have no idea why.
\end_layout
-\begin_layout Standard
-
-You can ignore these, too.
-\end_layout
-\end_deeper
\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
-
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
+\begin_layout Plain Layout
Overfull
\backslash
vbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
and
-\begin_inset Quotes eld
-\end_inset
-
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
Underfull
\backslash
vbox
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
Warnings about troubles breaking the page.
Once again, just look at the output.
Your eyes will tell you where something has gone wrong.
\end_layout
-\end_deeper
-\begin_layout Itemize
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-LaTeX Error: File
+\begin_layout Plain Layout
+ LaTeX Error: File
\begin_inset Quotes els
\end_inset
\end_inset
not found
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
-\end_layout
-\begin_deeper
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
The file
\begin_inset Quotes eld
isn't installed on this system.
This usually appears because some package your document needs isn't installed.
If you didn't touch the preamble or didn't use the
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
usepackage{}
-\family default
+\end_layout
+
+\end_inset
+
command, then one of the packages LyX tried to load is missing.
Use
-\family sans
-\bar under
-H
-\bar default
-elp\SpecialChar \menuseparator
-L
-\bar under
-a
-\bar default
-TeX Configuration
-\family default
-, to get a list of packages that LyX knows about.
- This file is updated whenever you reconfigure LyX (using
-\family sans
-\bar under
-T
-\bar default
-ools
-\bar under
-\SpecialChar \menuseparator
-R
-\bar default
-econfigure
-\family default
-) and tells you which packages have been detected and what they do.
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Help\SpecialChar \menuseparator
+LaTeX Configuration
\end_layout
-\begin_layout Standard
+\end_inset
-If you
-\emph on
-did
-\emph default
- use the
-\family typewriter
+ to get a list of packages that LyX knows about.
+ This file is updated whenever you reconfigure LyX (using
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-usepackage{}
-\family default
- command, and the package in question isn't installed, you'll need to install
- it yourself.
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Reconfigure
\end_layout
-\end_deeper
-\begin_layout Itemize
+\end_inset
-\begin_inset Quotes eld
+) and tells you which packages have been detected and what they do.
+\begin_inset Newline newline
\end_inset
+If you did use the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
-LaTeX Error: Unknown option
-\family default
+\begin_layout Plain Layout
+
+\backslash
+usepackage{}
+\end_layout
-\begin_inset Quotes erd
\end_inset
+ command and the package in question isn't installed, then you'll need to
+ install it yourself.
+\end_layout
+
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+LaTeX Error: Unknown option
\end_layout
-\begin_deeper
-\begin_layout Standard
+\end_inset
+
+
+\begin_inset Newline newline
+\end_inset
Error messages beginning with this are trying to tell you that you specified
a bad or undefined option to a package.
Check the package's documentation.
\end_layout
-\end_deeper
-\begin_layout Itemize
-
-
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
Undefined control sequence
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
If you've inserted LaTeX code into your document, but made a typo, you'll
get one of these.
You may have forgotten to load a package.
In any case, this error message usually means that you used an undefined
command.
+
\end_layout
-\end_deeper
-\begin_layout Standard
+\begin_layout Standard
There are other error and warning messages.
Some are self-explanatory.
These are usually LaTeX messages.
Others are downright cryptic.
- These are actually TeX error messages, and we really have
+ These are usually TeX error messages, and we really have
\emph on
no clue
\emph default
what they mean or how to decipher them.
+ No-one does.
\end_layout
\begin_layout Standard
-
There's a general sequence you should follow if you get error messages:
\end_layout
\begin_layout Enumerate
-
Look at the LaTeX code you inserted for typos.
\end_layout
\begin_layout Enumerate
-
-If there are no typos, check and see that you used the command(s) correctly.
+If there are no typos, check that you used the command(s) correctly.
\end_layout
\begin_layout Enumerate
+If you get a bunch of error boxes piled up at the very top of the document—and
+ especially if you see a
+\begin_inset Quotes eld
+\end_inset
+
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Missing
+\backslash
+begin{document}
+\end_layout
+
+\end_inset
-If you get a bunch of error boxes piled up at the very top of the document,
- it means that there are errors in the preamble.
+
+\begin_inset Quotes erd
+\end_inset
+
+ error—it means that there are errors in the preamble.
Start debugging your preamble.
\end_layout
\begin_layout Enumerate
-
If you didn't add anything to the preamble and didn't add any LaTeX code
to the document, the first suspect is your LaTeX distribution itself.
Check for missing packages and install them.
\end_layout
\begin_layout Enumerate
-
Okay, so there are no missing packages.
Did you use any of the fine-tuning options in LyX? Specifically, did you
misuse
\emph default
any of them, like trying to manually insert lots of
-\family sans
-Protected\InsetSpace ~
-Blank
-\family default
-s,
-\family sans
-Linebreak
-\family default
-s, or
-\family sans
-Pagebreak
-\family default
-s? Did you try to kludge something together with these instead of using
- the appropriate paragraph environment?
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Protected
+\begin_inset space ~
+\end_inset
+
+Blanks
\end_layout
-\begin_layout Enumerate
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Linebreaks
+\end_layout
+
+\end_inset
+
+, or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Pagebreaks
+\end_layout
+
+\end_inset
+? Did you try to kludge something together with these instead of using the
+ appropriate paragraph environment?
+\end_layout
+
+\begin_layout Enumerate
All right, you didn't use any of the fine-tuning options, you played by
the rules.
Did you try to pull a fancy maneuver? Did you do something funky inside
\end_layout
\begin_layout Enumerate
-
Do you have long sections of text where LaTeX cannot find a place to break
a line? By default, LaTeX is rather strict about how much extra inter-word
spacing it will add in order to break a line.
- 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_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
sloppypar
-\family default
+\end_layout
+
+\end_inset
+
to make LaTeX's line breaking more, well, sloppy.
\end_layout
\begin_layout Enumerate
-
Did you go overboard with the nesting? LyX (currently) doesn't check to
make sure you're in the limits for nesting environments.
If you nested a bunch of environments to the
\end_inset
level, that's the problem.
+ (The limit in LaTeX is five.)
\end_layout
\begin_layout Enumerate
-
-Okay, you didn't get any error messages, but your output looks whacked.
+Okay, you didn't get any error messages, but your output looks awful.
If you have a table or figure that's too wide or long for the page, you
need to:
\end_layout
\begin_deeper
\begin_layout Enumerate
-
rescale the figure so it fits.
\end_layout
\begin_layout Enumerate
-
trim down the table so it fits.
\end_layout
-\begin_layout Standard
-
+\end_deeper
+\begin_layout Enumerate
If something else is wrong with the output, and you didn't try to pull anything
fancy or kludge the fine-tuning options, we're not sure what's wrong.
\end_layout
-\end_deeper
-\begin_layout Standard
-If all this doesn't help --- well, then
+\begin_layout Standard
+If all this doesn't help—well, then
\emph on
perhaps
\emph default
you might have found a bug in LyX\SpecialChar \ldots{}
-
+.
\end_layout
\begin_layout Chapter
-
Supplemental Tools
\end_layout
\begin_layout Section
-
-Preparing a Bibliography with BibTeX
+Customizing Bibliographies with BibTeX
\end_layout
\begin_layout Standard
+The basics how to use BibTeX are explained in section
+\emph on
+Bibliography databases (BibTeX)
+\emph default
+ of the
+\emph on
+User's Guide
+\emph default
+.
+ The following subsections explain special bibliography features supported
+ by LyX.
+\end_layout
-by
-\noun on
-Mike Ressler
+\begin_layout Subsection
+Alternative Citation Styles
\end_layout
\begin_layout Standard
+Standard BibTeX uses numbers (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_inset VSpace bigskip
+
+\begin_inset Quotes eld
\end_inset
+[12]
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+) 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.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-\noindent
-STOP! If you don't know what BibTeX is, or have a reasonably good idea of
- how to use it (
-\emph on
-e.g.
-\emph default
- setting up your own bibliographic databases),
-\emph on
-run
-\emph default
-, do not walk, to your nearest copy of the 2nd edition of Lamport's
-\emph on
-LaTeX: A Document Preparation System
-\emph default
-, particularly Appendix B.
- The rest of this discussion assumes you have created a correct bibliography
- file, that you have all relevant environment variables set correctly (esp.
-
-\family typewriter
-BIBINPUTS
-\family default
-,
-\family typewriter
-BSTINPUTS
-\family default
-, and
-\family typewriter
-TEXINPUTS
-\family default
-), and that if sufficiently desperate, you could create and
\begin_inset Quotes eld
\end_inset
-TeX
+Knuth 1984a
\begin_inset Quotes erd
\end_inset
- a LaTeX file with a BibTeX database.
-
+).
+ LyX supports two packages that provide this style,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+natbib
\end_layout
-\begin_layout Standard
+\end_inset
-For those who don't know what BibTeX is, it is a system for creating a large
- database of your most used journal references.
- For all future articles you write, you only need to include this standard
- database and reference the appropriate key to each reference.
- Even if you write only a few papers with handful of references each, it
- is well worth your time to examine BibTeX and decide whether it will be
- useful to you.
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+jurabib
\end_layout
-\begin_layout Standard
+\end_inset
-To use BibTeX with LyX, first read the
-\emph on
-User Guide
-\emph default
- where it describes how to insert citations.
- The basic mechanism for inserting BibTeX references is the same.
- Then, at the very end of your document, select
-\family sans
-Insert\SpecialChar \menuseparator
-List
-\family default
- /
-\family sans
-TOC\SpecialChar \menuseparator
-BibTeX Reference
-\family default
.
- In the resulting dialog, fill out the dialog boxes as follows:
-\end_layout
-
-\begin_layout Description
+ Both packages have their pros and cons, which cannot be listed in detail.
+ If you only want to have simple author-year (or author-numerical) style,
+ or if you want to use one of the countless style files for
+\begin_inset Flex CharStyle:Code
+status collapsed
-Database: enter the name of your
-\family typewriter
-.bib
-\family default
- file
-\emph on
-without
-\emph default
- the
-\family typewriter
-.bib
-\family default
- extension.
- For searching multiple
-\family typewriter
-.bib
-\family default
- files, just enter them in the desired order, separated by commas.
-
+\begin_layout Plain Layout
+natbib
\end_layout
-\begin_layout Description
+\end_inset
-Style: enter the name of your BibTeX style file *without* the
-\family typewriter
-.bst
-\family default
- extension.
- The default style is
-\family typewriter
-plain
-\family default
- (which should be included in your LaTeX distribution, so you don't have
- to worry about creating it).
-\end_layout
+, than the established
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+natbib
+\end_layout
-For each citation, assuming that the source is in the
-\family typewriter
-.bib
-\family default
- file, just call
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+\end_inset
-\bar under
-C
-\bar default
-itation Reference
-\family default
- at the correct location in the text, and enter the appropriate reference
- key.
- Nothing else is required; when invoking
-\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
+ package is probably your choice.
+ If you need special features like short title references, ibidem etc., you
+ might consider the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\bar under
-D
-\bar default
-VI
-\family default
-, for example, you should see that BibTex and LaTeX are invoked as needed,
- including multiple invocations of LaTeX.
-
+\begin_layout Plain Layout
+jurabib
\end_layout
-\begin_layout Section
+\end_inset
-Making an Index
+ package.
\end_layout
\begin_layout Standard
+The handling of both packages in LyX is basically the same.
+ Go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-A good index is one of the hardest things to make in a lengthy document,
- but LyX helps make things a bit simpler by interfacing to the
-\family typewriter
-makeindex
-\family default
- program which is found in most recent LaTeX distributions.
- Inserting an index and marking words to include in it works much the same
- way as preparing a bibliography as mentioned in the last section.
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
-\begin_layout Standard
-
-First, go to the end of your file and select
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-List
-\family default
-\InsetSpace ~
-/\InsetSpace ~
-
-\family sans
-T
-\bar under
-O
-\bar default
-C\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ndex
-\family default
-\InsetSpace ~
-
-\family sans
-List
-\family default
-.
- Then, for each word you would like to include in the index, go to the end
- of that word and click on
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-ndex
-\family default
-\InsetSpace ~
-
-\family sans
-Entry
-\family default
-.
- This will insert a tag showing the word as it will appear in the index.
- That's all there is to it; LyX will automatically call
-\family typewriter
-makeindex
-\family default
- for you and create the index itself.
- The text in the dialog available from right-clicking on the index button
- accepts LaTeX, so you'll need to be careful to avoid using any special
- characters.
- On the positive side, you can use the advanced options - have a look at
- the documentation which comes with your LaTeX distribution to find out
- how to do things like
-\begin_inset Quotes eld
-\end_inset
-
-nested entries
-\begin_inset Quotes erd
\end_inset
-, etc.
-\end_layout
-
-\begin_layout Standard
+ and select under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-Be careful not to put spaces between the word in the text and the index
- marker; apparently the wrong page number can be produced if this happens.
+\begin_layout Plain Layout
+Bibliography
\end_layout
-\begin_layout Section
-
-Multipart Documents
-\end_layout
+\end_inset
-\begin_layout Subsection
+ the option
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-General Operation
+\begin_layout Plain Layout
+Natbib
\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
-\family typewriter
-
-\backslash
-begin{document}
-\family default
- line as well as the
-\family typewriter
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-end{document}
-\family default
- line must be deleted) or else errors will be generated when you try to
- make a DVI file.
+\begin_layout Plain Layout
+Jurabib
\end_layout
-\begin_layout Standard
+\end_inset
-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
+ With both packages, you will get some extra features in the citation dialog
+ and you can select the style of the reference (
\begin_inset Quotes eld
\end_inset
-include
+Knuth 1984
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-input
+Knuth (1984)
\begin_inset Quotes erd
\end_inset
-, and
+,
\begin_inset Quotes eld
\end_inset
-verbatim
+Knuth, 1984
\begin_inset Quotes erd
\end_inset
-.
- The difference between
+,
\begin_inset Quotes eld
\end_inset
-include
+1984
\begin_inset Quotes erd
\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+ etc.).
+ Note that both packages need specifically designed style files.
+ They both ship their own, but there are lots of additional style files,
+ and there is even an interactive style file builder
+\begin_inset Foot
+status collapsed
-input
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
+See
+\begin_inset Flex URL
+status open
- is really only meaningful to LaTeXperts, but the practical difference is
- that files which are
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-included
-\begin_inset Quotes erd
-\end_inset
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
+\end_layout
- 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
+\end_inset
-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 ~
+ for
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-typeset
-\family default
- button prevents this conversion.
+\begin_layout Plain Layout
+natbib
\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.
-
-\emph on
-
+.
\end_layout
\begin_layout Subsection
-
-Cross-References Between Files
+Sectioned Bibliographies
\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
+Sometimes you might need to divide your bibliography into several sections.
+ If you are for instance a historian, the possibility to separate sources
+ and scientific works is most likely a
\begin_inset Quotes eld
\end_inset
-buffer
+must have
\begin_inset Quotes erd
\end_inset
- to use.
-\end_layout
-
-\begin_layout Section
-
-Algorithms
+.
+ Unfortunately, BibTeX itself does not allow you to do this.
+ But with the help of some LaTeX packages, BibTeX can be extended to fit
+ your needs.
\end_layout
\begin_layout Standard
-
-The package
-\family sans
-algorithm
+LyX provides native support for one of these packages,
+\family typewriter
+bibtopic
\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.
-\end_layout
-
-\begin_layout Section
+.
+\begin_inset Foot
+status collapsed
-Subfigures
-\end_layout
+\begin_layout Plain Layout
+Available from
+\begin_inset Flex URL
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
-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.
+ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
\end_layout
-\begin_layout Section
+\end_inset
+
-Fancy Headers and Footers
\end_layout
-\begin_layout Standard
+\end_inset
-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
+ The advantage of this package (compared to other packages like
+\family typewriter
+multibib
+\family default
+) is that you don't need to define new citation commands.
+ Instead, you need to prepare different bibliographic databases which include
+ the entries for the different sections of the bibliography.
+ For example: If you want to divide your bibliography into the sections
+
\begin_inset Quotes eld
\end_inset
-fancy
+Sources
\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
+ and
\begin_inset Quotes eld
\end_inset
-left
+Scientific works
\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Quotes eld
+, you first need to create two bibliographic databases, e.
+\begin_inset space \thinspace{}
\end_inset
-center
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-, and
-\begin_inset Quotes eld
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+sources.bib
+\end_layout
+
\end_inset
-right
-\begin_inset Quotes erd
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+scientific.bib
+\end_layout
+
\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
+
+\end_layout
-\backslash
-lhead
-\family default
-,
-\family typewriter
+\begin_layout Standard
+Go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-chead
-\family default
-,
-\family typewriter
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
-\backslash
-rhead
-\family default
-,
-\family typewriter
+\end_inset
-\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
+ and check under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+Bibliography
+\end_layout
+\end_inset
-\family typewriter
+ the option
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-lhead{John Q.
- DocWriter}
+\begin_layout Plain Layout
+Sectioned bibliography
\end_layout
-\begin_layout Standard
+\end_inset
-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.
-\end_layout
+.
+ Now you can insert multiple BibTeX bibliographies, one for each section
+ of your bibliography.
+ Returning to our example: Insert the BibTeX bibliography
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+sources.bib
+\end_layout
+\end_inset
-\family typewriter
+ and a second one for the database
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-cfoot{}
+\begin_layout Plain Layout
+scientific.bib
\end_layout
-\begin_layout Standard
+\end_inset
-Let's get really fancy: lets put the section number with the word
+.
+ You are free to use the same or different styles for each section.
+ Additionally, you can chose if the bibliography section should contain
+
\begin_inset Quotes eld
\end_inset
-Section
+all cited references
\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
+ of the specified database(s) (which is the default),
+\begin_inset Quotes eld
+\end_inset
+all uncited references
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+ or even
+\begin_inset Quotes eld
+\end_inset
-\backslash
-lhead{Section
-\backslash
-thesection}
-\end_layout
+all references
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+.
+ This might be useful if you would like to separate your bibliography into
+ three sections:
+\begin_inset Quotes eld
+\end_inset
+Cited sources
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+,
+\begin_inset Quotes eld
+\end_inset
-\backslash
-chead{}
-\end_layout
+Uncited sources
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+, and
+\begin_inset Quotes eld
+\end_inset
+Scientific works
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+.
+ The titles for the sections can be added as ordinary sections or subsections.
+ Since
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-rhead{Page
-\backslash
-thepage}
+\begin_layout Plain Layout
+bibtopic
\end_layout
-\begin_layout Standard
-
+\end_inset
-\family typewriter
+ removes the bibliography title, you have manually re-add that, too (as
+ a chapter* or section*, for instance).
+\end_layout
-\backslash
-lfoot{John Q.
- DocWriter}
+\begin_layout Subsection
+Multiple Bibliographies
\end_layout
\begin_layout Standard
+Multiple bibliographies, e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\family typewriter
+a bibliography for each section or chapter of the document, are not supported
+ by BibTeX itself.
+ But the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-cfoot{}
+\begin_layout Plain Layout
+bibtopic
\end_layout
-\begin_layout Standard
-
+\end_inset
-\family typewriter
+ package, which is used for the creation of sectioned bibliographies in
+ LyX (see the previous section), provides an easy way to solve this task,
+ if you are willing to use some
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-rfoot{
-\backslash
-today}
+\begin_layout Plain Layout
+TeX Code
\end_layout
-\begin_layout Standard
-
-The codes
-\family typewriter
+\end_inset
-\backslash
-thesection
-\family default
- and
-\family typewriter
+ (see section
+\begin_inset space ~
+\end_inset
-\backslash
-thepage
-\family default
- access LaTeX's section and page counters, and so print out the current
- section and page numbers.
-
-\family typewriter
-\backslash
-today
-\family default
- simply prints out today's date.
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
-\begin_layout Standard
+\end_inset
-The thicknesses of the horizontal rules drawn beneath the header and above
- the footer can also be modified.
- If you don't want one of the headers, set its thickness to 0.
- The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
- Use the commands, e.g.
-
-\family typewriter
+).
+\begin_inset Foot
+status collapsed
-\backslash
-renewcommand{
-\backslash
-headrulewidth}{0.4pt}
-\family default
- and
-\family typewriter
+\begin_layout Plain Layout
+An alternative approach is to use the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-renewcommand{
-\backslash
-footrulewidth}{0.4pt}
-\family default
- to set the thicknesses.
+\begin_layout Plain Layout
+chapterbib
\end_layout
-\begin_layout Standard
+\end_inset
-You can switch the header/footer settings on and off for individual pages
- using commands like
-\family typewriter
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-thispagestyle{empty}
-\family default
-,
-\family typewriter
+\begin_layout Plain Layout
+bibunits
+\end_layout
-\backslash
-thispagestyle{plain}
-\family default
-, and
-\family typewriter
+\end_inset
-\backslash
-thispagestyle{fancy}
-\family default
-.
- Simply insert them in the text on the page you want changed and mark them
- as TeX code.
- In fact, title pages are marked as plain by default, while following pages
- are marked fancy when using the global fancy setting.
+ package, respectively.
\end_layout
-\begin_layout Standard
+\end_inset
+
-There are more complex commands which will let you insert things in the
- upper left on odd numbered pages, etc., but I will refer you to the
-\family typewriter
-fancyhdr
-\family default
- package documentation for more descriptions.
- For example, if you have a teTeX installation, look for
-\family typewriter
-/usr/share/texmf/doc/latex/fancyhdr/\SpecialChar \-
-fancyhdr.dvi
-\family default
-.
\end_layout
\begin_layout Standard
+First go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-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
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
\end_layout
-\begin_layout Standard
-
+\end_inset
-\family typewriter
+ and under
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-lhead{
-\backslash
-resizebox{1in}{!}{
-\backslash
-includegraphics{logo.eps}}}
+\begin_layout Plain Layout
+Bibliography
\end_layout
-\begin_layout Standard
-\noindent
-(you may need to preface this with
-\family typewriter
+\end_inset
-\backslash
-usepackage{graphics}
-\family default
- if you don't include EPS files elsewhere in your document).
+ check
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Sectioned bibliography
\end_layout
-\begin_layout Section
+\end_inset
-Minipages
-\end_layout
+.
+ In the document, you have to enclose the sections, which shall contain
+ their own bibliography (including the BibTeX bibliography itself), between
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-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.
+\backslash
+begin{btUnit}
\end_layout
-\begin_layout Standard
+\end_inset
-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
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-This is a minipage which does not use hfill.
- This is the second sentence of a minipage which does not use hfill.
+\backslash
+end{btUnit}
\end_layout
\end_inset
+ (those commands have to be inserted as TeX code).
+ The bibliography will contain all references which have been cited in the
+ current
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+btUnit
\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
+\end_inset
-\begin_layout Standard
+.
+
+\series bold
+Note:
+\series default
+ If you are using this approach, then every citation reference has to be
+ inside some
+\begin_inset Flex CharStyle:Code
+status collapsed
-This is a second minipage which does not use hfill.
- This is the second sentence of a second minipage which does not use hfill.
+\begin_layout Plain Layout
+btUnit
\end_layout
\end_inset
+.
+ Also, the
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+btUnit
\end_layout
-
-\begin_layout Standard
-
-
-\begin_inset VSpace medskip
\end_inset
-
+s cannot be nested.
\end_layout
-\begin_layout Standard
-
-Here is some normal text to separate the two examples.
+\begin_layout Section
+Multipart Documents
\end_layout
-\begin_layout Standard
-
-
-\begin_inset VSpace medskip
-\end_inset
-
-
+\begin_layout Subsection
+General Operation
\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
-
+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
-
-\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
-
+master
+\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Section
-
-Wrapping Text Around Figures
-\begin_inset LatexCommand \label{sec:floatflt}
-
+ 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 (i.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
-
-\begin_layout Standard
-
-
-\begin_inset Wrap figure
-placement r
-width "6cm"
-status open
-
-\begin_layout Standard
+everything up to and including the
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\begin_inset Graphics
- filename mobius.eps
- display color
- width 40col%
- rotateOrigin center
+\backslash
+begin{document}
+\end_layout
\end_inset
+ line as well as the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\end_layout
-
-\begin_layout Caption
+\begin_layout Plain Layout
-This is a wrapped figure, and this is the brilliant caption that describes
- it
+\backslash
+end{document}
\end_layout
\end_inset
-
+ line must be deleted) or else errors will be generated when you try to
+ make a DVI file.
\end_layout
\begin_layout Standard
+LyX allows you to include files quite easily with
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-A very frequently asked question is whether text can be made to
-\begin_inset Quotes eld
-\end_inset
-
-wrap
-\begin_inset Quotes erd
+\begin_layout Plain Layout
+Insert\SpecialChar \menuseparator
+ChiId
+\begin_inset space ~
\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.
+Document
\end_layout
-\begin_layout Standard
+\end_inset
-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
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Flo
-\bar under
-a
-\bar default
-ts\SpecialChar \menuseparator
-Floatflt Figure
-\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
-
-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
+The file selection box should by now be obvious.
+ The three inclusion methods are
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-l
-\family default
-
+include
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-c
-\family default
-
+input
\begin_inset Quotes erd
\end_inset
-, or
+, and
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-r
-\family default
-
+verbatim
\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
+.
+ The difference between
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-p
-\family default
-
+include
\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
+ and
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-|
-\family default
-
+input
\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
+ is really only meaningful to LaTeXperts, but the practical difference is
+ that files which are
\begin_inset Quotes eld
\end_inset
-borders
+included
\begin_inset Quotes erd
\end_inset
- buttons.
- Finally, there is a type
+ are typeset beginning on a new page, while files which are
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-@
-\family default
-
+inputted
\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.
-\end_layout
-
-\begin_layout Subsection
-
-Removing Extra Column Space
+ are typeset starting on the current page.
\end_layout
\begin_layout Standard
-
-Here is a standard table:
+Generally, the master file is converted into a full LaTeX file before typesettin
+g, while the included files are converted to LaTeX files which do not have
+ all the preamble information.
\end_layout
\begin_layout Standard
-\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" leftline="true" width="0pt">
-<row bottomline="true">
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+A
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+verbatim
+\begin_inset Quotes erd
+\end_inset
+ included file allows you to include a file typeset exactly as it appears
+ in the file, i.
+\begin_inset space \thinspace{}
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Type
-\end_layout
-
+g.
+\begin_inset space \space{}
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Standard
+in
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Example
+\begin_layout Plain Layout
+verbatim
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+ 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
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+Mark
+\begin_inset space ~
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
-\end_layout
+spaces
+\begin_inset space ~
+\end_inset
+in
+\begin_inset space ~
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+output
+\end_layout
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
+ checkbox typesets a mark to unambiguously define the presence of a space.
+
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\begin_layout Subsection
+Cross-References Between Files
+\end_layout
\begin_layout Standard
+\begin_inset Box Shadowbox
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
+\begin_layout Plain Layout
+This section is somewhat out of date.
+ Need to describe default master documents and how children are opened when
+ the master is.
+ [[FIXME]]
\end_layout
\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
-Quartz
\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
-</cell>
-</row>
-</lyxtabular>
+buffer
+\begin_inset Quotes erd
\end_inset
-
+ to use.
\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:
+\begin_layout Subsection
+Bibliography Lists in all Subdocuments
\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">
-\begin_inset Text
-
-\begin_layout Standard
-
+\begin_inset Box Frameless
+position "t"
+hor_pos "c"
+has_inner_box 1
+inner_pos "t"
+use_parbox 0
+width "100col%"
+special "none"
+height "1in"
+height_special "totalheight"
+status open
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Type
+\begin_layout Plain Layout
+This section also needs updating.
+ There is now material about this on the wiki, and it could be copied here.
\end_layout
\end_inset
-</cell>
-<cell alignment="left" 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
-Example
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+Copy the bibliography list with all entries to all subdocuments and transform
+ them to a comment.
+ This way LyX will find the
+\begin_inset Flex CharStyle:Code
+status collapsed
-
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
+\begin_layout Plain Layout
+.bib
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+-files and you can easily insert references without making the bibliography
+ list visible.
+\end_layout
+\begin_layout Standard
+As the bibliography list is in a comment, LaTeX won't use use it and the
+ references will look like this: [?], instead of like this: [1].
+ One solution is to use the LaTeX-package
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
+\begin_layout Plain Layout
+comment
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+ that will only include comments by processing the files separately.
+ To do this, add in the LaTeX preamble of every subdocument the following:
+\end_layout
+\begin_layout LyX-Code
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
+\backslash
+usepackage{comment}
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+\begin_layout LyX-Code
+
+\backslash
+includecomment{comment}
+\end_layout
\begin_layout Standard
+See also
+\begin_inset Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
+http://wiki.lyx.org/FAQ/Unsorted#toc31
\end_layout
-\end_inset
-</cell>
-</row>
-</lyxtabular>
-
\end_inset
+.
+\end_layout
+\begin_layout Section
+Fancy Headers and Footers
\end_layout
\begin_layout Standard
+The default page layout is rather plain; for an
+\begin_inset Flex CharStyle:Code
+status collapsed
-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_layout Plain Layout
+article
+\end_layout
-\begin_inset Quotes erd
\end_inset
-, while the right column was set to
+ document class, all you get is a centered page number at the bottom of
+ the page.
+ This document uses KOMA-script's 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
-
-\family typewriter
-l @{}
-\family default
-
+fancy
\begin_inset Quotes erd
\end_inset
-, in order to put the null characters on the edges.
-
+, as mentioned in the
+\emph on
+User Guide
+\emph default
+.
+ This section describes the LaTeX code you need to insert in your LaTeX
+ preamble in order to get the desired effects.
\end_layout
-\begin_layout Subsection
+\begin_layout Standard
+For more information on fancy headers, see the
+\begin_inset Flex CharStyle:Code
+status collapsed
-Changing the Column Separator Character
+\begin_layout Plain Layout
+fancyhdr
\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
+ package documentation.
+ This can be found in the file
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+fancyhdr.dvi
+\end_layout
-\family typewriter
-@{~$
-\backslash
-sqrt{
-\backslash
-pi}$~} l
-\family default
+\end_inset
+
+, which should have been installed with your LaTeX distribution, or
+\begin_inset CommandInset href
+LatexCommand href
+name "online"
+target "http://www.ctan.org/tex-archive/macros/latex/contrib/fancyhdr/"
-\begin_inset Quotes erd
\end_inset
.
- You could now make a table like this:
\end_layout
\begin_layout Standard
-\align center
+The page header is divided into three fields, not surprisingly labeled
+\begin_inset Quotes eld
+\end_inset
-\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">
-\begin_inset Text
+left
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+,
+\begin_inset Quotes eld
+\end_inset
+center
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Type
+, 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
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+lhead
\end_layout
\end_inset
-</cell>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Example
+\backslash
+chead
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="left" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Rock
+\backslash
+rhead
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
+\backslash
+lfoot
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+
+, 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
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Mineral
+\backslash
+lhead{John Q.
+ DocWriter}
\end_layout
+\begin_layout Standard
+You will now see your name in the upper left.
+ If a field has a default entry that you would like to get rid of (often
+ the page number appears in the central footer, simply include a command
+ with a blank argument, e.
+\begin_inset space \thinspace{}
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+
+g.:
+\end_layout
\begin_layout Standard
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
+\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
-</cell>
-</row>
-</lyxtabular>
+ (e.
+\begin_inset space \thinspace{}
\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\end_layout
+Section 3) in the upper left, the page number (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
+g.
+\begin_inset space \space{}
+\end_inset
-Making a Decimal Point Aligned Column
+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
-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:
+\family typewriter
+
+\backslash
+lhead{Section
+\backslash
+thesection}
\end_layout
\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
+\family typewriter
+
+\backslash
+chead{}
+\end_layout
\begin_layout Standard
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Expression
+\backslash
+rhead{Page
+\backslash
+thepage}
\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 typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Value
+\backslash
+lfoot{John Q.
+ DocWriter}
\end_layout
-\end_inset
-</cell>
-<cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-\end_layout
+\family typewriter
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+\backslash
+cfoot{}
+\end_layout
\begin_layout Standard
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
+\backslash
+rfoot{
+\backslash
+today}
+\end_layout
-\begin_inset Formula $\pi$
-\end_inset
+\begin_layout Standard
+The commands
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+\backslash
+thesection
\end_layout
\end_inset
-</cell>
-<cell alignment="right" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-3.
+\backslash
+thepage
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Standard
+ access LaTeX's section and page counters, and so print out the current
+ section and page numbers.
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-1416
+\begin_layout Plain Layout
+
+\backslash
+today
\end_layout
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
+
+ simply prints out today's date.
+\end_layout
\begin_layout Standard
+The thicknesses of the horizontal rules drawn beneath the header and above
+ the footer can also be modified.
+ If you don't want one of the rules, set its thickness to 0.
+ The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
+ Use commands
+\family typewriter
+
+\family default
+like
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
+\backslash
+renewcommand{
+\backslash
+headrulewidth}{0.4pt}
+\end_layout
-\begin_inset Formula $\pi^{\pi}$
\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\backslash
+renewcommand{
+\backslash
+footrulewidth}{0.4pt}
\end_layout
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
-\begin_inset Text
+
+ to set the thicknesses.
+\end_layout
+
+\begin_layout Standard
+You can switch the header/footer settings on and off for individual pages
+ using commands like
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thispagestyle{empty}
+\end_layout
+
+\end_inset
+
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thispagestyle{plain}
+\end_layout
+
+\end_inset
+
+, and
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+
+\backslash
+thispagestyle{fancy}
+\end_layout
+
+\end_inset
+
+.
+ Simply insert them in the text on the page you want changed and mark them
+ as TeX code.
+ In fact, title pages are marked as plain by default, while following pages
+ are marked fancy when using the global fancy setting.
+\end_layout
+
+\begin_layout Standard
+As a final example, it is possible to include an image in the header or
+ footer.
+ Suppose you want to put a company logo in the upper lefthand corner.
+ You might try something like
+\end_layout
+
+\begin_layout Standard
+
+\family typewriter
+
+\backslash
+lhead{
+\backslash
+resizebox{1in}{!}{
+\backslash
+includegraphics{logo.eps}}}
+\end_layout
+
+\begin_layout Standard
+\noindent
+(you may need to preface this with
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+\noindent
+
+\backslash
+usepackage{graphics}
+\end_layout
+
+\end_inset
+
+ if you don't include graphics elsewhere in your document).
+\end_layout
+
+\begin_layout Section
+Itemize Bullet Selection
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:bullet"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+ Allan Rae
+\end_layout
+
+\begin_layout Subsection
+Introduction
+\end_layout
+
+\begin_layout Standard
+LyX provides 216 bullet shapes that can be accessed from a simple dialog.
+ Using this dialog you can easily specify what bullet shape to use at each
+ level of an itemized list.
+ 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 Plain Layout
+Well, actually you can but you'll have to do it by hand.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
+How it looks
+\end_layout
+
+\begin_layout Standard
+Open the dialog by selecting the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Document\SpecialChar \menuseparator
+Settings
+\end_layout
+
+\end_inset
+
+ menu item and then select the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Bullets
+\end_layout
+
+\end_inset
+
+ tab.
+\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.
+\end_layout
+
+\begin_layout Standard
+The six panels are divided up by the packages they require.
+ The following table shows the mappings from button name to LaTeX packages.
+\end_layout
\begin_layout Standard
+\align center
+\begin_inset Tabular
+<lyxtabular version="3" rows="7" columns="2">
+<features tabularvalignment="middle">
+<column alignment="center" valignment="top" width="0pt">
+<column alignment="center" valignment="top" width="0pt">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
+\begin_inset Text
+\begin_layout Plain Layout
\family roman
\series medium
\bar no
\noun off
\color none
-36.
+Button
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
\family roman
\series medium
\bar no
\noun off
\color none
-462
+Packages Required
\end_layout
\end_inset
</cell>
</row>
<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-
-\begin_inset Formula $(\pi^{\pi})^{\pi}$
-\end_inset
-
-
+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
-
+\begin_layout Plain Layout
-\family roman
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-80663.
-\end_layout
-
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
-\begin_layout Standard
-
+base LaTeX
\end_layout
\end_inset
</cell>
</row>
<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-
-\begin_inset Formula $\pi^{\pi^{\pi}}$
-\end_inset
-
-
+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
-
+\begin_layout Plain Layout
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-1.
+amssymb.sty
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
+</row>
+<row>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-3402
-\begin_inset Formula $\times10^{18}$
-\end_inset
-
-
+Ding1
\end_layout
\end_inset
</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-
-Though it appears a bit funny in LyX, on paper it will produce what appears
- to be a 2-column table in which the right column is aligned on the decimal
- point and the header appears to be centered over it.
-\end_layout
-
-\begin_layout Standard
-
-Perhaps it is best if I described just what I did: first, create a 3
-\begin_inset Formula $\times$
-\end_inset
-
-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
-\family sans
-center
-\family default
-.
- Type in the
-\family typewriter
-3.
-\family default
-,
-\family typewriter
-36.
-\family default
-,
-\family typewriter
-80663.
-\family default
-, and
-\family typewriter
-1.
-
-\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}$
-\end_inset
-
-
-\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
-\family sans
-Special Cell
-\family default
- entry
-\family sans
-multicolumn
-\family default
-.
- Easy, right?
-\end_layout
-
-\begin_layout Subsection
-
-A Better Decimal-Alignment Solution
-\end_layout
-
-\begin_layout Standard
-
-An alternative way to have decimal alignment in tables is through the
-\family typewriter
-dcolumn
-\family default
- package.
- Add the following to the LateX preamble:
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-usepackage{dcolumn}
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-newcolumntype{d}[1]{D{.}{.}{#1}}
-\end_layout
-
-\begin_layout Standard
-
-To have a column decimally aligned, enter in the
-\family sans
-Special Column Alignment
-\family default
- box of the
-\family sans
-Table
-\family default
- dialog the following:
-\end_layout
-
-\begin_layout LyX-Code
-
-d{number of decimals of the data}
-\end_layout
-
-\begin_layout Standard
-
-To create extra column space just increase the number of decimals in
-\family typewriter
-d{}
-\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.
-\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:
-\end_layout
-
-\begin_layout LyX-Code
-
-D{inputsep}{outputsep}{decimal places}
-\end_layout
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
-\begin_layout Standard
+\begin_layout Plain Layout
-The interested reader is directed towards the
\family typewriter
-dcolumn
-\family default
- package documentation for more details.
-\end_layout
-
-\begin_layout Section
-
-Itemize Bullet Selection
-\begin_inset LatexCommand \label{sec:bullet}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-
-by
-\noun on
- Allan Rae
-\end_layout
-
-\begin_layout Subsection
-
-Introduction
-\end_layout
-
-\begin_layout Standard
-
-LyX provides 216 bullet shapes that can be accessed from a simple dialog.
- Using this dialog you can easily specify what bullet shape to use at each
- level of an itemized list.
- 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
-
-Well, actually you can but you'll have to do it by hand.
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+pifont.sty
\end_layout
\end_inset
-
-.
-\end_layout
-
-\begin_layout Subsection
-
-How it looks
-\end_layout
-
-\begin_layout Standard
-
-Open the dialog by selecting the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\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.
-\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.
-\end_layout
-
-\begin_layout Standard
-
-The six panels are divided up by the packages they require.
- The following table shows the mappings from button name to LaTeX packages.
-\end_layout
-
-\begin_layout Standard
-\align center
-
-\begin_inset Tabular
-<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>
+</row>
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
-\family roman
+\family sans
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Button
+Ding2
\end_layout
\end_inset
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
-\family roman
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-Packages Required
+pifont.sty
\end_layout
\end_inset
</cell>
</row>
-<row topline="true">
+<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
\family sans
\series medium
\bar no
\noun off
\color none
-Standard
+Ding3
\end_layout
\end_inset
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
+\family typewriter
\series medium
\shape up
\size normal
\bar no
\noun off
\color none
-base LaTeX
+pifont.sty
\end_layout
\end_inset
</cell>
</row>
-<row topline="true">
-<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+<row>
+<cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
\begin_inset Text
-\begin_layout Standard
-
+\begin_layout Plain Layout
\family sans
\series medium
\bar no
\noun off
\color none
-Maths
+Ding4
\end_layout
\end_inset
</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+<cell alignment="center" valignment="top" topline="true" bottomline="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
-amssymb.sty
-\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
-
-
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding1
-\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
-\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
-
-
-\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
-
+\begin_layout Plain Layout
\family typewriter
\series medium
\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
-Ding3
-\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
-\end_layout
+</lyxtabular>
\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 Standard
-\family sans
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Ding4
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
-\begin_inset Text
-
\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
+ it is likely you are missing a package.
+\begin_inset Foot
+status collapsed
-
-\family typewriter
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-pifont.sty
+\begin_layout Plain Layout
+LyX doesn't restrict your use since you may be editing locally and exporting
+ elsewhere.
\end_layout
\end_inset
-</cell>
-</row>
-</lyxtabular>
-
-\end_inset
-
-
-\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
\begin_layout Subsection
-
How to use it
\end_layout
\begin_layout Standard
-
Select which bullet depth you want to change then select the bullet shape
and size.
-
-\family sans
-
-\family default
-Any changes will not be visible in LyX, but are visible when viewing the
- document using xdvi or ghostview.
+ Any changes will not be visible in LyX, but are visible when viewing the
+ document.
\end_layout
\begin_layout Standard
-
You can reset a bullet shape to the default simply by clicking your right
mouse button on the appropriate bullet depth button.
-\end_layout
-
-\begin_layout Standard
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
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.
+ in each, then you're going to have to get your hands dirty with TeX code.
+ The 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
-\begin_layout Standard
-
-
+\begin_layout Plain Layout
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
let
\end_layout
-\begin_layout Standard
-
-
+\begin_layout Plain Layout
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
renewcommand
\end_layout
\begin_layout Itemize
-
Use the LaTeX command
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
\backslash
renewcommand{}{}
-\family default
+\end_layout
+
+\end_inset
+
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
+\end_layout
-\family typewriter
+\begin_deeper
+\begin_layout LyX-Code
\backslash
let
\backslash
savelabelitemi=
\backslash
-labelitemi
-\family default
-
-\family typewriter
+labelitemi
+\end_layout
-\newline
+\begin_layout LyX-Code
\backslash
renewcommand
sharp
\backslash
)}
-\newline
+\end_layout
-\family default
+\end_deeper
+\begin_layout Itemize
Note that the itemize depth is specified in Roman numerals as part of the
\family typewriter
\end_layout
\begin_layout Itemize
-
-
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
[
\backslash
(
\end_inset
Specify each individual entry by starting each item with the bullet shape
- enclosed in square brackets and set as TeX.
+ enclosed in square brackets and set as
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+TeX Code
+\end_layout
+
+\end_inset
+
+.
For example, this item was started with
-\family typewriter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
[
\backslash
(
star
\backslash
)]
-\family default
-.
\end_layout
-\begin_layout Standard
+\end_inset
+.
+\end_layout
+\begin_layout Plain Layout
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
renewcommand
\end_layout
-\begin_layout Standard
-
+\begin_layout Plain Layout
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
+\end_layout
-\family typewriter
+\begin_layout LyX-Code
\backslash
renewcommand
savelabelitemi}
\end_layout
-\begin_layout Chapter
+\end_inset
+
-Special Document Classes
\end_layout
-\begin_layout Section
+\begin_layout Chapter
+The LyX Server
+\end_layout
-AMS LaTeX
+\begin_layout Section
+Introduction
\end_layout
\begin_layout Standard
+The `LyX server' allows other programs to talk to LyX, invoke LyX commands,
+ and retrieve information about the LyX internal state.
+ This is only intended for advanced users, but they should find it useful.
+ It is by writing to the LyX server, for example, that bibliography managers,
+ such as JabRef, are able to
+\begin_inset Quotes eld
+\end_inset
-by
-\noun on
-David Johnson
-\end_layout
+push
+\begin_inset Quotes erd
+\end_inset
+ citations to LyX.
+\end_layout
\begin_layout Standard
+Please note that, at present,
+\emph on
+the server does not work natively on Windows
+\emph default
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+There is no reason it cannot do so.
+ But none of the developers on Windows have yet implemented this functionality
+ there.
+\end_layout
-\begin_inset VSpace bigskip
\end_inset
+ but it does work with Cygwin versions of LyX.
+\end_layout
+\begin_layout Section
+Starting the LyX Server
\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
-
- or by ftp at
-\begin_inset LatexCommand \url{ftp://ftp.ams.org/pub/tex/amslatex/}
-
-\end_inset
+The LyX server works through the use of a pair of named pipes.
+ These are usually located in
+\begin_inset Flex CharStyle:Code
+status collapsed
-.These layouts are appropriate, and useful, for any mathematical writing.
- There are currently 4 distinct AMS LaTeX layouts:
+\begin_layout Plain Layout
+UserDir
\end_layout
-\begin_layout Enumerate
+\end_inset
-amsart: The standard AMS-article format.
- All results and similar statements are numbered as
-\begin_inset Formula $(n.m)$
+ and have the names
+\begin_inset Quotes eld
\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
+\begin_inset Flex CharStyle:Code
+status collapsed
-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.
+\begin_layout Plain Layout
+lyxpipe.in
\end_layout
-\begin_layout Enumerate
-
-amsart-plain: This one is even more terse, since all the environments are
- unnumbered.
-\end_layout
+\end_inset
-\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)$
+\begin_inset Quotes erd
\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
+ and
+\begin_inset Quotes eld
+\end_inset
-\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
+\begin_inset Flex CharStyle:Code
+status collapsed
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-
+\begin_layout Plain Layout
+lyxpipe.out
\end_layout
-\begin_layout Subsection
+\end_inset
-What these layouts provide
-\end_layout
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-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
-sections, bibliography, title, author, date
-\family default
-), is:
-\end_layout
+.
+ External programs write into
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_layout Description
+\begin_layout Plain Layout
+.lyxpipe.in
+\end_layout
-Theorem This is typically used for the statements of major results.
- The word
-\begin_inset Quotes eld
\end_inset
+ and read back data from
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Theorem
-\family default
+\begin_layout Plain Layout
+.lyxpipe.out
+\end_layout
-\begin_inset Quotes erd
\end_inset
- 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
-
-\begin_layout Description
+.
+ The stem of the pipe names can be defined in the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-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.
+\begin_layout Plain Layout
+Tools\SpecialChar \menuseparator
+Preferences
\end_layout
-\begin_layout Description
-
-Lemma These are smaller results needed to prove other statements.
-\end_layout
+\end_inset
-\begin_layout Description
+ dialog, for example
+\begin_inset Flex CharStyle:Code
+status collapsed
-Proposition These are less major results which (hopefully) add to the general
- theory being discussed.
+\begin_layout Plain Layout
+"/home/myhome/lyxpipe"
\end_layout
-\begin_layout Description
+\end_inset
-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).
+.
+ You
+\emph on
+must
+\emph default
+ configure this manually in order for the server to start.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+LyX will add the '
+\begin_inset Flex CharStyle:Code
+status collapsed
-Criterion A required condition.
+\begin_layout Plain Layout
+.in
\end_layout
-\begin_layout Description
-
-Algorithm A general procedure to be used.
-\end_layout
+\end_inset
-\begin_layout Description
+' and '
+\begin_inset Flex CharStyle:Code
+status collapsed
-Axiom This is a property or statement taken as true within the system being
- discussed.
+\begin_layout Plain Layout
+.out
\end_layout
-\begin_layout Description
+\end_inset
-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 (
+' to create the pipes.
+ If one of the pipes already exists, LyX will assume that another LyX process
+ is already running and will not start the server.
+ If for some other reason, an unused
\begin_inset Quotes eld
\end_inset
-definition
+stale
\begin_inset Quotes erd
\end_inset
-) is still set in boldface, along with the number, if any, but the rest
- is set upright.
+ pipe is left in existence when LyX closes, then LyX will try to delete
+ it.
+ If this fails for some reason, you will need to delete the pipes manually
+ and then restart LyX.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+To have several LyX processes with servers at the same time, you have to
+ use different configurations, perhaps by using separate user directories,
+ each with its own
+\begin_inset Flex CharStyle:Code
+status collapsed
-Example Typeset similarly to Definition.
+\begin_layout Plain Layout
+preferences
\end_layout
-\begin_layout Description
+\end_inset
-Condition
+ file, for each process.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+If you are developing a client program, you might find it useful to enable
+ debugging information from the LyX server.
+ Do this by starting LyX as
+\begin_inset Flex CharStyle:Code
+status collapsed
-Problem
+\begin_layout Plain Layout
+lyx -dbg lyxserver
\end_layout
-\begin_layout Description
+\end_inset
-Exercise
+.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+You can find a complete example client written in C in the source distribution
+ as
+\begin_inset Flex CharStyle:Code
+status collapsed
-Remark This environment is also a new type of theorem.
- This is set with the word Remark in italics, and the rest upright.
+\begin_layout Plain Layout
+development/lyxserver/server_monitor.c
\end_layout
-\begin_layout Description
+\end_inset
-Note Set similarly to the Remark environment.
+.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Another useful tool is command-line based client you will find in
+\begin_inset Flex CharStyle:Code
+status collapsed
-Notation
+\begin_layout Plain Layout
+src/client/lyxclient
\end_layout
-\begin_layout Description
+\end_inset
-Claim
+.
\end_layout
-\begin_layout Description
-
-Summary
+\begin_layout Section
+Normal communication
\end_layout
-\begin_layout Description
+\begin_layout Standard
+To issue a LyX call, the client writes a line of ASCII text into the input
+ pipe.
+ This line has the following format:
+\end_layout
-Acknowledgement
+\begin_layout Quote
+LYXCMD:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+argument
\end_layout
\begin_layout Description
-
-Case Generally, these are used to break up long arguments, using specific
- instances of some condition.
- The numbering scheme for cases is on its own, not together with other numbered
- statements.
-
+clientname is a name that the client can choose arbitrarily.
+ Its only use is that LyX will echo it if it sends an answer—so a client
+ can dispatch results from different requesters.
\end_layout
\begin_layout Description
-
-Conclusion
+function is the function you want LyX to perform.
+ It is the same as the commands you'd use in the minibuffer.
\end_layout
\begin_layout Description
+argument is an optional argument which is meaningful only to some functions
+ (for instance, the
+\begin_inset Quotes eld
+\end_inset
+
+self-insert
+\begin_inset Quotes erd
+\end_inset
-Fact
+ LFUN will insert the argument as text at the cursor position).
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The answer from LyX will arrive in the output pipe and be of the form
+\end_layout
+
+\begin_layout Quote
+INFO:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+data
+\end_layout
-Proof The word
+\begin_layout Standard
+where
+\emph on
+clientname
+\emph default
+ and
+\emph on
+function
+\emph default
+ are just echoed from the command request, while
+\emph on
+data
+\emph default
+ is more or less useful information filled according to how the command
+ execution worked out.
+ Some commands, such as
\begin_inset Quotes eld
\end_inset
-
-\shape italic
-Proof
-\shape default
-
+font-state
\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.
+, will return information about the internal state of LyX, while other will
+ return an empty data-response.
+ This means that the command execution went fine.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+In case of errors, the response from LyX will have this form
+\end_layout
-Address This should be the author's permanent address.
+\begin_layout Quote
+ERROR:
+\emph on
+clientname
+\emph default
+:
+\emph on
+function
+\emph default
+:
+\emph on
+error message
\end_layout
-\begin_layout Description
+\begin_layout Standard
+where the
+\emph on
+error message
+\emph default
+ should contain an explanation of why the command failed.
+\end_layout
-Current\InsetSpace ~
-Address This should be the author's temporary address at the time
- of submission, if different from the Address.
+\begin_layout Standard
+Examples:
\end_layout
-\begin_layout Description
+\begin_layout LyX-Code
+echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
+\begin_inset Newline newline
+\end_inset
-Email Author's e-mail address
-\end_layout
+echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
+\begin_inset Newline newline
+\end_inset
-\begin_layout Description
+read a <~/.lyxpipe.out
+\begin_inset Newline newline
+\end_inset
-URL Author's Web address, if desired.
+echo $a
\end_layout
-\begin_layout Description
-
-Keywords Key words or phrases used to identify specific topics discussed
- in the paper.
+\begin_layout Section
+Notification
\end_layout
-\begin_layout Description
+\begin_layout Standard
+LyX can notify clients of events going on asynchronously.
+ Currently it will only do this if the user binds a key sequence with the
+ function
+\begin_inset Quotes eld
+\end_inset
+
+notify
+\begin_inset Quotes erd
+\end_inset
-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.
+ The format of the string LyX sends is as follows:
\end_layout
-\begin_layout Description
+\begin_layout Quote
+\begin_inset Flex CharStyle:Code
+status collapsed
-Thanks
+\begin_layout Plain Layout
+NOTIFY:
\end_layout
-\begin_layout Description
-
-Dedicatory
-\end_layout
+\end_inset
-\begin_layout Description
-Translator
+\emph on
+key-sequence
\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.
+where
+\emph on
+key-sequence
+\emph default
+ is the printed representation of the key sequence that was actually typed
+ by the user.
\end_layout
-\begin_layout Section
+\begin_layout Standard
+This mechanism can be used to extend LyX's command set and implement macros.
+ Bind some key sequence to
+\begin_inset Quotes eld
+\end_inset
-Dinbrief
-\end_layout
-
-\begin_layout Standard
+notify
+\begin_inset Quotes erd
+\end_inset
-The document class
-\family sans
-dinbrief
-\family default
- can be used to type letters according to German conventions.
- A template file is included in
-\family typewriter
-.../lyx/share/templates
-\family default
- for you to use as a starting point.
+.
+ Then start a client that listens on the output pipe, dispatches the command
+ according to the sequence, and starts a function that may use LyX calls
+ and LyX requests to issue a command or a series of commands to LyX.
\end_layout
\begin_layout Section
-
-Paper
+The simple LyX Server Protocol
\end_layout
\begin_layout Standard
-
-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.
+LyX implements a simple protocol that can be used for session management.
+ All messages are of the form
\end_layout
-\begin_layout Section
-
-A&A Paper
+\begin_layout Quote
+LYXSRV:
+\emph on
+clientname
+\emph default
+:
+\emph on
+protocol message
\end_layout
\begin_layout Standard
+where
+\emph on
+protocol message
+\emph default
+ can be
+\begin_inset Quotes eld
+\end_inset
-by
-\noun on
-Peter Sütterlin
-\end_layout
+hello
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
+ or
+\begin_inset Quotes eld
+\end_inset
-Introduction
+bye
+\begin_inset Quotes erd
+\end_inset
+
+.
+ If
+\begin_inset Quotes eld
+\end_inset
+
+hello
+\begin_inset Quotes erd
+\end_inset
+
+ is received from a client, LyX will report back to inform the client that
+ it's listening to it's messages, while
+\begin_inset Quotes eld
+\end_inset
+
+bye
+\begin_inset Quotes erd
+\end_inset
+
+ sent from LyX will inform clients that LyX is closing.
+\end_layout
+
+\begin_layout Section
+Reverse DVI/PDF search
\end_layout
\begin_layout Standard
+Some DVI/PDF viewers
+\begin_inset Foot
+status collapsed
-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/}
+\begin_layout Plain Layout
+The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
+ Skim on Mac OSX and SumatraPDF on Windows.
+\end_layout
\end_inset
-)
+ provide
\emph on
-
+reverse search
\emph default
-using
+ facility (also called
\emph on
-
+inverse search
\emph default
-Version 5.01 of the document class
-\family typewriter
-aa.cls
-\family default
-.
- This package can be downloaded from the ftp site
-\end_layout
-
-
-\begin_layout Standard
+).
+ This means that you can tell LyX to put the cursor to a specific line in
+ the document by clicking at the respective position in the DVI/PDF output.
+ To achieve this, the viewer must be able to communicate with LyX.
+ This is done via the LyX server either by using the named pipe (
+\emph on
+lyxpipe
+\emph default
+), or the UNIX domain socket (
+\emph on
+lyxsocket
+\emph default
+) that LyX creates in its temporary directory (this is the way the
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+lyxclient
+\end_layout
-\begin_inset VSpace medskip
\end_inset
+ program communicates with LyX).
+ In some cases, you need a helper script that mediates between the viewer
+ and LyX, in others, the viewer can communicate with LyX directly.
+ This depends on the selected viewer and on your operating system.
+ The same applies to the way viewers need to be configured and the way the
+ reverse search is actually performed.
+ In what follows, we will thus describe how to setup reverse search for
+ specific viewers.
+ Before we turn to this, though, we will explain what needs to be done generally
+ to enable reverse search in the DVI/PDF output.
+\end_layout
+\begin_layout Subsection
+Enabling reverse search
\end_layout
\begin_layout Standard
-\align center
+LaTeX provides several different methods for reverse search.
+ Some are built-in in the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset LatexCommand \url{ftp://ftp.edpsciences.org/pub/aa/readme.html}
+\begin_layout Plain Layout
+latex/pdflatex
+\end_layout
\end_inset
+ program, some are provided by external packages.
+ Your choice depends on whether your LaTeX distribution already provides
+ a given method (the built-in methods are rather new) and whether your viewer
+ can cope with it.
+ The available methods are described in the following.
+\end_layout
+\begin_layout Subsubsection*
+Built-in DVI-search via src-specials (DVI only)
\end_layout
\begin_layout Standard
+This method provides the DVI file with the necessary information for reverse
+ search.
+ It is available in LaTeX since quite some time (any somewhat recent LaTeX
+ distribution should include it), and it works reliably.
+ To enable it, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\begin_inset VSpace medskip
-\end_inset
+\begin_layout Plain Layout
+
+{}
+\end_layout
+\end_inset
+eX (plain)->DVI
\end_layout
+\end_inset
-\begin_layout Standard
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-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 Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-Please note that the publisher of the journal was changed from Springer
- to EDP Sciences starting January 1, 2001.
- That change implicated also some slight changes of the style files, namely
- the removal of the thesaurus command.
- The LyX class aa supports the newest version of these style files, V 5.01.
- If you have an older version installed, please upgrade.
- For compatibility, the old (version 4) layout has been kept as
-\family sans
-article (A&A V4)
-\family default
-.
- Please refer to the comments in
-\family typewriter
-LyXDir/layouts/aapaper.layout
-\family default
-.
+{}
\end_layout
-\begin_layout Subsection
+\end_inset
-Getting started
+eX (plain)->DraftDVI
\end_layout
-\begin_layout Standard
+\end_inset
-It is recommended you start from the example template distributed with LyX.
- If you are not using a template, note the following settings:
+ converter in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
-\begin_layout Itemize
+\end_inset
-Select
-\family sans
-article (A&A)
-\family default
- in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog (OK, that one was obvious).
+\begin_layout Plain Layout
+latex -src-specials $$i
\end_layout
-\begin_layout Itemize
+\end_inset
-Don't change the option
-\family sans
-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.
+ If this doesn't work, check if your TeX engine needs different options
+ (the syntax might differ in some distributions).
\end_layout
-\begin_layout Subsection
-
-The header block
+\begin_layout Subsubsection*
+External Packages (PDFSync and scrltx)
\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
+The packages
+\emph on
+pdfsync
+\emph default
+ and
+\emph on
+scrltx
+\emph default
+ provide reverse search facility for PDF output (via pdflatex) and DVI output,
+ respectively.
+ In order to enable it, load the packages in the LyX preamble:
\end_layout
\begin_layout Itemize
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family sans
-Title
-\family default
-: [required]
+\backslash
+usepackage{pdfsync}
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family sans
-Subtitle
-\family default
-: [optional]
+ for reverse PDF search,
\end_layout
\begin_layout Itemize
+
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
-\family sans
-Author
-\family default
-: [required]
+\backslash
+usepackage[active]{srcltx}
\end_layout
-\begin_layout Itemize
+\end_inset
+ for reverse DVI search.
+\end_layout
-\family sans
-Address
-\family default
-: [required]
+\begin_layout Standard
+If you want to be able to perform both DVI and PDF reverse searches, you
+ can also insert in the preamble the following lines
\end_layout
-\begin_layout Itemize
+\begin_layout LyX-Code
+\backslash
+usepackage{ifpdf}
+\begin_inset Newline newline
+\end_inset
-\family sans
-Offprints
-\family default
-: [optional] if more than one author: whom to contact for offprint requests.
-\end_layout
-\begin_layout Itemize
+\backslash
+ifpdf
+\begin_inset Newline newline
+\end_inset
+
+\backslash
+usepackage{pdfsync}
+\begin_inset Newline newline
+\end_inset
-\family sans
-Mail
-\family default
-: [optional] mail address for contacts.
-\end_layout
-\begin_layout Itemize
+\backslash
+else
+\begin_inset Newline newline
+\end_inset
+
+\backslash
+usepackage[active]{srcltx}
+\begin_inset Newline newline
+\end_inset
-\family sans
-Date
-\family default
-: [required].
- Suggested format is
-\family typewriter
-Received: <date>; Accepted <date>
+
+\backslash
+fi
\end_layout
\begin_layout Standard
-
-There is no need to issue the
-\family typewriter
-
-\backslash
-maketitle
-\family default
- command, this is done automatically by LyX when the header is finished.
- Although the order of the single header entries doesn't matter it is advised
- to keep the above sequence, just to get the best optics and meets the layout
- of the real document.
+This way, you can preview the file as either DVI or PDF (pdflatex) and the
+ right package will be used.
\end_layout
\begin_layout Standard
+Note that PDFSync might affect the output layout of your document.
+ It is therefore advised to disable PDFsync for final documents.
+\end_layout
-If you want to place footnotes in the header block, e.g.
-\begin_inset ERT
-status collapsed
+\begin_layout Subsubsection*
+Built-in reverse search via SyncTeX (DVI and PDF)
+\end_layout
\begin_layout Standard
+Recent versions of
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-
+\begin_layout Plain Layout
+(pdf)latex
\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.
+ have built-in support for both PDF and DVI reverse search.
+ This so-called
+\emph on
+SyncTeX
+\emph default
+ facility is basically the result of the integration of the PDFSync package
+ to the pdftex program and its merge with the
+\emph on
+scr-specials
+\emph default
+ approach.
+ You need at least TeXLive 2008 or a recent MikTeX distribution in order
+ to use it.
+ Also note that only a few PDF viewers (Skim on the Mac, SumatraPDF on Windows)
+ already provide SyncTeX support.
\end_layout
\begin_layout Standard
+To enable SyncTeX for DVI output, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-In addition to these topics, the macros use three additional LaTeX commands
- that have no counterpart in LyX:
-\end_layout
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+{}
+\end_layout
-\family typewriter
+\end_inset
-\backslash
-and
-\family default
- to separate different names for more than one author and institute, respectivel
-y.
+eX (plain) -> DVI
\end_layout
-\begin_layout Itemize
+\end_inset
+ or
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-\backslash
-inst{<nr>}
-\family default
-to mark corresponding author/institute pairs.
- The institutes are numbered sequentially as they appear in the
-\family sans
-Address
-\family default
- field, so you have to put a marker to each author.
+\begin_layout Plain Layout
+
+{}
\end_layout
-\begin_layout Itemize
+\end_inset
+eX (plain) -> DraftDVI
+\end_layout
-\family typewriter
+\end_inset
-\backslash
-email{address}
-\family default
- to supply an email address for fast contact.
+ converter in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+Converters
\end_layout
-\begin_layout Standard
+\end_inset
-In all cases, the appropriate command has to be entered in LyX an marked
- as LaTeX code.
- See the examples.
-
+ to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+latex -synctex=1 $$i
\end_layout
-\begin_layout Subsection
+\end_inset
-The abstract
-\end_layout
+, and for PDF output, change the
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+LaT
+\begin_inset ERT
+status collapsed
-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
+\begin_layout Plain Layout
-\backslash
-keywords{}
-\family default
- by hand and mark it as LaTeX code.
- Refer to the example paper.
+{}
\end_layout
-\begin_layout Subsection
+\end_inset
-Supported environments
+eX (pdflatex) -> PDF (pdflatex)
\end_layout
-\begin_layout Standard
+\end_inset
-The A&A paper layout supports the following environments for structuring
- your text:
+ or converter to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+pdflatex -synctex=1 $$i
\end_layout
-\begin_layout Itemize
+\end_inset
+
+.
+ Check the documentation of your viewer whether the viewer needs to be configure
+d for the use with SyncTeX.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+The
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Standard
+\begin_layout Plain Layout
+-synctex=1
\end_layout
-\begin_layout Itemize
+\end_inset
+ option enables gzip compression.
+ If your viewer does not support it, you should instead use
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Section
+\begin_layout Plain Layout
+-synctex=-1
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family sans
-Subsection
+.
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Subsubsection
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Configuring and using specific viewers
+\end_layout
+\begin_layout Subsubsection*
+Xdvi (all platforms)
+\end_layout
-\family sans
-Itemize
+\begin_layout Standard
+If you use
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+xdvi
\end_layout
-\begin_layout Itemize
+\end_inset
+, you don't need to do anything else for performing a reverse DVI search,
+ as LyX already provides the necessary hooks for automatically using the
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Enumerate
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\begin_layout Itemize
+\end_inset
+ program.
+ Just setup your document as described above (reverse search is triggered
+ by Ctrl-click or Alt-click on Mac OSX, respectively).
+\end_layout
-\family sans
-Description
+\begin_layout Standard
+However, if for whatever reason you want to use the named pipe instead of
+ the socket for communicating with LyX, simply change the DVI viewer in
+
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats
\end_layout
-\begin_layout Itemize
+\end_inset
+
+ to
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+On Mac OSX you have to use
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Caption
+\begin_layout Plain Layout
+DISPLAY=:0.0 xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Abstract
\end_layout
-\begin_layout Itemize
+\end_inset
+
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Acknowledgment
+\begin_layout Plain Layout
+xdvi -editor 'lyxeditor.sh %f %l'
\end_layout
-\begin_layout Itemize
+\end_inset
+, where
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Bibliography
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family sans
-LaTeX
+ is a suitable script.
+ For example, a minimal shell script is the following one:
\end_layout
-\begin_layout Subsection
+\begin_layout LyX-Code
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
-Commands not supported by LyX
+LYXPIPE="/path/to/lyxpipe"
+\begin_inset Newline newline
+\end_inset
+
+COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
+\begin_inset Newline newline
+\end_inset
+
+echo "$COMMAND" > "${LYXPIPE}".in || exit
+\begin_inset Newline newline
+\end_inset
+
+read < "${LYXPIPE}".out || exit
\end_layout
\begin_layout Standard
+where
+\begin_inset Flex CharStyle:Code
+status collapsed
-Some commands are not yet supported by the
-\family sans
-paper (A&A)
-\family default
- layout for LyX.
- Some have already been mentioned.
- For the sake of completeness, they are listed all together here:
+\begin_layout Plain Layout
+/path/to/lyxpipe
\end_layout
-\begin_layout Itemize
+\end_inset
+ is the Ly
+\begin_inset ERT
+status open
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-and
+{}
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family typewriter
+XServer pipe path specified in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\backslash
-email
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+Paths
\end_layout
-\begin_layout Itemize
+\end_inset
+.
+\begin_inset Foot
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
+In the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-appendix
+\begin_layout Plain Layout
+development/tools
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family typewriter
+ folder of a source distribution you can find a
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-authorrunning
+\begin_layout Plain Layout
+lyxeditor
\end_layout
-\begin_layout Itemize
-
-
-\family typewriter
+\end_inset
-\backslash
-inst{}
+ script which is able to locate the
+\emph on
+lyxpipe
+\emph default
+ based on your preferences.
\end_layout
-\begin_layout Itemize
+\end_inset
-\family typewriter
+\end_layout
-\backslash
-keywords{}
+\begin_layout Subsubsection*
+MacDviX (Mac OSX)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+At the end of
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+/Applications/MacDviX_Folder/calleditor.script
+\end_layout
-\family typewriter
+\end_inset
-\backslash
-object{}
+, add the following lines:
\end_layout
-\begin_layout Itemize
-
+\begin_layout LyX-Code
+/Applications/Ly
+\begin_inset ERT
+status collapsed
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-titlerunning{}
+{}
\end_layout
-\begin_layout Standard
-
-If you want to use any of these commands, you have to enter them yourself.
-
-\series bold
-Do not forget to mark them as LaTeX code!
-\end_layout
+\end_inset
-\begin_layout Subsection
+X.app/Contents/MacOS/lyxeditor "$2" $1
+\begin_inset Newline newline
+\end_inset
-Figure and Table Floats
+exit 1
\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
-
-\bar under
-P
-\bar default
-aragraph\InsetSpace ~
-Settings.
+Modify the lines accordingly if you install LyX somewhere else than in the
+ Applications folder.
\end_layout
\begin_layout Standard
-
-There is
-\family sans
-
-\family default
-only one special thing: the figures with caption besides the figure.
- To create such a figure, you have to do the following:
+Reverse search is triggered by Alt-click (OPTION-click).
\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
-\family default
-.
+\begin_layout Subsubsection*
+Skim (Mac OSX)
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+Enter
+\begin_inset Flex CharStyle:Code
+status collapsed
-Enter your caption text.
+\begin_layout Plain Layout
+open -a Skim.app $$i
\end_layout
-\begin_layout Enumerate
-
-Press
-\family sans
-Return
-\family default
- to move the cursor above the caption.
-\end_layout
+\end_inset
-\begin_layout Enumerate
+ to the viewer setting in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-Insert your figure
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Enumerate
+\end_inset
-Position the cursor behind the figure and insert a horizontal fill:
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+, and then in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-\bar under
-S
-\bar default
-pecial\InsetSpace ~
-Character
-\bar under
-\SpecialChar \menuseparator
-H
-\bar default
-orizontal\InsetSpace ~
-Fill
-\family default
-.
+\begin_layout Plain Layout
+Skim\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Sync
\end_layout
-\begin_layout Enumerate
-
-Switch to LaTeX mode:
-\family sans
-M-c\InsetSpace ~
-t
-\family default
-.
-\end_layout
+\end_inset
-\begin_layout Enumerate
+ select Ly
+\begin_inset ERT
+status collapsed
-Enter
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-parbox[b]{55mm}{
-\family default
-.
-
-\series bold
-Do not close the brace!
+{}
\end_layout
-\begin_layout Enumerate
+\end_inset
-Position the cursor behind the caption text, switch to LaTeX mode and insert
- the closing brace:
-\family sans
-M-c\InsetSpace ~
-t
-\family typewriter
-}
-\family default
-.
+X.
\end_layout
\begin_layout Standard
-
-Also, refer to the figures in the example paper.
+Reverse search is triggered by COMMAND-SHIFT-click
\end_layout
-\begin_layout Subsection
-
-Referee layout
+\begin_layout Subsubsection*
+Okular (KDE)
\end_layout
\begin_layout Standard
+Go to
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-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
-\family default
- dialog.
- Just enter the string
-\family typewriter
-referee
-\family default
- there.
+\begin_layout Plain Layout
+Settings\SpecialChar \menuseparator
+Configure Okular\SpecialChar \ldots{}
+\SpecialChar \menuseparator
+Editor
\end_layout
-\begin_layout Subsection
+\end_inset
-The example paper
-\end_layout
+, select
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Custom Text Editor
+\begin_inset Quotes erd
+\end_inset
-The
-\family sans
-Examples
-\family default
- directory contains an example paper written with LyX.
- It is the example paper from the original macro package, translated to
- LyX.
- Use it for inspiration, and compare the original LaTeX code with LyX way
- of writing.
+ and add the command
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient -g %f %l
\end_layout
-\begin_layout Section
+\end_inset
-AASTeX
+.
\end_layout
\begin_layout Standard
-
-by
-\noun on
-Mike Ressler
+Reverse search is triggered by SHIFT-click.
\end_layout
-\begin_layout Subsection
-
-Introduction
+\begin_layout Subsubsection*
+YAP (Cygwin)
\end_layout
\begin_layout Standard
+Launch yap, choose its
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
-AASTeX is a set of macros produced by the American Astronomical Society
- to facilitate electronic manuscript submission to the three journals they
- publish: the Astrophysical Journal (including the Letters and Supplement),
- the Astronomical Journal, and the Publications of the Astronomical Society
- of the Pacific.
- LyX has proven to be an excellent tool for generating these documents,
- especially given its equation, citation, and figure handling capabilities.
- LyX requires version 5.0 (or higher) of these macros; preferably 5.2, which
- is the version described here, or higher.
- Versions prior to 5.0 are intended for use with LaTeX2.09 and are fundamentally
- incompatible with LyX.
- The AASTeX package may be downloaded from the AASTeX Web site
+\begin_layout Plain Layout
+View\SpecialChar \menuseparator
+Options
\end_layout
+\end_inset
-\begin_layout Standard
+ menu and select the
+\begin_inset Quotes eld
+\end_inset
+Inverse DVI Search
+\begin_inset Quotes erd
+\end_inset
-\begin_inset VSpace medskip
+ tab.
+ Click on the
+\begin_inset Quotes eld
\end_inset
+New\SpecialChar \ldots{}
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-\align center
+ button and, in the window that opens, enter
+\begin_inset Quotes eld
+\end_inset
-\begin_inset LatexCommand \url{http://www.journals.uchicago.edu/AAS/AASTeX}
+LyX Editor
+\begin_inset Quotes erd
+\end_inset
+ (or any other name you like) in the
+\begin_inset Quotes eld
\end_inset
+Name:
+\begin_inset Quotes erd
+\end_inset
-\end_layout
+ field.
+ Now click on the button labeled
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+\SpecialChar \ldots{}
-
-\begin_inset VSpace medskip
+\begin_inset Quotes erd
\end_inset
+ to open a file dialog and navigate to the directory containing the batch
+ file
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
+\end_inset
-\begin_layout Standard
+ (see below).
+ Select
+\begin_inset Flex CharStyle:Code
+status collapsed
-A complete user guide is contained in that package and you should familiarize
- yourself with it thoroughly before embarking on writing a paper in LyX.
- LyX will not reduce the need to figure out all the AASTeX commands, it
- will only reduce the drudgery of typing everything in.
- It is your responsibility to ensure that the final exported LaTeX document
- conforms completely to the requirements of the journal to which you are
- submitting your paper.
+\begin_layout Plain Layout
+lyxeditor.bat
\end_layout
-\begin_layout Subsection
+\end_inset
-Starting a New Paper
+ and then specify the program arguments as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+%f %l
\end_layout
-\begin_layout Standard
+\end_inset
-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
-\family default
-, enter the new file name, then choose the
-\family typewriter
-aastex.lyx
-\family default
- template.
- This will show the most common fields found in a manuscript.
- Simply overwrite the existing text (including the brackets,
-\family typewriter
-<>
-\family default
-) with the correct information.
- Many of the AASTeX commands and environments can be implemented directly
- in LyX, but some cannot: most noticeably
-\family typewriter
+ if you want to use the shell script above, or as
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-altaffilmark
-\family default
- and
-\family typewriter
+\begin_layout Plain Layout
+-g %f %l
+\end_layout
-\backslash
-altaffiltext
-\family default
-, which should stick out like a sore thumb if you actually just opened the
- template file.
- For commands such as these, the LaTeX code must be entered directly and
- marked as such.
- Such commands are referred to as 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_inset
+
+ if you want to use the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
\end_layout
-\begin_layout Subsection
+\end_inset
-Finishing Your Paper
+ program.
+ Since yap is a native Windows application, the filename it provides should
+ be converted to POSIX style before being passed to
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Standard
+\end_inset
+
+ or
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxclient
+\end_layout
-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
+, and this is the purpose of the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.bat
+\end_layout
+
\end_inset
- actions which need to be done before you submit it to the journals.
-
+ wrapper, which is as follows:
\end_layout
-\begin_layout Enumerate
+\begin_layout LyX-Code
+@echo off
+\begin_inset Newline newline
+\end_inset
-Export your paper as a LaTeX file (
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+if "%1" == "-g" goto lyxclient
+\begin_inset Newline newline
+\end_inset
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+bash -c 'lyxeditor.sh $(cygpath -a "%1") %2'
+\begin_inset Newline newline
+\end_inset
-\bar under
-L
-\bar default
-aTeX
-\family default
-).
-
+exit
+\begin_inset Newline newline
+\end_inset
+
+:lyxclient
+\begin_inset Newline newline
+\end_inset
+
+bash -c 'lyxclient %1 $(cygpath -a "%2") %3'
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+You have to make sure that both
+\begin_inset Flex CharStyle:Code
+status collapsed
-Edit the resulting
-\family typewriter
-.tex
-\family default
- file with your favorite text editor
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_deeper
-\begin_layout Enumerate
+\end_inset
-remove the comment lines before the
-\family typewriter
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-documentclass
-\family default
- command
+\begin_layout Plain Layout
+lyxclient.exe
\end_layout
-\begin_layout Enumerate
+\end_inset
-remove the
-\family typewriter
+ are in the command PATH, otherwise you have to use their full posix path
+ in the above batch file.
+\end_layout
-\backslash
-usepackage...{fontenc}
-\family default
- line if it appears (usually just after
-\family typewriter
+\begin_layout Standard
+In yap, reverse search is triggered by double-click.
+\end_layout
-\backslash
-documentclass
-\family default
-}; also remove the
-\family typewriter
+\begin_layout Subsubsection*
+SumatraPDF (Cygwin)
+\end_layout
-\backslash
-secnumdepth
-\family default
- line if it appears.
+\begin_layout Standard
+In SumatraPDF, you can set the name of the program that communicates with
+ LyX by simply launching SumatraPDF as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF -inverse-search "lyxeditor.bat -g %f %l"
\end_layout
-\begin_layout Enumerate
+\end_inset
-remove everything between (and including) the
-\family typewriter
+ and then quit.
+ The program will remember the setting and using the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-makeatletter
-\family default
- and
-\family typewriter
+\begin_layout Plain Layout
+-inverse-search
+\end_layout
-\backslash
-makeatother
-\family default
- commands, except for any commands you specifically put into the LaTeX preamble
- (which should appear immediately after the
-\begin_inset Quotes eld
\end_inset
-User specified LaTeX commands
-\begin_inset Quotes erd
-\end_inset
+ option will not be needed from now on
+\begin_inset Foot
+status collapsed
- comment in the
-\family typewriter
-.tex
-\family default
- file).
+\begin_layout Plain Layout
+It has been reported that SumatraPDF is not able to remember the settings
+ if it is installed in the Program Files system folder.
+ This problem can be avoided by installing it somewhere else, for example
+ in
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+/usr/local/bin
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the resulting file through LaTeX to make sure it still processes correctly.
+\end_inset
+
+.
\end_layout
-\begin_layout Enumerate
+\end_inset
-Reread the journal requirements to make sure your filenames and formats
- are correct.
+ (in this way you will be using the lyxsocket; omit the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+-g
\end_layout
-\begin_layout Enumerate
+\end_inset
-Submit it.
+ option if you want to use the lyxpipe and be sure that the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+lyxeditor.sh
\end_layout
-\begin_layout Subsection
+\end_inset
-Comments On Specific Commands
+ script is in your command PATH).
+ If SumatraPDF is not your default PDF viewer, you should enter
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF.sh
\end_layout
-\begin_layout Standard
+\end_inset
-I will not describe the detailed usage of the individual AASTeX commands:
- the AASTeX User Guide (
-\family typewriter
-aasguide.tex
-\family default
-) gives a good description of each.
- Thus it's probably easiest for me to go down the list as found in the guide
- and offer comments where necessary.
- So let's begin \SpecialChar \ldots{}
+ in the viewer setting in
+\begin_inset Flex CharStyle:MenuItem
+status collapsed
+\begin_layout Plain Layout
+Preferences\SpecialChar \menuseparator
+File Handling\SpecialChar \menuseparator
+File formats\SpecialChar \menuseparator
+PDF (pdflatex)
\end_layout
-\begin_layout Subsubsection
+\end_inset
-Things that work as expected
+, where
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+SumatraPDF.sh
\end_layout
-\begin_layout Standard
+\end_inset
+ is the following script (to be placed in your command PATH,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset ERT
-status inlined
+\begin_layout Plain Layout
+/usr/local/bin
+\end_layout
-\begin_layout Standard
+\end_inset
-\backslash
-begin{sloppypar}
+ being the best choice):
\end_layout
+\begin_layout LyX-Code
+#!/bin/bash
+\begin_inset Newline newline
\end_inset
+cd $(dirname $1)
+\begin_inset Newline newline
+\end_inset
+SumatraPDF.exe $(basename $1)
\end_layout
\begin_layout Standard
+This is needed because SumatraPDF is a native Windows application and does
+ not understand the posix paths used by the Cygwin version of LyX.
+\end_layout
-Because they work as you might expect, I simply list them and the section
- they are found in:
-\family typewriter
+\begin_layout Standard
+Reverse search is triggered by double-click.
+\end_layout
-\backslash
-documentclass
-\family default
- (2.1.1),
-\family typewriter
+\begin_layout Chapter
+Special Document Classes
+\end_layout
-\backslash
-begin{document}
-\family default
- (2.2),
-\family typewriter
+\begin_layout Section
+A&A Paper
+\end_layout
-\backslash
-title
-\family default
- (2.3),
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Peter Sütterlin
+\end_layout
-\backslash
-author
-\family default
- (2.3),
-\family typewriter
+\begin_layout Subsection
+Introduction
+\end_layout
-\backslash
-affil
-\family default
- (2.3),
-\family typewriter
+\begin_layout Standard
+This section describes how LyX can be used to write articles for submission
+ to the scientific journal
+\emph on
+Astronomy and Astrophysics
+\emph default
+ (www.edpsciences.fr/aa/
+\begin_inset Flex URL
+status collapsed
-\backslash
-abstract
-\family default
- (2.4),
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-keywords
-\family default
- (2.5),
-\family typewriter
+http://www.edpsciences.fr/aa/
+\end_layout
-\backslash
-section
-\family default
- (2.7),
-\family typewriter
+\end_inset
-\backslash
-subsection
-\family default
- (2.7),
+) using Version 5.01 of the document class
\family typewriter
-
-\backslash
-subsubsection
+aa.cls
\family default
- (2.7),
-\family typewriter
+.
+ This package can be downloaded from the ftp site
+\end_layout
-\backslash
-paragraph
-\family default
- (2.7),
-\family typewriter
-
-\backslash
-facility
-\family default
- (2.10),
-\family typewriter
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\backslash
-begin{displaymath}
-\family default
- (2.12),
-\family typewriter
-\backslash
-begin{equation}
-\family default
- (2.12),
-\family typewriter
+\end_layout
-\backslash
-begin{eqnarray}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-\backslash
-begin{mathletters}
-\family default
- (2.12),
-\family typewriter
+\begin_layout Plain Layout
-\backslash
-begin{thebibliography}
-\family default
- (2.13.1),
-\family typewriter
+ftp://ftp.edpsciences.org/pub/aa/readme.html
+\end_layout
-\backslash
-bibitem
-\family default
- (2.13.2), all the cite commands and their variations (2.13.2), the generic
- graphicx figure commands (2.14.1),
-\family typewriter
-
-\backslash
-begin{table}
-\family default
- (2.15.4),
-\family typewriter
+\end_inset
-\backslash
-begin{tabular}
-\family default
- (2.15.4),
-\family typewriter
-\backslash
-caption
-\family default
- (2.15.4),
-\family typewriter
+\end_layout
-\backslash
-label
-\family default
- (2.15.4, amongst other places),
-\family typewriter
+\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-\backslash
-tablerefs
-\family default
- (2.15.5),
-\family typewriter
-\backslash
-tablecomments
-\family default
- (2.15.5),
-\family typewriter
+\end_layout
-\backslash
-url
+\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
- (2.17.4),
+.
+ Please refer to the comments in
\family typewriter
-
-\backslash
-end{document}
+LyXDir/layouts/aapaper.layout
\family default
- (2.18).
+.
+\end_layout
+
+\begin_layout Subsection
+Getting started
\end_layout
\begin_layout Standard
+It is recommended you start from the example template distributed with LyX.
+ If you are not using a template, note the following settings:
+\end_layout
-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
+\begin_layout Itemize
+Select
+\family sans
+article (A&A)
\family default
- (3.3),
-\family typewriter
-flushrt
+ in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
\family default
- (3.4).
- Simply put them in the
+ dialog (OK, that one was obvious).
+\end_layout
+
+\begin_layout Itemize
+Don't change the option
\family sans
-Options
+Page
+\begin_inset space ~
+\end_inset
+
+style
\family default
- box in
+: Leave it set to
\family sans
-Layout\SpecialChar \menuseparator
-Document
+default
\family default
.
+ The whole layout is done by the macros, you shouldn't change anything.
\end_layout
-\begin_layout Standard
-
-
-\begin_inset ERT
-status inlined
+\begin_layout Subsection
+The header block
+\end_layout
\begin_layout Standard
-
-\backslash
-end{sloppypar}
+First thing to enter is the header information.
+ It consists of seven entries, of which some are optional.
+ They are
\end_layout
-\end_inset
-
+\begin_layout Itemize
+\family sans
+Title
+\family default
+: [required]
\end_layout
-\begin_layout Subsubsection
+\begin_layout Itemize
-Things that work, but require more comment
+\family sans
+Subtitle
+\family default
+: [optional]
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-The following items work, but require a little more discussion:
+\family sans
+Author
+\family default
+: [required]
\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
+\family sans
+Address
+\family default
+: [required]
+\end_layout
-\backslash
-received
+\begin_layout Itemize
+
+\family sans
+Offprints
\family default
-,
-\family typewriter
+: [optional] if more than one author: whom to contact for offprint requests.
+\end_layout
-\backslash
-revised
+\begin_layout Itemize
+
+\family sans
+Mail
\family default
-,
-\family typewriter
+: [optional] mail address for contacts.
+\end_layout
-\backslash
-accepted
+\begin_layout Itemize
+
+\family sans
+Date
\family default
-,
+: [required].
+ Suggested format is
\family typewriter
+Received: <date>; Accepted <date>
+\end_layout
-\backslash
-ccc
-\family default
-,
+\begin_layout Standard
+There is no need to issue the
\family typewriter
\backslash
-cpright
+maketitle
\family default
- (all from 2.1.3)
+ 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 Itemize
+\begin_layout Standard
+If you want to place footnotes in the header block, e.
+\begin_inset space \thinspace{}
+\end_inset
-These items may be placed in the LaTeX preamble, and are included as blanks
- in the template file:
-\family typewriter
+g.
+\begin_inset space \space{}
+\end_inset
+
+to state your present address, just use the standard footnote via the menu
+
+\family sans
+Insert\SpecialChar \menuseparator
+Footnote.
-\backslash
-slugcomment
\family default
- (2.1.4),
+ LyX will automagically use the term
\family typewriter
\backslash
-shorttitle
+thanks{}
\family default
- (2.1.5),
+ 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:
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-shortauthors
+and
\family default
- (2.1.5)
+ to separate different names for more than one author and institute, respectivel
+y.
\end_layout
\begin_layout Itemize
-
\family typewriter
\backslash
-email
+inst{<nr>}
\family default
- (2.3) -- can only be used
-\begin_inset Quotes eld
-\end_inset
-
-standalone
-\begin_inset Quotes erd
-\end_inset
-
-, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+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
\begin_layout Itemize
-
\family typewriter
\backslash
-and
+email{address}
\family default
- (2.3) -- will have extra {} after it.
- This should not cause an error.
+ to supply an email address for fast contact.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+In all cases, the appropriate command has to be entered in LyX and marked
+ as LaTeX code.
+ See the examples.
+
+\end_layout
+\begin_layout Subsection
+The abstract
+\end_layout
+\begin_layout Standard
+The abstract should immediately follow the header block.
+ With version 5 the abstract environment was changed to a command, and there
+ is now a resctriction to only one paragraph.
+ 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
-notetoeditor
+keywords{}
\family default
- (2.6) -- can only be used
-\begin_inset Quotes eld
-\end_inset
+ by hand and mark it as LaTeX code.
+ Refer to the example paper.
+\end_layout
-standalone
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Supported environments
+\end_layout
-, not in the middle of a paragraph.
- Use ERT if you need to embed it.
+\begin_layout Standard
+The A&A paper layout supports the following environments for structuring
+ your text:
\end_layout
\begin_layout Itemize
+\family sans
+Standard
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-placetable
-\family default
- (2.8) -- can't insert a cross-reference tag, you must type the tag name
- by hand
+\family sans
+Section
\end_layout
\begin_layout Itemize
+\family sans
+Subsection
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-placefigure
-\family default
- (2.8) -- same as for
-\family typewriter
+\family sans
+Subsubsection
+\end_layout
-\backslash
-placetable
+\begin_layout Itemize
+
+\family sans
+Itemize
\end_layout
\begin_layout Itemize
+\family sans
+Enumerate
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-acknowledgements
-\family default
- (2.9) -- will have extra {} after it.
- This should not cause an error.
+\family sans
+Description
\end_layout
\begin_layout Itemize
+\family sans
+Caption
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\backslash
-appendix
-\family default
- (2.11) -- will have extra {} after it.
- This should not cause an error.
+\family sans
+Abstract
\end_layout
\begin_layout Itemize
+\family sans
+Acknowledgment
+\end_layout
-\family typewriter
+\begin_layout Itemize
-\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
+Bibliography
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+LaTeX
+\end_layout
+
+\begin_layout Subsection
+Commands not supported by LyX
+\end_layout
+
+\begin_layout Standard
+Some commands are not yet supported by the
+\family sans
+paper (A&A)
\family default
-.
-
-\begin_inset Quotes eld
-\end_inset
+ layout for LyX.
+ Some have already been mentioned.
+ For the sake of completeness, they are listed all together here:
+\end_layout
-Short Title
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- inserts an optional argument of the type needed by
\family typewriter
\backslash
-figcaption
-\family default
-.
- Hopefully it will be renamed someday.
+and
\end_layout
\begin_layout Itemize
-
\family typewriter
\backslash
-objectname
-\family default
- (2.17.1) -- same as
+email
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
+appendix
\end_layout
\begin_layout Itemize
-
\family typewriter
\backslash
-dataset
-\family default
- (2.17.1) -- same as
+authorrunning
+\end_layout
+
+\begin_layout Itemize
+
\family typewriter
\backslash
-figcaption
-\family default
- for the catalog ID optional parameter
+inst{}
\end_layout
-\begin_layout Subsubsection
+\begin_layout Itemize
+
+\family typewriter
-Things not implemented, use ERT
+\backslash
+keywords{}
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+\family typewriter
-\begin_inset ERT
-status inlined
+\backslash
+object{}
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+
+\family typewriter
\backslash
-begin{sloppypar}
+titlerunning{}
\end_layout
-\end_inset
-
+\begin_layout Standard
+If you want to use any of these commands, you have to enter them yourself.
+
+\series bold
+Do not forget to mark them as LaTeX code!
+\end_layout
+\begin_layout Subsection
+Figure and Table Floats
\end_layout
\begin_layout Standard
+LyX provides support for the necessary float environments
+\family sans
+figure, figure*, table
+\family default
+ and
+\family sans
+table*
+\family default
+, therefore we won't tell much about it here.
+ Refer to the
+\emph on
+User's
+\begin_inset space ~
+\end_inset
+Guide
+\emph default
+.
+ Just remember that tables should be left-aligned.
+ For that, select the table and change the alignment in
+\family sans
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
+\end_inset
-\family typewriter
+Settings.
+\end_layout
-\backslash
-altaffilmark
-\family default
- (2.3),
-\family typewriter
+\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
-\backslash
-altaffiltext
+\begin_layout Enumerate
+Create a wide figure float:
+\family sans
+Insert\SpecialChar \menuseparator
+Float\SpecialChar \menuseparator
+Figure
\family default
- (2.3),
-\family typewriter
+, then right click in the figure and select
+\family sans
+\bar under
+S
+\bar default
+pan
+\begin_inset space ~
+\end_inset
-\backslash
-eqnum
+columns
\family default
- (2.12),
-\family typewriter
+.
+\end_layout
-\backslash
-setcounter{equation}
-\family default
- (2.12), Journal name abbreviations (2.13.4),
-\family typewriter
+\begin_layout Enumerate
+Enter your caption text.
+\end_layout
-\backslash
-figurenum
+\begin_layout Enumerate
+Press
+\family sans
+Return
\family default
- (2.14.1),
-\family typewriter
+ to move the cursor above the caption.
+\end_layout
-\backslash
-epsscale
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Enumerate
+Insert your figure
+\end_layout
-\backslash
-plotone
-\family default
- (2.14.1),
-\family typewriter
+\begin_layout Enumerate
+Position the cursor behind the figure and insert a horizontal fill:
+\family sans
+Insert\SpecialChar \menuseparator
+Special
+\begin_inset space ~
+\end_inset
-\backslash
-plottwo
-\family default
- (2.14.1),
-\family typewriter
+Character\SpecialChar \menuseparator
+Horizontal
+\begin_inset space ~
+\end_inset
-\backslash
-tablenum
+Fill
\family default
- (2.15.4),
-\family typewriter
+.
+\end_layout
-\backslash
-tableline
-\family default
- (2.15.4, insert it as the first element in the lefthand cell after where
- you want it.
- Don't use any of LyX's rules in the table),
-\family typewriter
+\begin_layout Enumerate
+Switch to LaTeX mode:
+\family sans
+M-c
+\begin_inset space ~
+\end_inset
-\backslash
-tablenotemark
+t
\family default
- (2.15.5),
-\family typewriter
+.
+\end_layout
-\backslash
-tablenotetext
-\family default
- (2.15.5), much of Misc (2.17, except
+\begin_layout Enumerate
+Enter
\family typewriter
\backslash
-objectname
+parbox[b]{55mm}{
\family default
-,
-\family typewriter
+.
-\backslash
-dataset
+\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
+\begin_inset space ~
+\end_inset
+
+t
\family default
-,
-\family typewriter
-\backslash
-url
-\family default
-, and
\family typewriter
-
-\backslash
-email
+}
\family default
-; see above),
-\family typewriter
+.
+\end_layout
-\backslash
-singlespace
-\family default
- (3.1),
-\family typewriter
+\begin_layout Standard
+Also, refer to the figures in the example paper.
+\end_layout
-\backslash
-doublespace
-\family default
- (3.1),
-\family typewriter
+\begin_layout Subsection
+Referee layout
+\end_layout
-\backslash
-onecolumn
+\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
- (3.2),
+ to the documentclass.
+ This must be done using the extra class options field in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
+ Just enter the string
\family typewriter
-
-\backslash
-twocolumn
+referee
\family default
- (3.2)
+ there.
\end_layout
-\begin_layout Standard
-
-
-\begin_inset ERT
-status inlined
+\begin_layout Subsection
+The example paper
+\end_layout
\begin_layout Standard
+The
+\family sans
+Examples
+\family default
+ directory contains an example paper written with LyX.
+ It is the example paper from the original macro package, translated to
+ LyX.
+ Use it for inspiration, and compare the original LaTeX code with LyX way
+ of writing.
+\end_layout
-\backslash
-end{sloppypar}
+\begin_layout Section
+AASTeX
\end_layout
-\end_inset
-
-
+\begin_layout Standard
+by
+\noun on
+Mike Ressler
\end_layout
-\begin_layout Subsubsection
+\begin_layout Subsection
+Introduction
+\end_layout
-Things that cannot be implemented
+\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
+
-\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
+\begin_layout Standard
+\align center
+\begin_inset Flex URL
+status collapsed
-FAQs, Tips, Tricks, and Other Ruminations
+\begin_layout Plain Layout
+
+http://www.journals.uchicago.edu/AAS/AASTeX
\end_layout
-\begin_layout Subsubsection
+\end_inset
+
-Getting LyX and AASTeX to cooperate
\end_layout
\begin_layout Standard
+\begin_inset VSpace medskip
+\end_inset
-It can be a bit tricky to get LyX to recognize a new layout and document
- class.
- When all else fails, do this:
-\end_layout
-\begin_layout Enumerate
+\end_layout
-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
-.
+\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 Enumerate
+\begin_layout Subsection
+Starting a New Paper
+\end_layout
-Make certain that
-\family typewriter
-aastex.layout
+\begin_layout Standard
+I strongly suggest that you start with the AASTeX template file.
+ Click on
+\family sans
+File\SpecialChar \menuseparator
+New from
+\family default
+
+\family sans
+Template
\family default
- appears in
+, enter the new file name, then choose the
\family typewriter
-/usr/.../share/lyx/layouts
+aastex.lyx
\family default
- or
+ template.
+ This will show the most common fields found in a manuscript.
+ Simply overwrite the existing text (including the brackets,
\family typewriter
-~/.lyx/layouts
+<>
\family default
-.
-\end_layout
-
-\begin_layout Enumerate
+) with the correct information.
+ Many of the AASTeX commands and environments can be implemented directly
+ in LyX, but some cannot: most noticeably
+\family typewriter
-Rerun
-\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
+\backslash
+altaffilmark
+\family default
+ and
+\family typewriter
-\bar under
-R
-\bar default
-econfigure
+\backslash
+altaffiltext
\family default
- in LyX, then restart LyX.
+, which should stick out like a sore thumb if you actually just opened the
+ template file.
+ For commands such as these, the LaTeX code must be entered directly and
+ marked as such.
+ Such commands are referred to as TeX code, or Evil Red Text.
+ I tried to minimize the amount of TeX code needed in an AASTeX document,
+ but there is still a bit more required than any of us would like.
\end_layout
-\begin_layout 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
-?
+\begin_layout Subsection
+Finishing Your Paper
\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
+When the paper is finished to your satisfaction and previews/prints correctly,
+ there are a few
\begin_inset Quotes eld
\end_inset
-You should not mix title layouts with normal ones
+postprocessing
\begin_inset Quotes erd
\end_inset
-, things haven't been installed correctly.
-\end_layout
-
-\begin_layout Subsubsection
-
-LaTeX error processing a table
+ actions which need to be done before you submit it to the journals.
+
\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
-\family default
-, then set the
-\family sans
-Alignment
-\family default
- to
+\begin_layout Enumerate
+Export your paper as a LaTeX file (
\family sans
-\bar under
-B
-\bar default
-lock
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
-.
- This took care of it for me.
-\end_layout
-
-\begin_layout Subsubsection
-
-References
-\begin_inset LatexCommand \label{cite}
-
-\end_inset
-
-
+).
+
\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;
-
-\emph on
-e.g.
-
-\emph default
-type
-\family typewriter
- Ressler(1992)
-\family default
-, not
+\begin_layout Enumerate
+Edit the resulting
\family typewriter
-Ressler (1992)
-\family default
-.
- 2) Entering the references at all is not obvious.
- The easiest thing is to start typing your first reference at the end of
- the document, then mark it as type
-\family sans
-References
+.tex
\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.
+ file with your favorite text editor
\end_layout
-\begin_layout Subsubsection
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
+\family typewriter
-Including EPS files
+\backslash
+documentclass
+\family default
+ command
\end_layout
-\begin_layout Standard
-
-Even though AASTeX provides its own figure commands (
+\begin_layout Enumerate
+remove the
\family typewriter
\backslash
-plotone
+usepackage...{fontenc}
\family default
-, for example), I much prefer LaTeX's standard figure commands (with the
- default graphicx).
- You can insert the
+ line if it appears (usually just after
\family typewriter
\backslash
-plotone
+documentclass
\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
+}; also remove the
\family typewriter
\backslash
-usepackage{graphicx}
+secnumdepth
\family default
- command into the LaTeX preamble and handle the figures in the standard
- LaTeX2e way, interspersing the figures in the text.
- I believe ApJ accepts figures exactly this way now; AJ might still use
- the
-\begin_inset Quotes eld
-\end_inset
-
-stack everything at the end
-\begin_inset Quotes erd
-\end_inset
-
- technique.
+ line if it appears.
\end_layout
-\begin_layout Subsubsection
-
-Things I could have done, but didn't
-\end_layout
+\begin_layout Enumerate
+remove everything between (and including) the
+\family typewriter
-\begin_layout Standard
+\backslash
+makeatletter
+\family default
+ and
+\family typewriter
-There are a few
+\backslash
+makeatother
+\family default
+ commands, except for any commands you specifically put into the LaTeX preamble
+ (which should appear immediately after the
\begin_inset Quotes eld
\end_inset
-pretty
+User specified LaTeX commands
\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.
-
+ comment in the
+\family typewriter
+.tex
+\family default
+ file).
\end_layout
-\begin_layout Subsection
-
-Final Caveat
+\end_deeper
+\begin_layout Enumerate
+Run the resulting file through LaTeX to make sure it still processes correctly.
\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!
+\begin_layout Enumerate
+Reread the journal requirements to make sure your filenames and formats
+ are correct.
\end_layout
-\begin_layout Section
+\begin_layout Enumerate
+Submit it.
+\end_layout
-ijmpd
+\begin_layout Subsection
+Comments On Specific Commands
\end_layout
\begin_layout Standard
+I will not describe the detailed usage of the individual AASTeX commands:
+ the AASTeX User Guide (
+\family typewriter
+aasguide.tex
+\family default
+) gives a good description of each.
+ Thus it's probably easiest for me to go down the list as found in the guide
+ and offer comments where necessary.
+ So let's begin \SpecialChar \ldots{}
-by
-\noun on
-Panayotis Papasotiriou
\end_layout
-\begin_layout Subsection
-
-Overview
+\begin_layout Subsubsection
+Things that work as expected
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
-The ijmpd package is a set of macros that facilitates electronic manuscript
- submission to the
-\emph on
-International Journal of Modern Physics D
-\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}
+\begin_layout Plain Layout
-\end_inset
-.
- The ijmpd package is a modified version of the standard
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{sloppypar}
+\end_layout
-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
-.
-\end_layout
-
-\begin_layout Subsection
-Writing a paper
\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
-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
-\bar under
-T
-\bar default
-emplate
+\backslash
+documentclass
\family default
-, then choose the
+ (2.1.1),
\family typewriter
-ijmpd.lyx
+
+\backslash
+begin{document}
\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,
+ (2.2),
\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
+\backslash
+title
+\family default
+ (2.3),
+\family typewriter
-\begin_layout Enumerate
+\backslash
+author
+\family default
+ (2.3),
+\family typewriter
-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
+\backslash
+affil
+\family default
+ (2.3),
+\family typewriter
-\bar under
-P
-\bar default
-references
+\backslash
+abstract
\family default
-, deselect the
-\family sans
-\bar under
-U
-\bar default
-se babel
+ (2.4),
+\family typewriter
+
+\backslash
+keywords
\family default
- checkbox in the language settings, and click on
-\family sans
-\bar under
-A
-\bar default
-pply
+ (2.5),
+\family typewriter
+
+\backslash
+section
\family default
- (or
-\family sans
-Save
+ (2.7),
+\family typewriter
+
+\backslash
+subsection
\family default
-, if you wish to make this change permanent).
-\end_layout
+ (2.7),
+\family typewriter
-\begin_layout Enumerate
+\backslash
+subsubsection
+\family default
+ (2.7),
+\family typewriter
-Two new environments, named
-\begin_inset Quotes eld
-\end_inset
+\backslash
+paragraph
+\family default
+ (2.7),
+\family typewriter
-Theorem
-\begin_inset Quotes erd
-\end_inset
+\backslash
+facility
+\family default
+ (2.10),
+\family typewriter
- and
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{displaymath}
+\family default
+ (2.12),
+\family typewriter
-Proof
-\begin_inset Quotes erd
-\end_inset
+\backslash
+begin{equation}
+\family default
+ (2.12),
+\family typewriter
- are available (their use is obvious).
-\end_layout
+\backslash
+begin{eqnarray}
+\family default
+ (2.12),
+\family typewriter
-\begin_layout Enumerate
+\backslash
+begin{mathletters}
+\family default
+ (2.12),
+\family typewriter
-Appendices may be added to the paper.
- LyX offers a special environment, called
-\begin_inset Quotes eld
-\end_inset
+\backslash
+begin{thebibliography}
+\family default
+ (2.13.1),
+\family typewriter
-Appendix
-\begin_inset Quotes erd
-\end_inset
+\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
- which marks the beginning of the appendix.
- An appendix can contain normal sections, subsections, or subsubsections.
-\end_layout
+\backslash
+begin{table}
+\family default
+ (2.15.4),
+\family typewriter
-\begin_layout Enumerate
+\backslash
+begin{tabular}
+\family default
+ (2.15.4),
+\family typewriter
-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
+\backslash
+caption
+\family default
+ (2.15.4),
\family typewriter
-.tex
+
+\backslash
+label
\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
+ (2.15.4, amongst other places),
+\family typewriter
+
+\backslash
+tablerefs
\family default
-).
- Details on how to create an ijmpd table float can be found in the file
-
+ (2.15.5),
\family typewriter
-ws-ijmpd.tex
+
+\backslash
+tablecomments
\family default
-, which is included in the ijmpd package.
-\end_layout
+ (2.15.5),
+\family typewriter
-\begin_layout Subsection
+\backslash
+url
+\family default
+ (2.17.4),
+\family typewriter
-Preparing a paper for submission
+\backslash
+end{document}
+\family default
+ (2.18).
\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
-ateX
+The following style options also work correctly:
+\family typewriter
+longabstract
+\family default
+ (2.4),
+\family typewriter
+preprint
\family default
-), then make the following changes to the resulting
+ (3.2.1),
\family typewriter
-.tex
+preprint2
\family default
- file.
+ (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 Enumerate
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
-Remove the comment lines before the
-\family typewriter
\backslash
-documentclass
-\family default
- command.
+end{sloppypar}
\end_layout
-\begin_layout Enumerate
+\end_inset
-Remove everything between (and including) the
+
+\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
-makeatletter
+received
\family default
- and
+,
\family typewriter
\backslash
-makeatother
+revised
\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
-\end_layout
-
-\begin_layout Standard
-
-The modified
+,
\family typewriter
-.tex
+
+\backslash
+accepted
\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 Subsection
+\backslash
+ccc
+\family default
+,
+\family typewriter
-Use of ERT
+\backslash
+cpright
+\family default
+ (all from 2.1.3)
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+These items may be placed in the LaTeX preamble, and are included as blanks
+ in the template file:
+\family typewriter
-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
+\backslash
+slugcomment
+\family default
+ (2.1.4),
\family typewriter
-ijmpd.lyx
+
+\backslash
+shorttitle
\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
+ (2.1.5),
\family typewriter
\backslash
-markboth{Authors' Names}{Short Paper's Title}
+shortauthors
\family default
-.
+ (2.1.5)
\end_layout
-\begin_layout Section
+\begin_layout Itemize
-Kluwer
-\end_layout
+\family typewriter
-\begin_layout Standard
+\backslash
+email
+\family default
+ (2.3) – can only be used
+\begin_inset Quotes eld
+\end_inset
-by
-\noun on
-Panayotis Papasotiriou
+standalone
+\begin_inset Quotes erd
+\end_inset
+
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-Overview
+\family typewriter
+
+\backslash
+and
+\family default
+ (2.3) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-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}
+\family typewriter
+\backslash
+notetoeditor
+\family default
+ (2.6) – can only be used
+\begin_inset Quotes eld
\end_inset
-).
- The Kluwer package may be downloaded from the site
-\begin_inset LatexCommand \url{http://www.wkap.nl/kaphtml.htm/STYLEFILES}
-
+standalone
+\begin_inset Quotes erd
\end_inset
-.
- A complete user guide is contained in that package (but it can also be
- downloaded separately).
+, not in the middle of a paragraph.
+ Use TeX code if you need to embed it.
\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{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 Itemize
-\begin_layout Subsection
+\family typewriter
-Writing a paper
+\backslash
+placetable
+\family default
+ (2.8) – can't insert a cross-reference tag, you must type the tag name by
+ hand
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-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
+
+\backslash
+placefigure
\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,
+ (2.8) – same as for
\family typewriter
-<>
-\family default
-) with the correct information.
-\end_layout
-
-\begin_layout Subsection
-Preparing a paper for submission
+\backslash
+placetable
\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
+\begin_layout Itemize
-postprocess
-\begin_inset Quotes erd
-\end_inset
+\family typewriter
- it as follows.
+\backslash
+acknowledgements
+\family default
+ (2.9) – will have extra {} after it.
+ This should not cause an error.
\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
+\begin_layout Itemize
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+\family typewriter
-\bar under
-L
-\bar default
-ateX
+\backslash
+appendix
\family default
-.
-
+ (2.11) – will have extra {} after it.
+ This should not cause an error.
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-Edit the resulting
\family typewriter
-.tex
+
+\backslash
+figcaption
\family default
- file with a text editor and make the following changes
-\end_layout
+ (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
-\begin_deeper
-\begin_layout Enumerate
+Short Title
+\begin_inset Quotes erd
+\end_inset
-remove the comment lines before the
+ inserts an optional argument of the type needed by
\family typewriter
\backslash
-documentclass
+figcaption
\family default
- command,
+.
+ Hopefully it will be renamed someday.
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-remove everything between (and including) the
\family typewriter
\backslash
-makeatletter
+objectname
\family default
- and
+ (2.17.1) – same as
\family typewriter
\backslash
-makeatother
+figcaption
\family default
- commands, except for any commands you specifically put into the LaTeX preamble.
+ for the catalog ID optional parameter
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-Save the resulting
\family typewriter
-.tex
-\family default
- file.
-\end_layout
-\end_deeper
-\begin_layout Enumerate
-Run the
-\family typewriter
-.tex
+\backslash
+dataset
\family default
- file through LaTeX as many times as necessary (usually up to three).
-\end_layout
-
-\begin_layout Enumerate
-
-View the resulting
+ (2.17.1) – same as
\family typewriter
-.dvi
-\family default
- document using, e.g.,
-\family sans
-xdvi
+
+\backslash
+figcaption
\family default
-, and check if everything is ok (it should, if you didn't make any mistake).
+ for the catalog ID optional parameter
\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
-
-
+\begin_layout Subsubsection
+Things not implemented, use TeX code
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
-The Kluwer package has the following
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
-peculiarities
-\begin_inset Quotes erd
-\end_inset
-.
+\backslash
+begin{sloppypar}
\end_layout
-\begin_layout Enumerate
-
-It is possible to write multiple articles in the same LaTeX file
-\begin_inset Foot
-status collapsed
+\end_inset
-\begin_layout Standard
-I can't imagine any good reason to do this.
\end_layout
-\end_inset
-
-.
- Each article must be included in the environment
-\begin_inset Quotes eld
-\end_inset
-
-article
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
-.
- Unfortunately, this environment cannot be omitted, even if you write just
- one article.
- Therefore, each article starts with the command
\family typewriter
\backslash
-begin{article}
+altaffilmark
\family default
- and, obviously, ends with the command
+ (2.3),
\family typewriter
\backslash
-end{article}
+altaffiltext
\family default
-.
- Although this can be implemented in LyX, I didn't included it, since it
- looks ugly and can confuse the novice user.
- Therefore, you need to enter them directly and mark them as LaTeX code
- (the well-known
-\begin_inset Quotes eld
-\end_inset
-
-ERT
-\begin_inset Quotes erd
-\end_inset
-
-).
-\end_layout
-
-\begin_layout Enumerate
-
-Information given at the beginning of the article (i.e., title, subtitle,
- author, institution, running title, running author, abstract and keywords)
- must be included in an environment called
-\begin_inset Quotes eld
-\end_inset
-
-opening
-\begin_inset Quotes erd
-\end_inset
-
-.
- This is not implemented in LyX, so you must enter title, subtitle etc.
- between two ERT lines (
+ (2.3),
\family typewriter
\backslash
-begin{opening}
+eqnum
\family default
- and
+ (2.12),
\family typewriter
\backslash
-end{opening}
+setcounter{equation}
\family default
-).
-\end_layout
-
-\begin_layout Enumerate
-
-According to the user manual, the label of each bibliography item must be
- written as
+ (2.12), Journal name abbreviations (2.13.4),
\family typewriter
\backslash
-protect
-\backslash
-citeauthoryear{
+figurenum
\family default
-\emph on
-author(s)
+ (2.14.1),
\family typewriter
-\emph default
-}{
+
+\backslash
+epsscale
\family default
-\emph on
-year
+ (2.14.1),
\family typewriter
-\emph default
-}
-\family default
-.
-\end_layout
-\begin_layout Standard
-
-The
-\family typewriter
-kluwer.lyx
+\backslash
+plotone
\family default
- template takes care of all these
-\begin_inset Quotes eld
-\end_inset
-
-peculiarities
-\begin_inset Quotes erd
-\end_inset
-
-.
- If you start a new paper using this template you don't need to do anything
- special.
- Just
-\end_layout
-
-\begin_layout Enumerate
-
-don't delete the ERT included in the template, and
-\end_layout
-
-\begin_layout Enumerate
-
-copy the example bibliography item included in the template and modify it
- as necessary to enter new bibliography items.
-\end_layout
-
-\begin_layout Section
-
-Koma-Script
-\end_layout
-
-\begin_layout Standard
+ (2.14.1),
+\family typewriter
-by
-\noun on
-Bernd Rellermeyer
-\end_layout
+\backslash
+plottwo
+\family default
+ (2.14.1),
+\family typewriter
-\begin_layout Subsection
+\backslash
+tablenum
+\family default
+ (2.15.4),
+\family typewriter
-Overview
-\end_layout
+\backslash
+tableline
+\family default
+ (2.15.4, insert it as the first element in the lefthand cell after where
+ you want it.
+ Don't use any of LyX's rules in the table),
+\family typewriter
-\begin_layout Standard
+\backslash
+tablenotemark
+\family default
+ (2.15.5),
+\family typewriter
-The LyX document classes
-\emph on
- article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
-,
-\emph on
-book
-\emph default
-
-\emph on
-(koma-script)
-\emph default
-, and
-\emph on
-letter
-\emph default
-
-\emph on
-(koma-script)
-\emph default
- correspond to the LaTeX document classes
+\backslash
+tablenotetext
+\family default
+ (2.15.5), much of Misc (2.17, except
\family typewriter
-scrartcl.cls
+
+\backslash
+objectname
\family default
,
\family typewriter
-scrreprt.cls
+
+\backslash
+dataset
\family default
,
\family typewriter
-scrbook.cls
+
+\backslash
+url
\family default
, and
\family typewriter
-scrlettr.cls
+
+\backslash
+email
\family default
-, resp.
- of the Koma-Script family.
- They are replacements for the standard document classes
+; see above),
\family typewriter
-article.cls
+
+\backslash
+singlespace
\family default
-,
+ (3.1),
\family typewriter
-report.cls
+
+\backslash
+doublespace
\family default
-,
+ (3.1),
\family typewriter
-book.cls
+
+\backslash
+onecolumn
\family default
- and
+ (3.2),
\family typewriter
-letter.cls
+
+\backslash
+twocolumn
\family default
-, resp., and fit better to European typography conventions in a number of
- points.
+ (3.2)
\end_layout
-\begin_layout Itemize
-
-Standard character size is 11pt in
-\emph on
-article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
-, and
-\emph on
-book (koma-script)
-\emph default
-, and 12pt in
-\emph on
-letter (koma-script)
-\emph default
-.
-\end_layout
+\begin_layout Standard
+\begin_inset ERT
+status open
-\begin_layout Itemize
+\begin_layout Plain Layout
-Headings, labels of the description environment, and a number of elements
- of the
-\emph on
-letter (koma-script)
-\emph default
-document class are set in a bold sans serif font.
-\begin_inset Foot
-status collapsed
-\begin_layout Standard
+\backslash
+end{sloppypar}
+\end_layout
-There is a big difference between the bold sans serif old cm fonts and new
- ec fonts, especially in the appearance of headings.
- In comparison, the ec bold sans serif fonts look a bit thin.
- Here the LaTeX package
-\family typewriter
-cmsd.sty by
-\family default
-\shape smallcaps
-Walter Schmidt
-\shape default
- helps to produce the
-\begin_inset Quotes eld
\end_inset
-usual
-\begin_inset Quotes erd
-\end_inset
- appearance when using the ec fonts.
\end_layout
-\end_inset
+\begin_layout Subsubsection
+Things that cannot be implemented
+\end_layout
- The numbering of chapter headings is made in the same way as the numbering
- of section headings, that is without the extra line
-\begin_inset Quotes eld
+\begin_layout Standard
+\SpecialChar \ldots{}
+ at least in any meaningful sort of way, so I suggest ignoring them.
+ They are the references environment (2.13.3), and the deluxetable environment
+ (2.15).
+ If you really, really need to use deluxetable, I suggest editing it in
+ a separate file with a text editor, then using
+\family sans
+Insert\SpecialChar \menuseparator
+Child
+\begin_inset space ~
\end_inset
-Chapter\SpecialChar \ldots{}
+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_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+FAQs, Tips, Tricks, and Other Ruminations
+\end_layout
-.
- In addition, the appearance of the headings can be modified by using a
- number of options (in LyX to be entered in the field
-\family sans
-E
-\bar under
-x
-\bar default
-tra\InsetSpace ~
-Options
-\family default
- of the dialog
-\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
+\begin_layout Subsubsection
+Getting LyX and AASTeX to cooperate
+\end_layout
-\bar under
-D
-\bar default
-ocument
+\begin_layout Standard
+It can be a bit tricky to get LyX to recognize a new layout and document
+ class.
+ When all else fails, do this:
+\end_layout
+
+\begin_layout Enumerate
+Make certain that LaTeX can find AASTeX.
+ Copy sample.tex (and perhaps table.tex) from the AASTeX distribution into
+ a directory completely unrelated to LaTeX or AASTeX and run LaTeX on
+\family typewriter
+sample.tex
\family default
-).
- A detailed German description of these options can be found in the Koma-Script
- documentation
-\emph on
-scrguide
-\emph default
.
\end_layout
-\begin_layout Itemize
-
-The main means in the Koma-Script document classes to design the type area
- are the options
-\family sans
-BCOR
+\begin_layout Enumerate
+Make certain that
+\family typewriter
+aastex.layout
\family default
- and
-\family sans
-DIV
+ appears in LyX's
+\family typewriter
+layouts
\family default
- (in LyX to be entered in the extra class options field in the dialog
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+ folder
+\end_layout
-\bar under
-S
-\bar default
-ettings
-\family default
-).
- They make a clearer modification of page margins possible as do the options
- of the dialog
+\begin_layout Enumerate
+Rerun
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
+Tools\SpecialChar \menuseparator
+Reconfigure
\family default
-.
- A detailed German description of these and other type area options can
- be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
+ in LyX, then restart LyX.
\end_layout
-\begin_layout Itemize
-
-The LaTeX document classes of the Koma-Script family define a number of
- additional commands.
- Those part of it which makes sense in LyX is implemented in corresponding
- paragraph types.
+\begin_layout Enumerate
+Open a regular new file, not from a template.
+ Does AASTeX appear in the class list in
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+?
\end_layout
\begin_layout Standard
+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
-A detailed German description of the LaTeX document classes of the Koma-Script
- family can be found in the Koma-Script documentation
-\emph on
-scrguide
-\emph default
-.
-\begin_inset Foot
-status collapsed
+You should not mix title layouts with normal ones
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+, things haven't been installed correctly.
+\end_layout
-There is an English translation
-\emph on
-screnggu
-\emph default
-, but it is not a complete one.
+\begin_layout Subsubsection
+LaTeX error processing a table
\end_layout
+\begin_layout Standard
+LyX, by default, attempts to center the table caption/title.
+ This seems to produce a bad interaction in AASTeX so you should click somewhere
+ in the caption/title, then select
+\family sans
+Edit\SpecialChar \menuseparator
+Paragraph
+\begin_inset space ~
\end_inset
- The following sections describe only those aspects, which are relevant
- in LyX.
+Settings
+\family default
+, then set the
+\family sans
+Alignment
+\family default
+ to
+\family sans
+Block
+\family default
+.
+ This took care of it for me.
\end_layout
-\begin_layout Subsection
-
-article (koma-script), report (koma-script), and book (koma-script)
+\begin_layout Subsubsection
+References
\end_layout
\begin_layout Standard
-
-The document classes
-\emph on
-article (koma-script)
-\emph default
-,
-\emph on
-report (koma-script)
-\emph default
-, and
+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
-book
+no
\emph default
+ space between the last author and the parenthesis setting off the year;
\emph on
-(koma-script)
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
\emph default
- are implemented in the layout files
-\family typewriter
-scrartcl.layout
-\family default
-,
+type
\family typewriter
-scrreprt.layout
+Ressler(1992)
\family default
-, and
+, not
\family typewriter
-scrbook.layout
-\family default
-, resp.
- They contain all the paragraph types of the corresponding standard document
- classes
-\emph on
-article
-\emph default
-,
-\emph on
-report
-\emph default
-, and
-\emph on
-book
-\emph default
-, resp., partly modified, with the exception of the LyX specific
-\family sans
-List
-\family default
--type, which is replaced by the new
-\family sans
-Labeling
+Ressler (1992)
\family default
--type having the same functionality.
- Beside the
+.
+ 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
-Labeling
+References
\family default
--Type there is a number of new paragraph types added.
- They are
-\emph on
-not
-\emph default
- part of
-\emph on
-letter (koma-script)
-\emph default
.
+ That will put a small gray box in front of what you just typed.
+ Click on the box to fill in the rest of the information.
+ For new references, go to the end of an existing reference and press return.
+ That will create a new line with its own box, etc.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection
+Including EPS files
+\end_layout
+\begin_layout Standard
+Even though AASTeX provides its own figure commands (
+\family typewriter
-\family sans
-Addpart, Addchap
-\family default
-,
-\family sans
-Addsec
+\backslash
+plotone
\family default
-: are equivalents to
-\family sans
-Part*, Chapter*
+, for example), I much prefer LaTeX's standard figure commands (with the
+ default graphicx).
+ You can insert the
+\family typewriter
+
+\backslash
+plotone
\family default
- and
-\family sans
-Section*
+, etc.
+\begin_inset space ~
+\end_inset
+
+commands as TeX code into a Figure Float box if you desire, but I never
+ have much luck getting the layout right.
+ With the standard graphics, LyX will insert a
+\family typewriter
+
+\backslash
+usepackage{graphicx}
\family default
-, resp., additionally inserting an entry in the table of contents.
-
-\family sans
-Addpart
-\family default
-and
-\family sans
- Addchap
-\family default
- are not contained in
-\emph on
-article (koma-script)
-\emph default
-.
+ command into the LaTeX preamble and handle the figures in the standard
+ LaTeX2e way, interspersing the figures in the text.
+ I believe ApJ accepts figures exactly this way now; AJ might still use
+ the
+\begin_inset Quotes eld
+\end_inset
+
+stack everything at the end
+\begin_inset Quotes erd
+\end_inset
+
+ technique.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsubsection
+Things I could have done, but didn't
+\end_layout
+\begin_layout Standard
+There are a few
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Addchap*
-\family default
-,
-\family sans
-Addsec*
-\family default
-: behave exactly as
-\family sans
-Addchap
-\family default
- and
-\family sans
-Addsec
-\family default
-, resp., additionally clearing running heads.
+pretty
+\begin_inset Quotes erd
+\end_inset
-\family sans
- Addchap*
-\family default
- is not contained in
-\emph on
-article (koma-script)
-\emph default
-.
-\begin_inset Foot
-status collapsed
+ 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 Subsection
+Final Caveat
+\end_layout
\begin_layout Standard
+Your mileage may vary.
+ I've now had papers published by both ApJ and AJ that have had 98% of the
+ effort done in LyX; the last 2% was the LaTeX post-processing and a few
+ 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
-There is also an
-\family typewriter
+\begin_layout Section
+AMS LaTeX
+\end_layout
-\backslash
-addpart*
-\family default
- command in
-\emph on
-book (koma-script)
-\emph default
- and in
-\emph on
-report (koma-script)
-\emph default
-, but since this is identical to
-\family sans
-Part*
-\family default
-, is has not been implemented in LyX.
+\begin_layout Standard
+by
+\noun on
+David Johnson; updated by Richard Heck
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\noindent
+The AMS LaTeX layouts are set up to conform to suggested styles for mathematical
+ papers to be submitted to American Mathematical Society publications.
+ The layouts are not tailored to a specific journal, but easily can be.
+ You should refer to the AMS documentation for specific instructions for
+ each journal (usually it will entail only changing a single line in the
+ TeX output).
+ That documentation is available on the Web at
+\begin_inset Flex URL
+status open
+\begin_layout Plain Layout
-\family sans
-Minisec
-\family default
-: generates a heading directly above the following paragraph in the standard
- character size without affecting the structure of the document.
+http://www.ams.org
\end_layout
-\begin_layout Itemize
+\end_inset
+ or by ftp at
+\begin_inset Flex URL
+status open
-\family sans
-Captionabove
-\family default
- and
-\family sans
-Captionbelow
-\family default
-are special captions which respect the different space settings needed for
- captions placed above or below an element (if you follow strict typographic
- rules, you might want to place table captions always above the table).
- You can also use the class option
-\family typewriter
-tablecaptionsabove
-\family default
-, which will switch
-\family sans
-caption
-\family default
- to
-\family sans
-captionabove
-\family default
- for tables and
-\family sans
-captionbelow
-\family default
- for figures.
- You need at least Koma-Script version 2.8q to use this.
+\begin_layout Plain Layout
+
+ftp://ftp.ams.org/pub/tex/amslatex/
\end_layout
-\begin_layout Itemize
+\end_inset
+.
+ These layouts are appropriate, and useful, for any mathematical writing.
+
+\end_layout
-\family sans
-Dictum
-\family default
-: can be used to set a bonmot, e.
-\begin_inset ERT
-status collapsed
+\begin_layout Standard
+There are two basic AMS LaTeX layouts:
+\end_layout
+
+\begin_layout Itemize
+amsart: The standard AMS article format.
+\end_layout
+
+\begin_layout Itemize
+amsbook: the standard AMS book (really, monograph) format.
+
+\end_layout
\begin_layout Standard
+The layouts themselves contain only the minimum necessary to use the AMS
+ classes.
+ They do not, in particular, contain any of the `theorem' environments used
+ for setting theorems, lemmas, and the like.
+ These are contained, instead, in the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-,
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
\end_inset
-g.
-\begin_inset ERT
+ module, which is loaded by default when when you select one of the AMS
+ classes.
+ (It can also be used with other classes and can be removed, if you would
+ rather use something else.) Less commonly used environments are in the
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout Standard
-
-\backslash
-
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
\end_inset
-at the beginning of a chapter.
- If you use the optional argument (
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
-Short\InsetSpace ~
-Title
-\family default
-), you can insert the dictum's author there.
- Dictum and author are separated by a line.
- You need at least Koma-Script version 2.8q to use this.
-
-\family sans
-Dictum
-\family default
- is not contained in
-\emph on
-article (koma-script)
-\emph default
-.
+ module, which must be loaded manually.
\end_layout
\begin_layout Standard
+By default, theorems and the like are numbered consecutively throughout
+ the document, but this may be modified by loading the module
+\begin_inset Flex CharStyle:Code
+status collapsed
-The following types, together with the standard types
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-, and
-\family sans
-Date
-\family default
-, form the title area of the document.
- They must be entered ahead of the first
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Theorems (Order by Section)
+\end_layout
-ordinary
-\begin_inset Quotes erd
\end_inset
- paragraph.
-\begin_inset Foot
+ or, if you are using
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout Standard
-
-The corresponding LaTeX commands must appear before the
-\family typewriter
-
-\backslash
-maketitle
-\family default
- command.
+\begin_layout Plain Layout
+book (AMS)
\end_layout
\end_inset
- When such a type is used more than once, the latter usage overwrites the
- former one, that means, for every type only the latest usage is valid.
- The order of the different types however has, like
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-, and
-\family sans
-Date
-\family default
-, no effect on the appearance of the produced document.
+, the module
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (Order by Chapter)
\end_layout
-\begin_layout Itemize
+\end_inset
+.
+ These will number the results as
+\begin_inset Formula $n.m$
+\end_inset
-\family sans
-Subject
-\family default
-: produces a centered paragraph above the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-) for the subject of the document.
-\end_layout
-
-\begin_layout Itemize
-
+, where the first number refers to the section (or chapter) and the second
+ refers to the total number of results so far in that section (or chapter).
+ Many environments are also available unnumbered.
+ These are indicated by an asterisk at the end.
+ If you happen to want
+\emph on
+only
+\emph default
+ unnumbered results, the the module
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Publishers
-\family default
-: produces a centered paragraph below the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-) for the publishers' name.
+\begin_layout Plain Layout
+Theorems (Starred)
\end_layout
-\begin_layout Itemize
+\end_inset
+ provides that option.
+\end_layout
-\family sans
-Dedication
-\family default
-: in
-\emph on
-report (koma-script)
-\emph default
- and
-\emph on
-book (koma-script)
-\emph default
- produces a centered paragraph on its own page behind the title page, or
- in
+\begin_layout Standard
+Note that these modules do not
\emph on
-article (koma-script)
+have
\emph default
- produces a centered paragraph below the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
-,
-\family sans
-Publishers
-\family default
-) for a dedication.
+ to be used with the AMS classes.
+ It is perfectly possible to use the
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Itemize
+\end_inset
+ module, and the others mentioned, with other classes, such as
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article
+\end_layout
+
+\end_inset
-\family sans
-Titlehead
-\family default
-: produces a left aligned paragraph above the ordinary title (
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
-\family sans
-Date
-\family default
,
-\family sans
-Subject
-\family default
-) for a document`s head.
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+report
\end_layout
-\begin_layout Itemize
+\end_inset
+,
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family sans
-Uppertitleback
-\family default
-: produces in a double-sided print in
-\emph on
-report (koma-script)
-\emph default
- and
-\emph on
-book (koma-script)
-\emph default
- a left-aligned paragraph at the top of the title page`s back or has no
- effect in a single-sided print or in
-\emph on
-article (koma-script)
-\emph default
-.
+\begin_layout Plain Layout
+book (KOMA-script)
\end_layout
-\begin_layout Itemize
+\end_inset
+, and so forth.
+\end_layout
-\family sans
-Lowertitleback
-\family default
-: produces in a double-sided print in
-\emph on
-report (koma-script)
-\emph default
- and
-\emph on
-book (koma-script)
-\emph default
- a left-aligned paragraph at the bottom of the title page`s back or has
- no effect in a single-sided print or in
-\emph on
-article (koma-script)
-\emph default
-.
+\begin_layout Subsection
+What these layouts provide
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+There is a long list of included environments provided by these layouts.
+ In AMS-LaTeX, there is, in fact, an opportunity to define an unlimited
+ variety of `theorem' environments.
+ However, the AMS recommends the environments that are available in LyX.
+
+\end_layout
+\begin_layout Standard
+The following environments—as well as the standard environments, such as
+
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+section
+\end_layout
-\family sans
-Extratitle
-\family default
-: produces a special
-\begin_inset Quotes eld
\end_inset
-dirty
-\begin_inset Quotes erd
+,
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+bibliography
+\end_layout
+
\end_inset
- page ahead of the actual document containing a paragraph without special
- formatting.
+,
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+title
\end_layout
-\begin_layout Standard
+\end_inset
-The layout files for the document classes
-\emph on
-article (koma-script)
-\emph default
,
-\emph on
-report (koma-script)
-\emph default
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+author
+\end_layout
+
+\end_inset
+
, and
-\emph on
-book (koma-script)
-\emph default
- do include the file
-\family typewriter
-scrmacros.inc
-\family default
-.
- This is thought of as a place to define your own types.
- Copy s
-\family typewriter
-crmacros.inc
-\family default
- in your personal layout directory and edit the file!
+\begin_inset Flex CharStyle:Noun
+status collapsed
+
+\begin_layout Plain Layout
+date
\end_layout
-\begin_layout Subsection
+\end_inset
-letter (koma-script)
+—are provided by
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+article (AMS)
\end_layout
-\begin_layout Standard
+\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
-\begin_inset ERT
-status inlined
+\begin_layout Plain Layout
+book (AMS)
+\end_layout
-\begin_layout Standard
+\end_inset
-\backslash
-begin{sloppypar}
+:
+\end_layout
+
+\begin_layout Description
+Address This should be the author's permanent address.
\end_layout
+\begin_layout Description
+Current
+\begin_inset space ~
\end_inset
+Address This should be the author's temporary address at the time of submission,
+ if different from the Address.
+\end_layout
+\begin_layout Description
+Email Author's e-mail address
\end_layout
-\begin_layout Standard
-\noindent
-The document class
+\begin_layout Description
+URL Author's Web address, if desired.
+\end_layout
+
+\begin_layout Description
+Keywords Key words or phrases used to identify specific topics discussed
+ in the paper.
+\end_layout
+
+\begin_layout Description
+Subjectclass These refer to the AMS Subject Classifications, published and
+ described in
\emph on
-letter (koma-script)
+Mathematical Reviews
\emph default
- is implemented in the layout file
-\family typewriter
-scrlettr.layout
-\family default
.
- It contains all the paragraph types of the corresponding standard document
- class
-\emph on
-letter
-\emph default
-, partly modified, with the exception of the LyX specific types
-\family sans
-LyX-Code
-\family default
- and
-\family sans
-Comment
-\family default
- and the
-\family sans
-List
-\family default
- type, which is replaced by the new
-\family sans
-Labeling
-\family default
- type.
- In addition, it contains, in contrast to the standard document class, the
- standard types
-\family sans
-LaTeX
-\family default
-,
-\family sans
-Quotation
-\family default
-,
-\family sans
-Quote
-\family default
-, and
-\family sans
-Verse
-\family default
-.
- Furthermore, there are a number of new letter specific types.
+ These are also available online at the AMS cites listed above.
\end_layout
-\begin_layout Standard
+\begin_layout Description
+Thanks
+\end_layout
+\begin_layout Description
+Dedicatory
+\end_layout
-\begin_inset ERT
-status inlined
+\begin_layout Description
+Translator
+\end_layout
\begin_layout Standard
+The following environments are provided by both the
+\begin_inset Flex CharStyle:Code
+status collapsed
-\backslash
-end{sloppypar}
+\begin_layout Plain Layout
+Theorems
\end_layout
\end_inset
+ and
+\begin_inset Flex CharStyle:Code
+status collapsed
+\begin_layout Plain Layout
+Theorems (AMS)
\end_layout
-\begin_layout Standard
+\end_inset
-The appearance of the letter produced by this document class can be controlled
- by a number of LaTeX commands, which you can put in the LaTeX preamble.
-\begin_inset Foot
+ modules, in the latter case in both starred (unnumbered) and unstarred
+ (numbered) versions.
+ These same environments are provided only in the starred versions by the
+
+\begin_inset Flex CharStyle:Code
status collapsed
-\begin_layout Standard
-
-For example, the standard appearance of the letter`s heading, consisting
- of name and address, is quite self-willed.
- An
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+Theorems (Starred)
+\end_layout
-ordinary
-\begin_inset Quotes erd
\end_inset
- heading is produced by the following LaTeX commands in the preamble:
+ module:
\end_layout
-\begin_layout LyX-Code
+\begin_layout Theorem
+This is typically used for the statements of major results.
+
+\end_layout
+\begin_layout Corollary*
+This is used for statements which follow fairly directly from previous statement
+s.
+ Again, these can be major results.
+
+\end_layout
-\backslash
-firsthead{
-\backslash
-parbox[b]{
-\backslash
-textwidth}
+\begin_layout Lemma
+These are smaller results needed to prove other statements.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Proposition
+These are less major results which (hopefully) add to the general theory
+ being discussed.
+\end_layout
- {
-\backslash
-ignorespaces
-\backslash
-fromname
-\backslash
+\begin_layout Conjecture
+These are statements provided without justification, which the author does
+ not know how to prove, but which seem to be true (to the author, at least).
+\end_layout
-\backslash
+\begin_layout Definition*
+Guess what this is for.
+ The font is different for this environment than for the previous ones.
-\backslash
-ignorespaces
-\backslash
-fromaddress}}
\end_layout
-\begin_layout LyX-Code
+\begin_layout Example*
+Used for examples illustrating proven results.
+\end_layout
+\begin_layout Problem
+It's not really known what this is for.
+ You should figure it out.
+\end_layout
-\backslash
-nexthead{
-\backslash
-parbox[b]{
-\backslash
-textwidth}
+\begin_layout Exercise*
+Write a description for this one.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Remark
+This environment is also a type of theorem, usually a lesser sort of observation.
+\end_layout
- {
-\backslash
-ignorespaces
-\backslash
-fromname
-\backslash
-hfill
-\backslash
-ignorespaces
-\backslash
-pagename
-\backslash
+\begin_layout Claim*
+Often used in the course of giving a proof of a larger result.
+\end_layout
+
+\begin_layout Case
+Generally, these are used to break up long arguments, using specific instances
+ of some condition.
-\backslash
-thepage}}
\end_layout
-\end_inset
+\begin_layout Case
+The numbering scheme for cases is on its own, not together with other numbered
+ statements.
+
+\end_layout
- A detailed German description of such LaTeX commands can be found in the
- Koma-Script documentation
+\begin_layout Proof
+At the end of this environment, a QED symbol (usually a square, but it can
+ vary with different styles) is placed.
+ If you want to have other environments within this one—for example, Case
+ environments—and have the QED symbol appear only after them, then the other
+ environments need to be nested within the proof environment.
+ See the section
\emph on
-scrguide
+Nesting Environments
\emph default
-.
- With it, the letter's author can produce his personal letter layout.
+ of the
+\emph on
+User's Guide
+\emph default
+ for information on nesting.
\end_layout
\begin_layout Standard
+And these environments are provided by
+\begin_inset Flex CharStyle:Code
+status collapsed
-The types
-\family sans
-Letter
-\family default
-and
-\family sans
-Opening
-\family default
- define the beginning of the letter and must be used in every letter.
- To emphasize them in the LyX document class, they are marked with the letter
-
-\shape italic
-L
-\shape default
- or
-\shape italic
-O
-\shape default
-, resp.
- in the left margin.
- It is possible to write any number of letters in one file.
- An
-\family sans
-Opening
-\family default
- type produces a new letter using the same addressee and a
-\family sans
-Letter
-\family default
- type produces a new addressee.
- The types
-\family sans
-Closing
-\family default
-,
-\family sans
-PS
-\family default
-,
-\family sans
-CC
-\family default
-, and
-\family sans
-Encl
-\family default
- are ordinary paragraph types and can also be used several times in one
- and the same letter.
+\begin_layout Plain Layout
+Theorems (AMS-Extended)
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family sans
-Letter
-\family default
-: produces a paragraph for the addressee and implicitly defines the beginning
- of the letter.
+:
\end_layout
-\begin_layout Itemize
+\begin_layout Criterion*
+A required condition.
+\end_layout
+\begin_layout Algorithm*
+A general procedure to be used.
+\end_layout
-\family sans
-Opening
-\family default
-: produces a paragraph for the form of address and implicitly produces a
- new letter.
+\begin_layout Axiom*
+This is a property or statement taken as true within the system being discussed.
\end_layout
-\begin_layout Itemize
+\begin_layout Condition*
+Sometimes used to state a condition assumed within the present context of
+ discussion.
+\end_layout
+\begin_layout Note*
+Similar to a Remark.
+\end_layout
-\family sans
-Closing
-\family default
-: produces a paragraph for a close.
+\begin_layout Notation*
+Used for the explanation of, yes, notation.
\end_layout
-\begin_layout Itemize
+\begin_layout Summary
+Do we really need to tell you?
+\end_layout
+\begin_layout Acknowledgement*
+Acknowledgement.
+\end_layout
-\family sans
-PS
-\family default
-: produces a paragraph for a postscript.
+\begin_layout Conclusion*
+Sometimes used at the end of a long train of argument.
\end_layout
-\begin_layout Itemize
+\begin_layout Fact
+Used in a way similar to Proposition, though perhaps lower on the scale.
+\end_layout
+\begin_layout Standard
+In addition, the AMS classes automatically provide the AMS LaTeX and AMS
+ fonts packages.
+ They need to be available on your system in order to use these environments.
+\end_layout
+\begin_layout Section
+AGU journals (
\family sans
-CC
+aguplus
\family default
-: produces a paragraph for a distribution list.
+)
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+by
+\shape smallcaps
+Martin Vermeer
+\end_layout
-\family sans
-Encl
-\family default
-: produces a paragraph for enclosures.
+\begin_layout Subsection
+Description
\end_layout
\begin_layout Standard
+These are the layout files for some of the journals of the American Geophysical
+ Society.
+ It is assumed that you have both the AGU's own class files and AGUplus
+ installed (everything to be found at
+\begin_inset Flex URL
+status collapsed
-The types
-\family sans
-Name
-\family default
-,
-\family sans
-Signature
-\family default
-,
+\begin_layout Plain Layout
+
+ftp://ftp.agu.org/journals/latex/journals
+\end_layout
+
+\end_inset
+
+).
+\end_layout
+
+\begin_layout Subsection
+New styles
+\end_layout
+
+\begin_layout Standard
+Redefined are
\family sans
-Address
+Paragraph
\family default
-,
+,
\family sans
- Telephone
+Paragraph*
\family default
-,
+.
+ They are still called this in the LyX GUI, though their LaTeX equivalents
+ in the AGU classes are
\family sans
-Place
+Subsubsubsection
\family default
-,
+ and
\family sans
-Backaddress
+Subsubsubsection*
\family default
-,
+.
+\end_layout
+
+\begin_layout Standard
+Newly defined styles are
\family sans
-Specialmail
+Left_Header
\family default
,
\family sans
-Location
+Right_Header
\family default
,
\family sans
-Title
+Received
\family default
-, and
+,
\family sans
-Subject
+Revised
\family default
- are input types provided with a label to enter information, which will
- be processed by the document class.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-It could be seen as a matter of inconsequence, that the types
+,
\family sans
-Letter
+Accepted
\family default
- and
+,
\family sans
-Opening
+CCC
\family default
- described above are not such input types as well.
- Because of the special meaning of those types, however, I have implemented
- them as ordinary paragraph types with a one letter mark in the left margin.
- Moreover, it would affect my feeling of symmetry, if the
+,
\family sans
-Opening
+PaperId
\family default
- type and the
+,
\family sans
-Closing
+AuthorAddr
\family default
- type had such a serious different appearance.
-\end_layout
-
-\end_inset
-
- The types must be used ahead of the corresponding
+,
\family sans
-Opening
+SlugComment
\family default
- type.
+.
+ These are mostly manuscript attributes and defined in the AGU class documentati
+on.
\end_layout
\begin_layout Standard
+I suspect this is still badly incomplete.
+\end_layout
-An implementation of these types in a WYSIWYG fashion does not seem to make
- sense, because the real appearance of the produced letter does not only
- depend on the usage of the particular type, but also on other factors.
- For example, a signature entered in the
-\family sans
-Signature
-\family default
- type will in the standard behavior appear in the produced letter only,
- when in the same letter also a
-\family sans
-Closing
-\family default
- type is used.
- The entered value of the
-\family sans
-Telephone
-\family default
- type will in the standard behavior not appear in the produced letter at
- all.
- The possibility to design the letter`s heading freely is already indicated
- in a footnote above.
+\begin_layout Subsection
+New floats
\end_layout
\begin_layout Standard
-The input types can also be used as empty paragraphs.
- This makes sense e.\InsetSpace ~
-g.
- for the
-\family sans
-Signature
-\family default
- type.
- If the
\family sans
-Signature
+Planotable
\family default
- type is not used at all, in the standard behavior the value of the
+ and
\family sans
-Name
+Plate
\family default
- type is used as signature, whereas if an empty
+.
+ We also have a new
\family sans
-Signature
+Table_Caption
\family default
- type is used, no signature value is defined.
+.
\end_layout
-\begin_layout Standard
-
-By using the input types it is possible to write a letter template, containing
- filled input types with your personal dates (name, address, etc.) and empty
- input types for other dates you want to enter.
+\begin_layout Subsection
+Supported journals
\end_layout
\begin_layout Itemize
+\emph on
+Journal of Geophysical Research
+\emph default
+:
+\family typewriter
+jgrga.layout
+\family default
+ — Martin Vermeer
+\end_layout
-\family sans
-Name
+\begin_layout Standard
+Add your own, it isn't so hard! Look at the
+\family typewriter
+jgrga.layout
\family default
-: sender's name, in the standard behavior appears as a centered paragraph
- in small caps in the letter`s heading.
+ example and
+\family typewriter
+aguplus.inc
+\family default
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Bugs and things to remember
+\end_layout
+
+\begin_layout Standard
+In order to use the new layouts, you must remember to do the following for
+ a new document:
+\end_layout
+\begin_layout Enumerate
+\emph on
+Turn off babel
+\emph default
+.
+ This can be done in the
\family sans
-Signature
+Layout\SpecialChar \menuseparator
+Document
\family default
-: sender's signature, in the standard behavior appears below the
+ or
\family sans
-Closing
+Document\SpecialChar \menuseparator
+Settings
\family default
- type.
- If no
-\family sans
-Signature
+ menu item.
+ (AGU articles are always in English, right? So
+\emph on
+don't
+\emph default
+ choose a language.)
+\end_layout
+
+\begin_layout Enumerate
+Enter
+\family typewriter
+jgrga
\family default
- type is used, the value of the
+ into the document's
\family sans
-Name
+Extra Options
\family default
- type appears instead.
+ field.
+ (Yes, this is a bug.)
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Enumerate
+Make sure you use the
+\family typewriter
+agu.bst
+\family default
+ bibliography style, by entering
\family sans
-Address
+agu
\family default
-: sender's address, in the standard behavior appears in a centered paragraph
- in the letter`s heading below the sender's name.
+ into the second field of the BibTeX inset.
+ None of the standard styles will do.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Section
+Broadway
+\end_layout
-\family sans
-Telephone
-\family default
-: sender's telephone number, in the standard behavior only sets the LaTeX
- variable
-\family typewriter
+\begin_layout Standard
+by
+\shape smallcaps
+Garst Reese
+\end_layout
-\backslash
-telephonenum
-\family default
-.
+\begin_layout Subsection
+Introduction
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Broadway is for writing plays.
+ The format is more decorative than Hollywood, and much less standardized.
+ This format should be suitable for workshops.
+\end_layout
+\begin_layout Subsection
+Special problems
+\end_layout
-\family sans
-Place
-\family default
-: place of the letter`s making.
+\begin_layout Standard
+The same as in Hollywood.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Subsection
+Special features
+\end_layout
+\begin_layout Standard
+Insert the
\family sans
-Date
-\family default
-: date of the letter`s making.
-
-\family sans
-Place
-\family default
- and
-\family sans
-Date
-\family default
-, in the standard behavior, produce the place and the date in a right-aligned
- line below the addressee's field.
- If an empty
-\family sans
-Date
-\family default
- type is used, neither place nor date appear, independent of the value of
- the
-\family sans
-Place
-\family default
- type.
- If no
-\family sans
-Date
+Speaker
\family default
- type is used, the date of the letter `s production is used.
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Paper size and Margins
+\end_layout
+\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
-\family sans
-Backaddress
-\family default
-: sender`s back address, in the standard behavior appears above the addressee's
- field in a small sans serif font.
+\begin_layout Subsection
+Environments
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The following environments are available.
+ You can use broadway.bind to get the bind keys shown at the right.
+\end_layout
+\begin_layout Itemize
\family sans
-Specialmail
+Standard
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: special mail information, in the standard behavior appears underlined
- above the addressee's field below the back address.
+You should not have to use this, but it is here for anything that does not
+ fit otherwise.
\end_layout
\begin_layout Itemize
-
\family sans
-Location
+Narrative
+\begin_inset space \hfill{}
+\end_inset
+
+M-z n
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: additional information, in the standard behavior appears on right side
- below the addressee`s field.
+Used to describe stage setting and the action.
+ First use of speaker names in all CAPs.
\end_layout
\begin_layout Itemize
-
\family sans
-Title
+ACT
+\begin_inset space \hfill{}
+\end_inset
+
+M-z a
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: the letter's title, in the standard behavior appears in a big, bold, sans
- serif font above the subject.
+Automatically numbered.
+ On screen it will be arabic, but will print as Roman.
\end_layout
\begin_layout Itemize
-
\family sans
-Subject
+ACT*
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S at
+\begin_inset Newline newline
+\end_inset
+
+
\family default
-: the letter's subject, in the standard behavior appears in a bold font
- above the
+Subtitle for
\family sans
-Opening
+ACT.
+
\family default
- paragraph.
+ It is just centered text.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-The types
-\family sans
-Yourref
-\family default
-,
-\family sans
-Yourmail
-\family default
-,
-\family sans
-Myref
-\family default
-,
-\family sans
-Customer
-\family default
-, and
-\family sans
-Invoice
-\family default
- produce a business letter like line above the
\family sans
-Title
-\family default
- line containing the fields
-\begin_inset Quotes eld
+SCENE
+\begin_inset space \hfill{}
\end_inset
-Your ref.
-\begin_inset Quotes erd
+M-z S-S
+\begin_inset Newline newline
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-Your letter of
-\begin_inset Quotes erd
-\end_inset
+\family default
+Not automatically numbered.
+ You supply the number.
+ This is because I couldn't figure out how.
+\end_layout
-,
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Itemize
-Our ref.
-\begin_inset Quotes erd
+\family sans
+AT_RISE:
+\begin_inset space \hfill{}
\end_inset
-,
-\begin_inset Quotes eld
+M-z S-R
+\begin_inset Newline newline
\end_inset
-Customer no.
-\begin_inset Quotes erd
-\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
+\family default
+A special case of Narrative to describe the setting and action as the curtain
+ rises.
+\end_layout
-Invoice no.
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-, and
-\begin_inset Quotes eld
+\family sans
+Speaker
+\begin_inset space \hfill{}
\end_inset
-Date
-\begin_inset Quotes erd
+M-z s
+\begin_inset Newline newline
\end_inset
-.
- For the date field, the value of the
-\family sans
-Date
+
\family default
- type is used.
- If one of these
-\begin_inset Quotes eld
+The speaker's (actor's) title, centered in all CAPS.
+\end_layout
+
+\begin_layout Itemize
+
+\family sans
+Parenthetical
+\begin_inset space \hfill{}
\end_inset
-business letter types
-\begin_inset Quotes erd
+M-z p
+\begin_inset Newline newline
\end_inset
- is used, the value of the
-\family sans
-Place
-\family default
- type however does not appear, but only the LaTeX variable
-\family typewriter
-\backslash
-fromplace
\family default
- is set.
- The ordinary output of place and date in a right-aligned line below the
- addressee`s field is suppressed.
- The types are implemented as input types provided with a label and must
- be used ahead of the corresponding
+Instructions to the speaker.
+ The parentheses are automatically inserted.
+ The ( will appear on screen, but both will be in the printed play.
+ This environment is only used within
\family sans
-Opening
+Dialogue
\family default
- type.
+.
\end_layout
\begin_layout Itemize
-
\family sans
-Yourref
-\family default
-: Your ref.
-\end_layout
+Dialogue
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Itemize
+M-z d
+\begin_inset Newline newline
+\end_inset
-\family sans
-Yourmail
\family default
-: Your letter of.
+What the Speaker says.
\end_layout
\begin_layout Itemize
-
\family sans
-Myref
-\family default
-: Our ref.
-\end_layout
+CURTAIN
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Itemize
+M-z S-C
+\begin_inset Newline newline
+\end_inset
-\family sans
-Customer
\family default
-: Customer no.
+The curtain comes down.
\end_layout
\begin_layout Itemize
-
\family sans
-Invoice
-\family default
-: Invoice no.
+Title
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-T
\end_layout
-\begin_layout Subsection
-
-The new letter class: letter (koma-script v.2)
-\end_layout
+\begin_layout Itemize
-\begin_layout Standard
+\family sans
+Author
+\begin_inset space \hfill{}
+\end_inset
-by
-\noun on
-Jürgen Spitzmüller
+M-z S-A
\end_layout
+\begin_layout Itemize
-\begin_layout Standard
-
-
-\begin_inset VSpace medskip
+\family sans
+Right_Address
+\begin_inset space \hfill{}
\end_inset
-
+M-z r
\end_layout
\begin_layout Standard
-\noindent
-Koma-Script version 2.8 has introduced a new letter class
-\family typewriter
-scrlttr2
-\family default
- which superceeds the now unsupported
-\family typewriter
-scrlettr
-\family default
-.
- It has --- on the LaTeX side --- a completely new interface and is not
- compatible with the old class.
- Therefore, LyX supports both, though it is recommended to use the new class.
+Hello there.
\end_layout
-\begin_layout Standard
+\begin_layout Section
+Dinbrief
+\end_layout
-This class covers the same functionality as
-\emph on
-letter (koma-script),
-\emph default
- and a few more.
- The basic items are
-\family sans
-Address
-\family default
- (receiver's address, same as
-\family sans
-Letter
-\family default
- in the old layout),
+\begin_layout Standard
+The document class
\family sans
-Opening
+dinbrief
\family default
-, and
-\family sans
-Closing
+ 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
+
+\begin_layout Section
+EGS journals (
\family sans
-NextAddress
+egs
\family default
- will start a new letter (i.
-\begin_inset ERT
-status collapsed
+)
+\end_layout
\begin_layout Standard
-
-\backslash
-,
+by
+\shape smallcaps
+Martin Vermeer
\end_layout
-\end_inset
+\begin_layout Subsection
+Description
+\end_layout
-e.
-\begin_inset ERT
+\begin_layout Standard
+This is the layout file for the European Geophysical Society journals.
+ The needed
+\family typewriter
+egs.cls
+\family default
+ can be downloaded from the web site of the EGS under
+\begin_inset Flex URL
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-\backslash
-
+www.copernicus.org
\end_layout
\end_inset
-you can write several letters per document).
- New elements are sender's
-\family sans
-E-Mail
-\family default
-,
-\family sans
-URL
-\family default
-,
+.
+\end_layout
+
+\begin_layout Subsection
+New styles
+\end_layout
+
+\begin_layout Standard
+
\family sans
-Fax
+Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
+ Accepted
\family default
,
\family sans
-Bank
+Offsets
\family default
- and the possibility to use a
-\family sans
-Logo
+.
+ The current layout file is unfortunately very unmodular and would benefit
+ from using the various
+\family typewriter
+std*.inc
\family default
- (via
-\family sans
-\bar under
-I
-\bar default
-nsert\SpecialChar \menuseparator
+ file inclusions.
+\end_layout
-\bar under
-G
-\bar default
-raphics
-\family default
-) in the header.
+\begin_layout Section
+Elsevier Journals
\end_layout
\begin_layout Standard
+By
+\noun on
+Rod Pinna
+\end_layout
-The biggest improvement is, though, that the letter's layout is configurable
- at almost any needs.
- This can be done via the preamble or with a special style file (Letter
- Class Option, extension
+\begin_layout Standard
+Elsevier Science Publishers B.V.
+ provides a standard LaTeX document class (
\family typewriter
-*.lco
+elsart.cls
\family default
-), that will be read in as a class option.
-\begin_inset Foot
+) for submitting articles to their various journals.
+ The style file can be downloaded directly from their web site:
+\begin_inset Flex URL
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-The KOMA package comes with some default
-\family typewriter
-*.lco
-\family default
- files.
- There is, for instance, a
-\family typewriter
-DIN.lco
-\family default
- file that follows german typesetting rules, or a
-\family typewriter
-KOMAold.lco
-\family default
- that provides the default layout of the old
+http://authors.elsevier.com/
+\end_layout
+
+\end_inset
+
+.
+ Instructions are supplied along with the class file, which details the
+ requirements of the publishers.
+ LyX includes package that allows for the use of this class, by a layout
+ and a template file.
+ Installation of the class file is the same as for any other LaTeX package;
+ instructions are provided in the Elsevier documentation.
+\end_layout
+
+\begin_layout Standard
+To make use of
\family typewriter
-scrlettr
+elsart.cls
\family default
- class.
- The latter can be loaded with the class option
+, a file
\family typewriter
-KOMAold
-\family default
-, inserted via the
-\family sans
-\bar under
-L
-\bar default
-ayout\SpecialChar \menuseparator
-
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-Extra Options
+elsart.layout
\family default
-field.
+ is supplied.
+ As the Elsevier class file is based mainly on the standard article class,
+ most of the normal functionality is provided.
+ The Elsevier class defines a number of mathematical environments, which
+ are similar to the AMS environments.
+ These commands are all described in the Elsevier documentation, and are
+ available in LyX.
\end_layout
+\begin_layout Standard
+The easiest way to use the Elsevier style is to base documents on the included
+ template file.
+ It is best not to use options such as fancy headings or the geometry package,
+ as elements such as these are defined by Elsevier in their style file.
+ Ideally, no extra packages except those mentioned in the Elsevier documentation
+ should be used.
+ Essentially, Elsevier require as
+\begin_inset Quotes eld
\end_inset
- Have a look at the
-\emph on
-koma-letter2
-\emph default
- template that is included in LyX for examples.
- A detailed description is to be found in the Koma-Script documentation
- (
-\emph on
-scrguide
-\emph default
-).
+clean
+\begin_inset Quotes erd
+\end_inset
+
+ a LaTeX file as possible, as their intention is to take the supplied file
+ and replace the class file with one for the particular journal to which
+ the paper has been submitted.
+ This also means that not too much time should be spent on the formating
+ of the document.
+ When it comes to be published, this will change anyway.
+ The rest of the usage for this layout is substantially the same as for
+ the normal article class.
+ For details of what Elsevier do and don't allow, refer to their documentation.
\end_layout
-\begin_layout Subsection
+\begin_layout Section
+Foils [aka
+\family sans
+FoilTeX
+\family default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foiltex"
-Problems
-\end_layout
+\end_inset
-\begin_layout Standard
-Visualizing the Koma-Script document classes in LyX, the LyX internals cause
- some problems.
\end_layout
-\begin_layout Itemize
-
-The chapter number of a
-\family sans
-Chapter
-\family default
- type appears on a line of its own above the chapter heading instead of
- appearing in the same line ahead of it.
- The cause for that is the LyX internal behavior for the labeltype
-\family sans
-Counter_Chapter
-\family default
- in the layout file.
+\begin_layout Standard
+by
+\noun on
+Allan Rae
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Introduction
+\end_layout
-The headings of the types
-\family sans
-Addchap
-\family default
- and
+\begin_layout Standard
+This section describes how to use LyX to make slides for overhead projectors.
+ There are two document classes that can do this: the default slides class
+ and the
\family sans
-Addsec
+FoilTeX
\family default
- are only put in the
-\begin_inset Quotes eld
-\end_inset
+ slides class.
+ This section documents the latter.
+\end_layout
-true
-\begin_inset Quotes erd
+\begin_layout Standard
+I'm going to say this again, nice and clear, so that there's no misunderstanding
+:
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
- LaTeX table of contents, but not in the LyX table of contents (
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-\bar under
-T
-\bar default
-able\InsetSpace ~
-of\InsetSpace ~
-Contents
-\family default
-).
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+\align center
+
+\size large
+This section documents the class
+\begin_inset Quotes eld
+\end_inset
-The paragraphs in a
-\emph on
-letter
-\emph default
- document class appear in a skip separation mode, not indented.
- This is the standard behavior, no special LaTeX commands are needed for
- that.
- But in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog the corresponding radio button indicates
-\family sans
-\bar under
-I
-\bar default
-ndent
-\family default
-.
- A
\family sans
-S
-\bar under
-k
-\bar default
-ip
+slides (FoilTeX)
\family default
- value always has the effect that extra LaTeX commands are inserted in the
- document to produce the gap, which is not what is wanted in this case.
-\end_layout
-\begin_layout Section
+\begin_inset Quotes erd
+\end_inset
-Springer Journals (
-\family sans
-svjour
-\family default
-)
+
+\emph on
+only.
\end_layout
\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-by
-\noun on
-Martin Vermeer
-\end_layout
-
-\begin_layout Subsection
-Description
\end_layout
\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
+\end_inset
-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}
+\family sans
+slides (default)
+\family default
+
+\begin_inset Quotes erd
\end_inset
-, where you should also go to fetch the class files (yes, these are LaTeX2e
- now!).
- It is a modular system: the things common to all journals are implemented
- in
-\family typewriter
-svjour.inc
-\family default
-, which journal-specific layout files (such as, e.g.,
-\family typewriter
-svjog.layout
-\family default
- for Journal of Geodesy) can include.
-\end_layout
+, check out section
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-This means that implementing support for any other Springer journal on this
- list is as simple as writing your own
-\family typewriter
-sv
-\family default
-<myjournal>
-\family typewriter
-.layout
-\family default
- file following the outline given in
-\family typewriter
-svjog.layout
-\family default
-.
-
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slitex"
-\begin_layout Standard
+\end_inset
-It is reasonably well tested only for the Journal of Geodesy.
-
-\family typewriter
-svjour
-\family default
- and
-\family typewriter
-svjog
-\family default
- come with the standard LyX distribution.
- Install the relevant class file (downloaded from Springer) in a proper
- directory, reconfigure LaTeX (in the teTeX case by running
-\family typewriter
-texhash
+.
+ If your machine doesn't have the
+\family sans
+foils
\family default
-, as root if necessary --- doesn't LyX take care of this?), reconfigure
- LyX and it should work.
-\end_layout
+ class [
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
-New styles
-\end_layout
+\family sans
+slides (FoilTeX)
+\family default
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-A large number of theorem-like styles ---
+] installed, you'll probably have to use the default
\family sans
-Claim, Conjecture,
+slides
\family default
-
+ class, which isn't quite as good as
\family sans
-\SpecialChar \ldots{}
-Theorem
-\family default
-.
+foils.
\end_layout
\begin_layout Standard
-
-
+The
\family sans
-Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
- Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
+foils
\family default
-.
- See the Springer class file documentation for details.
+ class is designed for use with version 2.1 of the
+\family sans
+foils.cls
+\family default
+ LaTeX class file which is now an integral part of LaTeX2e.
\end_layout
\begin_layout Subsection
-
-Supported journals
+Getting Started
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
+\end_inset
-\emph on
-Journal of Geodesy
-\emph default
-:
-\family typewriter
-svjog.layout
+\family sans
+slides (FoilTeX)
\family default
---- Martin Vermeer
-\end_layout
-
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-\emph on
-Probability Theory and Related Fields
-\emph default
-:
-\family typewriter
-svprobth.layout
+ from the
+\family sans
+Class
\family default
- --- Jean-Marc Lasgouttes
-\end_layout
+ entry in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
+Layout
+\family default
+ dialog.
+ There are some settings in the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
-Add your own, it isn't so hard!
+Layout
+\family default
+ dialog that you should know about that are specific to this class:
\end_layout
-\begin_layout Subsection
-
-Credits
-\end_layout
-
-\begin_layout Standard
-
-These files are partly based on the older
-\family typewriter
-ejour2.layout
+\begin_layout Itemize
+Don't change the options
+\family sans
+Sides
\family default
-, which was again based on a tinkered-with version of an old LaTeX 2.09 style
- file from Springer.
- All this, and the
-\family typewriter
-ejour2
+ and
+\family sans
+Columns
\family default
- layout, are now defunct.
- Jean-Marc Lasgouttes helped out big in making me find my way around the
- LyX layout file mechanism.
-\end_layout
-
-\begin_layout Subsection
-
-Bugs
-\end_layout
-
-\begin_layout Standard
+ on the
+\family sans
+Document
+\begin_inset space ~
+\end_inset
-Probably.
- But probably less than in the old hacked-LaTeX
-\family typewriter
-ejour2
+Layout
\family default
-.
-\end_layout
-
-\begin_layout Standard
-
-Limitations e.g.: does not display the number for theorem-like layouts, just
- #.
-\end_layout
-
-\begin_layout Section
-
-AGU journals (
+ dialog.
+ They're ignored by the
\family sans
-aguplus
+foils
\family default
-)
-\end_layout
-
-\begin_layout Standard
-
-by
-\shape smallcaps
-Martin Vermeer
-\end_layout
-
-\begin_layout Subsection
-
-Description
+ class.
\end_layout
-\begin_layout Standard
-
-These are the layout files for some of the journals of the American Geophysical
- Society.
- It is assumed that you have both the AGU's own class files and AGUplus
- installed (everything to be found at
-\begin_inset LatexCommand \url{ftp://ftp.agu.org/journals/latex/journals}
+\begin_layout Itemize
+The default font size is 20
+\begin_inset space \thinspace{}
+\end_inset
+pt with the other options being 17
+\begin_inset space \thinspace{}
\end_inset
-).
-\end_layout
+pt, 25
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
+pt and 30
+\begin_inset space \thinspace{}
+\end_inset
-New styles
+pt.
\end_layout
-\begin_layout Standard
-
-Redefined are
-\family sans
-Paragraph
-\family default
-,
-\family sans
-Paragraph*
-\family default
-.
- They are still called this in the LyX GUI, though their LaTeX equivalents
- in the AGU classes are
+\begin_layout Itemize
+The default font is
\family sans
-Subsubsubsection
+sans
\family default
- and
+
\family sans
-Subsubsubsection*
+serif
\family default
-.
+ but all math equations are still typeset in the usual roman font.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-Newly defined styles are
-\family sans
-Left_Header
-\family default
-,
-\family sans
-Right_Header
-\family default
-,
-\family sans
-Received
-\family default
-,
-\family sans
-Revised
-\family default
-,
\family sans
-Accepted
+FoilTeX
\family default
-,
+ supports A4 and Letter paper sizes as well as a special size for working
+ with 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slides.
+ It doesn't support A5, B5, legal or executive paper sizes.
+\end_layout
+
+\begin_layout Itemize
+Don't bother changing the
\family sans
-CCC
+Float Placement
\family default
-,
+ settings because they are ignored anyway.
+ All floats appear where they are defined in the text.
+\end_layout
+
+\begin_layout Itemize
+The
\family sans
-PaperId
+Pagestyle
\family default
-,
+ setting behaves a bit differently for this class.
+
\family sans
-AuthorAddr
+FoilTeX
\family default
-,
+ provides extensive footer and header capabilities including a user-defined
+ logo.
+ See section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foilfoot"
+
+\end_inset
+
+ for more details.
+ The title page is treated differently to all other pages in the document
+ and is
+\emph on
+always
+\emph default
+ unnumbered and
+\emph on
+always
+\emph default
+ has the logo centered at the bottom of the page (if one is defined).
+ The possible page style choices and what they do are as follows:
+\end_layout
+
+\begin_deeper
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+
\family sans
-SlugComment
+\series bold
+empty
\family default
-.
- These are mostly manuscript attributes and defined in the AGU class documentati
-on.
+\series default
+ The final output contains no page numbers, or other headers or footers
+ (except footnotes of course).
+
\end_layout
-\begin_layout Standard
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
-I suspect this is still badly incomplete.
+\family sans
+\series bold
+plain
+\family default
+\series default
+ The final output contains page numbers centered at the bottom of the page.
+ No other headings or footers (other than footnotes).
\end_layout
-\begin_layout Subsection
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
-New floats
+\series bold
+foilheadings
+\series default
+ Page numbers in lower right corner.
+ Additional headers and footers are also shown.
+ This is also the default.
\end_layout
-\begin_layout Standard
-
+\begin_layout Labeling
+\labelwidthstring MMMMMMM
+\series bold
+fancy
+\series default
+ Gives you access to the
\family sans
-Planotable
+fancyheadings
\family default
- and
+ package although its use with
\family sans
-Plate
+FoilTeX
\family default
-.
- We also have a new
+ is discouraged by the writer of the
\family sans
-Table_Caption
+FoilTeX
\family default
-.
+ package because of some potential page layout clashes.
\end_layout
-\begin_layout Subsection
+\end_deeper
+\begin_layout Subsubsection
+Extra Options
+\end_layout
-Supported journals
+\begin_layout Standard
+The following options may be used in the extra class options in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
+\series bold
+35mmSlide
+\series default
+ This sets up the page layout for 7.33
+\begin_inset space \thinspace{}
+\end_inset
-\emph on
-Journal of Geophysical Research
-\emph default
-:
-\family typewriter
-jgrga.layout
-\family default
---- Martin Vermeer
+in by 11
+\begin_inset space \thinspace{}
+\end_inset
+
+in paper, which is about the same aspect ratio as a 35
+\begin_inset space \thinspace{}
+\end_inset
+
+mm slide, making it a bit easier to work with this medium.
\end_layout
-\begin_layout Standard
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-Add your own, it isn't so hard! Look at the
-\family typewriter
-jgrga.layout
-\family default
- example and
-\family typewriter
-aguplus.inc
-\family default
-.
-\end_layout
-
-\begin_layout Subsection
-
-Bugs and things to remember
+\series bold
+headrule
+\series default
+ Places a rule across the page below the header on every page except the
+ title page.
\end_layout
-\begin_layout Standard
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-In order to use the new layouts, you must remember to do the following for
- a new document:
+\series bold
+footrule
+\series default
+ Places a rule across the page above the footer on every page except the
+ title page.
\end_layout
-\begin_layout Enumerate
-
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-\emph on
-Turn off babel
-\emph default
-.
- This can be done in the
+\series bold
+dvips
+\series default
+ This is automatically set each time you create a new
\family sans
-layout\SpecialChar \menuseparator
-document
+foils
\family default
- or
+ document.
+ This option tells
\family sans
-document\SpecialChar \menuseparator
-settings
+FoilTeX
\family default
- menu item.
- (AGU articles are always in English, right? So
-\emph on
-don't
-\emph default
- choose a language.)
+ to use the dvips driver to rotate those pages that are set as landscape
+ foils.
\end_layout
-\begin_layout Enumerate
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-Enter
-\family typewriter
-jgrga
+\series bold
+landscape
+\series default
+ Simply changes the page dimensions to those of a landscape page but doesn't
+ do any rotation.
+ Thus if you use this option you need to use an external program to rotate
+ each page or feed your paper through your printer as landscape.
+ Note that this option effectively reverses the roles of the
+\family sans
+Foilhead
\family default
- into the document's
+ and
\family sans
-Extra Options
+Rotatefoilhead
\family default
- field.
- (Yes, this is a bug.)
+ environments (don't worry these are described in the next section).
\end_layout
-\begin_layout Enumerate
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-Make sure you use the
-\family typewriter
-agu.bst
-\family default
- bibliography style, by entering
-\family sans
-agu
-\family default
- into the second field of the BibTeX inset.
- None of the standard styles will do.
+\series bold
+leqno
+\series default
+ Equation numbers on the left.
\end_layout
-\begin_layout Section
+\begin_layout Labeling
+\labelwidthstring MMMMMMx
-EGS journals (
+\series bold
+fleqn
+\series default
+ Flush-left equations.
+\end_layout
+
+\begin_layout Subsection
+Supported Environments
+\end_layout
+
+\begin_layout Standard
+Most of the environments commonly supported in other classes are also supported
+ by the
\family sans
-egs
+foils
\family default
-)
+ class.
+ There are several additional environments provided by
+\family sans
+FoilTeX
+\family default
+ as well as a couple added by LyX.
+ The following environments are shared with other classes:
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
-by
-\shape smallcaps
-Martin Vermeer
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsection
-Description
+\backslash
+begin{multicols}{2}
\end_layout
-\begin_layout Standard
+\end_inset
-This is the layout file for the European Geophysical Society journals.
- The needed
-\family typewriter
-egs.cls
-\family default
- can be downloaded from the web site of the EGS under
-\begin_inset LatexCommand \url{www.copernicus.org}
-\end_inset
+\end_layout
-.
+\begin_layout Itemize
+
+\family sans
+Standard
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-New styles
+\family sans
+Itemize
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+
+\family sans
+Enumerate
+\end_layout
+\begin_layout Itemize
\family sans
-Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
- Accepted
-\family default
-,
+Description
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-Offsets
-\family default
-.
- The current layout file is unfortunately very unmodular and would benefit
- from using the various
-\family typewriter
-std*.inc
-\family default
- file inclusions.
+List
\end_layout
-\begin_layout Section
+\begin_layout Itemize
-Slides [aka
-\noun on
-Sli
-\noun default
-TeX]
-\begin_inset LatexCommand \label{sec:slitex}
+\family sans
+LyX-Code
+\end_layout
-\end_inset
+\begin_layout Itemize
+
+\family sans
+Verse
+\end_layout
+\begin_layout Itemize
+\family sans
+Quote
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-by
-\noun on
-John Weiss
-\noun default
-
+\family sans
+Quotation
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-Introduction
+\family sans
+Title
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-This section describes how to use LyX to make slides for overhead projectors.
- There are two document classes that can do this: the default slides class
- and the
\family sans
-Foil
-\family default
-TeX slides class.
- This section documents the former.
+Author
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\family sans
+Date
\end_layout
+\begin_layout Itemize
-\begin_layout Standard
+\family sans
+Abstract
+\end_layout
+\begin_layout Itemize
-\begin_inset VSpace bigskip
-\end_inset
+\family sans
+Bibliography
+\end_layout
+\begin_layout Itemize
+\family sans
+Address
\end_layout
-\begin_layout Standard
-\align center
+\begin_layout Itemize
-\size large
-This section documents the class
-\begin_inset Quotes eld
-\end_inset
+\family sans
+RightAddress
+\end_layout
+\begin_layout Itemize
\family sans
-slides (default)
-\family default
+Caption
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-
-\emph on
-only.
+\family sans
+Comment
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
+
+
+\backslash
+end{multicols}
+\end_layout
-\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
+That is, all the major environments apart from the sectioning environments.
+ Since foils are essentially self-contained sections, with a title and body,
+
+\family sans
+FoilTeX
+\family default
+ provides specific commands for starting new foils and these are:
+\end_layout
-If you're looking for the documentation for
-\begin_inset Quotes eld
-\end_inset
-
+\begin_layout Itemize
\family sans
-slides (FoilTeX)
-\family default
+Foilhead
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-, check out section\InsetSpace ~
+\family sans
+Rotatefoilhead
+\end_layout
-\begin_inset LatexCommand \ref{sec:foiltex}
+\begin_layout Standard
+LyX also provides slightly modified versions of these two environments called:
+\end_layout
-\end_inset
+\begin_layout Itemize
-.
- The
\family sans
-foils
-\family default
-class [
-\begin_inset Quotes eld
-\end_inset
+ShortFoilhead
+\end_layout
+\begin_layout Itemize
\family sans
-slides (FoilTeX)
-\family default
+ShortRotatefoilhead
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+and the differences will be explained in the next section.
+\end_layout
-] is actually somewhat better than the default
+\begin_layout Standard
+Since foils are often used in presenting ideas or new theorems and such
+
\family sans
-slides
+FoilTeX
\family default
- class,
-\begin_inset Foot
-status collapsed
+ also provides a comprehensive box of goodies for presenting them:
+\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
-\SpecialChar \ldots{}
-or so I've been told repeatedly by its advocates.
- Having never used it, I have no idea if this claim is true or not.
+\begin_layout Plain Layout
+
+
+\backslash
+begin{multicols}{2}
\end_layout
\end_inset
- which this section documents.
+
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-This class is the LaTeX2e improvement of the old
-\noun on
-Sli
-\noun default
-TeX package.
- Every LaTeX2e distribution includes this class [which I'll just refer to
- as
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Theorem
+\end_layout
+\begin_layout Itemize
\family sans
-slides
-\family default
+Lemma
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from now on], so you're bound to have it.
- As I noted earlier, there are other classes, such as
-\family sans
-foils
-\family default
-, which also produce slides for overhead projectors and do a better job
- at it.
- However, there are some things which
\family sans
-slides
-\family default
- can do which the others can't, such as generate overlays.
- Read on to learn more!
+Corollary
\end_layout
-\begin_layout Subsection
-
-Getting Started
-\begin_inset LatexCommand \label{sec:slidesetup}
+\begin_layout Itemize
-\end_inset
+\family sans
+Proposition
+\end_layout
+\begin_layout Itemize
+\family sans
+Definition
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-Obviously, to use this document class, you need to select
-\begin_inset Quotes eld
-\end_inset
+\family sans
+Proof
+\end_layout
+\begin_layout Itemize
\family sans
-slides (default)
-\family default
+Theorem*
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- from the class list in the
\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
- There are some other special things you should know about this class:
+Lemma*
\end_layout
\begin_layout Itemize
-Don't bother changing the options
\family sans
-Sides and Columns
-\family default
-.
- They're not supported by the
+Corollary*
+\end_layout
+
+\begin_layout Itemize
+
\family sans
-slides
-\family default
- class, anyways.
+Proposition*
\end_layout
\begin_layout Itemize
-The option
\family sans
-\bar under
-P
-\bar default
-age\InsetSpace ~
-style
-\family default
- behaves a bit differently for this class.
- The possible choices and what they do are as follows:
+Definition*
\end_layout
-\begin_deeper
-\begin_layout Description
+\begin_layout Standard
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
-\family sans
-plain
-\family default
- The final output contains page numbers in the lower right corner.
+
+\backslash
+end{multicols}
\end_layout
-\begin_layout Description
+\end_inset
-\family sans
-headings
-\family default
- Like
-\family sans
-plain
-\family default
-, but also prints out any time markers you've put in.
- This is the default.
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The starred versions are unnumbered while the unstarred versions are numbered.
+ There are also two list environments added by LyX and these are:
+\end_layout
+\begin_layout Itemize
\family sans
-empty
-\family default
- The final output contains no page numbers, time markers, or alignment markers.
+TickList
\end_layout
-\end_deeper
+
\begin_layout Itemize
-The
\family sans
-slides
-\family default
- class has an extra option:
-\family typewriter
-clock
-\family default
-.
- To use it, put
-\begin_inset Quotes eld
-\end_inset
+CrossList
+\end_layout
+\begin_layout Standard
-\family typewriter
-clock
+\family sans
+FoilTeX
\family default
+ provides some powerful header and footer capabilities that are best set
+ in the preamble although they may be set at any point in a document.
+ If you want to change these settings in your document the best place to
+ do so is at the very top of a foil, i.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset Quotes erd
+g.
+\emph on
+
+\begin_inset space \space{}
\end_inset
- in the extra class options.
+
+\emph default
+straight after the foilhead.
\end_layout
-\begin_deeper
\begin_layout Standard
+For this purpose, the following command styles are provided [
+\shape smallcaps
+Martin Vermeer
+\shape default
+]:
+\end_layout
-Using this options allows you to add time markers to
-\family sans
-Note
-\family default
-s.
- See section\InsetSpace ~
+\begin_layout Standard
+\begin_inset ERT
+status open
-\begin_inset LatexCommand \ref{sec:slideNote}
+\begin_layout Plain Layout
-\end_inset
- for more details.
+\backslash
+begin{multicols}{2}
\end_layout
-\end_deeper
-\begin_layout Standard
-You can also use the template file
-\begin_inset Quotes eld
\end_inset
-\family typewriter
-slides.lyx
-\family default
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- to automatically set up a document to use the
\family sans
-slides
-\family default
-class [using
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New\InsetSpace ~
-from\InsetSpace ~
+My
+\begin_inset space ~
+\end_inset
-\bar under
-T
-\bar default
-emplate
-\family default
- to open your new document].
- The template file also contains some examples of the special paragraph
- environments used by this class.
- I'll describe those next.
-\end_layout
-
-\begin_layout Subsection
-
-Paragraph Environments
+Logo
\end_layout
-\begin_layout Subsubsection
+\begin_layout Itemize
-Supported Environments
+\family sans
+Restriction
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-The first thing you'll notice when you start up a new
\family sans
-slides
-\family default
-document is the font size and type: it's the equivalent of the size
-\begin_inset Quotes eld
+Right
+\begin_inset space ~
\end_inset
+Footer
+\end_layout
-\family sans
-Largest
-\family default
-
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
- in the
\family sans
-Sans\InsetSpace ~
-Serif
-\family default
- font.
- This is also what's used in the output.
- Think of this as a
-\begin_inset Quotes eld
+Right
+\begin_inset space ~
\end_inset
-visual cue
-\begin_inset Quotes erd
-\end_inset
-
- to remind you that this is a slide.
- Your final slides will use a larger font; ergo, you'll have less space.
- Of course, the larger default screen font isn't WYSIWYG, only a reminder.
-\end_layout
-
-\begin_layout Standard
-
-The next thing that becomes obvious is the changes to the paragraph environment
- pull-down box [at the far-left end of the toolbar].
- Most of the paragraph environments you're used to seeing are missing.
- There are also five new ones.
- That's because the
-\family sans
-slides
-\family default
- class itself only supports certain paragraph environments:
+Header
\end_layout
\begin_layout Itemize
-
\family sans
-Standard
-\end_layout
-
-\begin_layout Itemize
-
+Left
+\begin_inset space ~
+\end_inset
-\family sans
-Itemize
+Header
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Standard
+\begin_inset space ~
+\end_inset
-\family sans
-Enumerate
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-Description
-\end_layout
+\end_deeper
+\begin_layout Standard
+\begin_inset ERT
+status open
-\begin_layout Itemize
+\begin_layout Plain Layout
-\family sans
-List
+\backslash
+end{multicols}
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Quotation
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Standard
+There are also a few commands provided by
\family sans
-Quote
-\end_layout
-
-\begin_layout Itemize
-
+FoilTeX
+\family default
+ that aren't directly supported by LyX but I'll tell you what they do and
+ how to use them in section
+\begin_inset space ~
+\end_inset
-\family sans
-Verse
-\end_layout
-\begin_layout Itemize
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:unsuppfoils"
+\end_inset
-\family sans
-Caption
+.
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-LyX-Code
+\begin_layout Subsection
+Building a Set of Foils
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+This section will give a simple introduction to using the different environments
+ to build a set of foils.
+ If you want to see an example set of foils, take a look at the
+\family typewriter
+Foils.lyx
+\family default
+ file you find in LyX's
+\family typewriter
+examples
+\family default
+ folder.
+\end_layout
-\family sans
-Comment
+\begin_layout Subsubsection
+Give It a Title Page
\end_layout
\begin_layout Standard
-
-All of the other standard environments, including the section-heading environmen
-ts, aren't used in the
+Unlike other classes that provide
\family sans
-slides
+Title
\family default
- class.
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+ and
+\family sans
+Abstract
+\family default
+ environments,
+\family sans
+foils
+\family default
+ creates the title on a page of its own.
+ If you leave out the
+\family sans
+Date
+\family default
+ environment LaTeX will substitute the current date (every time you regenerate
+ the output).
\end_layout
-\begin_layout Standard
-
-On the other hand, you'll notice the following new environments:
+\begin_layout Subsubsection
+Start a New Foil
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Standard
+As I mentioned earlier, there are four ways of starting a new foil.
+ For portrait foils you should use
\family sans
-Slide
-\end_layout
-
-\begin_layout Itemize
-
-
+Foilhead
+\family default
+ or
\family sans
-Overlay
-\end_layout
-
-\begin_layout Itemize
-
+ShortFoilhead.
-\family sans
-Note
+\family default
+ The difference between these two environments is the amount of space between
+ the title of the foil (the foilhead) and the body of the foil.
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Standard
+Landscape foils are generated using the
\family sans
-InvisibleText
+Rotatefoilhead
+\family default
+ and
+\family sans
+ShortRotatefoilhead
+\family default
+ environments.
+ Again the only difference is the spacing between foilhead and body.
+ Both of the short versions have 0.5 inches less separation between the foilhead
+ and the body.
+
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+One problem with the support for landscape foils is the requirement that
+ you have to use the
+\family typewriter
+dvips
+\family default
+ driver to generate the PostScript output otherwise the foils won't be rotated.
+ It is possible to get landscape foils even if you haven't got the
+\family typewriter
+dvips
+\family default
+ driver provided you can feed your foils sideways through your printer ;-)
+\end_layout
-\family sans
-VisibleText
+\begin_layout Subsubsection
+Theorems, Lemmas, Proofs and more
\end_layout
\begin_layout Standard
-
-These five are kind of quirky, due to a
+Due to a small bug in LyX you can't have two of the same type of these environme
+nts directly following each other.
+ They must be separated by something.
+ If you try, you will just be extending the previous environment as if you
+ had merged the two environments together.
+ So, how do you get around this problem? The simplest option is to insert
+ some text between the two environments or add a
+\family sans
+LaTeX
+\family default
+ environment between the two with just a
\begin_inset Quotes eld
\end_inset
-feature
+
+\family typewriter
+%
+\family default
+
\begin_inset Quotes erd
\end_inset
- in LyX.
- You see, LyX doesn't permit you to nest any other paragraph environment
- into an empty environment.
- Now, that's fine and dandy, but it means that you wouldn't be able to start
- a slide with anything except plain text.
- To deal with this, I've performed a little
-\begin_inset Quotes eld
+ in it.
+ This will force LyX to produce two separate environments and hence the
+ correct LaTeX output.
+ An example is provided in the example file included with the LyX distribution.
+ Remember, this problem only occurs if you are trying to place two of the
+ same type of theorem-like environments one directly after the other.
+\end_layout
+
+\begin_layout Subsubsection
+Lists
+\end_layout
+
+\begin_layout Standard
+You get all the commonly supported list styles found in other classes as
+ well as two new ones.
+ I'll only describe the new ones here.
+ If you want to find out more about the other list environments check out
+ the
+\emph on
+User's Guide.
+
+\emph default
+ If you intend to use itemized lists you might also want to read about the
+
+\family sans
+Itemize
+\begin_inset space ~
\end_inset
-LaTeX magic.
-\begin_inset Quotes erd
+Bullet
+\begin_inset space ~
\end_inset
-
-\end_layout
+Selection
+\family default
+ dialog described above in section
+\begin_inset space ~
+\end_inset
-\begin_layout Subsubsection
-Quirks of the New Environments
-\begin_inset LatexCommand \label{sec:slideQuirk}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:bullet"
\end_inset
-
+.
\end_layout
\begin_layout Standard
-
-All five of the new paragraph environments are somewhat quirky due to inherent
- limitiations in the current version of LyX.
- As I just mentioned, LyX forbids environments that begin with another environme
-nt.
- To get around this, the
+The two new list styles,
\family sans
-Slide
+TickList
\family default
- environment isn't a paragraph environment as described in the
-\emph on
-User's Guide
-\emph default
-.
-
+ and
+\family sans
+CrossList
+\family default
+, are designed to make it easier for you to create lists of do's and don'ts
+ or right and wrong by providing dedicated environments that use a tick
+ or a cross as the label of the list.
+ These lists are in fact dedicated variants of the
+\family sans
+Itemize
+\family default
+ environment.
+ They do however require that you have the
+\family typewriter
+psnfss
+\family default
+ packages installed.
+\end_layout
+
+\begin_layout Subsubsection
+Figures and Tables
\end_layout
\begin_layout Standard
-You should consider
\family sans
-Slide
+FoilTeX
\family default
-,
+ redefines the floating tables and figures so that they appear exactly where
+ they are in the text rather than pushing them to the top of the page or
+ to some user specified location.
+ In fact if you change the float placement settings they are simply ignored.
+\end_layout
+
+\begin_layout Subsubsection
+Page Headers and Footers
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:foilfoot"
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+
\family sans
-Overlay
+My
+\begin_inset space ~
+\end_inset
+
+Logo
\family default
-, and
+ and
\family sans
-Note
+Restriction
\family default
- to be
+ are two commands used to control the left-footer text string.
+ The first is meant to allow you to include a graphic logo on your foils
+ and defaults to
\begin_inset Quotes eld
\end_inset
-pseudo-environments.
+-Typeset by
+\family sans
+FoilTeX
+\family default
+-
\begin_inset Quotes erd
\end_inset
- They look like a section heading or a
-\begin_inset Quotes eld
+.
+ While the second is meant to provide a classification for the audience,
+
+\emph on
+e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\emph default
+
+\begin_inset space \space{}
\end_inset
+Confidential.
+ It is empty by default.
+\end_layout
+\begin_layout Standard
+The remaining page corners can be filled by
\family sans
-Caption
+Right
+\begin_inset space ~
+\end_inset
+
+Footer
\family default
-,
-\begin_inset Quotes erd
+ (which defaults to page numbers),
+\family sans
+Right
+\begin_inset space ~
\end_inset
- but really begin a [and, if necessary, end the previous] paragraph environment.
- Likewise, treat
+Header
+\family default
+ (top right) and
\family sans
-InvisibleText
+Left
+\begin_inset space ~
+\end_inset
+
+Header
\family default
- and
+ (top left).
+\end_layout
+
+\begin_layout Subsection
+Unsupported
\family sans
-VisibleText
+FoilTeX
\family default
- as
-\begin_inset Quotes eld
-\end_inset
+ Goodies
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:unsuppfoils"
-pseudo-commands.
-\begin_inset Quotes erd
\end_inset
- These two perform some action.
+
\end_layout
\begin_layout Standard
-
-A common feature of all five environments,
-\family sans
-Slide
-\family default
-,
+All the commands mentioned below need to be set in a
\family sans
-Overlay
+LaTeX
\family default
-,
+ environment or as
\family sans
-Note
+TeX
\family default
-,
-\family sans
-InvisibleText
+ within another environment.
+\end_layout
+
+\begin_layout Subsubsection
+Lengths
+\end_layout
+
+\begin_layout Standard
+All lengths are adjusted using the
+\family typewriter
+
+\backslash
+setlength{
\family default
- and
-\family sans
-VisibleText
+\emph on
+lengthname
+\family typewriter
+\emph default
+}{
\family default
-, is a rather long-ish label.
- The text following this label --- ordinarily the contents of the paragraph
- environment --- is utterly irrelevant for
-\family sans
-Slide
+\emph on
+newlength
+\family typewriter
+\emph default
+}
\family default
-,
-\family sans
-Overlay
+ command.
+ Where
+\emph on
+lengthname
+\emph default
+ should be replaced by the name given to the length you want to change and
+
+\emph on
+newlength
+\emph default
+ is the length value.
+ All lengths should be specified in units of length such as inches (
+\family typewriter
+in
\family default
-,
-\family sans
-Note
+), millimeters (
+\family typewriter
+mm
\family default
-,
-\family sans
-InvisibleText
+) or points (
+\family typewriter
+pt
\family default
- and
-\family sans
-VisibleText
+) or relative to some document or font-based length such as
+\family typewriter
+
+\backslash
+textwidth
\family default
.
- LyX completely ignores it.
- In fact, you can leave these five environments completely empty.
\end_layout
\begin_layout Standard
+It's possible to change the spacing between a foilhead and the body of the
+ foil by adjusting the length specified by
+\family typewriter
-While you don't
+\backslash
+foilheadskip
+\family default
+.
+ For example, to make
\emph on
-have
+all
\emph default
- to put any text after the rather long-ish label, you might want to.
- This could be a short description of the contents of the
-\family sans
-Slide
-\family default
-, for example.
- In that case, enter in your descriptive comment and hit
-\family sans
-Return
-\family default
- as you normally would.
+ foilheads 0.5
+\begin_inset space \space{}
+\end_inset
+
+in closer to their bodies put the following in the preamble:
+\family typewriter
+
+\backslash
+setlength{
+\backslash
+foilheadskip}{-0.5in}
\end_layout
\begin_layout Standard
-
-If, on the other hand, you don't want to enter in any descriptive text,
- you'll hit another LyX quirk.
- LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
- environment until you put something in the old one.
- So, do this:
+The spacings around floats can be adjusted by setting these lengths:
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-Start entering the text that will
-\emph on
-follow
-\emph default
- the new
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
-\family default
-,
-\family sans
-Note
-\family default
-,
-\family sans
-InvisibleText
+\family typewriter
+
+\backslash
+abovefloatskip
\family default
- or
-\family sans
-VisibleText
+ Separation between the text and the top of the float
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+abovecaptionskip
\family default
-.
-
+ Separation between the float and the caption
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-Now move to the beginning of that paragraph.
-
+\family typewriter
+
+\backslash
+belowcaptionskip
+\family default
+ Separation between the caption and the following text
\end_layout
-\begin_layout Itemize
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-Next, hit
-\family sans
-Return
+\family typewriter
+
+\backslash
+captionwidth
+\family default
+ You can make the captions narrower than the surrounding text by adjusting
+ this length.
+ Best done relative to
+\family typewriter
+
+\backslash
+textwidth
\family default
.
-
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+There are also several title page related lengths that you may find useful
+ if you have a long title or several authors:
+\end_layout
-Finally, change this new, empty paragraph to a
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+abovetitleskip
\family default
-,
+ Separation from headers to
\family sans
-Note
+Title
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
+
+\family typewriter
+
+\backslash
+titleauthorskip
\family default
-,
+ between
\family sans
-InvisibleText
+Title
\family default
- or
+ and
\family sans
-VisibleText
+Author
\family default
-.
-
+ environments
\end_layout
-\begin_layout Standard
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
+\family typewriter
+\backslash
+authorauthorskip
+\family default
+ between multiple
+\family sans
+Author
+\family default
+ lines
\end_layout
-\begin_layout Subsection
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-Making a Presentation with
-\family sans
-Slide
+\family typewriter
+
+\backslash
+authordateskip
\family default
-,
+ between the
\family sans
- Overlay
+Author
\family default
- and
+ and the
\family sans
-Note
+Date
\end_layout
-\begin_layout Subsubsection
+\begin_layout Labeling
+\labelwidthstring MMMMMMMMMMM
-Using the
+\family typewriter
+
+\backslash
+dateabstractskip
+\family default
+ between the
\family sans
-Slide
+Date
\family default
- Environment
+ and the
+\family sans
+Abstract
\end_layout
\begin_layout Standard
+The last length related command affects all the list environments.
+ If you place
+\family typewriter
-If you're expecting this section to teach you how to actually make a presentatio
-n, you'll be sorely disappointed.
- Naturally, I'll describe all of the ways the
-\family sans
-slides
+\backslash
+zerolistvertdimens
\family default
- class can assist you in preparing the materials for a presentation.
- Filling in the contents, however, is up to you.
- [Then again, that
+
\emph on
-is
+inside
\emph default
- the LyX philosophy.]
+ a list environment then all the vertical spacing between the list items
+ is removed.
+ Note that this is a command not a length so it doesn't require
+\family typewriter
+
+\backslash
+setlength
+\family default
+ like the stuff mentioned above.
+\end_layout
+
+\begin_layout Subsubsection
+Headers and Footers
\end_layout
\begin_layout Standard
+The
+\family typewriter
-Choosing the
-\family sans
-Slide
+\backslash
+LogoOn
\family default
- environment [in the manner described in section\InsetSpace ~
+ and
+\family typewriter
-\begin_inset LatexCommand \ref{sec:slideQuirk}
+\backslash
+LogoOff
+\family default
+ commands control whether the logo in the
+\family sans
+MyLogo
+\family default
+ definition appear on a given page.
+ If you put
+\family typewriter
-\end_inset
+\backslash
+LogoOff
+\family default
+ in the preamble then none of the foils will have the logo on them.
+ If you don't want the logo on a particular page place the
+\family typewriter
-] tells LyX to begin a new slide [duh].
- The label for this environment/
-\begin_inset Quotes erd
-\end_inset
+\backslash
+LogoOff
+\family default
+ directly after the foilhead of that page and the
+\family typewriter
-pseudo-command
-\begin_inset Quotes erd
-\end_inset
+\backslash
+LogoOn
+\family default
+ directly after the next foilhead.
+\end_layout
- is an
-\begin_inset Quotes eld
+\begin_layout Standard
+If you decide to use the
+\family sans
+fancy
+\family default
+ page style setting in the
+\family sans
+Document
+\begin_inset space ~
\end_inset
-ASCII line,
-\begin_inset Quotes erd
-\end_inset
+Layout
+\family default
+ dialog you should probably add
+\family typewriter
- in cool blue, followed by the label,
-\begin_inset Quotes eld
-\end_inset
-
-NewSlide:
-\begin_inset Quotes erd
-\end_inset
-
-.
- Any text or paragraph environments that follow this one go on the new slide.
- It's that simple.
-\end_layout
-
-\begin_layout Standard
-
-Slides are probably the only time you'll need to forcibly end pages in LyX
- (this can be specified in the
-\family sans
-Paragraph Layout
+\backslash
+let
+\backslash
+headwidth
+\backslash
+textwidth
\family default
- dialog).
- In fact, you'll want to, once you finish entering the contents of one slide.
- If you've entered more text than can physically fit on a slide, the extra
- overflows onto a new slide.
- I don't recommend doing this, however, since the overflow slide won't have
- any page number on it.
- Furthermore, it may interfere with any
+ to your preamble so headers and footers on landscape pages are correctly
+ placed when rotated.
+ This is due to some clashes between the page layouts provided by the
\family sans
-Overlay
+fancyheadings
\family default
- you've made to accompany the oversized
+ package and the
\family sans
-Slide
+foils
\family default
-.
+ class.
\end_layout
-\begin_layout Standard
-
-The
-\family sans
-Overlay
-\family default
- and
-\family sans
-Note
-\family default
- environments work the same way as the
-\family sans
-Slide
-\family default
-environment.
- They both create an
-\begin_inset Quotes eld
-\end_inset
-
-ASCII line
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Section
+Hollywood (Hollywood spec scripts)
+\end_layout
- followed by a label [
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+by
+\shape smallcaps
+Garst Reese
+\end_layout
-NewOverlay:
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Introduction
+\end_layout
- and
+\begin_layout Standard
+Getting the format of a Hollywood script right is a
\begin_inset Quotes eld
\end_inset
-NewNote:
+rite of passage.
\begin_inset Quotes erd
\end_inset
-, respectively].
- The color is a stunning magenta instead of blue, and the
-\begin_inset Quotes eld
-\end_inset
-
-ASCII line
-\begin_inset Quotes erd
-\end_inset
+ It is designed to make the readers focus on content and to be easy and
+ familiar for the actors to read.
+ Each page of a script should be one minute of film.
+ Nothing goes in a script that you cannot see or hear on screen.
+ The courier 12 pt font should be used throughout.
+ No italics.
+\end_layout
- will look different, in style and in length.
- The label fonts of all three also differ from one another.
+\begin_layout Subsection
+Special problems
\end_layout
\begin_layout Standard
-
-As with a
-\family sans
-Slide
-\family default
-, if the contents of a
-\family sans
-Note
-\family default
- or
-\family sans
-Overlay
-\family default
- exceed the physical size of a slide or sheet of paper, the extra will overflow
- onto a new sheet.
- Again, you should avoid this.
- It defeats the whole purpose of
-\family sans
-Note
-\family default
-s and
+Speakers' lines should NEVER break in mid-sentence.
+ If a speaker's lines continue over a page break, repeat the
\family sans
-Overlay
+Speaker
\family default
-s.
+ title followed by (Cont'd).
\end_layout
-\begin_layout Subsubsection
+\begin_layout Subsection
+Special features
+\end_layout
-Using
+\begin_layout Standard
+Insert the
\family sans
-Overlay
+Speaker
\family default
- with
-\family sans
-Slide
+ names as labels then cross-reference the label to insert the name.
+ The cross-reference dialog will show the current cast of characters.
+ You can use this to insert the speaker name in narratives also.
+\end_layout
+
+\begin_layout Subsection
+Paper size and Margins
\end_layout
\begin_layout Standard
+USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+\end_layout
-The idea behind an
-\family sans
-Overlay
-\family default
- is a slide that sits atop another slide.
- Perhaps you wish to discuss a figure on the main
-\family sans
-Slide
-\family default
- before displaying the text associated with it.
- One way to accomplish this is tape a flap of dark paper over the part of
- the
-\family sans
-Slide
-\family default
- you want to display later.
- This method fails, however, if you wish to overlap one graph with another,
- for example.
- You would then have to fumble while speaking to align the two separate,
- overlapping
-\family sans
-Slide
-\family default
-s to align the two graphs.
- The use of an
-\family sans
-Overlay
-\family default
- environment in both cases makes life much easier.
+\begin_layout Subsection
+Environments
\end_layout
\begin_layout Standard
+The following environments are available.
+ You can use hollywood.bind to get the bind keys shown at the right.
+\end_layout
-Each
-\family sans
-Overlay
-\family default
- receives the page number of its
-\begin_inset Quotes eld
-\end_inset
-
-parent
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-
\family sans
-Slide
-\family default
-, appended by
-\begin_inset Quotes eld
+Standard
+\begin_inset Newline newline
\end_inset
-\family typewriter
--a
\family default
+Used where nothing else works.
+ Try to avoid it.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
-.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
+\begin_layout Itemize
-Presumably, mutliple
\family sans
-Overlay
+FADE_IN
\family default
-s would have
-\begin_inset Quotes eld
+:
+\begin_inset space \hfill{}
\end_inset
-\family typewriter
--a
+\family sans
+M-z S-I
\family default
-\begin_inset Quotes erd
+\begin_inset Newline newline
\end_inset
-,
+Usually followed by something like
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
--b
-\family default
-
+on Sally waking up.
\begin_inset Quotes erd
\end_inset
-,
-\begin_inset Quotes eld
-\end_inset
-
-\family typewriter
--c
-\family default
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Itemize
-, etc.\InsetSpace ~
-appended to the page number of the parent
\family sans
-Slide
-\family default
-.
-
-\end_layout
-
+INT:
+\begin_inset space \hfill{}
\end_inset
- Clearly, you want the contents of both the
-\family sans
-Slide
-\family default
- and the
-\family sans
-Overlay
-\family default
- to each fit on a single physical slide! You should probably consider an
-
-\family sans
-Overlay
-\family default
- as
-\begin_inset Quotes eld
+M-z i
+\begin_inset Newline newline
\end_inset
-part of
-\begin_inset Quotes erd
-\end_inset
- a
-\family sans
-Slide
-\family default
-.
- Indeed, the LyX
-\family sans
-slides
-\family default
- class provides a visual cue for this: the label at the start of an
-\family sans
-Overlay
-\family default
- is shorter than that at the start of a
-\family sans
-Slide
-\family default
-.
- Lastly, when you generate printable output, you'll find alignment markers
- in all four corners of both the
-\family sans
-Overlay
-\family default
- page and its parent
-\family sans
-Slide
\family default
-.
- These will assist you in lining up the two physical slides.
+Introduces a new INTERIOR camera set-up.
+ Always followed by DAY or NIGHT, or something similar to define the lighting
+ required.
+ Everthing on this line in CAPS.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-The major problem in overlaying two slides is aligning the contents of the
- two transparencies.
- How much space should you leave for that graph on the second slide? Worse
- still, what if you want a graph and a sentence on second slide, but there
- is text on the main transparency that goes in between them? You could try
- and insert vertical space of the right size.
- The better way is to use
-\family sans
-InvisibleText
-\family default
- and
\family sans
-VisibleText
-\family default
-.
-\end_layout
+EXT:
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Standard
+M-z e
+\begin_inset Newline newline
+\end_inset
-As their names imply,
-\family sans
-InvisibleText
-\family default
- and
-\family sans
-VisibleText
-\family default
- are two command-like paragraph environments that make all subsequent text
- invisible and visible, respectively.
- Note from section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:slideQuirk}
+\family default
+Introduces a new EXTERIOR camera set-up.
+ Everthing on this line in CAPS.
+\end_layout
-\end_inset
+\begin_layout Itemize
- that you don't place anything
-\emph on
-into
-\emph default
- these two environments, however.
- When you create an
\family sans
-InvisibleText
-\family default
-, it inserts a centered, sky-blue label into the page reading
-\begin_inset Quotes eld
+Speaker
+\begin_inset space \hfill{}
\end_inset
-<Invisible Text Follows>
-\begin_inset Quotes erd
+M-z s
+\begin_inset Newline newline
\end_inset
-.
- For paragraphs following this label, the parts of the
-\family sans
-Slide
-\family default
- [or
-\family sans
-Overlay
+
\family default
-; it doesn't matter which] where they would be contain instead blank space.
-
+The character speaking.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-For
\family sans
-VisibleText
-\family default
-, the corresponding centered label is
-\begin_inset Quotes eld
+Parenthetical
+\begin_inset space \hfill{}
\end_inset
-<Visible Text Follows>
-\begin_inset Quotes erd
+M-z p
+\begin_inset Newline newline
\end_inset
- in blazing green.
- Paragraphs following this label behave normally.
- Note that the beginning of a new
-\family sans
-Slide
-\family default
-,
-\family sans
-Overlay
-\family default
-, or
-\family sans
-Note
-\family default
- automatically shuts off an
-\family sans
-InvisibleText
-\family default
-.
- It's therefore not necessary to use
-\family sans
-VisibleText
-\family default
- at the end of a
-\family sans
-Slide
+
\family default
-.
+Instructions to the speaker.
+ The () are automatically inserted, but only the ( will show in LyX.
+ Both will be printed.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-By now, it should be obvious how to create overlay transparencies using
- the proper combination of
-\family sans
-InvisibleText
-\family default
- and
-\family sans
-VisibleText
-\family default
- on a
-\family sans
-Slide
-\family default
- and
\family sans
-Overlay
-\family default
-:
-\end_layout
+Dialogue
+\begin_inset space \hfill{}
+\end_inset
+
+M-z d
+\begin_inset Newline newline
+\end_inset
-\begin_layout Enumerate
-Create a
-\family sans
-Slide
\family default
-, including everything that will appear on it, whether on the main slide
- or on the
+What the
\family sans
-Overlay
+Speaker
\family default
-.
+ says.
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-Before each figure or paragraph that will appear only on the
-\family sans
-Overlay
-\family default
-, insert an
-\family sans
-InvisibleText
-\family default
- environment.
- If necessary, insert a
-\family sans
-VisibleText
-\family default
- environment after the
\family sans
-Overlay
+Transition
+\begin_inset space \hfill{}
+\end_inset
+
+M-z t
+\begin_inset Newline newline
+\end_inset
+
+
\family default
--only text.
+Camera movement instruction.
+ e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+CUT TO:
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-Start an
-\family sans
-Overlay
-\family default
- immediately following the
\family sans
-Slide
-\family default
-.
+FADE OUT:
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-I
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-Copy the contents of this
-\family sans
-Slide
-\family default
- into the
\family sans
-Overlay
-\family default
-.
+Author
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-A
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
-Within the
\family sans
-Overlay
-\family default
-, change all of the
-\family sans
-InvisibleText
-\family default
- lines to
-\family sans
-VisibleText
-\family default
- and vice-versa.
+Title
+\begin_inset space \hfill{}
+\end_inset
+
+M-z S-T
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-That's it.
- You've just made an
\family sans
-Overlay
-\family default
-.
-\end_layout
+Right_Address
+\begin_inset space \hfill{}
+\end_inset
-\begin_layout Standard
+M-z r
+\end_layout
-There's one problem with the way I've designed the LyX
-\family sans
-slides
-\family default
- class: you can't make text in the middle of a paragraph invisible, nor
- make text in the middle of an invisible paragraph visible again.
- To accomplish this feat, you'll need to use some inlined LaTeX codes.
-\begin_inset Foot
-status collapsed
+\begin_layout Subsection
+Script jargon
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+(O.S) — off screen
+\end_layout
-The commands of interest are:
+\begin_layout Itemize
+(V.0) — voice over
\end_layout
\begin_layout Itemize
+b.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+ — background
+\end_layout
-\family typewriter
-{
-\backslash
-invisible \SpecialChar \ldots{}
- }
+\begin_layout Itemize
+C.U.
+ — close-up
\end_layout
\begin_layout Itemize
+PAN — camera movement
+\end_layout
+\begin_layout Itemize
+INSERT — cut to close-up of
+\end_layout
-\family typewriter
-{
-\backslash
-visible \SpecialChar \ldots{}
- }
+\begin_layout Section
+ijmpc and ijmpd
\end_layout
\begin_layout Standard
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
-\SpecialChar \ldots{}
-and need to be marked as TeX.
- The text whose
-\begin_inset Quotes eld
-\end_inset
-
-visibility
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+Overview
+\end_layout
- you wish to change goes in between the brackets [and after the
+\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
-invisible
+ws-ijmpc.cls
\family default
- or
+ and
\family typewriter
-
-\backslash
-visible
+ws-ijmpd.cls
\family default
- command].
- If you don't know how to mark text as TeX, see the apprpriate section of
- the
-\emph on
-User's Guide
-\emph default
-.
+, respectively.
+ These files, together with instructions for the authors, can be downloaded
+ from the sites
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
\end_layout
\end_inset
+ and
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
\end_layout
-\begin_layout Subsubsection
-
-Using
-\family sans
-Note
-\family default
- with
-\family sans
-Slide
-\family default
+\end_inset
-\begin_inset LatexCommand \label{sec:slideNote}
+.
+ Both packages are modified versions of the standard
+\begin_inset Quotes eld
+\end_inset
+article
+\begin_inset Quotes erd
\end_inset
+ 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 Subsection
+Writing a paper
\end_layout
\begin_layout Standard
-
-Like an
-\family sans
-Overlay
-\family default
-, a
+As usual, the easiest way to write a paper is to start with a template.
+ Click on
\family sans
-Note
+File\SpecialChar \menuseparator
+New from
\family default
- is associated with a
-\begin_inset Quotes eld
-\end_inset
-
-parent
-\begin_inset Quotes erd
-\end_inset
-
\family sans
-Slide
+\bar under
+T
+\bar default
+emplate
\family default
-.
- Here, too, the LyX
-\family sans
-slides
+, then choose the
+\family typewriter
+ijmpc.lyx
\family default
- class provides visual cues.
- The label for a
+ 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 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
+
+\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
-Note
+Tools\SpecialChar \menuseparator
+Preferences
\family default
- is shorter than that of a
+, select the
\family sans
-Slide
+Lang Opts
\family default
- [yet longer than that of an
+ tab, deselect the
\family sans
-Overlay
+Use babel
\family default
-] and, like the label of an
+ checkbox in the language settings, and click on
\family sans
-Overlay
+Apply
\family default
- is shockingly magenta.
- Additionally, the printed
+ (or
\family sans
-Note
+Save
\family default
- has the page number of its
+, if you wish to make this change permanent).
+\end_layout
+
+\begin_layout Enumerate
+The
\begin_inset Quotes eld
\end_inset
-parent
+Keywords
\begin_inset Quotes erd
\end_inset
-
-\family sans
-Slide
-\family default
-, appended by
+ style must be used to define keywords.
+\end_layout
+
+\begin_layout Enumerate
+The ijmpc package provides a style named
\begin_inset Quotes eld
\end_inset
+Classification Codes
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
--
-\family default
-1
+, 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 Enumerate
+Several new environments are available:
+\begin_inset Quotes eld
+\end_inset
+
+Definition
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
+Step
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
--
-\family default
-2
+,
+\begin_inset Quotes eld
+\end_inset
+
+Example
\begin_inset Quotes erd
\end_inset
\begin_inset Quotes eld
\end_inset
+Remark
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
--
-\family default
-3
+,
+\begin_inset Quotes eld
+\end_inset
+
+Notation
\begin_inset Quotes erd
\end_inset
-, etc.
- You can have multiple
-\family sans
-Note
-\family default
-s associated with a single
-\family sans
-Slide
-\family default
-, and, as with
-\family sans
-Slide
-\family default
- and
-\family sans
-Overlay
-\family default
-, you'll probably want to break up long
-\family sans
-Note
-\family default
-s so that they fit on a single sheet of paper.
-\end_layout
-
-\begin_layout Standard
-
-The purpose of a
-\family sans
-Note
-\family default
- is obvious: it contains anything additional you might want to say about
- a
-\family sans
-Slide
-\family default
-.
- It could also be used as a sheet of reminders for a particular
-\family sans
-Slide
-\family default
-.
- In the case of the latter, you might want to make use of time markers.
- Currently, the LyX
-\family sans
-slides
-\family default
- class has no
+,
\begin_inset Quotes eld
\end_inset
-native
+Theorem
\begin_inset Quotes erd
\end_inset
- support for time markers, a
-\noun on
-Sli
-\noun default
-TeX feature.
- So, you'll have to resort to using the LaTeX codes.
-\end_layout
-
-\begin_layout Standard
-
-To use time markers, you'll need to specify the extra class option
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-clock
-\family default
-
+Proof
\begin_inset Quotes erd
\end_inset
- [see section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:slidesetup}
+,
+\begin_inset Quotes eld
+\end_inset
+Corollary
+\begin_inset Quotes erd
\end_inset
-].
- This option turns on timing marks, which will appear in the lower-left-hand
- corner of every
-\family sans
-Note
-\family default
- you generate.
- To set what appears in the time marker, you use the LaTeX commands
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-settime{}
-\family default
-
+Lemma
\begin_inset Quotes erd
\end_inset
- and
+,
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-addtime{}
-\family default
-
+Proposition
\begin_inset Quotes erd
\end_inset
-.
- The arguments of both commands are time measured in seconds.
-
+,
\begin_inset Quotes eld
\end_inset
+Prop
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-
-\backslash
-settime{}
-\family default
+,
+\begin_inset Quotes eld
+\end_inset
+Question
\begin_inset Quotes erd
\end_inset
- sets the time marker to a given time.
-
+,
\begin_inset Quotes eld
\end_inset
+Claim
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-
-\backslash
-addtime{}
-\family default
+, and
+\begin_inset Quotes eld
+\end_inset
+Conjecture
\begin_inset Quotes erd
\end_inset
- increments the time marker by the specified amount.
- Using time markers and
-\family sans
-Note
-\family default
-s in this fashion, you can remind yourself how much time to spend on a particula
-r
-\family sans
-Slide
-\family default
.
+ 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
-
-There's one last feature to describe.
- Clearly, you'd like to print out all of your
-\family sans
-Slide
-\family default
-s and
-\family sans
-Overlay
-\family default
-s on transparencies while printing all of your
-\family sans
-Note
-\family default
-s on plain paper.
- However, a
-\family sans
-Note
-\family default
-
-\emph on
-must
-\emph default
- follow the
-\family sans
-Slide
+\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
+refcite
\family default
- with which it is associated.
- What's a person to do?
-\end_layout
+ command, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-Luckily, there are two LaTeX commands that allow you to select what to print
- out.
- Both must be placed into the preamble of your document.
- The command
\begin_inset Quotes eld
\end_inset
+See Ref.
+\begin_inset space \space{}
+\end_inset
+
\family typewriter
\backslash
-onlyslides{
-\backslash
-slides}
+refcite{key}
\family default
\begin_inset Quotes erd
\end_inset
- will cause the output to contain only the
-\family sans
-Slide
-\family default
-s and
-\family sans
-Overlay
-\family default
-s.
- Correspondingly, the command
+.
+\end_layout
+
+\begin_layout Enumerate
+There is no
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-
-\backslash
-onlynotes{
-\backslash
-notes}
-\family default
-
+Acknowledgments
\begin_inset Quotes erd
\end_inset
- prevents the output of anything but
-\family sans
-Note
-\family default
-s.
- I'd advise placing both commands in the preamble and initially comment
- both out.
- You can then preview your entire presentation as you write.
- When you're done writing, you can then uncomment one of the two to select
- what you want to print.
- I like to uncomment
+ section in both packages.
+ To put acknowledgments, just use the
\begin_inset Quotes eld
\end_inset
+Section*
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
+ environment.
+\end_layout
-\backslash
-onlyslides{
-\backslash
-slides}
-\family default
+\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
- , print to a file with
+ 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
-
-\family typewriter
--slides
-\family default
-
+Appendix
\begin_inset Quotes erd
\end_inset
- in its name, comment it back out, then uncomment
+ 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
-
-\family typewriter
-
-\backslash
-onlynotes{
-\backslash
-notes}
-\family default
-
+Appendix
\begin_inset Quotes erd
\end_inset
- and print to a
+ environment.
+ LyX will number each appendix with capital letters, as required by both
+ journals.
+ Note that
\begin_inset Quotes eld
\end_inset
-
-\family typewriter
-*-notes.ps
-\family default
-
+Appendices Section
\begin_inset Quotes erd
\end_inset
- file.
- I can then send either file to a printer, loading transparencies or plain
- paper as appropriate.
-\end_layout
-
-\begin_layout Standard
-
-You can also provide other arguments to the
-\begin_inset Quotes eld
-\end_inset
-
+
+\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
+\begin_layout Enumerate
+The ijmpc and the ijmpd packages use the
+\family typewriter
+tbl
+\family default
+ command to implement table captions.
+ As a result, a table created by LyX is printed correctly, but its caption
+ is ignored.
+ However, you can use some TeX code to overpass this problem, so that captions
+ are printed as expected.
+ To do so, create a float table as usual, remove the caption, and replace
+ it with the TeX code
\family typewriter
\backslash
-onlyslides{}
+tbl{
+\emph on
+your table caption
+\emph default
+}{
\family default
-
-\begin_inset Quotes erd
+ (sic); you must also the TeX code
+\family typewriter
+}
+\family default
+ 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
+.tex
+\family default
+ file, then include this file to the LyX document (
+\family sans
+Insert\SpecialChar \menuseparator
+File\SpecialChar \menuseparator
+Child
+\begin_inset space ~
\end_inset
+Document
+\family default
+).
+ Details on how to create a table float can be found in the files
+\family typewriter
+ws-ijmpc.tex
+\family default
and
-\begin_inset Quotes eld
-\end_inset
-
-
\family typewriter
-
-\backslash
-onlynotes{}
+ws-ijmpd.tex
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- commands.
- See a good LaTeX book for details.
+, included in the corresponding packages.
\end_layout
\begin_layout Subsection
+Preparing a paper for submission
+\end_layout
-The
+\begin_layout Standard
+Before you submit your paper you must export the LyX document as a LaTeX
+ file (
\family sans
-slides
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
- Class Template File
-\end_layout
+)
+\begin_inset Foot
+status open
-\begin_layout Standard
+\begin_layout Plain Layout
+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
-I have also provided a template file,
-\begin_inset Quotes eld
\end_inset
-
+, then make the following changes to the resulting
\family typewriter
-slides.lyx
+.tex
\family default
+ file.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
+Remove the comment lines before the
+\family typewriter
-, with the
-\family sans
-slides
+\backslash
+documentclass
\family default
- class.
- To use it, begin your new presentation with
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-New\InsetSpace ~
-from\InsetSpace ~
+ command.
+\end_layout
-\bar under
-T
-\bar default
-emplate
-\family default
-.
- Your new LyX presentation file will contain an example
-\family sans
-Slide
+\begin_layout Enumerate
+Remove everything between (and including) the
+\family typewriter
+
+\backslash
+makeatletter
\family default
- --
-\family sans
-Overlay
+ and
+\family typewriter
+
+\backslash
+makeatother
\family default
- --
-\family sans
- Note
+ commands, except for any commands you specifically put into the LaTeX preamble.
+\end_layout
+
+\begin_layout Standard
+The modified
+\family typewriter
+.tex
\family default
- triplet.
- The
-\family sans
-Slide
+ 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
- and
-\family sans
-Overlay
+ document.
+\end_layout
+
+\begin_layout Subsection
+Use of TeX code
+\end_layout
+
+\begin_layout Standard
+The use of TeX code 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
- additionally contain an example of the use of
-\family sans
-InvisibleText
+ or the
+\family typewriter
+ijmpd.lyx
\family default
- and
-\family sans
-VisibleText
+ template, the TeX code needed is already in its place; you usually don't
+ need to delete it.
+ You may only modify the first TeX code to specify the information printed
+ to the top of odd and even pages (authors' names and short paper's title,
+ respectively).
+ This TeX code must have the form
+\family typewriter
+
+\backslash
+markboth{Authors' Names}{Short Paper's Title}
\family default
.
- Lastly, the preamble will contain:
\end_layout
-\begin_layout LyX-Code
-
-% Uncomment to print out only slides and overlays
+\begin_layout Section
+iopart
\end_layout
-\begin_layout LyX-Code
-
-%
+\begin_layout Standard
+by
+\noun on
+Uwe Stöhr
\end_layout
-\begin_layout LyX-Code
-
-%
-\backslash
-onlyslides{
-\backslash
-slides}
-\newline
-
+\begin_layout Subsection
+Overview
\end_layout
-\begin_layout LyX-Code
+\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 Flex URL
+status collapsed
-% Uncomment to print out only notes
+\begin_layout Plain Layout
+
+ftp://ftp.iop.org/pub/journals/latex2e
\end_layout
-\begin_layout LyX-Code
+\end_inset
-%
+.
\end_layout
-\begin_layout LyX-Code
-
-%
-\backslash
-onlynotes{
-\backslash
-notes}
+\begin_layout Subsection
+Writing a paper
\end_layout
\begin_layout Standard
+The easiest way to write a paper is to start with the file
+\emph on
+IOP-article.lyx
+\emph default
+ 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
-One final thing: I created this class to support the LaTeX2e
-\begin_inset Quotes eld
-\end_inset
-
-
-\noun on
-Sli
-\noun default
-TeX emulation
-\begin_inset Quotes erd
-\end_inset
-
- class, one of the built-in LaTeX2e classes.
- Neither I nor the rest of the LyX Team endorse or oppose the use of this
- built-in slide class.
- It's here if you want it or need it.
- There exist other LaTeX2e classes for creating presentations, such as the
-
+\begin_layout Itemize
+To be able to compile your document to a PDF, PS, or DVI, assure that the
+ two options
\family sans
-Foils
+Use AMS math package
\family default
- class [see section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:foiltex}
+ in the document settings under
+\family sans
+Math Options
+\family default
+ are not used!
+\end_layout
-\end_inset
+\begin_layout Itemize
-] or the
-\begin_inset Quotes eld
-\end_inset
+\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 typewriter
-seminar
+\family sans
+\size normal
+Title
\family default
+ for a Paper
+\end_layout
-\begin_inset Quotes erd
-\end_inset
-
- package [present on some TeX distributions].
- The latter is not yet supported under LyX.
-\begin_inset Foot
-status collapsed
+\begin_layout Itemize
-\begin_layout Standard
+\family sans
+\size normal
+Review
+\family default
+ for a Review
+\end_layout
-Perhaps you can take on the task\SpecialChar \ldots{}
+\begin_layout Itemize
+\family sans
+\size normal
+Topical
+\family default
+ for a Topical review
\end_layout
-\end_inset
+\begin_layout Itemize
- I know nothing about these other classes.
- Try them out to see what sort of alternative they provide.
+\family sans
+\size normal
+Comment
+\family default
+ for a Comment
\end_layout
-\begin_layout Section
+\begin_layout Itemize
-Foils [aka
\family sans
-Foil
+\size normal
+Note
\family default
-\noun on
-TeX
-\noun default
-]
-\begin_inset LatexCommand \label{sec:foiltex}
-
-\end_inset
+ for a Note
+\end_layout
+\begin_layout Itemize
+\family sans
+\size normal
+Paper
+\family default
+ for a Paper (same as Title)
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-by
-\noun on
-Allan Rae
+\family sans
+\size normal
+Prelim
+\family default
+ for a Preliminary communication
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-Introduction
+\family sans
+\size normal
+Rapid
+\family default
+ for a Rapid communication
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-This section describes how to use LyX to make slides for overhead projectors.
- There are two document classes that can do this: the default slides class
- and the
\family sans
-Foil
+\size normal
+Letter
\family default
-TeX slides class.
- This section documents the latter.
+ for a Letter to the editor
\end_layout
-\begin_layout Standard
+\end_deeper
+\begin_layout Itemize
-I'm going to say this again, nice and clear, so that there's no misunderstanding
-:
+\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 TeX code when your document doesn't fit into one of
+ the other title types.
+\end_layout
\begin_layout Standard
+For more informations like hints for special table and formula formatting,
+ look at the IOP author guidelines.
+\end_layout
+\begin_layout Section
+Kluwer
+\end_layout
-\begin_inset VSpace bigskip
-\end_inset
-
+\begin_layout Standard
+by
+\noun on
+Panayotis Papasotiriou
+\end_layout
+\begin_layout Subsection
+Overview
\end_layout
\begin_layout Standard
-\align center
-
-\size large
-This section documents the class
-\begin_inset Quotes eld
-\end_inset
+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 Flex URL
+status collapsed
+\begin_layout Plain Layout
-\family sans
-slides (FoilTeX)
-\family default
+http://www.wkap.nl/jrnllist.htm/JRNLHOME
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
-\emph on
-only.
-\end_layout
+).
+ The Kluwer package may be downloaded from the site
+\begin_inset Flex URL
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+http://www.wkap.nl/kaphtml.htm/STYLEFILES
+\end_layout
-\begin_inset VSpace bigskip
\end_inset
-
+.
+ A complete user guide is contained in that package (but it can also be
+ downloaded separately).
\end_layout
-
\begin_layout Standard
-
-If you're looking for the documentation for
+LyX supports many features of the package but not everything.
+ However, the TeX code needed is reduced to some
\begin_inset Quotes eld
\end_inset
-
-\family sans
-slides (default)
-\family default
-
+peculiar
\begin_inset Quotes erd
\end_inset
-, check out section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:slitex}
-
-\end_inset
-
-.
- If your machine doesn't have the
-\family sans
-foils
-\family default
-class [
-\begin_inset Quotes eld
+ commands of the package (see
+\begin_inset space ~
\end_inset
-\family sans
-slides (FoilTeX)
-\family default
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:kluwer_peculiarities"
-\begin_inset Quotes erd
\end_inset
-] installed, you'll probably have to use the default
-\family sans
-slides
-\family default
- class, which isn't quite as good as
-\family sans
-foils.
+).
+ 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 Standard
+\begin_layout Subsection
+Writing a paper
+\end_layout
-The
+\begin_layout Standard
+The easiest way to write a paper is to start with the Kluwer template file.
+ Click on
\family sans
-foils
+File\SpecialChar \menuseparator
+New from
\family default
- class is designed for use with version 2.1 of the
+
\family sans
-foils.cls
+Template
\family default
- LaTeX class file which is now an integral part of LaTeX2e.
+, 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
-
-Getting Started
+Preparing a paper for submission
\end_layout
\begin_layout Standard
-
-Obviously, to use this document class, you need to select
+As in the AASTeX package, before you submit your paper to a journal you
+ must
\begin_inset Quotes eld
\end_inset
-
-\family sans
-slides (FoilTeX)
-\family default
-
+postprocess
\begin_inset Quotes erd
\end_inset
- from the
-\family sans
-\bar under
-C
-\bar default
-lass
-\family default
- entry in the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog.
- There are some settings in the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog that you should know about that are specific to this class:
+ it as follows.
\end_layout
-\begin_layout Itemize
-
-Don't change the options
-\family sans
-Sides
-\family default
- and
-\family sans
-Columns
-\family default
- on the
-\family sans
-Document\InsetSpace ~
-Layout
-\family default
- dialog.
- They're ignored by the
+\begin_layout Enumerate
+Export your paper as a LaTeX file.
+ To do this, click on
\family sans
-foils
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
\family default
- class.
+.
+
\end_layout
-\begin_layout Itemize
-
-The default font size is 20pt with the other options being 17pt, 25pt and
- 30pt.
+\begin_layout Enumerate
+Edit the resulting
+\family typewriter
+.tex
+\family default
+ file with a text editor and make the following changes
\end_layout
-\begin_layout Itemize
+\begin_deeper
+\begin_layout Enumerate
+remove the comment lines before the
+\family typewriter
-The default font is
-\family sans
-sans
-\family default
-
-\family sans
-serif
+\backslash
+documentclass
\family default
- but all math equations are still typeset in the usual roman font.
+ command,
\end_layout
-\begin_layout Itemize
-
+\begin_layout Enumerate
+remove everything between (and including) the
+\family typewriter
-\family sans
-Foil
+\backslash
+makeatletter
\family default
-TeX supports A4 and Letter paper sizes as well as a special size for working
- with 35mm slides.
- It doesn't support A5, B5, legal or executive paper sizes.
-\end_layout
-
-\begin_layout Itemize
+ and
+\family typewriter
-Don't bother changing the
-\family sans
-Float Placement
+\backslash
+makeatother
\family default
- settings because they are ignored anyway.
- All floats appear where they are defined in the text.
+ commands, except for any commands you specifically put into the LaTeX preamble.
\end_layout
-\begin_layout Itemize
-
-The
-\family sans
-\bar under
-P
-\bar default
-agestyle
-\family default
- setting behaves a bit differently for this class.
-
-\family sans
-Foil
+\begin_layout Standard
+Save the resulting
+\family typewriter
+.tex
\family default
-TeX provides extensive footer and header capabilities including a user-defined
- logo.
- See section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:foilfoot}
-
-\end_inset
-
- for more details.
- The title page is treated differently to all other pages in the document
- and is
-\emph on
-always
-\emph default
- unnumbered and
-\emph on
-always
-\emph default
- has the logo centered at the bottom of the page (if one is defined).
- The possible page style choices and what they do are as follows:
+ file.
\end_layout
-\begin_deeper
-\begin_layout List
-\labelwidthstring MMMMMMM
-
-
-\family sans
-\series bold
-empty
+\end_deeper
+\begin_layout Enumerate
+Run the
+\family typewriter
+.tex
\family default
-\series default
- The final output contains no page numbers, or other headers or footers
- (except footnotes of course).
-
+ file through LaTeX as many times as necessary (usually up to three).
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMM
+\begin_layout Enumerate
+View the resulting
+\family typewriter
+.dvi
+\family default
+ document using, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
\family sans
-\series bold
-plain
+xdvi
\family default
-\series default
- The final output contains page numbers centered at the bottom of the page.
- No other headings or footers (other than footnotes).
+, and check if everything is OK (it should, if you didn't make any mistake).
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMM
-
+\begin_layout Subsection
+\begin_inset Quotes eld
+\end_inset
-\series bold
-foilheadings
-\series default
- Page numbers in lower right corner.
- Additional headers and footers are also shown.
- This is also the default.
-\end_layout
+Peculiarities
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring MMMMMMM
+ of the Kluwer package
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:kluwer_peculiarities"
+\end_inset
-\series bold
-fancy
-\series default
- Gives you access to the
-\family sans
-fancyheadings
-\family default
- package although its use with
-\family sans
-Foil
-\family default
-TeX is discouraged by the writer of the
-\family sans
-Foil
-\family default
-TeX package because of some potential page layout clashes.
-\end_layout
-\end_deeper
-\begin_layout Subsubsection
-Extra Options
\end_layout
\begin_layout Standard
+The Kluwer package has the following
+\begin_inset Quotes eld
+\end_inset
-The following options may be used in the extra class options in the
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
+peculiarities
+\begin_inset Quotes erd
+\end_inset
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
+.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMx
-
+\begin_layout Enumerate
+It is possible to write multiple articles in the same LaTeX file
+\begin_inset Foot
+status collapsed
-\series bold
-35mmSlide
-\series default
- This sets up the page layout for 7.33in by 11in paper, which is about the
- same aspect ratio as a 35mm slide, making it a bit easier to work with
- this medium.
+\begin_layout Plain Layout
+I can't imagine any good reason to do this.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMx
+\end_inset
+.
+ Each article must be included in the environment
+\begin_inset Quotes eld
+\end_inset
-\series bold
-headrule
-\series default
- Places a rule across the page below the header on every page except the
- title page.
-\end_layout
+article
+\begin_inset Quotes erd
+\end_inset
-\begin_layout List
-\labelwidthstring MMMMMMx
+.
+ Unfortunately, this environment cannot be omitted, even if you write just
+ one article.
+ Therefore, each article starts with the command
+\family typewriter
+\backslash
+begin{article}
+\family default
+ and, obviously, ends with the command
+\family typewriter
-\series bold
-footrule
-\series default
- Places a rule across the page above the footer on every page except the
- title page.
+\backslash
+end{article}
+\family default
+.
+ Although this can be implemented in LyX, I didn't included it, since it
+ looks ugly and can confuse the novice user.
+ Therefore, you need to enter them directly and mark them as LaTeX code
+ (the well-known
+\begin_inset Quotes eld
+\end_inset
+
+TeX code
+\begin_inset Quotes erd
+\end_inset
+
+).
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMx
+\begin_layout Enumerate
+Information given at the beginning of the article (i.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\series bold
-dvips
-\series default
- This is automatically set each time you create a new
-\family sans
-foils
-\family default
- document.
- This option tells
-\family sans
-Foil
-\family default
-TeX to use the dvips driver to rotate those pages that are set as landscape
- foils.
-\end_layout
+title, subtitle, author, institution, running title, running author, abstract
+ and keywords) must be included in an environment called
+\begin_inset Quotes eld
+\end_inset
-\begin_layout List
-\labelwidthstring MMMMMMx
+opening
+\begin_inset Quotes erd
+\end_inset
+.
+ This is not implemented in LyX, so you must enter title, subtitle etc.
+\begin_inset space ~
+\end_inset
-\series bold
-landscape
-\series default
- Simply changes the page dimensions to those of a landscape page but doesn't
- do any rotation.
- Thus if you use this option you need to use an external program to rotate
- each page or feed your paper through your printer as landscape.
- Note that this option effectively reverses the roles of the
-\family sans
-Foilhead
+between two TeX code lines (
+\family typewriter
+
+\backslash
+begin{opening}
\family default
and
-\family sans
-Rotatefoilhead
-\family default
- environments (don't worry these are described in the next section).
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMx
-
+\family typewriter
-\series bold
-leqno
-\series default
- Equation numbers on the left.
+\backslash
+end{opening}
+\family default
+).
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMx
+\begin_layout Enumerate
+According to the user manual, the label of each bibliography item must be
+ written as
+\family typewriter
-
-\series bold
-fleqn
-\series default
- Flush-left equations.
-\end_layout
-
-\begin_layout Subsection
-
-Supported Environments
-\end_layout
-
-\begin_layout Standard
-
-Most of the environments commonly supported in other classes are also supported
- by the
-\family sans
-foils
+\backslash
+protect
+\backslash
+citeauthoryear{
\family default
- class.
- There are several additional environments provided by
-\family sans
-Foil
+\emph on
+author(s)
+\family typewriter
+\emph default
+}{
\family default
-TeX as well as a couple added by LyX.
- The following environments are shared with other classes:
+\emph on
+year
+\family typewriter
+\emph default
+}
+\family default
+.
\end_layout
\begin_layout Standard
-
-
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-begin{multicols}{2}
-\end_layout
-
+The
+\family typewriter
+kluwer.lyx
+\family default
+ template takes care of all these
+\begin_inset Quotes eld
\end_inset
+peculiarities
+\begin_inset Quotes erd
+\end_inset
+.
+ If you start a new paper using this template you don't need to do anything
+ special.
+ Just
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-Standard
+\begin_layout Enumerate
+don't delete the TeX code included in the template, and
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-Itemize
+\begin_layout Enumerate
+copy the example bibliography item included in the template and modify it
+ as necessary to enter new bibliography items.
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-Enumerate
+\begin_layout Section
+Koma-Script
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-Description
+\begin_layout Standard
+by
+\noun on
+Bernd Rellermeyer
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-List
+\begin_layout Subsection
+Overview
\end_layout
-\begin_layout Itemize
-
+\begin_layout Standard
+The LyX document classes
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+,
+\emph on
+book
+\emph default
+
+\emph on
+(koma-script)
+\emph default
+, and
+\emph on
+letter
+\emph default
+
+\emph on
+(koma-script)
+\emph default
+ correspond to the LaTeX document classes
+\family typewriter
+scrartcl.cls
+\family default
+,
+\family typewriter
+scrreprt.cls
+\family default
+,
+\family typewriter
+scrbook.cls
+\family default
+, and
+\family typewriter
+scrlettr.cls
+\family default
+, resp.
+\begin_inset space ~
+\end_inset
-\family sans
-LyX-Code
+of the Koma-Script family.
+ They are replacements for the standard document classes
+\family typewriter
+article.cls
+\family default
+,
+\family typewriter
+report.cls
+\family default
+,
+\family typewriter
+book.cls
+\family default
+ and
+\family typewriter
+letter.cls
+\family default
+, resp., and fit better to European typography conventions in a number of
+ points.
\end_layout
\begin_layout Itemize
-
-
-\family sans
-Verse
+Standard character size is 11pt in
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+, and
+\emph on
+book (koma-script)
+\emph default
+, and 12pt in
+\emph on
+letter (koma-script)
+\emph default
+.
\end_layout
\begin_layout Itemize
+Headings, labels of the description environment, and a number of elements
+ of the
+\emph on
+letter (koma-script)
+\emph default
+ document class are set in a bold sans serif font.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+There is a big difference between the bold sans serif old cm fonts and new
+ ec fonts, especially in the appearance of headings.
+ In comparison, the ec bold sans serif fonts look a bit thin.
+ Here the LaTeX package
+\family typewriter
+cmsd.sty by
+\family default
+
+\shape smallcaps
+Walter Schmidt
+\shape default
+ helps to produce the
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Quote
-\end_layout
-
-\begin_layout Itemize
-
+usual
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Quotation
+ appearance when using the ec fonts.
\end_layout
-\begin_layout Itemize
-
+\end_inset
-\family sans
-Title
-\end_layout
+ The numbering of chapter headings is made in the same way as the numbering
+ of section headings, that is without the extra line
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
+Chapter\SpecialChar \ldots{}
+\begin_inset Quotes erd
+\end_inset
+.
+ In addition, the appearance of the headings can be modified by using a
+ number of options (in LyX to be entered in the field
\family sans
-Author
-\end_layout
-
-\begin_layout Itemize
-
+Extra
+\begin_inset space ~
+\end_inset
+Options
+\family default
+ of the dialog
\family sans
-Date
+Layout\SpecialChar \menuseparator
+Document
+\family default
+).
+ A detailed German description of these options can be found in the Koma-Script
+ documentation
+\emph on
+scrguide
+\emph default
+.
\end_layout
\begin_layout Itemize
-
-
+The main means in the Koma-Script document classes to design the type area
+ are the options
\family sans
-Abstract
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-Bibliography
-\end_layout
-
-\begin_layout Itemize
-
-
+BCOR
+\family default
+ and
\family sans
-Address
-\end_layout
-
-\begin_layout Itemize
-
-
+DIV
+\family default
+ (in LyX to be entered in the extra class options field in the dialog
\family sans
-RightAddress
-\end_layout
-
-\begin_layout Itemize
-
-
+Document\SpecialChar \menuseparator
+Settings
+\family default
+).
+ They make a clearer modification of page margins possible as do the options
+ of the dialog
\family sans
-Caption
+Document\SpecialChar \menuseparator
+Settings
+\family default
+.
+ A detailed German description of these and other type area options can
+ be found in the Koma-Script documentation
+\emph on
+scrguide
+\emph default
+.
\end_layout
\begin_layout Itemize
-
-
-\family sans
-Comment
+The LaTeX document classes of the Koma-Script family define a number of
+ additional commands.
+ Those part of it which makes sense in LyX is implemented in corresponding
+ paragraph types.
\end_layout
\begin_layout Standard
+A detailed German description of the LaTeX document classes of the Koma-Script
+ family can be found in the Koma-Script documentation
+\emph on
+scrguide
+\emph default
+.
+\begin_inset Foot
+status collapsed
-
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-end{multicols}
+\begin_layout Plain Layout
+There is an English translation
+\emph on
+screnggu
+\emph default
+, but it is not a complete one.
\end_layout
\end_inset
+ The following sections describe only those aspects, which are relevant
+ in LyX.
+\end_layout
+\begin_layout Subsection
+article (koma-script), report (koma-script), and book (koma-script)
\end_layout
\begin_layout Standard
-
-That is, all the major environments apart from the sectioning environments.
- Since foils are essentially self-contained sections, with a title and body,
+The document classes
+\emph on
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+, and
+\emph on
+book
+\emph default
+\emph on
+(koma-script)
+\emph default
+ are implemented in the layout files
+\family typewriter
+scrartcl.layout
+\family default
+,
+\family typewriter
+scrreprt.layout
+\family default
+, and
+\family typewriter
+scrbook.layout
+\family default
+, resp.
+ They contain all the paragraph types of the corresponding standard document
+ classes
+\emph on
+article
+\emph default
+,
+\emph on
+report
+\emph default
+, and
+\emph on
+book
+\emph default
+, resp., partly modified, with the exception of the LyX specific
\family sans
-Foil
+List
\family default
-TeX provides specific commands for starting new foils and these are:
-\end_layout
-
-\begin_layout Itemize
-
-
+-type, which is replaced by the new
\family sans
-Foilhead
-\end_layout
-
-\begin_layout Itemize
-
-
+Labeling
+\family default
+-type having the same functionality.
+ Beside the
\family sans
-Rotatefoilhead
-\end_layout
-
-\begin_layout Standard
-
-LyX also provides slightly modified versions of these two environments called:
+Labeling
+\family default
+-Type there is a number of new paragraph types added.
+ They are
+\emph on
+not
+\emph default
+ part of
+\emph on
+letter (koma-script)
+\emph default
+.
\end_layout
\begin_layout Itemize
-
\family sans
-ShortFoilhead
+Addpart, Addchap
+\family default
+,
+\family sans
+Addsec
+\family default
+: are equivalents to
+\family sans
+Part*, Chapter*
+\family default
+ and
+\family sans
+Section*
+\family default
+, resp., additionally inserting an entry in the table of contents.
+
+\family sans
+Addpart
+\family default
+ and
+\family sans
+Addchap
+\family default
+ are not contained in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
\begin_layout Itemize
-
\family sans
-ShortRotatefoilhead
-\end_layout
-
-\begin_layout Standard
-
-and the differences will be explained in the next section.
-\end_layout
-
-\begin_layout Standard
-
-Since foils are often used in presenting ideas or new theorems and such
+Addchap*
+\family default
+,
+\family sans
+Addsec*
+\family default
+: behave exactly as
+\family sans
+Addchap
+\family default
+ and
+\family sans
+Addsec
+\family default
+, resp., additionally clearing running heads.
\family sans
-Foil
+Addchap*
\family default
-TeX also provides a comprehensive box of goodies for presenting them:
-\end_layout
-
-\begin_layout Standard
-
-
-\begin_inset ERT
-status inlined
+ is not contained in
+\emph on
+article (koma-script)
+\emph default
+.
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+There is also an
+\family typewriter
\backslash
-begin{multicols}{2}
+addpart*
+\family default
+ command in
+\emph on
+book (koma-script)
+\emph default
+ and in
+\emph on
+report (koma-script)
+\emph default
+, but since this is identical to
+\family sans
+Part*
+\family default
+, is has not been implemented in LyX.
\end_layout
\end_inset
\begin_layout Itemize
-
\family sans
-Theorem
+Minisec
+\family default
+: generates a heading directly above the following paragraph in the standard
+ character size without affecting the structure of the document.
\end_layout
\begin_layout Itemize
-
\family sans
-Lemma
+Captionabove
+\family default
+ and
+\family sans
+Captionbelow
+\family default
+ are special captions which respect the different space settings needed
+ for captions placed above or below an element (if you follow strict typographic
+ rules, you might want to place table captions always above the table).
+ You can also use the class option
+\family typewriter
+tablecaptionsabove
+\family default
+, which will switch
+\family sans
+caption
+\family default
+ to
+\family sans
+captionabove
+\family default
+ for tables and
+\family sans
+captionbelow
+\family default
+ for figures.
+ You need at least Koma-Script version 2.8q to use this.
\end_layout
\begin_layout Itemize
-
\family sans
-Corollary
-\end_layout
+Dictum
+\family default
+: can be used to set a bonmot, e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Itemize
+g.
+\begin_inset space \space{}
+\end_inset
+at the beginning of a chapter.
+ If you use the optional argument (
+\family sans
+Insert\SpecialChar \menuseparator
+Short
+\begin_inset space ~
+\end_inset
+Title
+\family default
+), you can insert the dictum's author there.
+ Dictum and author are separated by a line.
+ You need at least Koma-Script version 2.8q to use this.
+
\family sans
-Proposition
+Dictum
+\family default
+ is not contained in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+The following types, together with the standard types
+\family sans
+Title
+\family default
+,
+\family sans
+Author
+\family default
+, and
+\family sans
+Date
+\family default
+, form the title area of the document.
+ They must be entered ahead of the first
+\begin_inset Quotes eld
+\end_inset
+ordinary
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Definition
-\end_layout
+ paragraph.
+\begin_inset Foot
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
+The corresponding LaTeX commands must appear before the
+\family typewriter
+
+\backslash
+maketitle
+\family default
+ command.
+\end_layout
+\end_inset
+ When such a type is used more than once, the latter usage overwrites the
+ former one, that means, for every type only the latest usage is valid.
+ The order of the different types however has, like
\family sans
-Proof
+Title
+\family default
+,
+\family sans
+Author
+\family default
+, and
+\family sans
+Date
+\family default
+, no effect on the appearance of the produced document.
\end_layout
\begin_layout Itemize
-
\family sans
-Theorem*
+Subject
+\family default
+: produces a centered paragraph above the ordinary title (
+\family sans
+Title
+\family default
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+) for the subject of the document.
\end_layout
\begin_layout Itemize
-
\family sans
-Lemma*
+Publishers
+\family default
+: produces a centered paragraph below the ordinary title (
+\family sans
+Title
+\family default
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+) for the publishers' name.
\end_layout
\begin_layout Itemize
-
\family sans
-Corollary*
+Dedication
+\family default
+: in
+\emph on
+report (koma-script)
+\emph default
+ and
+\emph on
+book (koma-script)
+\emph default
+ produces a centered paragraph on its own page behind the title page, or
+ in
+\emph on
+article (koma-script)
+\emph default
+ produces a centered paragraph below the ordinary title (
+\family sans
+Title
+\family default
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+,
+\family sans
+Publishers
+\family default
+) for a dedication.
\end_layout
\begin_layout Itemize
-
\family sans
-Proposition*
+Titlehead
+\family default
+: produces a left aligned paragraph above the ordinary title (
+\family sans
+Title
+\family default
+,
+\family sans
+Author
+\family default
+,
+\family sans
+Date
+\family default
+,
+\family sans
+Subject
+\family default
+) for a document`s head.
\end_layout
\begin_layout Itemize
-
\family sans
-Definition*
+Uppertitleback
+\family default
+: produces in a double-sided print in
+\emph on
+report (koma-script)
+\emph default
+ and
+\emph on
+book (koma-script)
+\emph default
+ a left-aligned paragraph at the top of the title page`s back or has no
+ effect in a single-sided print or in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
-\begin_layout Standard
-
-
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
+\begin_layout Itemize
-\backslash
-end{multicols}
+\family sans
+Lowertitleback
+\family default
+: produces in a double-sided print in
+\emph on
+report (koma-script)
+\emph default
+ and
+\emph on
+book (koma-script)
+\emph default
+ a left-aligned paragraph at the bottom of the title page`s back or has
+ no effect in a single-sided print or in
+\emph on
+article (koma-script)
+\emph default
+.
\end_layout
+\begin_layout Itemize
+
+\family sans
+Extratitle
+\family default
+: produces a special
+\begin_inset Quotes eld
\end_inset
+dirty
+\begin_inset Quotes erd
+\end_inset
+ page ahead of the actual document containing a paragraph without special
+ formatting.
\end_layout
\begin_layout Standard
-
-The starred versions are unnumbered while the unstarred versions are numbered.
- There are also two list environments added by LyX and these are:
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-TickList
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-CrossList
-\end_layout
-
-\begin_layout Standard
-
-
-\family sans
-Foil
-\family default
-TeX provides some powerful header and footer capabilities that are best
- set in the preamble although they may be set at any point in a document.
- If you want to change these settings in your document the best place to
- do so is at the very top of a foil,
+The layout files for the document classes
\emph on
-i.e.
-
+article (koma-script)
+\emph default
+,
+\emph on
+report (koma-script)
+\emph default
+, and
+\emph on
+book (koma-script)
\emph default
- straight after the foilhead.
+ do include the file
+\family typewriter
+scrmacros.inc
+\family default
+.
+ This is thought of as a place to define your own types.
+ Copy scrmacros
+\family typewriter
+.inc
+\family default
+ in your personal layout directory and edit the file!
\end_layout
-\begin_layout Standard
-
-For this purpose, the following command styles are provided [
-\shape smallcaps
-Martin Vermeer
-\shape default
-]:
+\begin_layout Subsection
+letter (koma-script)
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
-begin{multicols}{2}
+begin{sloppypar}
\end_layout
\end_inset
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Standard
+\noindent
+The document class
+\emph on
+letter (koma-script)
+\emph default
+ is implemented in the layout file
+\family typewriter
+scrlettr.layout
+\family default
+.
+ It contains all the paragraph types of the corresponding standard document
+ class
+\emph on
+letter
+\emph default
+, partly modified, with the exception of the LyX specific types
\family sans
-My\InsetSpace ~
-Logo
-\end_layout
-
-\begin_layout Itemize
-
-
+LyX-Code
+\family default
+ and
\family sans
-Restriction
-\end_layout
-
-\begin_layout Itemize
-
-
+Comment
+\family default
+ and the
\family sans
-Right\InsetSpace ~
-Footer
-\end_layout
-
-\begin_layout Itemize
-
-
+List
+\family default
+ type, which is replaced by the new
\family sans
-Right\InsetSpace ~
-Header
-\end_layout
-
-\begin_layout Itemize
-
-
+Labeling
+\family default
+ type.
+ In addition, it contains, in contrast to the standard document class, the
+ standard types
\family sans
-Left\InsetSpace ~
-Header
+LaTeX
+\family default
+,
+\family sans
+Quotation
+\family default
+,
+\family sans
+Quote
+\family default
+, and
+\family sans
+Verse
+\family default
+.
+ Furthermore, there are a number of new letter specific types.
\end_layout
-\begin_deeper
-\begin_layout Standard
-
-\InsetSpace ~
-
-\end_layout
-\end_deeper
\begin_layout Standard
-
-
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
-end{multicols}
+end{sloppypar}
\end_layout
\end_inset
\end_layout
\begin_layout Standard
+The appearance of the letter produced by this document class can be controlled
+ by a number of LaTeX commands, which you can put in the LaTeX preamble.
+\begin_inset Foot
+status collapsed
-There are also a few commands provided by
-\family sans
-Foil
-\family default
-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_layout Plain Layout
+For example, the standard appearance of the letter`s heading, consisting
+ of name and address, is quite self-willed.
+ An
+\begin_inset Quotes eld
+\end_inset
+ordinary
+\begin_inset Quotes erd
\end_inset
-.
+ heading is produced by the following LaTeX commands in the preamble:
\end_layout
-\begin_layout Subsection
+\begin_layout LyX-Code
-Building a Set of Foils
+\backslash
+firsthead{
+\backslash
+parbox[b]{
+\backslash
+textwidth}
\end_layout
-\begin_layout Standard
+\begin_layout LyX-Code
+ {
+\backslash
+ignorespaces
+\backslash
+fromname
+\backslash
-This section will give a simple introduction to using the different environments
- to build a set of foils.
- If you want to see an example set of foils take a look at the
-\family typewriter
-Foils.lyx
-\family default
- file accessible from the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\backslash
+
+\backslash
+ignorespaces
+\backslash
+fromaddress}}
+\end_layout
-\bar under
-O
-\bar default
-pen\SpecialChar \ldots{}
+\begin_layout LyX-Code
-\family default
- dialog under the
-\family sans
-Examples
-\family default
- button.
+\backslash
+nexthead{
+\backslash
+parbox[b]{
+\backslash
+textwidth}
+\end_layout
+
+\begin_layout LyX-Code
+ {
+\backslash
+ignorespaces
+\backslash
+fromname
+\backslash
+hfill
+\backslash
+ignorespaces
+\backslash
+pagename
+\backslash
+\backslash
+thepage}}
\end_layout
-\begin_layout Subsubsection
+\end_inset
-Give It a Title Page
+ A detailed German description of such LaTeX commands can be found in the
+ Koma-Script documentation
+\emph on
+scrguide
+\emph default
+.
+ With it, the letter's author can produce his personal letter layout.
\end_layout
\begin_layout Standard
-
-Unlike other classes that provide
-\family sans
-Title
-\family default
-,
-\family sans
-Author
-\family default
-,
+The types
\family sans
-Date
+Letter
\family default
and
\family sans
-Abstract
-\family default
- environments,
-\family sans
-foils
+Opening
\family default
- creates the title on a page of its own.
- If you leave out the
+ define the beginning of the letter and must be used in every letter.
+ To emphasize them in the LyX document class, they are marked with the letter
+
+\shape italic
+L
+\shape default
+ or
+\shape italic
+O
+\shape default
+, resp.
+\begin_inset space ~
+\end_inset
+
+in the left margin.
+ It is possible to write any number of letters in one file.
+ An
\family sans
-Date
+Opening
\family default
- environment LaTeX will substitute the current date (every time you regenerate
- the output).
-\end_layout
-
-\begin_layout Subsubsection
-
-Start a New Foil
-\end_layout
-
-\begin_layout Standard
-
-As I mentioned earlier, there are four ways of starting a new foil.
- For portrait foils you should use
+ type produces a new letter using the same addressee and a
\family sans
-Foilhead
+Letter
\family default
- or
+ type produces a new addressee.
+ The types
\family sans
-ShortFoilhead.
-
+Closing
\family default
- The difference between these two environments is the amount of space between
- the title of the foil (the foilhead) and the body of the foil.
-\end_layout
-
-\begin_layout Standard
-
-Landscape foils are generated using the
+,
\family sans
-Rotatefoilhead
+PS
\family default
- and
+,
\family sans
-ShortRotatefoilhead
+CC
\family default
- environments.
- Again the only difference is the spacing between foilhead and body.
- Both of the short versions have 0.5 inches less separation between the foilhead
- and the body.
-
+, and
+\family sans
+Encl
+\family default
+ are ordinary paragraph types and can also be used several times in one
+ and the same letter.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-One problem with the support for landscape foils is the requirement that
- you have to use the
-\family typewriter
-dvips
-\family default
- driver to generate the PostScript® output otherwise the foils won't be
- rotated.
- It is possible to get landscape foils even if you haven't got the
-\family typewriter
-dvips
+\family sans
+Letter
\family default
- driver provided you can feed your foils sideways through your printer ;-)
+: produces a paragraph for the addressee and implicitly defines the beginning
+ of the letter.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Itemize
-Theorems, Lemmas, Proofs and more
+\family sans
+Opening
+\family default
+: produces a paragraph for the form of address and implicitly produces a
+ new letter.
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-Due to a small bug in LyX you can't have two of the same type of these environme
-nts directly following each other.
- They must be separated by something.
- If you try, you will just be extending the previous environment as if you
- had merged the two environments together.
- So, how do you get around this problem? The simplest option is to insert
- some text between the two environments or add a
\family sans
-LaTeX
+Closing
\family default
- environment between the two with just a
-\begin_inset Quotes eld
-\end_inset
+: produces a paragraph for a close.
+\end_layout
+\begin_layout Itemize
-\family typewriter
-%
+\family sans
+PS
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- in it.
- This will force LyX to produce two separate environments and hence the
- correct LaTeX output.
- An example is provided in the example file included with the LyX distribution.
- Remember, this problem only occurs if you are trying to place two of the
- same type of theorem-like environments one directly after the other.
+: produces a paragraph for a postscript.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Itemize
-Lists
+\family sans
+CC
+\family default
+: produces a paragraph for a distribution list.
\end_layout
-\begin_layout Standard
-
-You get all the commonly supported list styles found in other classes as
- well as two new ones.
- I'll only describe the new ones here.
- If you want to find out more about the other list environments check out
- the
-\emph on
-User's Guide.
+\begin_layout Itemize
-\emph default
- If you intend to use itemized lists you might also want to read about the
-
\family sans
-Itemize\InsetSpace ~
-Bullet\InsetSpace ~
-Selection
+Encl
\family default
- dialog described above in section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:bullet}
-
-\end_inset
-
-.
+: produces a paragraph for enclosures.
\end_layout
\begin_layout Standard
-
-The two new list styles,
+The types
\family sans
-TickList
+Name
\family default
-and
+,
\family sans
-CrossList
+Signature
\family default
-, are designed to make it easier for you to create lists of do's and don'ts
- or right and wrong by providing dedicated environments that use a tick
- or a cross as the label of the list.
- These lists are in fact dedicated variants of the
+,
\family sans
-Itemize
-\family default
- environment.
- They do however require that you have the
-\family typewriter
-psnfss
+Address
\family default
- packages installed.
-\end_layout
-
-\begin_layout Subsubsection
-
-Figures and Tables
-\end_layout
-
-\begin_layout Standard
-
-
+,
\family sans
-Foil
+Telephone
\family default
-TeX redefines the floating tables and figures so that they appear exactly
- where they are in the text rather than pushing them to the top of the page
- or to some user specified location.
- In fact if you change the float placement settings they are simply ignored.
-\end_layout
-
-\begin_layout Subsubsection
-
-Page Headers and Footers
-\begin_inset LatexCommand \label{sec:foilfoot}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-
-
+,
\family sans
-My\InsetSpace ~
-Logo
+Place
\family default
- and
+,
\family sans
-Restriction
+Backaddress
\family default
- are two commands used to control the left-footer text string.
- The first is meant to allow you to include a graphic logo on your foils
- and defaults to
-\begin_inset Quotes eld
-\end_inset
-
--Typeset by
+,
\family sans
-Foil
+Specialmail
\family default
-TeX-
-\begin_inset Quotes erd
-\end_inset
-
-.
- While the second is meant to provide a classification for the audience,
-
-\emph on
-e.g.
-
-\emph default
- Confidential.
- It is empty by default.
-\end_layout
-
-\begin_layout Standard
-
-The remaining page corners can be filled by
+,
\family sans
- Right\InsetSpace ~
-Footer
+Location
\family default
- (which defaults to page numbers),
+,
\family sans
-Right\InsetSpace ~
-Header
+Title
\family default
- (top right) and
+, and
\family sans
-Left\InsetSpace ~
-Header
+Subject
\family default
- (top left).
-\end_layout
-
-\begin_layout Subsection
+ are input types provided with a label to enter information, which will
+ be processed by the document class.
+\begin_inset Foot
+status open
-Unsupported
+\begin_layout Plain Layout
+It could be seen as a matter of inconsequence, that the types
\family sans
-Foil
+Letter
\family default
-TeX Goodies
-\begin_inset LatexCommand \label{sec:unsuppfoils}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Standard
-
-All the commands mentioned below need to be set in a
+ and
\family sans
-LaTeX
+Opening
\family default
- environment or as
+ described above are not such input types as well.
+ Because of the special meaning of those types, however, I have implemented
+ them as ordinary paragraph types with a one letter mark in the left margin.
+ Moreover, it would affect my feeling of symmetry, if the
\family sans
-TeX
+Opening
\family default
- within another environment.
+ type and the
+\family sans
+Closing
+\family default
+ type had such a serious different appearance.
\end_layout
-\begin_layout Subsubsection
+\end_inset
-Lengths
+ The types must be used ahead of the corresponding
+\family sans
+Opening
+\family default
+ type.
\end_layout
\begin_layout Standard
-
-All lengths are adjusted using the
-\family typewriter
-
-\backslash
-setlength{
-\family default
-\emph on
-lengthname
-\family typewriter
-\emph default
-}{
-\family default
-\emph on
-newlength
-\family typewriter
-\emph default
-}
-\family default
- command.
- Where
-\emph on
-lengthname
-\emph default
- should be replaced by the name given to the length you want to change and
-
-\emph on
-newlength
-\emph default
- is the length value.
- All lengths should be specified in units of length such as inches (
-\family typewriter
-in
-\family default
-), millimeters (
-\family typewriter
-mm
+An implementation of these types in a WYSIWYG fashion does not seem to make
+ sense, because the real appearance of the produced letter does not only
+ depend on the usage of the particular type, but also on other factors.
+ For example, a signature entered in the
+\family sans
+Signature
\family default
-) or points (
-\family typewriter
-pt
+ type will in the standard behavior appear in the produced letter only,
+ when in the same letter also a
+\family sans
+Closing
\family default
-) or relative to some document or font-based length such as
-\family typewriter
-
-\backslash
-textwidth
+ type is used.
+ The entered value of the
+\family sans
+Telephone
\family default
-.
-
+ type will in the standard behavior not appear in the produced letter at
+ all.
+ The possibility to design the letter`s heading freely is already indicated
+ in a footnote above.
\end_layout
\begin_layout Standard
+The input types can also be used as empty paragraphs.
+ This makes sense e.
+\begin_inset space \thinspace{}
+\end_inset
-It's possible to change the spacing between a foilhead and the body of the
- foil by adjusting the length specified by
-\family typewriter
+g.
+\begin_inset space \space{}
+\end_inset
-\backslash
-foilheadskip
+for the
+\family sans
+Signature
\family default
-.
- For example, to make
-\emph on
-all
-\emph default
- foilheads 0.5 inches closer to their bodies put the following in the preamble:
-
-\family typewriter
-
-\backslash
-setlength{
-\backslash
-foilheadskip}{-0.5in}
+ type.
+ If the
+\family sans
+Signature
+\family default
+ type is not used at all, in the standard behavior the value of the
+\family sans
+Name
+\family default
+ type is used as signature, whereas if an empty
+\family sans
+Signature
+\family default
+ type is used, no signature value is defined.
\end_layout
\begin_layout Standard
-
-The spacings around floats can be adjusted by setting these lengths:
+By using the input types it is possible to write a letter template, containing
+ filled input types with your personal dates (name, address, etc.) and empty
+ input types for other dates you want to enter.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-abovefloatskip
+\family sans
+Name
\family default
-Separation between the text and the top of the float
+: sender's name, in the standard behavior appears as a centered paragraph
+ in small caps in the letter`s heading.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-abovecaptionskip
+\family sans
+Signature
+\family default
+: sender's signature, in the standard behavior appears below the
+\family sans
+Closing
+\family default
+ type.
+ If no
+\family sans
+Signature
+\family default
+ type is used, the value of the
+\family sans
+Name
\family default
-Separation between the float and the caption
+ type appears instead.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-belowcaptionskip
+\family sans
+Address
\family default
-Separation between the caption and the following text
+: sender's address, in the standard behavior appears in a centered paragraph
+ in the letter`s heading below the sender's name.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-captionwidth
+\family sans
+Telephone
\family default
- You can make the captions narrower than the surrounding text by adjusting
- this length.
- Best done relative to
+: sender's telephone number, in the standard behavior only sets the LaTeX
+ variable
\family typewriter
\backslash
-textwidth
+telephonenum
\family default
.
\end_layout
-\begin_layout Standard
-
-There are also several title page related lengths that you may find useful
- if you have a long title or several authors:
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-abovetitleskip
-\family default
- Separation from headers to
\family sans
-Title
+Place
+\family default
+: place of the letter`s making.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-titleauthorskip
+\family sans
+Date
\family default
- between
+: date of the letter`s making.
+
\family sans
-Title
+Place
\family default
and
\family sans
-Author
+Date
\family default
- environments
-\end_layout
-
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
-
-\backslash
-authorauthorskip
+, in the standard behavior, produce the place and the date in a right-aligned
+ line below the addressee's field.
+ If an empty
+\family sans
+Date
\family default
- between multiple
+ type is used, neither place nor date appear, independent of the value of
+ the
\family sans
-Author
+Place
\family default
- lines
+ type.
+ If no
+\family sans
+Date
+\family default
+ type is used, the date of the letter `s production is used.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
+\begin_layout Itemize
-\family typewriter
-
-\backslash
-authordateskip
-\family default
- between the
\family sans
-Author
+Backaddress
\family default
- and the
-\family sans
-Date
+: sender`s back address, in the standard behavior appears above the addressee's
+ field in a small sans serif font.
\end_layout
-\begin_layout List
-\labelwidthstring MMMMMMMMMMM
-
-
-\family typewriter
+\begin_layout Itemize
-\backslash
-dateabstractskip
-\family default
- between the
\family sans
-Date
+Specialmail
\family default
- and the
-\family sans
-Abstract
+: special mail information, in the standard behavior appears underlined
+ above the addressee's field below the back address.
\end_layout
-\begin_layout Standard
-
-The last length related command affects all the list environments.
- If you place
-\family typewriter
-
-\backslash
-zerolistvertdimens
-\family default
-
-\emph on
-inside
-\emph default
- a list environment then all the vertical spacing between the list items
- is removed.
- Note that this is a command not a length so it doesn't require
-\family typewriter
+\begin_layout Itemize
-\backslash
-setlength
+\family sans
+Location
\family default
- like the stuff mentioned above.
-\end_layout
-
-\begin_layout Subsubsection
-
-Headers and Footers
+: additional information, in the standard behavior appears on right side
+ below the addressee`s field.
\end_layout
-\begin_layout Standard
-
-The
-\family typewriter
-
-\backslash
-LogoOn
-\family default
- and
-\family typewriter
+\begin_layout Itemize
-\backslash
-LogoOff
-\family default
- commands control whether the logo in the
\family sans
-MyLogo
+Title
\family default
- definition appear on a given page.
- If you put
-\family typewriter
+: the letter's title, in the standard behavior appears in a big, bold, sans
+ serif font above the subject.
+\end_layout
-\backslash
-LogoOff
-\family default
- in the preamble then none of the foils will have the logo on them.
- If you don't want the logo on a particular page place the
-\family typewriter
+\begin_layout Itemize
-\backslash
-LogoOff
+\family sans
+Subject
\family default
- directly after the foilhead of that page and the
-\family typewriter
-
-\backslash
-LogoOn
+: the letter's subject, in the standard behavior appears in a bold font
+ above the
+\family sans
+Opening
\family default
- directly after the next foilhead.
+ paragraph.
\end_layout
\begin_layout Standard
-
-If you decide to use the
+The types
\family sans
-fancy
+Yourref
\family default
- page style setting in the
+,
\family sans
-Document\InsetSpace ~
-Layout
+Yourmail
\family default
- dialog you should probably add
-\family typewriter
-
-\backslash
-let
-\backslash
-headwidth
-\backslash
-textwidth
+,
+\family sans
+Myref
\family default
- to your preamble so headers and footers on landscape pages are correctly
- placed when rotated.
- This is due to some clashes between the page layouts provided by the
+,
\family sans
-fancyheadings
+Customer
\family default
- package and the
+, and
\family sans
-foils
+Invoice
\family default
- class.
-\end_layout
+ produce a business letter like line above the
+\family sans
+Title
+\family default
+ line containing the fields
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Section
+Your ref.
+\begin_inset Quotes erd
+\end_inset
-Latex8 (IEEE Conference Papers)
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Your letter of
+\begin_inset Quotes erd
+\end_inset
-by
-\noun on
-Allan Rae
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
+Our ref.
+\begin_inset Quotes erd
+\end_inset
-Introduction
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Customer no.
+\begin_inset Quotes erd
+\end_inset
-Since this class is specifically for writing submissions to IEEE sponsored
- conferences I strongly recommend that you get a copy of their Authors Kit.
- The
-\family sans
-latex.sty
-\family default
- package and associated bibliography style file is included in the kit.
- The Authors Kit is usually sent out by email once your initial submission
- has been accepted.
- There is a lot of useful information in the Authors Kit explaining formatting
- restrictions and so on and I will assume you have read this since that
- means I don't have to repeat it all here.
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
+Invoice no.
+\begin_inset Quotes erd
+\end_inset
-Getting Started
-\end_layout
+, and
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Date
+\begin_inset Quotes erd
+\end_inset
-[AR\SpecialChar \@.
- more to come]
-\end_layout
+.
+ For the date field, the value of the
+\family sans
+Date
+\family default
+ type is used.
+ If one of these
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
+business letter types
+\begin_inset Quotes erd
+\end_inset
-Supported Environments
+ is used, the value of the
+\family sans
+Place
+\family default
+ type however does not appear, but only the LaTeX variable
+\family typewriter
+
+\backslash
+fromplace
+\family default
+ is set.
+ The ordinary output of place and date in a right-aligned line below the
+ addressee`s field is suppressed.
+ The types are implemented as input types provided with a label and must
+ be used ahead of the corresponding
+\family sans
+Opening
+\family default
+ type.
\end_layout
\begin_layout Itemize
-
\family sans
-Standard
+Yourref
+\family default
+: Your ref.
\end_layout
\begin_layout Itemize
-
\family sans
-Title
+Yourmail
+\family default
+: Your letter of.
\end_layout
\begin_layout Itemize
-
\family sans
-Author
+Myref
+\family default
+: Our ref.
\end_layout
\begin_layout Itemize
-
\family sans
-E-mail
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-Affiliation
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-Abstract
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-Section
-\end_layout
-
-\begin_layout Itemize
-
-
-\family sans
-SubSection
+Customer
+\family default
+: Customer no.
\end_layout
\begin_layout Itemize
-
\family sans
-Caption
+Invoice
+\family default
+: Invoice no.
\end_layout
\begin_layout Subsection
-
-Differences Between Screen and Paper
-\end_layout
-
-\begin_layout Standard
-
-There are slight differences in appearance mainly with the presentation
- of section counters.
- On screen the trailing period of the section counter is missing but it
- will appear in the output so don't let this worry you.
-\end_layout
-
-\begin_layout Section
-
-Hollywood (Hollywood spec scripts)
+The new letter class: letter (koma-script v.2)
\end_layout
\begin_layout Standard
-
by
-\shape smallcaps
-Garst Reese
-\end_layout
-
-\begin_layout Subsection
-
-Introduction
+\noun on
+Jürgen Spitzmüller
\end_layout
\begin_layout Standard
-
-Getting the format of a Hollywood script right is a
-\begin_inset Quotes eld
+\begin_inset VSpace medskip
\end_inset
-rite of passage.
-\begin_inset Quotes erd
-\end_inset
- It is designed to make the readers focus on content and to be easy and
- familiar for the actors to read.
- Each page of a script should be one minute of film.
- Nothing goes in a script that you cannot see or hear on screen.
- The courier 12 pt font should be used throughout.
- No italics.
\end_layout
-\begin_layout Subsection
-
-Special problems
+\begin_layout Standard
+\noindent
+Koma-Script version 2.8 has introduced a new letter class
+\family typewriter
+scrlttr2
+\family default
+ which supersedes the now unsupported
+\family typewriter
+scrlettr
+\family default
+.
+ It has — on the LaTeX side — a completely new interface and is not compatible
+ with the old class.
+ Therefore, LyX supports both, though it is recommended to use the new class.
\end_layout
\begin_layout Standard
-
-Speakers' lines should NEVER break in mid-sentence.
- If a speaker's lines continue over a page break, repeat the
+This class covers the same functionality as
+\emph on
+letter (koma-script),
+\emph default
+ and a few more.
+ The basic items are
\family sans
-Speaker
+Address
\family default
- title followed by (Cont'd).
-\end_layout
+ (receiver's address, same as
+\family sans
+Letter
+\family default
+ in the old layout),
+\family sans
+Opening
+\family default
+, and
+\family sans
+Closing
+\family default
+.
+
+\family sans
+NextAddress
+\family default
+ will start a new letter (i.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Subsection
+g.
+\begin_inset space \space{}
+\end_inset
-Special features
+you can write several letters per document).
+ New elements are sender's
+\family sans
+E-Mail
+\family default
+,
+\family sans
+URL
+\family default
+,
+\family sans
+Fax
+\family default
+,
+\family sans
+Bank
+\family default
+ and the possibility to use a
+\family sans
+Logo
+\family default
+ (via
+\family sans
+Insert\SpecialChar \menuseparator
+Graphics
+\family default
+) in the header.
\end_layout
\begin_layout Standard
-
-Insert the
-\family sans
-Speaker
+The biggest improvement is, though, that the letter's layout is configurable
+ at almost any needs.
+ This can be done via the preamble or with a special style file (Letter
+ Class Option, extension
+\family typewriter
+*.lco
\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
- You can use this to insert the speaker name in narratives also.
-\end_layout
+), that will be read in as a class option.
+\begin_inset Foot
+status collapsed
-\begin_layout Subsection
+\begin_layout Plain Layout
+The KOMA package comes with some default
+\family typewriter
+*.lco
+\family default
+ files.
+ There is, for instance, a
+\family typewriter
+DIN.lco
+\family default
+ file that follows german typesetting rules, or a
+\family typewriter
+KOMAold.lco
+\family default
+ that provides the default layout of the old
+\family typewriter
+scrlettr
+\family default
+ class.
+ The latter can be loaded with the class option
+\family typewriter
+KOMAold
+\family default
+, inserted via the
+\family sans
+\bar under
+L
+\bar default
+ayout\SpecialChar \menuseparator
-Paper size and Margins
+\bar under
+D
+\bar default
+ocument\SpecialChar \menuseparator
+Extra Options
+\family default
+ field.
\end_layout
-\begin_layout Standard
+\end_inset
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
+ Have a look at the
+\emph on
+koma-letter2
+\emph default
+ template that is included in LyX for examples.
+ A detailed description is to be found in the Koma-Script documentation
+ (
+\emph on
+scrguide
+\emph default
+).
\end_layout
\begin_layout Subsection
-
-Environments
+Problems
\end_layout
\begin_layout Standard
-
-The following environments are available.
- You can use hollywood.bind to get the bind keys shown at the right.
+Visualizing the Koma-Script document classes in LyX, the LyX internals cause
+ some problems.
\end_layout
\begin_layout Itemize
-
-
+The chapter number of a
\family sans
-Standard
-\newline
-
+Chapter
\family default
-Used where nothing else works.
- Try to avoid it.
+ type appears on a line of its own above the chapter heading instead of
+ appearing in the same line ahead of it.
+ The cause for that is the LyX internal behavior for the labeltype
+\family sans
+Counter_Chapter
+\family default
+ in the layout file.
\end_layout
\begin_layout Itemize
-
-
+The headings of the types
\family sans
-FADE_IN
+Addchap
\family default
-:
-\hfill
-
+ and
\family sans
-M-z S-I
+Addsec
\family default
-
-\newline
-Usually followed by something like
+ are only put in the
\begin_inset Quotes eld
\end_inset
-on Sally waking up.
+true
\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Itemize
-
-
+ LaTeX table of contents, but not in the LyX table of contents (
\family sans
-INT:
-\hfill
-M-z i
-\newline
+Document\SpecialChar \menuseparator
+Table
+\begin_inset space ~
+\end_inset
+
+of
+\begin_inset space ~
+\end_inset
+Contents
\family default
-Introduces a new INTERIOR camera set-up.
- Always followed by DAY or NIGHT, or something similar to define the lighting
- required.
- Everthing on this line in CAPS.
+).
\end_layout
\begin_layout Itemize
-
-
+The paragraphs in a
+\emph on
+letter
+\emph default
+ document class appear in a skip separation mode, not indented.
+ This is the standard behavior, no special LaTeX commands are needed for
+ that.
+ But in the
\family sans
-EXT:
-\hfill
-M-z e
-\newline
-
+Document\SpecialChar \menuseparator
+Settings
\family default
-Introduces a new EXTERIOR camera set-up.
- Everthing on this line in CAPS.
-\end_layout
-
-\begin_layout Itemize
-
-
+ dialog the corresponding radio button indicates
\family sans
-Speaker
-\hfill
-M-z s
-\newline
-
+Indent
\family default
-The character speaking.
-\end_layout
-
-\begin_layout Itemize
-
-
+.
+ A
\family sans
-Parenthetical
-\hfill
-M-z p
-\newline
-
+Skip
\family default
-Instructions to the speaker.
- The () are automatically inserted, but only the ( will show in LyX.
- Both will be printed.
+ value always has the effect that extra LaTeX commands are inserted in the
+ document to produce the gap, which is not what is wanted in this case.
\end_layout
-\begin_layout Itemize
-
-
-\family sans
-Dialogue
-\hfill
-M-z d
-\newline
-
-\family default
-What the
-\family sans
-Speaker
-\family default
- says.
+\begin_layout Section
+Latex8 (IEEE Conference Papers)
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+by
+\noun on
+Allan Rae
+\end_layout
+\begin_layout Subsection
+Introduction
+\end_layout
+\begin_layout Standard
+Since this class is specifically for writing submissions to IEEE sponsored
+ conferences I strongly recommend that you get a copy of their Authors Kit.
+ The
\family sans
-Transition
-\hfill
-M-z t
-\newline
-
+latex.sty
\family default
-Camera movement instruction.
- e.g.
- CUT TO:
+ package and associated bibliography style file is included in the kit.
+ The Authors Kit is usually sent out by email once your initial submission
+ has been accepted.
+ There is a lot of useful information in the Authors Kit explaining formatting
+ restrictions and so on and I will assume you have read this since that
+ means I don't have to repeat it all here.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Getting Started
+\end_layout
+\begin_layout Standard
+[AR\SpecialChar \@.
+ more to come]
+\end_layout
-\family sans
-FADE OUT:
-\hfill
-M-z S-I
+\begin_layout Subsection
+Supported Environments
\end_layout
\begin_layout Itemize
-
\family sans
-Author
-\hfill
-M-z S-A
+Standard
\end_layout
\begin_layout Itemize
-
\family sans
Title
-\hfill
-M-z S-T
\end_layout
\begin_layout Itemize
-
\family sans
-Right_Address
-\hfill
-M-z r
+Author
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-Script jargon
+\family sans
+E-mail
\end_layout
\begin_layout Itemize
-(O.S) --- off screen
+\family sans
+Affiliation
\end_layout
\begin_layout Itemize
-(V.0) --- voice over
+\family sans
+Abstract
\end_layout
\begin_layout Itemize
-b.g.
- --- background
+\family sans
+Section
\end_layout
\begin_layout Itemize
-C.U.
- --- close-up
+\family sans
+SubSection
\end_layout
\begin_layout Itemize
-PAN --- camera movement
+\family sans
+Caption
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Differences Between Screen and Paper
+\end_layout
-INSERT --- cut to close-up of
+\begin_layout Standard
+There are slight differences in appearance mainly with the presentation
+ of section counters.
+ On screen the trailing period of the section counter is missing but it
+ will appear in the output so don't let this worry you.
\end_layout
\begin_layout Section
-
-Broadway
+Memoir
\end_layout
\begin_layout Standard
-
-by
-\shape smallcaps
-Garst Reese
+By
+\noun on
+Jürgen Spitzmüller
\end_layout
\begin_layout Subsection
+Overview
+\end_layout
-Introduction
+\begin_layout Standard
+Memoir is a very powerful and constantly evolving class.
+ It has been designed with regard to fictional and non-fictional literature.
+ Its aim is to let the user have maximum control over the typesetting of
+ his document.
+ Memoir is based on the standard book class, but it can also emulate the
+ article class (see below).
\end_layout
\begin_layout Standard
+Peter Wilson, the developer of Memoir, is known as the author of lots of
+ useful packages in the LaTeX world.
+ Most of them have been merged with Memoir.
+ Therefore, it is much easier to layout the table of contents, appendices,
+ chapter designs and such.
+ LyX, though, does not support all of these goodies natively.
+ Some of them might be added to forthcoming releases
+\begin_inset Foot
+status collapsed
-Broadway is for writing plays.
- The format is more decorative than Hollywood, and much less standardized.
- This format should be suitable for workshops.
-\end_layout
+\begin_layout Plain Layout
+You are invited to send suggestions to
+\begin_inset Flex URL
+status collapsed
-\begin_layout Subsection
+\begin_layout Plain Layout
-Special problems
+lyx-devel@lists.lyx.org
\end_layout
-\begin_layout Standard
+\end_inset
-The same as in Hollywood.
+.
\end_layout
-\begin_layout Subsection
+\end_inset
-Special features
-\end_layout
+, lots will probably never, due to the limitations of LyX's framework.
+ Of course you can still use all features with the help of some native LaTeX
+ commands (TeX code
+\begin_inset Foot
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+Cf.
+\begin_inset ERT
+status collapsed
-Insert the
-\family sans
-Speaker
-\family default
- names as labels then cross-reference the label to insert the name.
- The cross-reference dialog will show the current cast of characters.
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Subsection
-Paper size and Margins
+\backslash
+
\end_layout
-\begin_layout Standard
+\end_inset
-USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
-\end_layout
+section
+\begin_inset space ~
+\end_inset
-\begin_layout Subsection
-Environments
-\end_layout
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:Inserting-TeX-Code"
-\begin_layout Standard
+\end_inset
-The following environments are available.
- You can use broadway.bind to get the bind keys shown at the right.
+ for details.
\end_layout
-\begin_layout Itemize
+\end_inset
+).
+ In this section, we can only list those features which are natively supported
+ by LyX.
+ For detailed descriptions (and for the rest of features) we are recommending
+ to have a look at the detailed manual of the Memoir class
+\begin_inset Foot
+status collapsed
-\family sans
-Standard
-\newline
+\begin_layout Plain Layout
+Cf.
+\begin_inset ERT
+status collapsed
-\family default
-You should not have to use this, but it is here for anything that does not
- fit otherwise.
+\begin_layout Plain Layout
+
+
+\backslash
+
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Narrative
-\hfill
-M-z n
-\newline
+\begin_inset Flex URL
+status collapsed
-\family default
-Used to describe stage setting and the action.
- First use of speaker names in all CAPs.
+\begin_layout Plain Layout
+
+CTAN:/macros/latex/memoir/memman.pdf
\end_layout
-\begin_layout Itemize
+\end_inset
+.
+\end_layout
-\family sans
-ACT
-\hfill
-M-z a
-\newline
+\end_inset
-\family default
-Automatically numbered.
- On screen it will be arabic, but will print as Roman.
+, which is not only a user guide for the class, but also both a comprehensive
+ description on good typesetting and a superb example for good typesetting
+ itself.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Basic features and restrictions
+\end_layout
+
+\begin_layout Standard
+Memoir supports basically all features of the standard book classes.
+ There are, however, some differences, as follows:
+\end_layout
+
+\begin_layout Description
+Font
+\begin_inset space ~
+\end_inset
+
+sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
+\end_layout
+\begin_layout Description
+Page
+\begin_inset space ~
+\end_inset
+style: The fancy page style is not supported, due to a command clash between
+ Memoir and the fancyhdr package (they are both defining a command with
+ the same name, which confuses LaTeX).
+ Instead, Memoir comes with a bunch of own page styles (see
\family sans
-ACT*
-\hfill
-M-z S at
-\newline
+Layout\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator
+Page
+\begin_inset space ~
+\end_inset
+Style
\family default
-Subtitle for
-\family sans
-ACT.
+).
+ If you want to use these for the chapter pages, you have to use the command
+\family typewriter
+
+\backslash
+chapterstyle
\family default
-It is just centered text.
-\end_layout
+ in the main text or in preamble (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_layout Itemize
+g.
+\begin_inset space \space{}
+\end_inset
-\family sans
-SCENE
-\hfill
-M-z S-S
-\newline
+\family typewriter
+\backslash
+chapterstyle{companion}
\family default
-Not automatically numbered.
- You supply the number.
- This is because I couldn't figure out how.
+).
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Description
+Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
+ an optional argument in the standard classes.
+ With this, you can specify an alternative version of the title for the
+ table of contents and the headers (for instance, if the title is too long).
+ In LyX, you can do this via
\family sans
-AT_RISE:
-\hfill
-M-z S-R
-\newline
+Insert\SpecialChar \menuseparator
+Short
+\begin_inset space ~
+\end_inset
+Title
\family default
-A special case of Narrative to describe the setting and action as the curtain
- rises.
+ at the beginning of a chapter/section.
+ Memoir features a second optional argument and thus separates the table
+ of contents from the header.
+ You can define three variants of a title with this: one for the main text,
+ one for the table of contents, and one for the headers.
+ Simply insert two optional arguments if you need this feature, the first
+ one containing the short title for the Table of Contents, the second one
+ containing an alternative short title for the headers.
\end_layout
-\begin_layout Itemize
-
+\begin_layout Description
+TOC/LOT/LOF: In the standard classes (and in many other classes), the table
+ of contents, the list of figures and the list of table start a new page
+ automatically.
+ Memoir does not follow this route.
+ You have to insert a page break yourself, if you want to have one.
+\end_layout
-\family sans
-Speaker
-\hfill
-M-z s
-\newline
+\begin_layout Description
+Titlepage: For some unknown reason, Memoir uses pagination on the title
+ page (in the standard classes, title pages are
+\begin_inset Quotes eld
+\end_inset
-\family default
-The speaker's (actor's) title, centered in all CAPS.
-\end_layout
+empty
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Itemize
+, i.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\family sans
-Parenthetical
-\hfill
-M-z p
-\newline
+without pagina).
+ If you want an empty title page, type
+\family typewriter
+\backslash
+aliaspagestyle{title}{empty}
\family default
-Instructions to the speaker.
- The parentheses are automatically inserted.
- The ( will appear on screen, but both will be in the printed play.
- This environment is only used within
-\family sans
-Dialogue
-\family default
-.
+ in the preamble.
\end_layout
-\begin_layout Itemize
-
-
+\begin_layout Description
+Article: With the class option
+\emph on
+article
+\emph default
+ (to be inserted in
\family sans
-Dialogue
-\hfill
-M-z d
-\newline
+Layout\SpecialChar \menuseparator
+Document\SpecialChar \menuseparator
+Extra
+\begin_inset space ~
+\end_inset
+Options
\family default
-What the Speaker says.
+), you can emulate article style.
+ That is, counters (footnotes, figures, tables etc.) will not be reset on
+ new chapters, chapters don't start a new page (but are—in contrary to
+\begin_inset Quotes eld
+\end_inset
+
+real
+\begin_inset Quotes erd
+\end_inset
+
+ article classes—still allowed), parts, though, use their own page, as in
+ book.
\end_layout
-\begin_layout Itemize
+\begin_layout Description
+Oldfontcommands: By default, Memoir does not allow the use of the deprecated
+ font commands, which have been used in the old LaTeX version 2.09 (e.
+\begin_inset space \thinspace{}
+\end_inset
+g.
+\begin_inset space \space{}
+\end_inset
-\family sans
-CURTAIN
-\hfill
-M-z S-C
-\newline
+\family typewriter
+
+\backslash
+rm
\family default
-The curtain comes down.
+,
+\family typewriter
+
+\backslash
+it
+\family default
+).
+ It produces an error and stops LaTeX whenever such a command appears.
+ The class option
+\emph on
+oldfontcommands
+\emph default
+ reallows the commands and spits out warnings instead (which does at least
+ not stop LaTeX).
+ Since a lot of packages and particularly BibTeX style files are still using
+ those commands, we have decided to use this option by default.
\end_layout
-\begin_layout Itemize
+\begin_layout Subsection
+Extra features
+\end_layout
+\begin_layout Standard
+We will only describe the features supported by LyX (which is not much currently
+).
+ Please consult the Memoir manual
+\begin_inset Foot
+status collapsed
-\family sans
-Title
-\hfill
-M-z S-T
-\end_layout
+\begin_layout Plain Layout
+Cf.
+\begin_inset ERT
+status collapsed
-\begin_layout Itemize
+\begin_layout Plain Layout
-\family sans
-Author
-\hfill
-M-z S-A
+\backslash
+
\end_layout
-\begin_layout Itemize
+\end_inset
-\family sans
-Right_Address
-\hfill
-M-z r
-\end_layout
+\begin_inset Flex URL
+status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
-Hello there.
+CTAN:/macros/latex/memoir/memman.pdf
\end_layout
-\begin_layout Section
+\end_inset
-RevTeX4
+.
\end_layout
-\begin_layout Standard
+\end_inset
-by
-\noun on
-Amir Karger
+ for details.
\end_layout
+\begin_layout Description
+Abstract: You may wonder why an abstract is an extra feature.
+ Well, it is in book class.
+ Usually books don't have abstracts.
+ Memoir, however, has.
+ You can use it wherever and how often you like.
+\end_layout
-\begin_layout Standard
-
+\begin_layout Description
+Chapterprecis: You may know this from belletristic: The contents of a chapter
+ is shortly described below the title and also in the table of contents
+ (e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset VSpace bigskip
+g.
+\begin_inset space \space{}
\end_inset
+\emph on
+Our hero arrives in Troia; he loses some friends; he finds others
+\emph default
+).
+ Chapterprecis does exactly this.
+ It is therefore only sensible below a chapter.
\end_layout
-\begin_layout Standard
-\noindent
-The
-\family sans
-Revtex\InsetSpace ~
-4
-\family default
+\begin_layout Description
+Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
+ The epigraph environment provides an elegant way of typesetting such a
+ motto.
+ The motto itself (text) and its author (source) are divided by a short
+ line.
+ Unfortunately, we have to fool LyX a bit here again, since the environment
+ needs two arguments (text and source).
+ In this case, we have to use curly brackets (in TeX mode) between the two
+ arguments:
+\emph on
+<smart slogan>
+\emph default
+
+\family typewriter
+}{
+\family default
+
+\emph on
+<author of the slogan>.
+\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.
+ 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.
+ Memoir has some enhanced versions of verse, but you need to use TeX code,
+ because they have to be nested inside regular verse environments, which
+ is not possible with LyX).
+\end_layout
+
+\begin_layout Description
+Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
+\end_layout
+
+\begin_layout Section
+Article (mwart), book (mwbk) and report (mwrep)
+\begin_inset OptArg
+status collapsed
+
+\begin_layout Plain Layout
+The
+\family typewriter
+mw
+\family default
+ Classes
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Tomasz Luczak
+\end_layout
+
+\begin_layout Standard
+The LyX document classes
+\emph on
+article (mwart)
+\emph default
+,
+\emph on
+report (mwrep)
+\emph default
+ and
+\emph on
+book
+\emph default
+
+\emph on
+(mwbk)
+\emph default
+ correspond to the LaTeX document classes
+\family typewriter
+mwart.cls
+\family default
+,
+\family typewriter
+mwrep.cls
+\family default
+ and
+\family typewriter
+mwbk.cls
+\family default
+, resp.
+ They are replacements for the standard document classes
+\family typewriter
+article.cls
+\family default
+,
+\family typewriter
+report.cls
+\family default
+ and
+\family typewriter
+book.cls
+\family default
+, resp., and fit better to Polish typography conventions in a number of points.
+
+\end_layout
+
+\begin_layout Standard
+Basic differences:
+\end_layout
+
+\begin_layout Itemize
+Unnumbered titles (with star, e.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+
+\family sans
+Section*
+\family default
+) are added into table of contents,
+\end_layout
+
+\begin_layout Itemize
+Additional page styles:
+\end_layout
+
+\begin_deeper
+\begin_layout Description
+uheadings header with separated lines,
+\end_layout
+
+\begin_layout Description
+myheadings custom header, contents headers via commands:
+\family typewriter
+
+\backslash
+markright
+\family default
+ and
+\family typewriter
+
+\backslash
+markboth
+\family default
+,
+\end_layout
+
+\begin_layout Description
+myuheadings custom header with separated lines,
+\end_layout
+
+\begin_layout Description
+outer page number is placed on outer side of page
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+Options
+\end_layout
+
+\begin_deeper
+\begin_layout Description
+rmheadings serif titles — default,
+\end_layout
+
+\begin_layout Description
+sfheadings sansserif titles,
+\end_layout
+
+\begin_layout Description
+authortitle on title page first placed is author next title — default,
+\end_layout
+
+\begin_layout Description
+titleauthor on title page first placed is title next author,
+\end_layout
+
+\begin_layout Description
+withmarginpar reserve place on page for margins.
+\end_layout
+
+\end_deeper
+\begin_layout Section
+Paper
+\end_layout
+
+\begin_layout Standard
+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
+
+\begin_layout Section
+RevTeX4
+\end_layout
+
+\begin_layout Standard
+by
+\noun on
+Amir Karger
+\end_layout
+
+\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\noindent
+The
+\family sans
+Revtex
+\begin_inset space ~
+\end_inset
+
+4
+\family default
textclass works with the American Physical Sociey's RevTeX 4.0 (the
\begin_inset Formula $\beta$
\end_inset
\end_layout
\begin_layout Standard
-
LyX has a
\family sans
Revtex
Since RevTeX 4.0 has been designed to work much more cleanly with LaTeX2e,
LyX with the
\family sans
-RevTeX\InsetSpace ~
+RevTeX
+\begin_inset space ~
+\end_inset
+
4
\family default
textclass should also be pretty easy to use.
\end_layout
\begin_layout Standard
-
These documents are supposed to be used in
\emph on
addition
\end_layout
\begin_layout Subsection
-
Installation
\end_layout
\begin_layout Standard
-
All you need to do is install RevTeX 4, as described in the package's README
file.
- the package can be found at
-\begin_inset LatexCommand \url[The RevTeX 4 Web Site]{http://publish.aps.org/revtex4/}
+ The package can be found at The RevTeX 4 Web Site
+\begin_inset Flex URL
+status collapsed
+
+\begin_layout Plain Layout
+
+http://publish.aps.org/revtex4/
+\end_layout
\end_inset
.
Install it somewhere that LaTeX can see it.
Test it by trying to LaTeX a short RevTeX 4 document in some random directory
- (i.e., not the directory where you installed the class file.) Then, if you
- reconfigure LyX, it will find the class file and let you use the RevTeX4
- textclass.
+ (i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+not the directory where you installed the class file.) Then, if you reconfigure
+ LyX, it will find the class file and let you use the RevTeX4 textclass.
\end_layout
\begin_layout Standard
-
Probably the easiest way to get started is either to import a RevTeX 4 document
using
\family typewriter
-reLyX
+tex2lyx
\family default
, or to use the
\family sans
-Revtex\InsetSpace ~
+Revtex
+\begin_inset space ~
+\end_inset
+
4
\family default
template, found in the templates directory.
\end_layout
\begin_layout Subsection
-
Preamble Matter
\end_layout
\begin_layout Standard
-
Optional arguments to
\family typewriter
\bar under
x
\bar default
-tra\InsetSpace ~
+tra
+\begin_inset space ~
+\end_inset
+
Options
\family default
field in the
\family sans
-Document\InsetSpace ~
+Document
+\begin_inset space ~
+\end_inset
+
Layout
\family default
dialog, as usual.
\end_layout
\begin_layout Standard
-
Other preamble matter, like
\family typewriter
draft
\family default
etc.
- goes in the
+\begin_inset space ~
+\end_inset
+
+goes in the
\family sans
-Latex\InsetSpace ~
+LaTeX
+\begin_inset space ~
+\end_inset
+
Preamble
\family default
dialog, also as usual.
\end_layout
\begin_layout Subsection
-
Layouts
\end_layout
\begin_layout Standard
-
The layouts basically correspond to the commands in RevTeX4.0.
For example, the Email layout corresponds to
\family typewriter
\begin_inset Foot
status collapsed
-\begin_layout Standard
-
+\begin_layout Plain Layout
In case you're curious, both were included so that
\family typewriter
-reLyX
+tex2lyx
\family default
would be able to translate both
\family typewriter
\end_layout
\begin_layout Subsection
-
Important Notes
\end_layout
\begin_layout Standard
-
There are a couple of important unique aspects of RevTeX 4 which might cause
bugs that will be even more confusing in LyX.
\end_layout
\begin_layout Standard
-
In RevTeX, the
\family typewriter
\end_layout
\begin_layout Standard
-
Also, the
\family sans
-Author\InsetSpace ~
+Author
+\begin_inset space ~
+\end_inset
+
Email
\family default
,
\family sans
-Author\InsetSpace ~
+Author
+\begin_inset space ~
+\end_inset
+
URL
\family default
, and
\end_layout
\begin_layout Subsection
-
Drawbacks
\end_layout
\begin_layout Standard
-
The main problem with this layout is that you can't use the optional arguments
to layouts like Email and Title.
(The problem is not unique to this layout; you can't use optional arguments
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.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+the running title for the page headers.
Lacking these layouts makes the
\family typewriter
\begin_inset Foot
status collapsed
-\begin_layout Standard
-
+\begin_layout Plain Layout
\emph on
Note from JMarc:
\end_layout
\begin_layout Section
+Springer Journals (
+\family sans
+svjour
+\family default
+)
+\end_layout
-Article (mwart), book (mwbk) and report (mwrep)
-\begin_inset OptArg
-status collapsed
+\begin_layout Standard
+by
+\noun on
+Martin Vermeer
+\end_layout
+
+\begin_layout Subsection
+Description
+\end_layout
\begin_layout Standard
+These are the layout files for some of the journal formats used by Springer
+ Verlag and listed on
+\begin_inset Flex URL
+status collapsed
-The
-\family typewriter
-mw
-\family default
- Classes
+\begin_layout Plain Layout
+
+http://www.springer.de/author/tex/help-journals.html
\end_layout
\end_inset
+, where you should also go to fetch the class files (yes, these are LaTeX2e
+ now!).
+ It is a modular system: the things common to all journals are implemented
+ in
+\family typewriter
+svjour.inc
+\family default
+, which journal-specific layout files (such as, e.
+\begin_inset space \thinspace{}
+\end_inset
-\end_layout
+g.
+\begin_inset space \space{}
+\end_inset
-\begin_layout Standard
-by
-\noun on
-Tomasz Luczak
+\family typewriter
+svjog.layout
+\family default
+ for Journal of Geodesy) can include.
\end_layout
\begin_layout Standard
-
-The LyX document classes
-\emph on
- article (mwart)
-\emph default
-,
-\emph on
-report (mwrep)
-\emph default
- and
-\emph on
-book
-\emph default
-
-\emph on
-(mwbk)
-\emph default
- correspond to the LaTeX document classes
+This means that implementing support for any other Springer journal on this
+ list is as simple as writing your own
\family typewriter
-mwart.cls
+sv
\family default
-,
+<myjournal>
\family typewriter
-mwrep.cls
+.layout
\family default
- and
+ file following the outline given in
\family typewriter
-mwbk.cls
+svjog.layout
\family default
-, resp.
- They are replacements for the standard document classes
+.
+
+\end_layout
+
+\begin_layout Standard
+It is reasonably well tested only for the Journal of Geodesy.
+
\family typewriter
-article.cls
+svjour
\family default
-,
+ and
\family typewriter
-report.cls
+svjog
\family default
- and
+ come with the standard LyX distribution.
+ Install the relevant class file (downloaded from Springer) in a proper
+ directory, reconfigure LaTeX (in the teTeX case by running
\family typewriter
-book.cls
+texhash
\family default
-, resp., and fit better to Polish typography conventions in a number of points.
-
+, as root if necessary — doesn't LyX take care of this?), reconfigure LyX
+ and it should work.
\end_layout
-\begin_layout Standard
-
-Basic differences:
+\begin_layout Subsection
+New styles
\end_layout
-\begin_layout Itemize
-
-Unnumbered titles (with star, eg.
+\begin_layout Standard
+A large number of theorem-like styles —
+\family sans
+Claim, Conjecture,
+\family default
\family sans
-Section*
+\SpecialChar \ldots{}
+Theorem
\family default
-) are added into table of contents,
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
-Additional page styles:
+\family sans
+Headnote, Dedication, Subtitle, Running_LaTeX_Title, Author_Running, Institute,
+ Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
+\family default
+.
+ See the Springer class file documentation for details.
\end_layout
-\begin_deeper
-\begin_layout Description
-
-uheadings header with separated lines,
+\begin_layout Subsection
+Supported journals
\end_layout
-\begin_layout Description
+\begin_layout Itemize
-myheadings custom header, contents headers via commands:
+\emph on
+Journal of Geodesy
+\emph default
+:
\family typewriter
-
-\backslash
-markright
+svjog.layout
\family default
- and
-\family typewriter
+ — Martin Vermeer
+\end_layout
-\backslash
-markboth
+\begin_layout Itemize
+
+\emph on
+Probability Theory and Related Fields
+\emph default
+:
+\family typewriter
+svprobth.layout
\family default
-,
+ — Jean-Marc Lasgouttes
\end_layout
-\begin_layout Description
+\begin_layout Standard
+Add your own, it isn't so hard!
+\end_layout
-myuheadings custom header with separated lines,
+\begin_layout Subsection
+Credits
\end_layout
-\begin_layout Description
+\begin_layout Standard
+These files are partly based on the older
+\family typewriter
+ejour2.layout
+\family default
+, which was again based on a tinkered-with version of an old LaTeX 2.09 style
+ file from Springer.
+ All this, and the
+\family typewriter
+ejour2
+\family default
+ layout, are now defunct.
+ Jean-Marc Lasgouttes helped out big in making me find my way around the
+ LyX layout file mechanism.
+\end_layout
-outer page number is placed on outer side of page
+\begin_layout Subsection
+Bugs
\end_layout
-\end_deeper
-\begin_layout Itemize
-Options
+\begin_layout Standard
+Probably.
+ But probably less than in the old hacked-LaTeX
+\family typewriter
+ejour2
+\family default
+.
\end_layout
-\begin_deeper
-\begin_layout Description
+\begin_layout Standard
+Limitations e.
+\begin_inset space \thinspace{}
+\end_inset
-rmheadings serif titles --- default,
+g.: does not display the number for theorem-like layouts, just #.
\end_layout
-\begin_layout Description
+\begin_layout Section
+Slides [aka
+\noun on
+SliTeX
+\noun default
+]
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slitex"
-sfheadings sansserif titles,
-\end_layout
+\end_inset
-\begin_layout Description
-authortitle on title page first placed is author next title --- default,
\end_layout
-\begin_layout Description
-
-titleauthor on title page first placed is title next author,
+\begin_layout Standard
+by
+\noun on
+John Weiss
+\noun default
+
\end_layout
-\begin_layout Description
+\begin_layout Subsection
+Introduction
+\end_layout
-withmarginpar reserve place on page for margins.
+\begin_layout Standard
+This section describes how to use LyX to make slides for overhead projectors.
+ There are two document classes that can do this: the default slides class
+ and the
+\family sans
+FoilTeX
+\family default
+ slides class.
+ This section documents the former.
\end_layout
-\end_deeper
-\begin_layout Section
-Elsevier Journals
+\begin_layout Standard
+I'm going to say this again, nice and clear, so that there's no misunderstanding
+:
\end_layout
\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
+
-By
-\noun on
-Rod Pinna
\end_layout
\begin_layout Standard
+\align center
-Elsevier Science Publishers B.V.
- provides a standard LaTeX document class (
-\family typewriter
-elsart.cls
-\family default
-) for submitting articles to their various journals.
- The style file can be downloaded directly from their web site:
-\begin_inset LatexCommand \url{http://authors.elsevier.com/}
-
+\size large
+This section documents the class
+\begin_inset Quotes eld
\end_inset
-.
- Instructions are supplied along with the class file, which details the
- requirements of the publishers.
- LyX includes package that allows for the use of this class, by a layout
- and a template file.
- Installation of the class file is the same as for any other LaTeX package;
- instructions are provided in the Elsevier documentation.
-\end_layout
-
-\begin_layout Standard
-To make use of
-\family typewriter
-elsart.cls
-\family default
-, a file
-\family typewriter
-elsart.layout
+\family sans
+slides (default)
\family default
- is supplied.
- As the Elsevier class file is based mainly on the standard article class,
- most of the normal functionality is provided.
- The Elsevier class defines a number of mathematical environments, which
- are similar to the AMS environments.
- These commands are all described in the Elsevier documentation, and are
- available in LyX.
-\end_layout
-
-\begin_layout Standard
-
-The easiest way to use the Elsevier style is to base documents on the included
- template file.
- It is best not to use options such as fancy headings or the geometry package,
- as elements such as these are defined by Elsevier in their style file.
- Ideally, no extra packages except those mentioned in the Elsevier documentation
- should be used.
- Essentially, Elsevier require as
-\begin_inset Quotes eld
-\end_inset
-clean
\begin_inset Quotes erd
\end_inset
- a
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-\backslash
-LaTeX
+
+\emph on
+only.
\end_layout
+\begin_layout Standard
+\begin_inset VSpace bigskip
\end_inset
- file as possible, as their intention is to take the supplied file and replace
- the class file with one for the particular journal to which the paper has
- been submitted.
- This also means that not too much time should be spent on the formating
- of the document.
- When it comes to be published, this will change anyway.
- The rest of the usage for this layout is substantially the same as for
- the normal article class.
- For details of what Elsevier do and don't allow, refer to their documentation.
-\end_layout
-
-\begin_layout Section
-Memoir
\end_layout
\begin_layout Standard
+If you're looking for the documentation for
+\begin_inset Quotes eld
+\end_inset
-By
-\noun on
-Jürgen Spitzmüller
-\end_layout
-
-\begin_layout Subsection
-
-Overview
-\end_layout
-
-\begin_layout Standard
-Memoir is a very powerful and constantly evolving class.
- It has been designed with regard to fictional and non-fictional literature.
- Its aim is to let the user have maximum control over the typesetting of
- his document.
- Memoir is based on the standard book class, but it can also emulate the
- article class (see below).
-\end_layout
+\family sans
+slides (FoilTeX)
+\family default
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-Peter Wilson, the developer of Memoir, is known as the author of lots of
- useful packages in the LaTeX world.
- Most of them have been merged with Memoir.
- Therefore, it is much easier to layout the table of contents, appendices,
- chapter designs and such.
- LyX, though, does not support all of these goodies natively.
- Some of them might be added to forthcoming releases
-\begin_inset Foot
-status collapsed
+, check out section
+\begin_inset space ~
+\end_inset
-\begin_layout Standard
-You are invited to send suggestions to
-\begin_inset LatexCommand \url{lyx-devel@lists.lyx.org}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foiltex"
\end_inset
.
-\end_layout
+ The
+\family sans
+foils
+\family default
+ class [
+\begin_inset Quotes eld
+\end_inset
+
+\family sans
+slides (FoilTeX)
+\family default
+
+\begin_inset Quotes erd
\end_inset
-, lots will probably never, due to the limitations of LyX's framework.
- Of course you can still use all features with the help of some native LaTeX
- commands (ERT
+] is actually somewhat better than the default
+\family sans
+slides
+\family default
+ class,
\begin_inset Foot
status collapsed
-\begin_layout Standard
-
-Cf.
-\begin_inset ERT
-status collapsed
+\begin_layout Plain Layout
+\SpecialChar \ldots{}
+or so I've been told repeatedly by its advocates.
+ Having never used it, I have no idea if this claim is true or not.
+\end_layout
-\begin_layout Standard
+\end_inset
-\backslash
-
+ which this section documents.
\end_layout
+\begin_layout Standard
+This class is the LaTeX2e improvement of the old
+\noun on
+SliTeX
+\noun default
+ package.
+ Every LaTeX2e distribution includes this class [which I'll just refer to
+ as
+\begin_inset Quotes eld
\end_inset
-section\InsetSpace ~
-\begin_inset LatexCommand \ref{sec:Inserting-LaTeX-Code}
+\family sans
+slides
+\family default
+\begin_inset Quotes erd
\end_inset
- for details.
+ from now on], so you're bound to have it.
+ As I noted earlier, there are other classes, such as
+\family sans
+foils
+\family default
+, which also produce slides for overhead projectors and do a better job
+ at it.
+ However, there are some things which
+\family sans
+slides
+\family default
+ can do which the others can't, such as generate overlays.
+ Read on to learn more!
\end_layout
-\end_inset
-
-).
- In this section, we can only list those features which are natively supported
- by LyX.
- For detailed descriptions (and for the rest of features) we are recommending
- to have a look at the detailed manual of the Memoir class
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
+\begin_layout Subsection
+Getting Started
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slidesetup"
-Cf.
-\begin_inset ERT
-status collapsed
+\end_inset
-\begin_layout Standard
-\backslash
-
\end_layout
+\begin_layout Standard
+Obviously, to use this document class, you need to select
+\begin_inset Quotes eld
\end_inset
-\begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
+\family sans
+slides (default)
+\family default
+\begin_inset Quotes erd
\end_inset
-.
+ from the class list in the
+\family sans
+Document\SpecialChar \menuseparator
+Settings
+\family default
+ dialog.
+ There are some other special things you should know about this class:
\end_layout
-\end_inset
-
-, which is not only a user guide for the class, but also both a comprehensive
- description on good typesetting and a superb example for good typesetting
- itself.
+\begin_layout Itemize
+Don't bother changing the options
+\family sans
+Sides and Columns
+\family default
+.
+ They're not supported by the
+\family sans
+slides
+\family default
+ class, anyways.
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
+The option
+\family sans
+Page
+\begin_inset space ~
+\end_inset
-Basic features and restrictions
+style
+\family default
+ behaves a bit differently for this class.
+ The possible choices and what they do are as follows:
\end_layout
-\begin_layout Standard
+\begin_deeper
+\begin_layout Description
-Memoir supports basically all features of the standard book classes.
- There are, however, some differences, as follows:
+\family sans
+plain
+\family default
+ The final output contains page numbers in the lower right corner.
\end_layout
\begin_layout Description
-Font\InsetSpace ~
-sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14,
- 17
+\family sans
+headings
+\family default
+ Like
+\family sans
+plain
+\family default
+, but also prints out any time markers you've put in.
+ This is the default.
\end_layout
\begin_layout Description
-Page\InsetSpace ~
-style: The fancy page style is not supported, due to a command clash
- between Memoir and the fancyhdr package (they are both defining a command
- with the same name, which confuses LaTeX).
- Instead, Memoir comes with a bunch of own page styles (see
\family sans
-Layout\SpecialChar \menuseparator
-Document\SpecialChar \menuseparator
-Page\InsetSpace ~
-Style
+empty
\family default
-).
- If you want to use these for the chapter pages, you have to use the command
-
+ The final output contains no page numbers, time markers, or alignment markers.
+\end_layout
+
+\end_deeper
+\begin_layout Itemize
+The
+\family sans
+slides
+\family default
+ class has an extra option:
\family typewriter
+clock
+\family default
+.
+ To use it, put
+\begin_inset Quotes eld
+\end_inset
-\backslash
-chapterstyle
+
+\family typewriter
+clock
\family default
- in the main text or in preamble (e.
-\begin_inset ERT
-status collapsed
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-\backslash
-,
+ in the extra class options.
\end_layout
+\begin_deeper
+\begin_layout Standard
+Using this options allows you to add time markers to
+\family sans
+Note
+\family default
+s.
+ See section
+\begin_inset space ~
\end_inset
-g.
-\begin_inset ERT
-status collapsed
-\begin_layout Standard
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideNote"
-\backslash
-
+\end_inset
+
+ for more details.
\end_layout
+\end_deeper
+\begin_layout Standard
+You can also use the template file
+\begin_inset Quotes eld
\end_inset
\family typewriter
-
-\backslash
-chapterstyle{companion}
+slides.lyx
\family default
-).
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
-Sectioning: Sectionings (chapter, section, subsection etc.) are coming with
- an optional argument in the standard classes.
- With this, you can specify an alternative version of the title for the
- table of contents and the headers (for instance, if the title is too long).
- In LyX, you can do this via
+ to automatically set up a document to use the
\family sans
-Insert\SpecialChar \menuseparator
-Short\InsetSpace ~
-Title
+slides
\family default
- at the beginning of a chapter/section.
- Memoir features a second optional argument and thus separates the table
- of contents from the header.
- You can define three variants of a title with this: one for the main text,
- one for the table of contents, and one for the headers.
- Simply insert two optional arguments if you need this feature, the first
- one containing the short title for the Table of Contents, the second one
- containing an alternative short title for the headers.
-\end_layout
-
-\begin_layout Description
-
-TOC/LOT/LOF: In the standard classes (and in many other classes), the table
- of contents, the list of figures and the list of table start a new page
- automatically.
- Memoir does not follow this route.
- You have to insert a page break yourself, if you want to have one.
-\end_layout
-
-\begin_layout Description
-
-Titlepage: For some unknown reason, Memoir uses pagination on the title
- page (in the standard classes, title pages are
-\begin_inset Quotes eld
+ class [using
+\family sans
+File\SpecialChar \menuseparator
+New
+\begin_inset space ~
\end_inset
-empty
-\begin_inset Quotes erd
+from
+\begin_inset space ~
\end_inset
-, i.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
-
-\backslash
-,
+Template
+\family default
+ to open your new document].
+ The template file also contains some examples of the special paragraph
+ environments used by this class.
+ I'll describe those next.
\end_layout
-\end_inset
-
-e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
+\begin_layout Subsection
+Paragraph Environments
+\end_layout
-\backslash
-
+\begin_layout Subsubsection
+Supported Environments
\end_layout
+\begin_layout Standard
+The first thing you'll notice when you start up a new
+\family sans
+slides
+\family default
+ document is the font size and type: it's the equivalent of the size
+\begin_inset Quotes eld
\end_inset
-without pagina).
- If you want an empty title page, type
-\family typewriter
-\backslash
-aliaspagestyle{title}{empty}
+\family sans
+Largest
\family default
-in the preamble.
-\end_layout
-\begin_layout Description
+\begin_inset Quotes erd
+\end_inset
-Article: With the class option
-\emph on
-article
-\emph default
-(to be inserted in
+ in the
\family sans
-Layout\SpecialChar \menuseparator
-Document\SpecialChar \menuseparator
-Extra\InsetSpace ~
-Options
+Sans
+\begin_inset space ~
+\end_inset
+
+Serif
\family default
-), you can emulate article style.
- That is, counters (footnotes, figures, tables etc.) will not be reset on
- new chapters, chapters don't start a new page (but are---in contrary to
-
+ font.
+ This is also what's used in the output.
+ Think of this as a
\begin_inset Quotes eld
\end_inset
-real
+visual cue
\begin_inset Quotes erd
\end_inset
- article classes---still allowed), parts, though, use their own page, as
- in book.
+ to remind you that this is a slide.
+ Your final slides will use a larger font; ergo, you'll have less space.
+ Of course, the larger default screen font isn't WYSIWYG, only a reminder.
\end_layout
-\begin_layout Description
-
-Oldfontcommands: By default, Memoir does not allow the use of the deprecated
- font commands, which have been used in the old LaTeX version 2.09 (e.
-\begin_inset ERT
-status collapsed
-
\begin_layout Standard
-
-\backslash
-,
+The next thing that becomes obvious is the changes to the paragraph environment
+ pull-down box [at the far-left end of the toolbar].
+ Most of the paragraph environments you're used to seeing are missing.
+ There are also five new ones.
+ That's because the
+\family sans
+slides
+\family default
+ class itself only supports certain paragraph environments:
\end_layout
-\end_inset
+\begin_layout Itemize
-g.
-\begin_inset ERT
-status collapsed
+\family sans
+Standard
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-\backslash
-
+\family sans
+Itemize
\end_layout
-\end_inset
-
+\begin_layout Itemize
-\family typewriter
+\family sans
+Enumerate
+\end_layout
-\backslash
-rm
-\family default
-,
-\family typewriter
+\begin_layout Itemize
-\backslash
-it
-\family default
-).
- It produces an error and stops LaTeX whenever such a command appears.
- The class option
-\emph on
-oldfontcommands
-\emph default
- reallows the commands and spits out warnings instead (which does at least
- not stop LaTeX).
- Since a lot of packages and particularly BibTeX style files are still using
- those commands, we have decided to use this option by default.
+\family sans
+Description
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-Extra features
+\family sans
+List
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-We will only describe the features supported by LyX (which is not much currently
-).
- Please consult the Memoir manual
-\begin_inset Foot
-status collapsed
+\family sans
+Quotation
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-Cf.
-\begin_inset ERT
-status collapsed
+\family sans
+Quote
+\end_layout
-\begin_layout Standard
+\begin_layout Itemize
-\backslash
-
+\family sans
+Verse
\end_layout
-\end_inset
-
+\begin_layout Itemize
-\begin_inset LatexCommand \url{CTAN:/macros/latex/memoir/memman.pdf}
-
-\end_inset
-
-.
-\end_layout
-
-\end_inset
-
- for details.
+\family sans
+Caption
\end_layout
-\begin_layout Description
+\begin_layout Itemize
-Abstract: You may wonder why an abstract is an extra feature.
- 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.
+\family sans
+LyX-Code
\end_layout
-\begin_layout Description
-
-Chapterprecis: You may know this from belletristic: The contents of a chapter
- is shortly described below the title and also in the table of contents
- (e.
-\begin_inset ERT
-status collapsed
-
-\begin_layout Standard
+\begin_layout Itemize
-\backslash
-,
+\family sans
+Comment
\end_layout
-\end_inset
-
-g.
-\begin_inset ERT
-status collapsed
-
\begin_layout Standard
-
-\backslash
-
-\end_layout
-
-\end_inset
-
-
-\emph on
-Our hero arrives in Troia; he loses some friends; he finds others
-\emph default
-).
- Chapterprecis does exactly this.
- It is therefore only sensible below a chapter.
-\end_layout
-
-\begin_layout Description
-
-Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
- The epigraph environment provides an elegant way of typesetting such a
- motto.
- The motto itself (text) and its author (source) are divided by a short
- line.
- Unfortunately, we have to fool LyX a bit here again, since the environment
- needs two arguments (text and source).
- In this case, we have to use curly brackets (in TeX mode) between the two
- arguments:
-\emph on
-<smart slogan>
-\emph default
-
-\family typewriter
-}{
+All of the other standard environments, including the section-heading environmen
+ts, aren't used in the
+\family sans
+slides
\family default
-
-\emph on
-<author of the slogan>.
-\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.
- 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.
- Memoir has some enhanced versions of verse, but you need to use ERT, because
- they have to be nested inside regular verse environments, which is not
- possible with LyX).
-\end_layout
-
-\begin_layout Description
-
-Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
+ class.
\end_layout
-\begin_layout Chapter
-
-Importing and Exporting Alternate File Formats
-\begin_inset OptArg
-status collapsed
-
\begin_layout Standard
-
-Importing and Exporting
-\end_layout
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Section
-
-Considerations
+On the other hand, you'll notice the following new environments:
\end_layout
-\begin_layout Standard
-
-Importing and exporting LyX documents from/to other formats has been touched
- on briefly in the
-\emph on
-User Guide
-\emph default
-.
- Here we describe more of the gory details needed to understand just what
- is going on when you click on the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\begin_layout Itemize
-\bar under
-I
-\bar default
-mport
-\family default
- and
\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-E
-\bar under
-x
-\bar default
-port
-\family default
- menu items.
-
+Slide
\end_layout
-\begin_layout Section
+\begin_layout Itemize
-Importing Other Formats
+\family sans
+Overlay
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-LaTeX
+\family sans
+Note
\end_layout
-\begin_layout Standard
-
-Translating from LaTeX into LyX is performed by a Perl script called reLyX.
- Although it is a standalone program which can be called from the command
- line, LyX will call it automatically when a LaTeX document is imported.
- See section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:reLyX}
-
-\end_inset
+\begin_layout Itemize
- for a complete description.
- There are no user tunable parameters for reLyX within LyX.
+\family sans
+InvisibleText
\end_layout
-\begin_layout Subsection
+\begin_layout Itemize
-ASCII Text
+\family sans
+VisibleText
\end_layout
\begin_layout Standard
-
-When importing plain ASCII text, there are two methods of reading the file.
- Importing
+These five are kind of quirky, due to a
\begin_inset Quotes eld
\end_inset
-as lines
+feature
\begin_inset Quotes erd
\end_inset
- preserves all the linebreaks in the ASCII; to LyX, then, each line looks
- like a paragraph.
- Importing
+ in LyX.
+ You see, LyX doesn't permit you to nest any other paragraph environment
+ into an empty environment.
+ Now, that's fine and dandy, but it means that you wouldn't be able to start
+ a slide with anything except plain text.
+ To deal with this, I've performed a little
\begin_inset Quotes eld
\end_inset
-as paragraphs
+LaTeX magic.
\begin_inset Quotes erd
\end_inset
- assumes that consecutive lines separated by only a single linebreak form
- a single paragraph.
- Successive linebreaks with no intervening text are thus assumed to be paragraph
- delimiters.
-\end_layout
-
-\begin_layout Subsection
-
-Noweb
-\end_layout
-
-\begin_layout Standard
-
-
-\emph on
-[Editor's note: Needs to be written, obviously - any volunteers? --- mer]
+
\end_layout
-\begin_layout Section
+\begin_layout Subsubsection
+Quirks of the New Environments
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slideQuirk"
-Exporting Other Formats
-\end_layout
+\end_inset
-\begin_layout Subsection
-LaTeX
\end_layout
\begin_layout Standard
-
-LyX generates two types of LaTeX files: stripped down versions for the normal
- processing (
+All five of the new paragraph environments are somewhat quirky due to inherent
+ limitiations in the current version of LyX.
+ As I just mentioned, LyX forbids environments that begin with another environme
+nt.
+ To get around this, the
\family sans
-View DVI
+Slide
\family default
-, etc.) which one normally never sees
-\begin_inset Foot
-status collapsed
+ environment isn't a paragraph environment as described in the
+\emph on
+User's Guide
+\emph default
+.
+
+\end_layout
\begin_layout Standard
+You should consider
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+, and
+\family sans
+Note
+\family default
+ to be
+\begin_inset Quotes eld
+\end_inset
-The resulting file is a perfectly valid LaTeX file, though the preamble
- might look a bit strange since it includes some definitions used by LyX
- which wouldn't show up in most human-written files.
-\end_layout
+pseudo-environments.
+\begin_inset Quotes erd
+\end_inset
+ They look like a section heading or a
+\begin_inset Quotes eld
\end_inset
-, and human readable forms which are suitable for exchanging with your colleague
-s.
- The only settable option for the translation is the line length of the
- output file.
- The default is 65 characters, but it can be set in
+
\family sans
-\bar under
-T
-\bar default
-ools
+Caption
\family default
-\SpecialChar \menuseparator
+,
+\begin_inset Quotes erd
+\end_inset
+ but really begin a [and, if necessary, end the previous] paragraph environment.
+ Likewise, treat
\family sans
-\bar under
-P
-\bar default
-references
+InvisibleText
\family default
- using the
+ and
\family sans
-\bar under
-A
-\bar default
-scii\InsetSpace ~
-line\InsetSpace ~
-length
+VisibleText
\family default
- field.
-
-\end_layout
+ as
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
+pseudo-commands.
+\begin_inset Quotes erd
+\end_inset
-Device Independent Files
+ These two perform some action.
\end_layout
\begin_layout Standard
-
-Device Independent files (DVI files) are produced by running LaTeX on your
- document.
- There are no user settable options.
-\end_layout
-
-\begin_layout Subsection
-
-PostScript®
-\end_layout
-
-\begin_layout Standard
-
-The next step in the conversion chain is converting a DVI file into Postscript®.
- You can either use
+A common feature of all five environments,
\family sans
-\bar under
-F
-\bar default
-ile
+Slide
\family default
-\SpecialChar \menuseparator
-
+,
\family sans
-\bar under
-E
-\bar default
-xport
+Overlay
\family default
-\SpecialChar \menuseparator
-
+,
\family sans
-Pos
-\bar under
-t
-\bar default
-script
+Note
\family default
- or, if you need more control on the result,
+,
\family sans
-\bar under
-F
-\bar default
-ile
+InvisibleText
\family default
-\SpecialChar \menuseparator
-
+ and
\family sans
-\bar under
-P
-\bar default
-rint
+VisibleText
\family default
-.
- If you use the later, note that it is possible to configure, in
+, is a rather long-ish label.
+ The text following this label — ordinarily the contents of the paragraph
+ environment — is utterly irrelevant for
\family sans
-\bar under
-T
-\bar default
-ools
+Slide
\family default
-\SpecialChar \menuseparator
-
+,
\family sans
-\bar under
-P
-\bar default
-references
+Overlay
\family default
-, the options passed to the dvips program to achieve different effects.
-\end_layout
-
-\begin_layout Subsection
-
-ASCII text
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+.
+ LyX completely ignores it.
+ In fact, you can leave these five environments completely empty.
+
\end_layout
\begin_layout Standard
-
-Exporting as ASCII attempts to preserve the
-\begin_inset Quotes eld
-\end_inset
-
-shape
-\begin_inset Quotes erd
-\end_inset
-
- of the document as well as possible, but things like centering and indentation
- are thrown out; paragraphs are separated by blank lines.
- Section numbering and cross-references are done correctly, so the resulting
- text files is remarkably readable.
- The only changeable option is the length of lines, as for LaTeX output.
-\end_layout
-
-\begin_layout Subsection
-
-HTML
+While you don't
+\emph on
+have
+\emph default
+ to put any text after the rather long-ish label, you might want to.
+ This could be a short description of the contents of the
+\family sans
+Slide
+\family default
+, for example.
+ In that case, enter in your descriptive comment and hit
+\family sans
+Return
+\family default
+ as you normally would.
\end_layout
\begin_layout Standard
+If, on the other hand, you don't want to enter in any descriptive text,
+ you'll hit another LyX quirk.
+ LyX, like nature, abhors a vacuum, and will not let you start a new paragraph
+ environment until you put something in the old one.
+ So, do this:
+\end_layout
-LyX documents can be converted to hypertext markup, usually by converting
- to LaTeX first, then converting that to HTML\SpecialChar \@.
- Three LaTeX
-\begin_inset Formula $\rightarrow$
-\end_inset
-
-HTML converters are currently known to LyX:
-\family typewriter
-tth
+\begin_layout Itemize
+Start entering the text that will
+\emph on
+follow
+\emph default
+ the new
+\family sans
+Slide
\family default
,
-\family typewriter
-latex2html
+\family sans
+Overlay
\family default
-, and
-\family typewriter
-hevea
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ or
+\family sans
+VisibleText
\family default
.
- Though they are autodetected, you can overide the selection in preferences.
- You can also include further command line options in this dialog.
\end_layout
-\begin_layout Subsection
-
-PDF
+\begin_layout Itemize
+Now move to the beginning of that paragraph.
+
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+Next, hit
+\family sans
+Return
+\family default
+.
+
+\end_layout
-by
-\noun on
-Dekel Tsur
-\noun default
- (mostly)
+\begin_layout Itemize
+Finally, change this new, empty paragraph to a
+\family sans
+Slide
+\family default
+,
+\family sans
+Overlay
+\family default
+,
+\family sans
+Note
+\family default
+,
+\family sans
+InvisibleText
+\family default
+ or
+\family sans
+VisibleText
+\family default
+.
+
\end_layout
\begin_layout Standard
-
-
-\begin_inset VSpace bigskip
-\end_inset
-
+Some future version of LyX will, hopefully, resolve this quirkiness\SpecialChar \ldots{}
\end_layout
-
-\begin_layout Standard
-
-The fastest way to generate a basic PDF file (no tags, links, etc.) with
- any version of LyX is to save the document as a Postscript® file, then
- run the
-\family typewriter
-ps2pdf
+\begin_layout Subsection
+Making a Presentation with
+\family sans
+Slide
\family default
- command on it.
- Starting with version 1.1.6, the menu item
+,
\family sans
-File->Export->PDF
+Overlay
\family default
- will do all this for you.
- There are some issues with fonts that you need to pay attention to: see
- Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:badfonts}
-
-\end_inset
-
-.
- Also, as of version 1.1.6, there is a better method that will generate much
- more sophisticated files.
+ and
+\family sans
+Note
\end_layout
\begin_layout Subsubsection
-
-Use pdfLaTeX
+Using the
+\family sans
+Slide
+\family default
+ Environment
\end_layout
\begin_layout Standard
+If you're expecting this section to teach you how to actually make a presentatio
+n, you'll be sorely disappointed.
+ Naturally, I'll describe all of the ways the
+\family sans
+slides
+\family default
+ class can assist you in preparing the materials for a presentation.
+ Filling in the contents, however, is up to you.
+ [Then again, that
+\emph on
+is
+\emph default
+ the LyX philosophy.]
+\end_layout
-With pdfLaTeX you need to convert your eps figures to PDF (see Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:pdfeps}
-
+\begin_layout Standard
+Choosing the
+\family sans
+Slide
+\family default
+ environment [in the manner described in section
+\begin_inset space ~
\end_inset
-), and 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.
-\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 CommandInset ref
+LatexCommand ref
+reference "sec:slideQuirk"
\end_inset
+] tells LyX to begin a new slide [duh].
+ The label for this environment/
+\begin_inset Quotes erd
+\end_inset
-\begin_inset OptArg
-status collapsed
+pseudo-command
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+ is an
+\begin_inset Quotes eld
+\end_inset
-Bad Fonts in Acrobat Reader
-\end_layout
+ASCII line,
+\begin_inset Quotes erd
+\end_inset
+ in cool blue, followed by the label,
+\begin_inset Quotes eld
\end_inset
+NewSlide:
+\begin_inset Quotes erd
+\end_inset
+.
+ Any text or paragraph environments that follow this one go on the new slide.
+ It's that simple.
\end_layout
\begin_layout Standard
-
-The problem is that bitmap fonts are displayed poorly by Acrobat Reader.
- When creating a PDF from the LyX file, you need to use outline font instead
- of the default bitmap fonts (in fact, you should also use outline fonts
- for Postscript files).
- 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
-\family typewriter
-~/.dvipsrc
+Slides are probably the only time you'll need to forcibly end pages in LyX
+ (this can be specified in the
+\family sans
+Paragraph Layout
\family default
- file
-\end_layout
-
-\begin_layout LyX-Code
-
-p+ psfonts.cmz
-\end_layout
-
-\begin_layout LyX-Code
-
-p+ psfonts.amz
-\end_layout
-
-\begin_layout Standard
-
-If the default LaTeX font encoding (OT1) is used, nothing else need to be
- done.
- However, if the T1 font encoding is used, then LaTeX uses the newer EC
- fonts, for which there are no Type1 version.
- The solution is to use the ae package which emulates T1 coded fonts using
- the standard CM fonts.
- This is done by adding
-\family typewriter
-
-\backslash
-usepackage{ae,aecompl}
+ dialog).
+ In fact, you'll want to, once you finish entering the contents of one slide.
+ If you've entered more text than can physically fit on a slide, the extra
+ overflows onto a new slide.
+ I don't recommend doing this, however, since the overflow slide won't have
+ any page number on it.
+ Furthermore, it may interfere with any
+\family sans
+Overlay
+\family default
+ you've made to accompany the oversized
+\family sans
+Slide
\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.
- Therefore you get these glyphs as bitmaps.
+.
\end_layout
\begin_layout Standard
-
-Note: LyX uses by default the T1 font encoding.
- If you wish to use the default font encoding (this is not recommended,
- unless you only write English documents), clear the field
-\family sans
-\bar under
-T
-\bar default
-eX\InsetSpace ~
-encoding
-\family default
- in preferences (tabs
+The
\family sans
-Outputs
+Overlay
\family default
-,
+ and
\family sans
-Misc
+Note
\family default
-).
-
-\end_layout
-
-\begin_layout Standard
-
-An alternate option is to use the standard Postscript® fonts instead of
- the Computer Modern fonts.
- To do that, you need to select
+ environments work the same way as the
\family sans
-pslatex
+Slide
\family default
- as the global font in the document layout dialog.
- 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
- man's bold must be used (see Section\InsetSpace ~
-
-\begin_inset LatexCommand \ref{sec:pdfbold}
-
+ environment.
+ They both create an
+\begin_inset Quotes eld
\end_inset
-).
- The Postscript® fonts also look different from the Computer Modern fonts.
-\end_layout
+ASCII line
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+ followed by a label [
+\begin_inset Quotes eld
+\end_inset
-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
+NewOverlay:
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsubsection
+ and
+\begin_inset Quotes eld
+\end_inset
-Why doesn't the
-\backslash
-boldsymbol{} command work when I use pslatex?
-\begin_inset LatexCommand \label{sec:pdfbold}
+NewNote:
+\begin_inset Quotes erd
+\end_inset
+, respectively].
+ The color is a stunning magenta instead of blue, and the
+\begin_inset Quotes eld
\end_inset
+ASCII line
+\begin_inset Quotes erd
+\end_inset
-\begin_inset OptArg
-status collapsed
+ will look different, in style and in length.
+ The label fonts of all three also differ from one another.
+\end_layout
\begin_layout Standard
-
-
-\family typewriter
-
-\backslash
-boldsymbol{}
+As with a
+\family sans
+Slide
\family default
- and
-\family typewriter
-pslatex
+, if the contents of a
+\family sans
+Note
+\family default
+ or
+\family sans
+Overlay
+\family default
+ exceed the physical size of a slide or sheet of paper, the extra will overflow
+ onto a new sheet.
+ Again, you should avoid this.
+ It defeats the whole purpose of
+\family sans
+Note
+\family default
+s and
+\family sans
+Overlay
+\family default
+s.
\end_layout
-\end_inset
-
-
+\begin_layout Subsubsection
+Using
+\family sans
+Overlay
+\family default
+ with
+\family sans
+Slide
\end_layout
\begin_layout Standard
-
-The Postscript® fonts do not have a bold symbol font.
- The solution is to use the
-\family typewriter
-
-\backslash
-pmb{}
+The idea behind an
+\family sans
+Overlay
+\family default
+ is a slide that sits atop another slide.
+ Perhaps you wish to discuss a figure on the main
+\family sans
+Slide
+\family default
+ before displaying the text associated with it.
+ One way to accomplish this is tape a flap of dark paper over the part of
+ the
+\family sans
+Slide
\family default
- (poor man's bold) command.
+ you want to display later.
+ This method fails, however, if you wish to overlap one graph with another,
+ for example.
+ You would then have to fumble while speaking to align the two separate,
+ overlapping
+\family sans
+Slide
+\family default
+s to align the two graphs.
+ The use of an
+\family sans
+Overlay
+\family default
+ environment in both cases makes life much easier.
\end_layout
\begin_layout Standard
-
-It is possible to redefine the
-\family typewriter
-
-\backslash
-boldsymbol
+Each
+\family sans
+Overlay
\family default
- command to use
-\family typewriter
+ receives the page number of its
+\begin_inset Quotes eld
+\end_inset
-\backslash
-pmb
-\family default
- by putting
-\end_layout
+parent
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+
+\family sans
+Slide
+\family default
+, appended by
+\begin_inset Quotes eld
+\end_inset
-\backslash
-renewcommand{
-\backslash
-boldsymbol}[1]{
-\backslash
-pmb{#1}}
-\end_layout
+\family typewriter
+-a
+\family default
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-in the preamble.
-\end_layout
+.
+\begin_inset Foot
+status collapsed
-\begin_layout Subsubsection
+\begin_layout Plain Layout
+Presumably, mutliple
+\family sans
+Overlay
+\family default
+s would have
+\begin_inset Quotes eld
+\end_inset
-Is it possible to do write latex code which is processed only when running
- pdfLaTeX?
-\begin_inset OptArg
-status collapsed
-\begin_layout Standard
+\family typewriter
+-a
+\family default
-Conditionals with pdfLaTeX
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+,
+\begin_inset Quotes eld
\end_inset
-\end_layout
+\family typewriter
+-b
+\family default
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-Yes.
- Here is an example:
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout LyX-Code
+\family typewriter
+-c
+\family default
-\backslash
-newif
-\backslash
-ifpdf
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+, etc.
+\begin_inset space ~
+\end_inset
-
-\backslash
-ifx
-\backslash
-pdfoutput
-\backslash
-undefined
+appended to the page number of the parent
+\family sans
+Slide
+\family default
+.
+
\end_layout
-\begin_layout LyX-Code
-
-
-\backslash
-pdffalse
-\end_layout
+\end_inset
-\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
-
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-ifpdf
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-pdfinfo { /Author (your name and e-mail address)
-\end_layout
-
-\begin_layout LyX-Code
-
- /Title (official title -- i.e., title element)
-\end_layout
-
-\begin_layout LyX-Code
-
- /Subject (one line description of the document)
-\end_layout
-
-\begin_layout LyX-Code
-
- }
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-pdfcatalog { /PageMode (/UseNone)
-\end_layout
-
-\begin_layout LyX-Code
-
- % /OpenAction (fitbh)
-\end_layout
-
-\begin_layout LyX-Code
-
- }
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-usepackage[pdftex]{hyperref}
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-else
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-usepackage[ps2pdf]{hyperref}
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-fi
-\end_layout
-
-\begin_layout Subsubsection
-
-How can I make URLs clickable ?
-\end_layout
-
-\begin_layout Standard
-
-See the references here :
-\end_layout
-
-\begin_layout Standard
-
-
-\begin_inset LatexCommand \url{http://wiki.lyx.org/pmwiki.php/FAQ/PDF}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-
-Custom
-\end_layout
-
-\begin_layout Standard
-
-Custom exports are possible if you have some particularly weird format you
- wish to convert to, assuming you have the relevant converter, of course.
- The format of the
-\emph on
-input
-\emph default
- file can be chosen in the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-ustom
-\family default
-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
-\family typewriter
-$$FName
-\family default
- to specify the name of the file.
- If this variable is not given, then the file will be sent to the standard
- input of your command.
- You may have to apply a bit of ingenuity to escape this sequence correctly
- so that it is compatible with your shell.
-
-\end_layout
-
-\begin_layout Standard
-
-While it is not possible to save this command using the
-\family sans
-Preferences
-\family default
-dialog, you can manually edit your
-\family typewriter
-.lyx/preferences
-\family default
- to add a line like
-\end_layout
-
-\begin_layout LyX-Code
-
-
-\backslash
-custom_export_command "mycommand $$FName"
-\end_layout
-
-\begin_layout Section
-
-The Complete reLyX Description
-\begin_inset LatexCommand \label{sec:reLyX}
-
-\end_inset
-
-
-\end_layout
-
-\begin_layout Subsection
-
-Synopsis
-\end_layout
-
-\begin_layout Standard
-
-The simplest way to use reLyX is via the
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
-
-\bar under
-I
-\bar default
-mport
-\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
-
-\begin_layout Standard
-
-
-\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_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
-...]]
-\emph on
-inputfiles
-\end_layout
-
-\begin_layout Standard
-
-
-\series bold
-reLyX
-\series default
-
-\series bold
--h
-\end_layout
-
-\begin_layout Subsection
-
-Options
-\end_layout
-
-\begin_layout Description
-
-
-\series bold
--c
-\series default
- Class.
- By default, when reLyX sees a
-\family typewriter
-
-\backslash
-documentclass{foo}
-\family default
- command, it creates a file of textclass
-\begin_inset Quotes eld
-\end_inset
-
-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).
-\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.
-\end_layout
-
-\begin_layout Description
-
-
-\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
-\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.
-\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
-
-\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_inset LatexCommand \ref{sub:relyx-syntax}
-
-\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.
-\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_inset LatexCommand \ref{sub:relyx-syntax}
-
-\end_inset
-
- for details).
-\end_layout
-
-\begin_layout Subsection
-
-Description
-\end_layout
-
-\begin_layout Subsubsection
-
-Introduction
-\end_layout
-
-\begin_layout Standard
-
-reLyX will create a LyX file
-\emph on
-dir/foo.lyx
-\emph default
- from the LaTeX file
-\emph on
-dir/foo.tex
-\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
-\family default
- and
-\family typewriter
-.latex
-\family default
- are supported.
- If
-\emph on
-inputfile
-\emph default
- does not exist and does not have one of these suffixes, reLyX will try
- to translate
-\emph on
-inputfile.tex
-\emph default
-.
- (This is similar to the behavior of LaTeX.)
-\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 Standard
-
-reLyX has some bugs and lacks a few features.
- However, its main goals are:
-\end_layout
-
-\begin_layout Itemize
-
-Get through a well-behaved LaTeX2e file without crashing
-\end_layout
-
-\begin_layout Itemize
-
-Translate a lot of that file.
-\end_layout
-
-\begin_layout Itemize
-
-Localize the parts that can't be translated and copy them in TeX mode
-\end_layout
-
-\begin_layout Standard
-
-It achieves these main goals pretty well on most files.
-\end_layout
-
-\begin_layout Standard
-
-There are many improvements that can and will be made to reLyX in the future.
- However, we wanted to get reLyX out there early on, to make it easier for
- new LyX users to read in their existing LaTeX files.
-\end_layout
-
-\begin_layout Subsubsection
-
-Usage
-\end_layout
-
-\begin_layout Standard
-
-Here's a more lengthy description of what you should do to translate a LaTeX
- document into LyX.
-\end_layout
-
-\begin_layout Itemize
-
-Run reLyX.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
-reLyX will inform you of its progress and give any warnings to stderr, so
- if you don't want any output at all, try (in csh)
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-reLyX foo.tex >& /dev/null
-\family default
-
-\begin_inset Quotes erd
-\end_inset
-
- or (in bash)
-\begin_inset Quotes eld
-\end_inset
-
-
-\family typewriter
-reLyX foo.tex
-\family default
-
-\family typewriter
-2>&1 >/dev/null
-\family default
-
-\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.
-\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
-\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
-
-\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!!
-\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
-\end_layout
-
-\begin_layout Standard
-
-reLyX understands many LaTeX commands.
- It will translate:
-\end_layout
-
-\begin_layout Itemize
-
-regular text, including mini-commands like ~, '',
-\family typewriter
-
-\backslash
-@
-\family default
-,
-\family typewriter
-
-\backslash
-TeX
-\family default
-, as well as accented characters like
-\family typewriter
-
-\backslash
-'{a}
-\family default
-, and the special cases ?` and !`
-\end_layout
-
-\begin_layout Itemize
-
-title commands like
-\family typewriter
-
-\backslash
-author
-\family default
-,
-\family typewriter
-
-\backslash
-date
-\family default
-,
-\family typewriter
-
-\backslash
-title
-\family default
-,
-\family typewriter
-
-\backslash
-thanks
-\family default
- and the abstract environment
-\end_layout
-
-\begin_layout Itemize
-
-heading commands like
-\family typewriter
-
-\backslash
-section
-\family default
- including starred commands (
-\family typewriter
-
-\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
-\family default
-, and
-\family typewriter
-flushleft
-\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 default
- commands.
- Also, well-behaved nested lists
-\end_layout
-
-\begin_layout Itemize
-
-cross-referencing commands:
-\family typewriter
-
-\backslash
-ref
-\family default
-,
-\family typewriter
-
-\backslash
-pageref
-\family default
-,
-\family typewriter
-
-\backslash
-label
-\family default
-, and
-\family typewriter
-
-\backslash
-cite
-\end_layout
-
-\begin_layout Itemize
-
-
-\family typewriter
-
-\backslash
-footnote
-\family default
- and
-\family typewriter
-
-\backslash
-margin
-\end_layout
-
-\begin_layout Itemize
-
-font-changing commands including
-\family typewriter
-
-\backslash
-em
-\family default
-,
-\family typewriter
-
-\backslash
-emph
-\family default
-,
-\family typewriter
-
-\backslash
-textit
-\family default
-, and corresponding commands to change family, size, series, and shape
-\end_layout
-
-\begin_layout Itemize
-
-
-\family typewriter
-
-\backslash
-input{foo}
-\family default
- (or
-\family typewriter
-
-\backslash
-input{foo.blah}
-\family default
-) and
-\family typewriter
-
-\backslash
-include{foo}
-\family default
-.
- Plain TeX
-\family typewriter
-
-\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
-
-
-\family typewriter
-tabular
-\family default
- environment, and commands that go inside it like
-\family typewriter
-
-\backslash
-hline
-\family default
-,
-\family typewriter
-
-\backslash
-cline
-\family default
-, and
-\family typewriter
-
-\backslash
-multicolumn
-\family default
- (but see below)
-\end_layout
-
-\begin_layout Itemize
-
-float environments
-\family typewriter
-table
-\family default
- and
-\family typewriter
-table*
-\family default
-, as well as
-\family typewriter
-
-\backslash
-caption
-\family default
- commands within them
-\end_layout
-
-\begin_layout Itemize
-
-
-\family typewriter
-thebibliography
-\family default
- environment and
-\family typewriter
-
-\backslash
-bibitem
-\family default
- command, as well as BibTeX's
-\family typewriter
-
-\backslash
-bibliography
-\family default
- and
-\family typewriter
-
-\backslash
-bibliographystyle
-\family default
- commands
-\end_layout
-
-\begin_layout Itemize
-
-miscellaneous commands:
-\family typewriter
-
-\backslash
-hfill
-\family default
-,
-\family typewriter
-
-\backslash
-
-\backslash
-
-\family default
-,
-\family typewriter
-
-\backslash
-noindent
-\family default
-,
-\family typewriter
-
-\backslash
-ldots
-\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
-
-\backslash
-mbox
-\family default
-)
-\end_layout
-
-\begin_layout Standard
-
-Some of this support may not be 100% yet.
- See below for details
-\end_layout
-
-\begin_layout Standard
-
-reLyX copies math (almost) verbatim from your LaTeX file.
- Luckily, LyX reads in LaTeX math, so (almost) any math which is supported
- by LyX should work just fine.
- A few math commands which are not supported by LyX will be replaced with
- their equivalents, e.g.,
-\family typewriter
-
-\backslash
-to
-\family default
- is converted to
-\family typewriter
-
-\backslash
-rightarrow
-\family default
-.
- See the section on
-\shape italic
-Syntax Files
-\shape default
- for more details.
-\end_layout
-
-\begin_layout Standard
-
-reLyX will also copy any preamble commands (i.e., anything before
-\family typewriter
-
-\backslash
-begin{document}
-\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.
-\end_layout
-
-\begin_layout Subsubsection
-
-What reLyX Can't Handle --- But it's OK
-\end_layout
-
-\begin_layout Itemize
-
-figures and
-\family typewriter
-tabular*
-\family default
- tables
-\end_layout
-
-\begin_layout Itemize
-
-minipages
-\end_layout
-
-\begin_layout Itemize
-
-spacing commands (
-\family typewriter
-
-\backslash
-vspace
-\family default
-,
-\family typewriter
-
-\backslash
-pagebreak
-\family default
-,
-\family typewriter
-
-\backslash
-par
-\family default
-)
-\end_layout
-
-\begin_layout Itemize
-
-
-\family typewriter
-
-\backslash
-centering
-\family default
-,
-\family typewriter
-
-\backslash
-raggedleft
-\family default
-,
-\family typewriter
-
-\backslash
-raggedright
-\end_layout
-
-\begin_layout Itemize
-
-
-\family typewriter
-
-\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
-\begin_inset Quotes eld
-\end_inset
-
-foo
-\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}
-
-\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/}
-
-\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
-\begin_inset Quotes eld
-\end_inset
-
-skip
-\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
-
-\backslash
-end
-\family default
- commands will not be put into the LyX file.
-\end_layout
-
-\begin_layout Itemize
-
-
-\begin_inset Quotes eld
-\end_inset
-
-Exact
-\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
-\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
-\family sans
-\bar under
-D
-\bar default
-ocument\SpecialChar \menuseparator
-
-\bar under
-S
-\bar default
-ettings
-\family default
- dialog.
-\end_layout
-
-\begin_deeper
-\begin_layout Standard
-
-More importantly, reLyX doesn't translate
-\family typewriter
-
-\backslash
-usepackage
-\family default
- commands, margin commands,
-\family typewriter
-
-\backslash
-newcommand
-\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
-\family sans
-\bar under
-D
-\bar default
-ocument
-\bar under
-\SpecialChar \menuseparator
-S
-\bar default
-ettings
-\family default
- dialog.
- So you should remove the options from the preamble to be safe.
- The same goes for setting your language with babel,
-\family typewriter
-
-\backslash
-inputencoding
-\family default
-,
-\family typewriter
-
-\backslash
-pagestyle
-\family default
-, etc.
-\end_layout
-\end_deeper
-\begin_layout Itemize
-
-The foil class has a couple bugs.
- reLyX may do weird things with optional arguments to
-\family typewriter
-
-\backslash
-foilhead
-\family default
- commands.
- Also, it may handle
-\family typewriter
-
-\backslash
-begin{dinglist}
-\family default
- incorrectly (although the stuff in the environment should translate normally).
-\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
-
-.
-\end_layout
-
-\begin_layout Subsubsection
-
-What LyX Can't Handle
-\end_layout
-
-\begin_layout Standard
-
-LyX itself is missing a couple features, such that even if reLyX translates
- things perfectly, LyX may still have trouble reading it.
- If you really need these features, you can export your final document as
- 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
-\family default
-,
-\family typewriter
-
-\backslash
-chapter
-\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
+ Clearly, you want the contents of both the
\family sans
-Section*
+Slide
\family default
- or similar
-\end_layout
-
-\begin_layout Itemize
-
-
+ and the
\family sans
-Enumerate:
+Overlay
\family default
- As usual this produces a numbered and indented list as described in the
+ to each fit on a single physical slide! You should probably consider an
-\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
+Overlay
\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
+ as
+\begin_inset Quotes eld
+\end_inset
+part of
+\begin_inset Quotes erd
+\end_inset
+ a
\family sans
-Verbatim:
+Slide
\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
-
-
+.
+ Indeed, the LyX
\family sans
-Author
+slides
\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
-
-
+ class provides a visual cue for this: the label at the start of an
\family sans
-Date:
+Overlay
\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
-
-
+ is shorter than that at the start of a
\family sans
-Abstract
+Slide
\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
-
-
+.
+ Lastly, when you generate printable output, you'll find alignment markers
+ in all four corners of both the
\family sans
-Displaymath
+Overlay
\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
+ page and its parent
\family sans
-Layout
+Slide
\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
+ These will assist you in lining up the two physical slides.
\end_layout
\begin_layout Standard
-
-On the
+The major problem in overlaying two slides is aligning the contents of the
+ two transparencies.
+ How much space should you leave for that graph on the second slide? Worse
+ still, what if you want a graph and a sentence on second slide, but there
+ is text on the main transparency that goes in between them? You could try
+ and insert vertical space of the right size.
+ The better way is to use
\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
+InvisibleText
\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
-
-
+ and
+\family sans
+VisibleText
+\family default
+.
\end_layout
\begin_layout Standard
+As their names imply,
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+ are two command-like paragraph environments that make all subsequent text
+ invisible and visible, respectively.
+ Note from section
+\begin_inset space ~
+\end_inset
-\begin_inset LatexCommand \label{sec:sgmloperate}
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slideQuirk"
\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
+ that you don't place anything
\emph on
-Linux Documentation Project Howto
-\family sans
+into
\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
+ these two environments, however.
+ When you create an
+\family sans
+InvisibleText
\family default
-(with
-\begin_inset Formula $x\geq3$
+, it inserts a centered, sky-blue label into the page reading
+\begin_inset Quotes eld
\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}
-
+<Invisible Text Follows>
+\begin_inset Quotes erd
\end_inset
-
+.
+ For paragraphs following this label, the parts of the
+\family sans
+Slide
+\family default
+ [or
+\family sans
+Overlay
\family default
+; it doesn't matter which] where they would be contain instead blank space.
\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
+For
+\family sans
+VisibleText
\family default
-.
-\end_layout
-
+, the corresponding centered label is
+\begin_inset Quotes eld
\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}
-
+<Visible Text Follows>
+\begin_inset Quotes erd
\end_inset
-
-\end_layout
-
-\begin_layout Standard
-
-
-\family roman
-The
+ in blazing green.
+ Paragraphs following this label behave normally.
+ Note that the beginning of a new
+\family sans
+Slide
\family default
- file
-\family typewriter
-sgml-tools-1.0.x.tar.gz
+,
+\family sans
+Overlay
\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
+, or
+\family sans
+Note
\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
+ automatically shuts off an
\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
+InvisibleText
+\family default
+.
+ It's therefore not necessary to use
+\family sans
+VisibleText
+\family default
+ at the end of a
+\family sans
+Slide
+\family default
+.
\end_layout
\begin_layout Standard
-
-by
-\noun on
-Asger Alstrup
+By now, it should be obvious how to create overlay transparencies using
+ the proper combination of
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+ on a
+\family sans
+Slide
+\family default
+ and
+\family sans
+Overlay
+\family default
+:
\end_layout
-\begin_layout Subsection
-
-Introduction
+\begin_layout Enumerate
+Create a
+\family sans
+Slide
+\family default
+, including everything that will appear on it, whether on the main slide
+ or on the
+\family sans
+Overlay
+\family default
+.
\end_layout
-\begin_layout Standard
-
-Under the
+\begin_layout Enumerate
+Before each figure or paragraph that will appear only on the
\family sans
-\bar under
-T
-\bar default
-ools
+Overlay
\family default
- menu, you'll find a
+, insert an
\family sans
-\bar under
-C
-\bar default
-heck\InsetSpace ~
-TeX
+InvisibleText
\family default
- command.
- This feature requires you to have the
-\family typewriter
-chktex
+ environment.
+ If necessary, insert a
+\family sans
+VisibleText
\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
-
-.
+ environment after the
+\family sans
+Overlay
+\family default
+-only text.
\end_layout
-\begin_layout Standard
-
-The
+\begin_layout Enumerate
+Start an
\family sans
-ChkTeX
+Overlay
\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
+ immediately following the
+\family sans
+Slide
\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
+\begin_layout Enumerate
+Copy the contents of this
+\family sans
+Slide
\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,
+ into the
+\family sans
+Overlay
+\family default
+.
+\end_layout
+
+\begin_layout Enumerate
+Within the
\family sans
-ChkTeX
+Overlay
\family default
- catches some common
-\emph on
-typographic
-\emph default
- errors, in addition to the syntactical ones.
- Specifically,
+, change all of the
\family sans
-ChkTeX
+InvisibleText
\family default
- is capable of detecting several common errors, such as
+ lines to
+\family sans
+VisibleText
+\family default
+ and vice-versa.
\end_layout
-\begin_layout Itemize
-
-Ellipsis detection:
-\newline
-Use \SpecialChar \ldots{}
- instead of ...
+\begin_layout Standard
+That's it.
+ You've just made an
+\family sans
+Overlay
+\family default
+.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+There's one problem with the way I've designed the LyX
+\family sans
+slides
+\family default
+ class: you can't make text in the middle of a paragraph invisible, nor
+ make text in the middle of an invisible paragraph visible again.
+ To accomplish this feat, you'll need to use some inlined LaTeX codes.
+\begin_inset Foot
+status collapsed
-No space in front of/after parenthesis:
-\newline
-( wrong spacing )
+\begin_layout Plain Layout
+The commands of interest are:
\end_layout
\begin_layout Itemize
-Enforcement of normal space after common abbreviations:
-\newline
-e.
- g.
- is too wide spacing.
+\family typewriter
+{
+\backslash
+invisible \SpecialChar \ldots{}
+ }
\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.
+\family typewriter
+{
+\backslash
+visible \SpecialChar \ldots{}
+ }
\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}
-
+\begin_layout Plain Layout
+\SpecialChar \ldots{}
+and need to be marked as TeX.
+ The text whose
+\begin_inset Quotes eld
\end_inset
-
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-
-This footnote is in danger of falling off to a wrong page
-\end_layout
-
+visibility
+\begin_inset Quotes erd
\end_inset
- The label is separated too much.
-\end_layout
-
-\begin_layout Itemize
-
-Space in front of references, instead of hard spaces:
-\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}
+ you wish to change goes in between the brackets [and after the
+\family typewriter
-\end_inset
+\backslash
+invisible
+\family default
+ or
+\family typewriter
+\backslash
+visible
+\family default
+ command].
+ If you don't know how to mark text as TeX, see the appropriate section
+ of the
+\emph on
+User's Guide
+\emph default
.
\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
+\begin_layout Subsubsection
+Using
+\family sans
+Note
+\family default
+ with
+\family sans
+Slide
+\family default
-and more \SpecialChar \ldots{}
- It is an invaluable tool when you are
-\begin_inset Quotes eld
-\end_inset
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:slideNote"
-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
+Like an
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-C
-\bar default
-heck\InsetSpace ~
-TeX
+Overlay
\family default
-.
- This will make LyX generate a LaTeX file of your document, start
+, a
\family sans
-ChkTeX
+Note
\family default
- to check it, and then make LyX insert
+ is associated with a
\begin_inset Quotes eld
\end_inset
-error boxes
+parent
\begin_inset Quotes erd
\end_inset
- with the warnings from
+
\family sans
-ChkTeX
+Slide
\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
+.
+ Here, too, the LyX
\family sans
-\bar under
-N
-\bar default
-avigate\SpecialChar \menuseparator
-
-\bar under
-E
-\bar default
-rror
+slides
\family default
- menu item, or the shortcut key
+ class provides visual cues.
+ The label for a
\family sans
-C-g
-\family default
- from the default
-\family typewriter
-cua
+Note
\family default
- bind file.
- Open the error boxes by clicking on them with the mouse, or use the shortcut
- key
+ is shorter than that of a
\family sans
-C-i
+Slide
\family default
- from
-\family typewriter
-cua
+ [yet longer than that of an
+\family sans
+Overlay
\family default
- bindings, or the corresponding
+] and, like the label of an
\family sans
-C-o
+Overlay
\family default
- for the alternate
-\family typewriter
-emacs
+ is shockingly magenta.
+ Additionally, the printed
+\family sans
+Note
\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
+ has the page number of its
+\begin_inset Quotes eld
+\end_inset
+
+parent
+\begin_inset Quotes erd
+\end_inset
+
+
\family sans
-ChkTeX
+Slide
\family default
-, and this gap can make some warnings seem arcane or just right down plain
- silly.
-\end_layout
+, appended by
+\begin_inset Quotes eld
+\end_inset
-\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
+\family typewriter
+-
+\family default
+1
+\begin_inset Quotes erd
+\end_inset
+
+,
+\begin_inset Quotes eld
+\end_inset
+
-\begin_layout Subsection
+\family typewriter
+-
+\family default
+2
+\begin_inset Quotes erd
+\end_inset
-How to fine tune it
-\end_layout
+,
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Sometimes, you'll find that
-\family sans
-ChkTeX
+\family typewriter
+-
\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
+3
+\begin_inset Quotes erd
+\end_inset
+
+, etc.
+ You can have multiple
\family sans
-ChkTeX
+Note
\family default
- to get better along with you.
- Another choice in the most desperate situations is to use
+s associated with a single
\family sans
-\bar under
-V
-\bar default
-iew\SpecialChar \menuseparator
-
-\bar under
-R
-\bar default
-emove\InsetSpace ~
-All\InsetSpace ~
-Error\InsetSpace ~
-Boxes
+Slide
\family default
-, which will get rid of all warnings instantly.
-\end_layout
-
-\begin_layout Standard
-
-Although
+, and, as with
\family sans
-ChkTeX
+Slide
\family default
-
-\emph on
-is
-\emph default
- very configurable and extensible, you shouldn't expect to solve all problems
- with
+ and
\family sans
-ChkTeX
+Overlay
\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
+, you'll probably want to break up long
\family sans
-ChkTeX
+Note
\family default
- output
-\begin_inset Foot
-status collapsed
+s so that they fit on a single sheet of paper.
+\end_layout
\begin_layout Standard
-
-You can inspect the specific output from
+The purpose of a
\family sans
-chktex
+Note
\family default
- by using
+ is obvious: it contains anything additional you might want to say about
+ a
\family sans
-Edit\SpecialChar \menuseparator
-View\InsetSpace ~
-LaTeX\InsetSpace ~
-Log
+Slide
\family default
- right after a
+.
+ It could also be used as a sheet of reminders for a particular
\family sans
-chktex
+Slide
\family default
- run.
-\end_layout
+.
+ In the case of the latter, you might want to make use of time markers.
+ Currently, the LyX
+\family sans
+slides
+\family default
+ class has no
+\begin_inset Quotes eld
+\end_inset
+native
+\begin_inset Quotes erd
\end_inset
- to the internal document structure, some of the warnings will not seen
- to appear correctly.
- There are two things you can do about this:
+ support for time markers, a
+\noun on
+SliTeX
+\noun default
+ feature.
+ So, you'll have to resort to using the LaTeX codes.
\end_layout
-\begin_layout Itemize
+\begin_layout Standard
+To use time markers, you'll need to specify the extra class option
+\begin_inset Quotes eld
+\end_inset
-Fine tune the
-\family sans
-ChkTeX
-\family default
- invocation command line in
-\family sans
-Preferences
+
+\family typewriter
+clock
\family default
- (tabs
+
+\begin_inset Quotes erd
+\end_inset
+
+ [see section
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:slidesetup"
+
+\end_inset
+
+].
+ This option turns on timing marks, which will appear in the lower-left-hand
+ corner of every
\family sans
-Outputs
+Note
\family default
-,
-\family sans
-Misc
+ you generate.
+ To set what appears in the time marker, you use the LaTeX commands
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+settime{}
\family default
-), or the global
-\family sans
-ChkTeX
+
+\begin_inset Quotes erd
+\end_inset
+
+ and
+\begin_inset Quotes eld
+\end_inset
+
+
+\family typewriter
+
+\backslash
+addtime{}
\family default
- installation configuration file (usually with the file
+
+\begin_inset Quotes erd
+\end_inset
+
+.
+ The arguments of both commands are time measured in seconds.
+
+\begin_inset Quotes eld
+\end_inset
+
+
\family typewriter
-/usr/local/share/chktexrc
+
+\backslash
+settime{}
\family default
-).
- See below to learn what warnings can be enabled and disabled on the command
- line.
+
+\begin_inset Quotes erd
+\end_inset
+
+ sets the time marker to a given time.
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-Export your document as a raw LaTeX file using
-\family sans
-\bar under
-F
-\bar default
-ile\SpecialChar \menuseparator
+\family typewriter
-\bar under
-E
-\bar default
-xport\SpecialChar \menuseparator
+\backslash
+addtime{}
+\family default
-\bar under
-L
-\bar default
-aTeX
+\begin_inset Quotes erd
+\end_inset
+
+ increments the time marker by the specified amount.
+ Using time markers and
+\family sans
+Note
\family default
- and run
-\family typewriter
-chktex
+s in this fashion, you can remind yourself how much time to spend on a particula
+r
+\family sans
+Slide
\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
+There's one last feature to describe.
+ Clearly, you'd like to print out all of your
\family sans
-Preferences
+Slide
\family default
-.
- Use
-\family typewriter
--n#
+s and
+\family sans
+Overlay
\family default
- to disable a warning, and
-\family typewriter
--w#
+s on transparencies while printing all of your
+\family sans
+Note
\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
+s on plain paper.
+ However, a
+\family sans
+Note
\family default
-".
+
+\emph on
+must
+\emph default
+ follow the
+\family sans
+Slide
+\family default
+ with which it is associated.
+ What's a person to do?
\end_layout
\begin_layout Standard
+Luckily, there are two LaTeX commands that allow you to select what to print
+ out.
+ Both must be placed into the preamble of your document.
+ The command
+\begin_inset Quotes eld
+\end_inset
+
-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
+
+\backslash
+onlyslides{
+\backslash
+slides}
\family default
-.
-\end_layout
-\begin_layout Enumerate
+\begin_inset Quotes erd
+\end_inset
+ will cause the output to contain only the
+\family sans
+Slide
+\family default
+s and
+\family sans
+Overlay
+\family default
+s.
+ Correspondingly, the command
+\begin_inset Quotes eld
+\end_inset
-\size small
-\emph on
-Command terminated with space.
-\end_layout
-\begin_layout Enumerate
+\family typewriter
+\backslash
+onlynotes{
+\backslash
+notes}
+\family default
-\size small
-Non-breaking space (
+\begin_inset Quotes erd
+\end_inset
+
+ prevents the output of anything but
+\family sans
+Note
+\family default
+s.
+ I'd advise placing both commands in the preamble and initially comment
+ both out.
+ You can then preview your entire presentation as you write.
+ When you're done writing, you can then uncomment one of the two to select
+ what you want to print.
+ I like to uncomment
\begin_inset Quotes eld
\end_inset
\family typewriter
-~
+
+\backslash
+onlyslides{
+\backslash
+slides}
\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
+ , print to a file with
\begin_inset Quotes eld
\end_inset
\family typewriter
-{}
+-slides
\family default
\begin_inset Quotes erd
\end_inset
-.
-\end_layout
-
-\begin_layout Enumerate
-
-
-\size small
-Italic correction (
+ in its name, comment it back out, then uncomment
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
-/
+onlynotes{
+\backslash
+notes}
\family default
\begin_inset Quotes erd
\end_inset
-) found in non-italic buffer.
-\end_layout
+ and print to a
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Enumerate
+\family typewriter
+*-notes.ps
+\family default
-\size small
-Italic correction (
+\begin_inset Quotes erd
+\end_inset
+
+ file.
+ I can then send either file to a printer, loading transparencies or plain
+ paper as appropriate.
+\end_layout
+
+\begin_layout Standard
+You can also provide other arguments to the
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
-/
+onlyslides{}
\family default
\begin_inset Quotes erd
\end_inset
-) found more than once.
-\end_layout
-
-\begin_layout Enumerate
-
-
-\size small
-\emph on
-No italic correction (
+ and
\begin_inset Quotes eld
\end_inset
\family typewriter
\backslash
-/
+onlynotes{}
\family default
\begin_inset Quotes erd
\end_inset
-) found.
+ commands.
+ See a good LaTeX book for details.
\end_layout
-\begin_layout Enumerate
-
+\begin_layout Subsection
+The
+\family sans
+slides
+\family default
+ Class Template File
+\end_layout
-\size small
-Accent command
+\begin_layout Standard
+I have also provided a template file,
\begin_inset Quotes eld
\end_inset
\family typewriter
-cmd
+slides.lyx
\family default
\begin_inset Quotes erd
\end_inset
- needs use of
-\begin_inset Quotes eld
+, with the
+\family sans
+slides
+\family default
+ class.
+ To use it, begin your new presentation with
+\family sans
+\bar under
+F
+\bar default
+ile\SpecialChar \menuseparator
+New
+\begin_inset space ~
\end_inset
+from
+\begin_inset space ~
+\end_inset
-\family typewriter
-cmd
+
+\bar under
+T
+\bar default
+emplate
+\family default
+.
+ Your new LyX presentation file will contain an example
+\family sans
+Slide
+\family default
+ –
+\family sans
+Overlay
+\family default
+ –
+\family sans
+Note
+\family default
+ triplet.
+ The
+\family sans
+Slide
\family default
+ and
+\family sans
+Overlay
+\family default
+ additionally contain an example of the use of
+\family sans
+InvisibleText
+\family default
+ and
+\family sans
+VisibleText
+\family default
+.
+ Lastly, the preamble will contain:
+\end_layout
-\begin_inset Quotes erd
+\begin_layout LyX-Code
+% Uncomment to print out only slides and overlays
+\end_layout
+
+\begin_layout LyX-Code
+%
+\end_layout
+
+\begin_layout LyX-Code
+%
+\backslash
+onlyslides{
+\backslash
+slides}
+\begin_inset Newline newline
\end_inset
-.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout LyX-Code
+% Uncomment to print out only notes
+\end_layout
+\begin_layout LyX-Code
+%
+\end_layout
-\size small
-Wrong length of dash may have been used.
+\begin_layout LyX-Code
+%
+\backslash
+onlynotes{
+\backslash
+notes}
\end_layout
-\begin_layout Enumerate
+\begin_layout Standard
+One final thing: I created this class to support the LaTeX2e
+\begin_inset Quotes eld
+\end_inset
+
+
+\noun on
+SliTeX
+\noun default
+ emulation
+\begin_inset Quotes erd
+\end_inset
+
+ class, one of the built-in LaTeX2e classes.
+ Neither I nor the rest of the LyX Team endorse or oppose the use of this
+ built-in slide class.
+ It's here if you want it or need it.
+ There exist other LaTeX2e classes for creating presentations, such as the
+
+\family sans
+Foils
+\family default
+ class [see section
+\begin_inset space ~
+\end_inset
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:foiltex"
-\size small
-\emph on
+\end_inset
+] or the
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+seminar
\family default
\begin_inset Quotes erd
\end_inset
- expected, found
-\begin_inset Quotes eld
-\end_inset
+ package [present on some TeX distributions].
+ The latter is not yet supported under LyX.
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+Perhaps you can take on the task\SpecialChar \ldots{}
-\family typewriter
-%s
-\family default
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+ I know nothing about these other classes.
+ Try them out to see what sort of alternative they provide.
\end_layout
-\begin_layout Enumerate
+\begin_layout Chapter
+LyX Features needing Extra Software
+\end_layout
+\begin_layout Section
+Checking TeX
+\end_layout
-\size small
-Solo
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+by
+\noun on
+Asger Alstrup
+\end_layout
+\begin_layout Subsection
+Introduction
+\end_layout
+\begin_layout Standard
+If you have the
\family typewriter
-%s
+chktex
\family default
+ program installed
+\begin_inset Foot
+status collapsed
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
- found.
+\family typewriter
+chktex
+\family default
+ is not yet available when you are using the LaTeX distribution MiKTeX.
\end_layout
-\begin_layout Enumerate
-
-
-\size small
-You should use
-\begin_inset Quotes eld
\end_inset
+, you'll find in the
+\family sans
+Tools
+\family default
+ menu the entry:
+\family sans
+Check
+\begin_inset space ~
+\end_inset
+TeX
+\family default
+.
+ You can get
\family typewriter
-%s
+chktex
\family default
+ it from CTAN,
+\begin_inset CommandInset href
+LatexCommand href
+target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
-\begin_inset Quotes erd
\end_inset
- to achieve an ellipsis.
+.
\end_layout
-\begin_layout Enumerate
-
+\begin_layout Standard
+The
+\family sans
+ChkTeX
+\family default
+ package is a program that was written by
+\begin_inset Flex CharStyle:Noun
+status collapsed
-\size small
-Inter-word spacing (
-\begin_inset Quotes eld
+\begin_layout Plain Layout
+Jens T.
+\begin_inset space ~
\end_inset
+Berger Thielemann
+\end_layout
+
+\end_inset
+ in frustration because some constructs in LaTeX are sometimes non-intuitive,
+ and easy to forget.
+ The program runs over your LaTeX file, checks the integrity of the file,
+ and flags some common errors.
+ In other technical words, it is
\family typewriter
+lint
+\family default
+ for LaTeX.
+\end_layout
-\backslash
-
+\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_inset Quotes eld
+\begin_layout Itemize
+Ellipsis detection:
+\begin_inset Newline newline
\end_inset
-) should perhaps be used.
+Use \SpecialChar \ldots{}
+ instead of ...
\end_layout
-\begin_layout Enumerate
-
-
-\size small
-Inter-sentence spacing (
-\begin_inset Quotes eld
+\begin_layout Itemize
+No space in front of/after parenthesis:
+\begin_inset Newline newline
\end_inset
+( wrong spacing )
+\end_layout
-\family typewriter
+\begin_layout Itemize
+Enforcement of normal space after common abbreviations:
+\begin_inset Newline newline
+\end_inset
-\backslash
-@
-\family default
+e.
+\begin_inset space \thinspace{}
+\end_inset
-\begin_inset Quotes erd
+g.
+\begin_inset space \space{}
\end_inset
-) should perhaps be used.
+is too wide spacing.
\end_layout
-\begin_layout Enumerate
-
+\begin_layout Itemize
+Enforcement of end-of-sentence space when the last sentence ends with a
+ capital letter:
+\begin_inset Newline newline
+\end_inset
-\size small
-Could not find argument for command.
+This is a TEST.
+ And this is wrong spacing.
\end_layout
-\begin_layout Enumerate
+\begin_layout Itemize
+Space in front of labels and similar commands:
+\begin_inset Newline newline
+\end_inset
+The label should stick right up to the text to avoid falling to a wrong
+ page.
+
+\begin_inset CommandInset label
+LatexCommand label
+name "sec:chktex"
-\size small
-No match found for
-\begin_inset Quotes eld
\end_inset
+
+\begin_inset Foot
+status collapsed
-\family typewriter
-%s
-\family default
+\begin_layout Plain Layout
+This footnote is in danger of falling off to a wrong page
+\end_layout
-\begin_inset Quotes erd
\end_inset
-.
+ The label is separated too much.
\end_layout
-\begin_layout Enumerate
-
+\begin_layout Itemize
+Space in front of references, instead of hard spaces:
+\begin_inset Newline newline
+\end_inset
-\size small
-Math mode still on at end of LaTeX file.
-\end_layout
+In you are in bad luck, the text will break right between the referenced
+ text and reference number, and that's a pity.
+ See section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "sec:chktex"
-\begin_layout Enumerate
+\end_inset
+.
+\end_layout
-\size small
-Number of
+\begin_layout Itemize
+Use of
\begin_inset Quotes eld
\end_inset
+x
+\begin_inset Quotes erd
+\end_inset
-\family typewriter
-char
-\family default
+ instead of
+\begin_inset Formula $\times$
+\end_inset
-\begin_inset Quotes erd
+ between numbers:
+\begin_inset Newline newline
\end_inset
- doesn't match the number of
-\begin_inset Quotes eld
+2x2 looks cheap compared to
+\begin_inset Formula $2\times2$
\end_inset
+.
+\end_layout
-\family typewriter
-char
-\family default
+\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 Enumerate
-
+\begin_layout Subsection
+How to use it
+\end_layout
-\size small
-You should use either
-\family typewriter
+\begin_layout Standard
+If you have the program installed, usage is as simple as choosing
+\family sans
+Tools\SpecialChar \menuseparator
+Check
+\begin_inset space ~
+\end_inset
+TeX
+\family default
+.
+ This will make LyX generate a LaTeX file of your document, start
+\family sans
+ChkTeX
+\family default
+ to check it, and then make LyX insert
\begin_inset Quotes eld
\end_inset
-
-\family default
- or
-\family typewriter
-
+error boxes
\begin_inset Quotes erd
\end_inset
-
+ with the warnings from
+\family sans
+ChkTeX
\family default
- as an alternative to
-\begin_inset Quotes eld
-\end_inset
-
-
+, if there were any.
+ The warnings will be placed close to the point of the mistake, and you
+ can quickly find them by using the
+\family sans
+Navigate\SpecialChar \menuseparator
+Error
+\family default
+ menu item, or the shortcut key
+\family sans
+C-g
+\family default
+ from the default
\family typewriter
-"
+cua
\family default
-
-\begin_inset Quotes erd
-\end_inset
-
-.
-\end_layout
-
-\begin_layout Enumerate
-
-
-\size small
-You should use "
+ 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
-" (ASCII 39) instead of "
+ bindings, or the corresponding
+\family sans
+C-o
+\family default
+ for the alternate
\family typewriter
-´
+emacs
\family default
-" (ASCII 180).
-\end_layout
-
-\begin_layout Enumerate
-
-
-\size small
-User-specified pattern found.
+ 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 Enumerate
-
-
-\size small
-This command might not be intended.
+\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 Enumerate
-
-
-\size small
-\emph on
-Comment displayed.
+\begin_layout Subsection
+How to fine tune it
\end_layout
-\begin_layout Enumerate
-
-
-\size small
-Either
-\family typewriter
-''
-\backslash
-,'
+\begin_layout Standard
+Sometimes, you'll find that
+\family sans
+ChkTeX
\family default
- or
-\family typewriter
-'
-\backslash
-,''
+ 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
- will look better.
-\end_layout
+ to get better along with you.
+ Another choice in the most desperate situations is to use
+\family sans
+View\SpecialChar \menuseparator
+Remove
+\begin_inset space ~
+\end_inset
-\begin_layout Enumerate
+All
+\begin_inset space ~
+\end_inset
+Error
+\begin_inset space ~
+\end_inset
-\size small
-Delete this space to maintain correct page references.
+Boxes
+\family default
+, which will get rid of all warnings instantly.
\end_layout
-\begin_layout Enumerate
-
-
-\size small
+\begin_layout Standard
+Although
+\family sans
+ChkTeX
+\family default
+
\emph on
-You might wish to put this between a pair of
-\begin_inset Quotes eld
-\end_inset
-
+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
-\family typewriter
-{}
+\begin_layout Plain Layout
+You can inspect the specific output from
+\family sans
+chktex
\family default
+ by using
+\family sans
+Edit\SpecialChar \menuseparator
+View
+\begin_inset space ~
+\end_inset
-\begin_inset Quotes erd
+LaTeX
+\begin_inset space ~
\end_inset
-.
+Log
+\family default
+ right after a
+\family sans
+chktex
+\family default
+ run.
\end_layout
-\begin_layout Enumerate
-
+\end_inset
-\size small
-You ought to remove spaces in front of punctuation.
+ 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 Enumerate
-
-
-\size small
-Could not execute LaTeX command.
+\begin_layout Itemize
+Fine tune the
+\family sans
+ChkTeX
+\family default
+ invocation command line in
+\family sans
+Preferences
+\family default
+ (tabs
+\family sans
+Outputs
+\family default
+,
+\family sans
+Misc
+\family default
+), or the global
+\family sans
+ChkTeX
+\family default
+ installation configuration file (usually with the file
+\family typewriter
+chktexrc
+\family default
+).
+ See below to learn what warnings can be enabled and disabled on the command
+ line.
+
\end_layout
-\begin_layout Enumerate
-
+\begin_layout Itemize
+Export your document as a raw LaTeX file using
+\family sans
+File\SpecialChar \menuseparator
+Export\SpecialChar \menuseparator
+LaTeX
+\family default
+ and run
+\family typewriter
+chktex
+\family default
+ manually on that.
+ Invoked in this way, it can be a hassle to find the corresponding place
+ in the document inside LyX, but with a little patience, you should be able
+ to do it.
+\end_layout
-\size small
-Don't use
+\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
-
-\backslash
-/
+chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
\family default
- in front of small punctuation.
+".
\end_layout
-\begin_layout Enumerate
-
-
+\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
-\size small
-$
-\backslash
-times$
+chktex
\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.
+Command terminated with space.
\end_layout
\begin_layout Enumerate
-
\size small
-Use
-\family typewriter
-
+Non-breaking space (
\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
+\begin_inset Quotes erd
\end_inset
-
-\family default
-.
-\end_layout
-
-\begin_layout Enumerate
-
-
-\size small
-Don't mix quotes.
+) should have been used.
\end_layout
\begin_layout Enumerate
-
\size small
-You should perhaps use
+\emph on
+You should enclose the previous parenthesis with
\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
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
-\size small
-You should avoid spaces in front of/after parenthesis.
-\end_layout
+\family typewriter
-\begin_layout Enumerate
+\backslash
+/
+\family default
+\begin_inset Quotes erd
+\end_inset
-\size small
-\emph on
-You should not use punctuation in front of/after quotes.
+) found in non-italic buffer.
\end_layout
\begin_layout Enumerate
-
\size small
-Double space found.
-\end_layout
-
-\begin_layout Enumerate
+Italic correction (
+\begin_inset Quotes eld
+\end_inset
-\size small
-You should put punctuation outside inner/inside display math mode.
-\end_layout
+\family typewriter
-\begin_layout Enumerate
+\backslash
+/
+\family default
+\begin_inset Quotes erd
+\end_inset
-\size small
-You ought to not use primitive TeX in LaTeX code.
+) found more than once.
\end_layout
\begin_layout Enumerate
-
\size small
-You should remove spaces in front of
+\emph on
+No italic correction (
\begin_inset Quotes eld
\end_inset
\family typewriter
-%s
+
+\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
-%s
+cmd
\family default
\begin_inset Quotes erd
\end_inset
- is normally not followed by
+ needs use of
\begin_inset Quotes eld
\end_inset
\family typewriter
-%c
+cmd
\family default
\begin_inset Quotes erd
.
\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
+\begin_layout Enumerate
-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.
+\size small
+Wrong length of dash may have been used.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-Before you begin to use the version control features in LyX, you should
- read
+\size small
+\emph on
\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
-
-\bar under
-V
-\bar default
-ersion\InsetSpace ~
-Control
-\family default
- submenu.
-\end_layout
-
-\begin_layout Subsubsection
-
-
-\family sans
-Register
-\end_layout
-
-\begin_layout Standard
-
-If your document is not under revision control, this is the only item shown
- in the menu.
- And if it is under revision control, the
-\family sans
-\bar under
-R
-\bar default
-egister
+%s
\family default
- item is grayed out.
-
-\end_layout
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-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
-Check\InsetSpace ~
-Out\InsetSpace ~
-For\InsetSpace ~
-Edit
-\family default
-, before making any changes to it.
- A document under revision control has a
+ expected, found
\begin_inset Quotes eld
\end_inset
-[RCS:<version> <locker>]
+
+\family typewriter
+%s
+\family default
+
\begin_inset Quotes erd
\end_inset
- item tagged to the filename in the minibuffer.
+.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-RCS command that is run:
-\family typewriter
-ci -q -u -i -t-"<initial description>" <file-name>
-\end_layout
+\size small
+Solo
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Read
\family typewriter
-man ci
+%s
\family default
- to understand the switches.
-
-\end_layout
-
-\begin_layout Subsubsection
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Check In Changes
+ found.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-When you are finished editing a file, you check in your changes.
- When you do this, you are asked for a description of the changes.
- This is stored in the history log.
- The version number is bumped, your changes are applied to the master RCS
- file, the document is unlocked and set to Read-Only mode.
-
-\end_layout
+\size small
+You should use
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-RCS command:
\family typewriter
-ci -q -u -m"<description>" <file-name>
-\end_layout
-
-\begin_layout Subsubsection
+%s
+\family default
+\begin_inset Quotes erd
+\end_inset
-\family sans
-Check Out For Edit
+ to achieve an ellipsis.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-By doing this you lock the document so that only you can edit it.
- This will also make the document Read-Write only for you.
- You will usually continue editing for a while and when you are finished
- you check in your changes.
- The status line is changed to reflect that you have locked the file.
-
-\end_layout
+\size small
+Inter-word spacing (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-RCS command:
\family typewriter
-co -q -l <file-name>
-\end_layout
-\begin_layout Subsubsection
+\backslash
+\family default
+
+\begin_inset Quotes eld
+\end_inset
-\family sans
-Revert To Last Version
+) should perhaps be used.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-This will discard all changes made to the document since the last check
- in.
- You get a warning before changes are discarded.
-\end_layout
+\size small
+Inter-sentence spacing (
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-RCS command:
\family typewriter
-co -f -u<version> <file-name>
-\end_layout
-
-\begin_layout Subsubsection
+\backslash
+@
+\family default
-\family sans
-Undo Last Checkin
-\end_layout
-
-\begin_layout Standard
+\begin_inset Quotes erd
+\end_inset
-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.
-
+) should perhaps be used.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-RCS command:
-\family typewriter
-rcs -o<version> <file-name>
+\size small
+Could not find argument for command.
\end_layout
-\begin_layout Subsubsection
-
+\begin_layout Enumerate
-\family sans
-Show History
-\end_layout
+\size small
+No match found for
+\begin_inset Quotes eld
+\end_inset
-\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
+%s
\family default
- for more info.
-\end_layout
-\begin_layout Section
-
-Literate Programming
-\end_layout
-
-\begin_layout Standard
-
-Updated by
-\noun on
-Kayvan Sylvan
-\noun default
-(kayvan@sylvan.com)
-\noun on
-,
-\noun default
-original documentation written by
-\noun on
-Edmar Wienskoski Jr.
+\begin_inset Quotes erd
+\end_inset
-\noun default
- (edmar-w-jr@technologist.com)
+.
\end_layout
-\begin_layout Subsection
+\begin_layout Enumerate
-Introduction
+\size small
+Math mode still on at end of LaTeX file.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-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
+\size small
+Number of
\begin_inset Quotes eld
\end_inset
-tangling
-\begin_inset Quotes erd
-\end_inset
- and
-\begin_inset Quotes eld
-\end_inset
+\family typewriter
+char
+\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.
-\end_layout
-
-\begin_layout Subsection
-
-Literate Programming
-\end_layout
+ doesn't match the number of
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-From the Literate Programming FAQ:
-\end_layout
+\family typewriter
+char
+\family default
-\begin_layout Quotation
+\begin_inset Quotes erd
+\end_inset
-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
+\begin_layout Enumerate
-\begin_layout Quotation
+\size small
+You should use either
+\family typewriter
+\begin_inset Quotes eld
+\end_inset
-\emph on
-How is literate programming different from verbose commenting?
-\end_layout
-\begin_layout Quotation
+\family default
+ or
+\family typewriter
-There are three distinguishing characteristics.
- In order of importance, they are:
-\end_layout
+\begin_inset Quotes erd
+\end_inset
-\begin_deeper
-\begin_layout Itemize
-flexible order of elaboration
-\end_layout
+\family default
+ as an alternative to
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Itemize
-automatic support for browsing
-\end_layout
+\family typewriter
+"
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-typeset documentation, especially diagrams and mathematics
+.
\end_layout
-\end_deeper
-\begin_layout Standard
-Now that I sparked your curiosity, take a look in the references.
+\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 Subsubsection
+\begin_layout Enumerate
-References
+\size small
+User-specified pattern found.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-The complete Literate Programming FAQ can be found at:
+\size small
+This command might not be intended.
\end_layout
-\begin_layout Quote
+\begin_layout Enumerate
+\size small
+\emph on
+Comment displayed.
+\end_layout
-\begin_inset LatexCommand \url[Literate Programming FAQ]{http://shelob.ce.ttu.edu/daves/lpfaq/faq.html}
+\begin_layout Enumerate
-\end_inset
+\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 Standard
+\begin_layout Enumerate
-The FAQ lists 23 (twenty three!) different literate programming tools.
- Where some are specialized or
+\size small
+\emph on
+You might wish to put this between a pair of
\begin_inset Quotes eld
\end_inset
-tailored
+
+\family typewriter
+{}
+\family default
+
\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
+\begin_layout Enumerate
-It can generate the documentation either in latex or html.
+\size small
+You ought to remove spaces in front of punctuation.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-It has a open architecture, i.e., it is easy to plug in new filters and to
- perform special processing that you may need.
-
+\size small
+Could not execute LaTeX command.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-There is a good selection of filters available already (the html is one
- of them).
+\size small
+Don't use
+\family typewriter
+
+\backslash
+/
+\family default
+ in front of small punctuation.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-It is free.
+\family typewriter
+\size small
+$
+\backslash
+times$
+\family default
+ may look prettier here.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-The Noweb web page can be found at:
+\size small
+\emph on
+Multiple spaces detected in output.
\end_layout
-\begin_layout Quote
-
+\begin_layout Enumerate
-\begin_inset LatexCommand \url[Noweb home page]{http://www.cs.virginia.edu/~nr/noweb/}
+\size small
+This text may be ignored.
+\end_layout
-\end_inset
+\begin_layout Enumerate
+\size small
+Use
+\family typewriter
-\end_layout
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-Starting from there you can reach many other interesting links and even
- some literate program examples.
+\family default
+ to begin quotation, not
+\family typewriter
+'
+\family default
+.
\end_layout
-\begin_layout Subsection
-
-LyX and Literate Programming
-\end_layout
+\begin_layout Enumerate
-\begin_layout Standard
+\size small
+Use
+\family typewriter
+'
+\family default
+ to end quotation, not
+\family typewriter
-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
-Noweb independent
-\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.
+\family default
+.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Enumerate
-Generating documents and code (weaving and tangling)
+\size small
+Don't mix quotes.
\end_layout
-\begin_layout Paragraph
+\begin_layout Enumerate
-Selecting the document class
-\end_layout
+\size small
+You should perhaps use
+\begin_inset Quotes eld
+\end_inset
-\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
+\family typewriter
+cmd
+\family default
-\begin_layout Itemize
+\begin_inset Quotes erd
+\end_inset
-Article (Noweb)
+ instead.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-Book (Noweb)
+\size small
+You should put a space in front of/after parenthesis.
\end_layout
-\begin_layout Itemize
+\begin_layout Enumerate
-Report (Noweb)
+\size small
+You should avoid spaces in front of/after parenthesis.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-You must select one of them to create your literate documents from.
-
+\size small
+\emph on
+You should not use punctuation in front of/after quotes.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-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
+Double space found.
+\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
-It is very simple, it involves the creation of a file with four lines, and
- re-running of the auto configuration.
+\size small
+You should put punctuation outside inner/inside display math mode.
\end_layout
-\end_inset
+\begin_layout Enumerate
- Moreover, if you use a literate tool other than Noweb you may need to create
- a new set of document classes for it.
+\size small
+You ought to not use primitive TeX in LaTeX code.
\end_layout
-\begin_layout Paragraph
+\begin_layout Enumerate
-Typing code in
-\end_layout
+\size small
+You should remove spaces in front of
+\begin_inset Quotes eld
+\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
+\family typewriter
+%s
+\family default
+
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
-The equivalent Noweb term is
+\end_layout
+
+\begin_layout Enumerate
+
+\size small
\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
+ is normally not followed by
\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 typewriter
+%c
+\family default
+\begin_inset Quotes erd
\end_inset
- Noweb delimits scraps like this:
+.
\end_layout
-\begin_layout LyX-Code
-
-<<My scrap>>=
+\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 LyX-Code
-
- code
+\begin_layout Section
+Version Control in LyX
\end_layout
-\begin_layout LyX-Code
-
- more code
+\begin_layout Standard
+by
+\noun on
+ Lars Gullik Bjønnes,
+\noun default
+updated by
+\noun on
+Pavel Sanda
\end_layout
-\begin_layout LyX-Code
-
- even more code
+\begin_layout Subsection
+Introduction
\end_layout
-\begin_layout LyX-Code
-
- @
+\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
-The problem is that whatever is written in between the << and the
+rcsintro
+\begin_inset Quotes erd
+\end_inset
+
+ (a man file, read it with
\family typewriter
-@
+man rcsintro
\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.
+).
+ 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
+Later basic CVS/SVN support was added.
+ You should be familiar with CVS/SVN usage before start using it under LyX.
+ Most of the log messages are not currently displayed after operations -
+ you can check them in terminal window if unsure.
+\end_layout
-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 implementation in LyX assumes a recent version of the GNU RCS or CVS/SVN
+ package—no guarantees are made for older versions.
+\end_layout
\begin_layout Standard
+For introducing your own external commands consult vc-command in the manual
+ of LyX functions.
+\end_layout
-If you have a printed version of this document you will not see any difference
- between the previous example and this one.
+\begin_layout Subsection
+RCS commands in LyX
\end_layout
+\begin_layout Standard
+The following sections describe the RCS commands supported by LyX.
+ You can find them in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
-
+Control
+\family default
+ submenu.
+ LyX was tested against RCS 5.7.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Subsubsection
-<<My scrap>>=
-\newline
- code
-\newline
- more code
-\newline
- even more code
-\newline
- @
+\family sans
+Register
\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
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+Register
+\family default
+ item is not visible.
+
+\end_layout
\begin_layout Standard
-
-It is in my list of
-\begin_inset Quotes eld
+This command registers your document with RCS (unless you are under the
+ directory managed by CVS)\SpecialChar \@.
+ You are asked interactively to supply an initial
+ description of the document.
+ The document is now set in Read-Only mode and you have to
+\family sans
+Check
+\begin_inset space ~
\end_inset
-improvements
-\begin_inset Quotes erd
+Out
+\begin_inset space ~
\end_inset
- to fix that.
-\end_layout
+For
+\begin_inset space ~
+\end_inset
+Edit
+\family default
+, before making any changes to it.
+ A document under revision control has a
+\begin_inset Quotes eld
\end_inset
+[RCS:<version> <locker>]
+\begin_inset Quotes erd
+\end_inset
+ item tagged to the filename in the minibuffer.
\end_layout
\begin_layout Standard
+RCS command that is run:
+\family typewriter
+ci -q -u -i -t-"<initial description>" <file-name>
+\end_layout
-As a special note, you can also use the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Standard
+Read
+\family typewriter
+man ci
+\family default
+ to understand the switches.
+
+\end_layout
-%def
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
- construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
-rence:
+\family sans
+Check In Changes
\end_layout
-\begin_layout LyX-Code
+\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
-<<My scrap>>=
-\newline
- def some_function(args):
-\newline
- "This is the doc string for this function."
-\newline
- print "My args: ", args
+\begin_layout Standard
+RCS command:
+\family typewriter
+ci -q -u -m"<description>" <file-name>
\end_layout
-\begin_layout LyX-Code
+\begin_layout Subsubsection
-@ %def some_function
+\family sans
+Check Out For Edit
\end_layout
\begin_layout Standard
+By doing this you lock the document so that only you can edit it.
+ This will also make the document Read-Write only for you.
+ You will usually continue editing for a while and when you are finished
+ you check in your changes.
+ The status line is changed to reflect that you have locked the file.
+
+\end_layout
-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.
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -q -l <file-name>
\end_layout
-\begin_layout Paragraph
+\begin_layout Subsubsection
-Generating the documentation
+\family sans
+Revert To Repository Version
\end_layout
\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+\end_layout
+
+\begin_layout Standard
+RCS command:
+\family typewriter
+co -f -u<version> <file-name>
+\end_layout
+
+\begin_layout Subsubsection
-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
+Undo Last Checkin
+\end_layout
-\bar under
-D
-\bar default
-VI,
-\family default
- etc.
- Just like you would do for a plain document.
- No special procedure is required.
+\begin_layout Standard
+This makes as if the last check in never happened.
+ No changes are made to the document loaded into LyX, but the last version
+ is removed from the master RCS file.
+
\end_layout
\begin_layout Standard
-
-To help orientate you, I will now explain what happens inside LyX:
+RCS command:
+\family typewriter
+rcs -o<version> <file-name>
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-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.
-
+Show History
\end_layout
-\begin_deeper
\begin_layout Standard
-
-If the document is of any literate class the generated file will be named
- with an extension name defined by the
-\begin_inset Quotes eld
-\end_inset
-
-literate
-\begin_inset Quotes erd
-\end_inset
-
- format (defined in the Preferences panel), otherwise the file will have
- the usual
+This show the complete history of the RCS document.
+ The output of
\family typewriter
-.tex
+rlog <file-name>
+\family default
+ is shown in a browser.
+ See
+\family typewriter
+man rlog
\family default
-extension.
+ for more info.
\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.
+\begin_layout Subsection
+CVS commands in LyX
\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
+CVS is now partially supported by LyX.
+ You can find the commands in the
\family sans
-\bar under
-T
-\bar default
-ools\SpecialChar \menuseparator
-
-\bar under
-P
-\bar default
-references
-\family default
- panel, under the
-\begin_inset Quotes eld
-\end_inset
-
-Conversion
-\begin_inset Quotes erd
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
- tab.
+Control
+\family default
+ submenu.
\end_layout
-\end_inset
+\begin_layout Subsubsection
- to generate the LaTeX file.
+\family sans
+Register
\end_layout
-\begin_deeper
\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
+\end_layout
-Otherwise it will just skip this step.
+\begin_layout Standard
+This command registers in CVS your document ONLY in case you have already
+ the documents directory under CVS control (in particular
+\family typewriter
+CVS/Entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
\end_layout
-\end_deeper
-\begin_layout Enumerate
-Finally, LaTeX is invoked and the regular post processing continues as in
- a plain document.
+\begin_layout Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
\end_layout
\begin_layout Standard
+CVS command that is run:
+\family typewriter
+cvs -q add -m
+\begin_inset Quotes erd
+\end_inset
-Independence from a particular
+<entered message>"
\begin_inset Quotes eld
\end_inset
-literate tool
+<file-name>
\begin_inset Quotes erd
\end_inset
- is easily achieved by changing the commands that are run by the various
- converters.
-\end_layout
-
-\begin_layout Paragraph
-Generating the code
\end_layout
\begin_layout Standard
-
-When the build menu option is chosen or the corresponding button in the
- toolbar is pressed, a latex file is generated just like step 1 above.
- Next, LyX invokes the
+Read
\family typewriter
- Noweb->Program
+man svn
\family default
- converter.
- Typically, this converter (like any other converter), has two parts:
+ to understand the switches.
+
\end_layout
-\begin_layout Enumerate
+\begin_layout Subsubsection
-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).
+\family sans
+Check In Changes
\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.
+\begin_layout Standard
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
\end_layout
\begin_layout Standard
-
-The first part, the
-\begin_inset Quotes eld
-\end_inset
-
-Converter
-\begin_inset Quotes erd
-\end_inset
-
- setting, should be set to
-\begin_inset Quotes eld
-\end_inset
-
-
+CVS command:
\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
+cvs -q commit -m"<description>" "<file-name>"
+\end_layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsubsection
- (a program or script) with the name of the Noweb file (generally a file
- in the LyX temp directory).
-
+\family sans
+Revert To Repository Version
\end_layout
\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+ Firstly the file is deleted, secondly CVS update command is run.
+\end_layout
-This is an implementation of
+\begin_layout Standard
+CVS command:
+\family typewriter
+cvs update
\begin_inset Quotes eld
\end_inset
-build-script
+<file-name>
\begin_inset Quotes erd
\end_inset
- that you can place in a directory on your path:
-\end_layout
-
-\begin_layout LyX-Code
-
-#!/bin/sh
-\end_layout
-
-\begin_layout LyX-Code
-#
\end_layout
-\begin_layout LyX-Code
+\begin_layout Subsubsection
-notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
+\family sans
+Show History
\end_layout
\begin_layout Standard
-
-The next part of the converter setting is the
+This show the complete history of the CVS document.
+ The output of
+\family typewriter
+cvs log
\begin_inset Quotes eld
\end_inset
-Flags
+<file-name>
\begin_inset Quotes erd
\end_inset
- which is to be set to
-\begin_inset Quotes eld
-\end_inset
-
-\family typewriter
-originaldir,parselog=listerrors
\family default
+ is shown in a browser.
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Subsection
+SVN commands in LyX
+\end_layout
-.
- This will run any errors that are generated by the
-\begin_inset Quotes eld
+\begin_layout Standard
+SVN is now partially supported by LyX.
+ You can find the commands in the
+\family sans
+File\SpecialChar \menuseparator
+Version
+\begin_inset space ~
\end_inset
-build-script
-\begin_inset Quotes erd
-\end_inset
+Control
+\family default
+ submenu.
+ Please note that if you use password protected access to repository via
+ ssh, you will be asked in terminal window.
+ LyX was tested against SVN 1.4 and 1.5.
+\end_layout
- process through the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
-listerrors
-\begin_inset Quotes erd
-\end_inset
+\family sans
+Register
+\end_layout
- program.
+\begin_layout Standard
+If your document is not under revision control, this is the only item shown
+ in the menu.
+ And if it is under revision control, the
+\family sans
+\bar under
+R
+\bar default
+egister
+\family default
+ item is not visible.
+
\end_layout
\begin_layout Standard
+This command registers in SVN your document ONLY in case you have already
+ the documents directory under SVN control (in particular
+\family typewriter
+.svn/entries
+\family default
+ file exists).
+ This means you have to checkout the archive by yourself.
+
+\end_layout
-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 Standard
+Then you are asked interactively to supply an initial description of the
+ document.
+ Don't forget that registered file is not yet commited.
+\end_layout
+
+\begin_layout Standard
+SVN command that is run:
+\family typewriter
+snv add -q
\begin_inset Quotes eld
\end_inset
-listerrors
+<file-name>
\begin_inset Quotes erd
\end_inset
- program.
-\end_layout
-
-\begin_layout Paragraph
-Build instructions in the document
\end_layout
\begin_layout Standard
+Read
+\family typewriter
+man svn
+\family default
+ to understand the switches.
+
+\end_layout
-The last piece of the integration between LyX and noweb is the
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Subsubsection
-build-script
-\begin_inset Quotes erd
-\end_inset
+\family sans
+Check In Changes
+\end_layout
- 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
+When you are finished editing a file, you commit your changes.
+ When you do this, you are asked for a description of the changes.
+ After that changes are commited.
+\end_layout
-build-script
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
- above uses the notangle command to look for this scrap (called
-\begin_inset Quotes eld
-\end_inset
+\begin_layout Plain Layout
+In case locking is not enabled.
+ See Section
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:SVN-File-Locking"
-build-script
-\begin_inset Quotes erd
\end_inset
-) and runs its contents through
-\begin_inset Quotes eld
-\end_inset
+.
+\end_layout
-sh
-\begin_inset Quotes erd
\end_inset
-.
+
+\family typewriter
+svn commit -q -m"<description>" <file-name>
\end_layout
-\begin_layout Standard
+\begin_layout Subsubsection
-Typically, such a scrap would look something like this:
+\family sans
+Check Out For Edit
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+Updates the changes of this file from the repository.
+ Be sure you understand SVN merging and conflicts resolving before using
+ this function, because all conflicts has to be done manually by you!
+\end_layout
-<<build-script>>=
-\newline
-#!/bin/sh
-\newline
+\begin_layout Standard
+SVN command:
+\begin_inset Foot
+status collapsed
-\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 Plain Layout
+Ditto.
\end_layout
-\begin_layout Standard
+\end_inset
-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
+
+\family typewriter
+svn update
\begin_inset Quotes eld
\end_inset
-listerrors
+<file-name>
\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
-Configuring LyX
+\family sans
+Revert To Repository Version
\end_layout
\begin_layout Standard
+This will discard all changes made to the document since the last check
+ in.
+ You get a warning before changes are discarded.
+
+\end_layout
-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_layout Standard
+SVN command:
+\family typewriter
+svn revert -q
\begin_inset Quotes eld
\end_inset
-Conversion
+<file-name>
\begin_inset Quotes erd
\end_inset
- tab.
- The important parts are:
+
\end_layout
-\begin_layout Description
+\begin_layout Subsubsection
-the\InsetSpace ~
+\family sans
+Show History
+\end_layout
+\begin_layout Standard
+This show the complete history of the SVN document.
+ The output of
+\family typewriter
+svn log
\begin_inset Quotes eld
\end_inset
-literate
+<file-name>
\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.
+ is shown in a browser.
\end_layout
-\begin_layout Description
+\begin_layout Subsubsection
+File Locking
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:SVN-File-Locking"
+
+\end_inset
-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).
\end_layout
-\begin_layout Description
+\begin_layout Standard
+The file exchange through various revision control systems brings the problem
+ of merge conflicts in case two different users try to edit the same (parts
+ of) document.
+ When such conflict happens it needs manual resolving and one reasonable
+ alternative is to provide some kind of locking mechanism, which guarantees
+ that only one user is allowed to edit file at the given time.
+\end_layout
+\begin_layout Standard
+SVN has two mechanisms to provide such kind of mutual exclusivity for file
+ access - locks and automatical setting of write permissions (see sec.
+
+\begin_inset CommandInset ref
+LatexCommand ref
+reference "subsec:Automatical-Locking-Property"
-\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
+) based on
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svn:needs-lock
+\end_layout
- of the literate document.
- For Noweb, it is set to
-\begin_inset Quotes eld
\end_inset
+ file svn property
+\begin_inset Foot
+status open
-\family typewriter
-noweave -delay -index $$i > $$o
-\family default
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
+\end_layout
-\begin_inset Quotes erd
\end_inset
+.
+ In a case this property is detected for a given document LyX starts to
+ use SVN locks for document editing automatically and the whole check-in/out
+ mechanism switches to the same regimen as for RCS.
+ This in particular means there are two different modes how file is used
+ in LyX:
+\end_layout
+\begin_layout Itemize
+Unlocked state.
+ The loaded file is in the read-only mode.
+ For editation on needs to check-out.
+
+\emph on
+Check-out
+\emph default
+ consists of update from repository and gaining write lock.
+ If the lock is not possible to obtain, we remain in unlocked state.
\end_layout
-\begin_layout Description
+\begin_layout Itemize
+Locked state.
+ The loaded file is in the 'normal' edit mode.
+ No other user is allowed to edit the file.
+
+\emph on
+Check-in
+\emph default
+ consists of commiting changes and releasing write-lock.
+ If no changes have been made to the document, no commit will be produced
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+Don't be puzzled by the fact that you will be asked for commit message anyway.
+\end_layout
-\family sans
-NoWeb
-\family default
-->
-\family sans
-Program
-\family default
- This performs the
-\begin_inset Quotes eld
\end_inset
-tangling step
-\begin_inset Quotes erd
+ and only the write-lock will be released.
+\end_layout
+
+\begin_layout Standard
+SVN commands:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-in:
+\family typewriter
+ svn commit -q -m"<description>" "<file-name>"
+\begin_inset Newline newline
\end_inset
-.
- As stated above, the Converter is set to
-\begin_inset Quotes eld
+svn unlock "<file-name>"
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Check-out:
+\family typewriter
+svn update "<file-name>"
+\begin_inset Newline newline
\end_inset
+svn lock "<file-name>"
+\end_layout
+
+\begin_layout Subsubsection
\family typewriter
-build-script $$i
-\family default
+\begin_inset CommandInset label
+LatexCommand label
+name "subsec:Automatical-Locking-Property"
-\begin_inset Quotes erd
\end_inset
-, with Flags set to
-\begin_inset Quotes eld
+
+\family default
+Automatical Locking Property
+\end_layout
+
+\begin_layout Standard
+The above mentioned automatical setting of write permissions of the .lyx
+ file can be set through
+\family sans
+\bar under
+ F
+\bar default
+ile\SpecialChar \menuseparator
+
+\bar under
+V
+\bar default
+ersion
+\begin_inset space ~
\end_inset
+Control\SpecialChar \menuseparator
-\family typewriter
-originaldir,parselog=listerrors
+\bar under
+T
+\bar default
+oggle locking property
\family default
+.
+ This command is active only when the file is not locked on the svn server
+ (i.e.
+ you need to check-out before proceeding).
+\end_layout
-\begin_inset Quotes erd
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+SVN
+\begin_inset space ~
\end_inset
-.
+commands:
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Set:
+\family typewriter
+ svn propset svn:needs-lock ON "<file-name>"
+\end_layout
+
+\begin_layout Labeling
+\labelwidthstring 00.00.0000
+Unset:
+\family typewriter
+svn propdel svn:needs-lock "<file-name>"
\end_layout
\begin_layout Subsubsection
+Revision Information in Documents
+\end_layout
-Debug extensions
+\begin_layout Standard
+Currently there is no way how to provide such kind of information directly
+ from LyX.
+ There are possibilities how to activate it with the help of svn features,
+ but each has its own drawbacks.
\end_layout
\begin_layout Standard
+One possibility is to use svn keywords
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
+\end_layout
-There is also a new function implemented in the LyX server, the
-\begin_inset Quotes eld
\end_inset
-server-goto-file-row" function, to be used with ddd/gdb or other debugger.
+.
+ In short -- you set file keywords property (e.g.
+\family sans
+svn propset svn:keywords 'Rev' file.lyx
+\family default
+) and then paste keyword ERT
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+This is an easy way how to ensure that LyX won't break the line in the middle
+ of keyword tag.
\end_layout
-\begin_layout Standard
+\end_inset
-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
+ tag in your document (e.g.
-\bar under
-E
-\bar default
-dit\SpecialChar \menuseparator
+\begin_inset ERT
+status open
-\bar under
-P
-\bar default
-references\SpecialChar \menuseparator
+\begin_layout Plain Layout
-\bar under
-H
-\bar default
-elpers
-\family default
-dialog and changing the "Edit Sources" entry.
+$Rev$
\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
+).
+ This way svn client will automatically substitute revision number (e.g.
+
+\begin_inset ERT
+status open
- to:
+\begin_layout Plain Layout
+
+$Rev: 59 $
\end_layout
-\begin_layout LyX-Code
+\end_inset
-echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
-\end_layout
+) after each update and commit.
+ There are more problems with this approach.
+ Firstly, the '$' character is used in TeX world for math equations, so
+ any occurence of math formula
+\begin_inset Formula $Rev$
+\end_inset
-\begin_layout Standard
+ become
+\begin_inset Formula $Rev:59$
+\end_inset
-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 !
+ in your LyX document.
+ Similarly for other keywords like Id, Date, Author, etc.
+ Secondly svn output is dependent on your locales, so its very easy that
+ svn would produce some problematic strings once Date is used.
+ Thirdly you get the whole 'Rev: 59' string in your document instead of
+ the plain number.
+ Until subversion implements user's custom keywords it will be hard to use
+ this approach reliably or let LyX to support it directly .
\end_layout
\begin_layout Standard
+The second possibility would be to write your own external-material template
+ which calls either
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+svnversion
+\end_layout
-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
+ utility or parses the output of
+\begin_inset Flex CharStyle:Code
+status collapsed
-\family typewriter
-/home/<your-home-directory>/.lyx/lyxpipe
-\family default
+\begin_layout Plain Layout
+svn info file.lyx
+\end_layout
-\begin_inset Quotes erd
\end_inset
-
+ command and returns the result back, when typeseting the document.
\end_layout
-\begin_layout Standard
+\begin_layout Subsection
+SVN and Windows Environment
+\end_layout
-Read the LyX server documentation in the
-\emph on
-Customization Manual
-\emph default
- for further information.
+\begin_layout Quote
+My inclination is to say that if the user cannot figure out the command
+ line operations on their own fairly quickly, they would be well advised
+ to use TortoiseSVN.
+ ---P.
+ A.
+ Rubin
\end_layout
\begin_layout Subsubsection
-
-Toolbar extensions
+Preparation
\end_layout
\begin_layout Standard
+In addition to installing LyX, and having access to a Subversion repository,
+ the user will need to install the Subversion client program.
+ A Windows installer for the client program is available from
+\begin_inset CommandInset href
+LatexCommand href
+name "CollabNet"
+target "http://www.collab.net/nonav/downloads/subversion/"
-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
+\end_inset
+
+.
+ The user may also want to install
+\begin_inset CommandInset href
+LatexCommand href
+name "TortoiseSVN"
+target "http://tortoisesvn.tigris.org/"
+
+\end_inset
+
+, which integrates Subversion operations into the context (rightclick) menu
+ of Windows Explorer.
+ Operations done outside LyX will typically be more convenient using the
+ Explorer context menu.
+ Note that TortoiseSVN is not a replacement for the client program, which
+ is what LyX itself will use.
+\end_layout
+
+\begin_layout Subsubsection
+Bringing a document under Subversion control
+\end_layout
+
+\begin_layout Standard
+Before a LyX document can be brought under version control in Subversion,
+ its parent directory needs to be under version control.
+ If the document is being added to a project already in the repository,
+ this is accomplished by checking the project out to the directory where
+ the new document will be placed.
+ If the project itself is not yet under version control (for instance, if
+ this document starts a new project), the directory must be imported into
+ the repository.
+ This is done outside LyX.
+ Both import and checkout are easily accomplished from the Explorer context
+ menu using TortoiseSVN, or alternatively can be done using the command
+ line client at a DOS prompt.
+ The procedure for importing the project using TortoiseSVN is described
+ below, assuming an existing repository and a new project being started
+ in
+\family typewriter
+C:
+\backslash
+new project
\family default
-,
-\family sans
-LaTeX
+.
+ For information on using the Subversion client program, run
+\family typewriter
+svn --help
\family default
-,
-\family sans
-LyX-Code
+in a DOS shell.
+\end_layout
+
+\begin_layout Enumerate
+Locate
+\family typewriter
+C:
+\backslash
+new project
\family default
-, and
-\family sans
-Scrap
+in Windows Explorer, right click it, and select
+\family typewriter
+TortoiseSVN > Repo-browser
\family default
.
- The last one is a short cut to the
-\begin_inset Quotes eld
-\end_inset
+ If necessary, adjust the URL for the repository, then click OK.
+\end_layout
-Build Program
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Enumerate
+Right click the level of the repository under which you want to place the
+ new project folder (typically the top level) and click
+\family typewriter
+Create folder\SpecialChar \ldots{}
- File menu entry.
-
+\family default
+ Supply a name for the project folder and click OK.
+ Add a message for the log file if desired, then click OK again.
+ The new project folder should appear in the repository.
+ Finally, click OK again to exit the repository browser.
\end_layout
-\begin_layout Standard
+\begin_layout Enumerate
+Once again right click
+\family typewriter
+C:
+\backslash
+new project
+\family default
+, this time selecting SVN Checkout\SpecialChar \ldots{}
+ Select the URL of the project folder
+ you just created in the repository, and set the checkout directory to
+\family typewriter
+C:
+\backslash
+new project.
-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 default
+ Click OK.
+ You will be warned about a non-empty folder; click OK to proceed.
+ You should now have a
+\family typewriter
+.svn
+\family default
+ directory under
+\family typewriter
+C:
+\backslash
+new project.
+\end_layout
+
+\begin_layout Enumerate
+Create or open your document in LyX and click
\family sans
\bar under
-V
+F
\bar default
-iew
-\family default
-\SpecialChar \menuseparator
+ile\SpecialChar \menuseparator
-\family sans
\bar under
-U
+V
\bar default
-pdate
-\family default
-\SpecialChar \menuseparator
+ersion
+\begin_inset space ~
+\end_inset
+
+Control\SpecialChar \menuseparator
-\family sans
\bar under
-D
+R
\bar default
-VI
+egister.
+
\family default
- and the other for
+Add a log message and click OK to commit the document to version control.
+\end_layout
+
+\begin_layout Standard
+From this point onward, you should have full functionality in the
\family sans
\bar under
-V
+F
\bar default
-iew\SpecialChar \menuseparator
+ile\SpecialChar \menuseparator
\bar under
-D
+V
\bar default
-VI
+ersion
+\begin_inset space ~
+\end_inset
+
+Control
\family default
- File menu entries.
- Here is how it looks like:
+ menu.
+ You also have the option of checking the document in and out, viewing its
+ history, etc.
+ using the TortoiseSVN context menu in Windows Explorer or the Subversion
+ client program from a command prompt.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Subsection
+Further tuning
+\end_layout
-Toolbar
+\begin_layout Standard
+With the recent addition of the vc-command function LyX power users are
+ allowed to create their own commands for revision control.
+\end_layout
+
+\begin_layout Standard
+As an example you can see how two TortoiseSVN commands could be integrated
+ directly:
+\end_layout
+
+\begin_layout Description
+Commit:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:commit /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Description
+Revert:
+\begin_inset Flex CharStyle:Code
+status collapsed
+
+\begin_layout Plain Layout
+vc-command DR "." "TortoiseProc /command:revert /path:$$p"
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Section
+Literate Programming
+\end_layout
+
+\begin_layout Standard
+Updated by
+\noun on
+Kayvan Sylvan
+\noun default
+(kayvan@sylvan.com)
+\noun on
+,
+\noun default
+original documentation written by
+\noun on
+Edmar Wienskoski Jr.
+
+\noun default
+ (edmar-w-jr@technologist.com)
+\end_layout
+
+\begin_layout Subsection
+Introduction
\end_layout
-\begin_layout LyX-Code
+\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
- Layouts
-\end_layout
+tangling
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+ and
+\begin_inset Quotes eld
+\end_inset
- Icon "layout Standard"
-\end_layout
+weaving
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+ 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
- Icon "layout Section"
+\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 LyX-Code
+\begin_layout Subsection
+Literate Programming
+\end_layout
- Icon "layout LaTeX"
+\begin_layout Standard
+From the Literate Programming FAQ:
\end_layout
-\begin_layout LyX-Code
+\begin_layout Quotation
+Literate programming is the combination of documentation and source together
+ in a fashion suited for reading by human beings.
+ In fact, literate programs should be enjoyable reading, even inviting!
+ (Sorry Bob, I couldn't resist!) In general, literate programs combine source
+ and documentation in a single file.
+ Literate programming tools then parse the file to produce either readable
+ documentation or compilable source.
+ The WEB style of literate programming was created by D.
+\begin_inset space \thinspace{}
+\end_inset
- Icon "layout LyX-Code"
+g.
+ Knuth during the development of his TeX typesetting software.
+
\end_layout
-\begin_layout LyX-Code
-
- Icon "layout Scrap"
+\begin_layout Standard
+Another excerpt says:
\end_layout
-\begin_layout LyX-Code
+\begin_layout Quotation
- Separator
+\emph on
+How is literate programming different from verbose commenting?
\end_layout
-\begin_layout LyX-Code
-
- Icon "buffer-view"
+\begin_layout Quotation
+There are three distinguishing characteristics.
+ In order of importance, they are:
\end_layout
-\begin_layout LyX-Code
+\begin_deeper
+\begin_layout Itemize
+flexible order of elaboration
+\end_layout
- Icon "buffer-typeset"
+\begin_layout Itemize
+automatic support for browsing
\end_layout
-\begin_layout LyX-Code
+\begin_layout Itemize
+typeset documentation, especially diagrams and mathematics
+\end_layout
- Icon "build-program"
+\end_deeper
+\begin_layout Standard
+Now that I sparked your curiosity, take a look in the references.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Subsubsection
+References
+\end_layout
- Separator
+\begin_layout Standard
+The complete Literate Programming FAQ can be found at:
\end_layout
-\begin_layout LyX-Code
+\begin_layout Quote
+Literate Programming FAQ
+\begin_inset Flex URL
+status collapsed
-.
+\begin_layout Plain Layout
+
+http://shelob.ce.ttu.edu/daves/lpfaq/faq.html
\end_layout
-\begin_layout LyX-Code
+\end_inset
+
-.
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+The FAQ lists 23 (twenty three!) different literate programming tools.
+ Where some are specialized or
+\begin_inset Quotes eld
+\end_inset
-.
-\end_layout
+tailored
+\begin_inset Quotes erd
+\end_inset
-\begin_layout LyX-Code
+ 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
-End
+\begin_layout Itemize
+It can generate the documentation either in LaTeX or HTML.
\end_layout
-\begin_layout Subsubsection
+\begin_layout Itemize
+It has a open architecture, i.
+\begin_inset space \thinspace{}
+\end_inset
-Colors customization
+g.
+\begin_inset space \space{}
+\end_inset
+
+it is easy to plug in new filters and to perform special processing that
+ you may need.
+
\end_layout
-\begin_layout Standard
+\begin_layout Itemize
+There is a good selection of filters available already (the HTML is one
+ of them).
+\end_layout
-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 Itemize
+It is free.
\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.
-
+The Noweb web page can be found at:
\end_layout
-\begin_layout Chapter
+\begin_layout Quote
+Noweb home page
+\begin_inset Flex URL
+status collapsed
-Secrets of the LaTeX Masters
-\begin_inset LatexCommand \label{cha:secrets}
+\begin_layout Plain Layout
+
+http://www.cs.virginia.edu/~nr/noweb/
+\end_layout
\end_inset
\end_layout
\begin_layout Standard
+Starting from there you can reach many other interesting links and even
+ some literate program examples.
+\end_layout
-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_layout Subsection
+LyX and Literate Programming
+\end_layout
+
+\begin_layout Standard
+The LyX support for Literate Programming is provided by using the generic
+ LyX converters mechanism.
+ This support is provided in a
\begin_inset Quotes eld
\end_inset
-TeX
+Noweb independent
\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!
+ way, i.
+\begin_inset space \thinspace{}
+\end_inset
+
+g.
+\begin_inset space \space{}
+\end_inset
+
+you will be able to use this new LyX feature with some other literate programmin
+g tool of your choice by just changing your LyX preferences.
+\end_layout
+
+\begin_layout Subsubsection
+Generating documents and code (weaving and tangling)
+\end_layout
+
+\begin_layout Paragraph
+Selecting the document class
\end_layout
\begin_layout Standard
+If you have installed Noweb and LyX successfully, whenever you open a new
+ document or try to change the document class of an existing one, you will
+ find that there are three new document classes available:
+\end_layout
-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.
+\begin_layout Itemize
+Article (Noweb)
\end_layout
-\begin_layout Section
+\begin_layout Itemize
+Book (Noweb)
+\end_layout
-Tricks for Footnotes and Margin Notes
+\begin_layout Itemize
+Report (Noweb)
\end_layout
\begin_layout Standard
+You must select one of them to create your literate documents from.
+
+\end_layout
-suggested by
-\noun on
-Robin Socha
+\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
+
+\begin_layout Plain Layout
+It is very simple, it involves the creation of a file with four lines, and
+ re-running of the auto configuration.
\end_layout
-\begin_layout Subsection
+\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
-Footnotes
+\begin_layout Paragraph
+Typing code in
\end_layout
\begin_layout Standard
+LyX enables you to write code with a layout named
+\noun on
+Scrap
+\noun default
+.
+\begin_inset Foot
+status collapsed
-LyX cannot yet take care of setting the footnote numbering back to 1 after
- each section in the
+\begin_layout Plain Layout
+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
-
-\family roman
- document class or changing the counter style.
- You'll need to insert LaTeX commands like the following to achieve that:
+ introduced by other literate tool named Nuweb, which I used for many years
+ before rendering myself to Noweb.
\end_layout
-\begin_layout Standard
-
+\end_inset
-\begin_inset ERT
-status inlined
+ Noweb delimits scraps like this:
+\end_layout
-\begin_layout Standard
+\begin_layout LyX-Code
+<<My scrap>>=
+\end_layout
-\backslash
-setcounter{footnote}{0}
+\begin_layout LyX-Code
+ code
\end_layout
-\end_inset
+\begin_layout LyX-Code
+ more code
+\end_layout
- Using
-\family typewriter
+\begin_layout LyX-Code
+ even more code
+\end_layout
-\backslash
-setcounter{footnote}{0}
-\family roman
- will set the counter back to 1
-\begin_inset Foot
-status collapsed
+\begin_layout LyX-Code
+ @
+\end_layout
\begin_layout Standard
+The problem is that whatever is written in between the << and the
+\family typewriter
+@
+\family default
+ must be taken literally, i.
+\begin_inset space \thinspace{}
+\end_inset
-The counter has been set back to 1.
-\end_layout
-
+g.
+\begin_inset space \space{}
\end_inset
-.
+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
\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
-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
-
-\begin_layout Standard
-
-\backslash
-renewcommand{
-\backslash
-thefootnote}{
-\backslash
-alph{footnote}}
+\begin_layout Plain Layout
+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
-:
-\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 LyX-Code
+<<My scrap>>=
+\begin_inset Newline newline
\end_inset
+ code
+\begin_inset Newline newline
+\end_inset
-\end_layout
-
-\begin_layout Standard
+ more code
+\begin_inset Newline newline
+\end_inset
-The next command sets the counter style back to default, i.e.
-
-\family typewriter
+ even more code
+\begin_inset Newline newline
+\end_inset
-\backslash
-arabic
-\family default
+ @
+\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 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
-
-\begin_inset ERT
-status collapsed
+\begin_layout Plain Layout
+It is in my list of
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+improvements
+\begin_inset Quotes erd
+\end_inset
-\backslash
-renewcommand {
-\backslash
-thefootnote} {
-\backslash
-arabic{footnote}}
+ to fix that.
\end_layout
\end_inset
\end_layout
+\begin_layout Standard
+As a special note, you can also use the
+\begin_inset Quotes eld
\end_inset
-.
-\end_layout
+%def
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+ construct of Noweb in your scraps to add items to Noweb's identifier cross-refe
+rence:
+\end_layout
-You can use
-\family typewriter
+\begin_layout LyX-Code
+<<My scrap>>=
+\begin_inset Newline newline
+\end_inset
-\backslash
-arabic
-\family default
-,
-\family typewriter
+ def some_function(args):
+\begin_inset Newline newline
+\end_inset
-\backslash
-roman
-\family default
-,
-\family typewriter
+ "This is the doc string for this function."
+\begin_inset Newline newline
+\end_inset
-\backslash
-Roman
-\family default
-,
-\family typewriter
+ print "My args: ", args
+\end_layout
-\backslash
-alph
-\family default
- or
-\family typewriter
+\begin_layout LyX-Code
+@ %def some_function
+\end_layout
-\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.
-
+\begin_layout Standard
+For an example of this usage and the resulting cross-reference output, look
+ at the Literate python program in
+\emph on
+LIBDIR/examples/listerrors.lyx
+\emph default
+ which should make this all clear.
\end_layout
-\begin_layout Subsection
+\begin_layout Paragraph
+Generating the documentation
+\end_layout
-Margin Notes
+\begin_layout Standard
+At this point you already have a new document file with a proper document
+ class, and with some code and text on it.
+ How do I print it? The answer is simple, you select
+\family sans
+View\SpecialChar \menuseparator
+DVI,
+\family default
+ etc.
+ Just like you would do for a plain document.
+ No special procedure is required.
\end_layout
\begin_layout Standard
+To help orientate you, I will now explain what happens inside LyX:
+\end_layout
-Here are two examples of neat things you can do to margin notes using LaTeX
- commands.
+\begin_layout Enumerate
+When the
+\family sans
+Update\SpecialChar \menuseparator
+DVI
+\family default
+ menu option is chosen, a LaTeX file is generated.
+
\end_layout
+\begin_deeper
\begin_layout Standard
-
-The following command will make a vertical line appear alongside your text---gre
-at for
+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
-thumbing
+literate
\begin_inset Quotes erd
\end_inset
-:
+ format (defined in the Preferences panel), otherwise the file will have
+ the usual
\family typewriter
-
-\backslash
-marginpar{
-\backslash
-rule[-10mm]{30mm}{5mm}}
-\family roman
-.
+.tex
\family default
-
-\begin_inset ERT
-status inlined
-
-\begin_layout Standard
-
-\backslash
-marginpar{
-\backslash
-rule[-10mm]{30mm}{5mm}}
-\end_layout
-
-\end_inset
-
-
+ extension.
\end_layout
-\begin_layout Standard
-
-Check your dvi- or ghostview-output to see what the
-\family typewriter
-
-\backslash
-reversemarginpar
-\family default
-command does to the following margin note.
+\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
-\begin_layout Standard
-
+\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 collapsed
-\begin_inset ERT
-status inlined
+\begin_layout Plain Layout
+The converters are defined in the
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences
+\family default
+ panel, under the
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+Conversion
+\begin_inset Quotes erd
+\end_inset
-\backslash
-reversemarginpar
+ tab.
+ See section
+\emph on
+Converters
+\emph default
+ of the
+\emph on
+Customization
+\emph default
+ manual for general information about converters.
\end_layout
\end_inset
+ to generate the LaTeX file.
+\end_layout
-\begin_inset Marginal
-status collapsed
-
+\begin_deeper
\begin_layout Standard
+Otherwise it will just skip this step.
+\end_layout
-This is a
-\newline
-margin note.
+\end_deeper
+\begin_layout Enumerate
+Finally, LaTeX is invoked and the regular post processing continues as in
+ a plain document.
\end_layout
+\begin_layout Standard
+Independence from a particular
+\begin_inset Quotes eld
\end_inset
+literate tool
+\begin_inset Quotes erd
+\end_inset
+ is easily achieved by changing the commands that are run by the various
+ converters.
\end_layout
-\begin_layout Section
-
-Multiple Columns
+\begin_layout Paragraph
+Generating the code
\end_layout
\begin_layout Standard
-
-by
-\noun on
-Lars Gullik Bjønnes
+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.
+ This converter needs to be defined by the user and is not installed by
+ default, though the Program format is.
+ This converter (like any other converter) will have two parts:
\end_layout
-\begin_layout Subsection
+\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
-Purpose
+\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
+The first part, the
+\begin_inset Quotes eld
+\end_inset
-The aim for this chapter
-\begin_inset Foot
-status collapsed
+Converter
+\begin_inset Quotes erd
+\end_inset
+
+ setting, should 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
+build-script $$i
\family default
-.
- --- mer
-\end_layout
+\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
+.
+ This basically means that LyX will call
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Subsection
+build-script
+\begin_inset Quotes erd
+\end_inset
-Limitations
+ (a program or script) with the name of the Noweb file (normally a file
+ in the LyX temp directory).
+
\end_layout
\begin_layout Standard
+This is an implementation of
+\begin_inset Quotes eld
+\end_inset
-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
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Subsection
+ that you can place in a directory on your path:
+\end_layout
-Examples
+\begin_layout LyX-Code
+#!/bin/sh
\end_layout
-\begin_layout Subsubsection
+\begin_layout LyX-Code
+#
+\end_layout
-Two columns
+\begin_layout LyX-Code
+notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
\end_layout
\begin_layout Standard
+The next part of the converter setting is the
+\begin_inset Quotes eld
+\end_inset
-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
+Flags
+\begin_inset Quotes erd
+\end_inset
-\backslash
-end{multicols}
-\family default
- where you want it to end.
- Like this:
-\end_layout
+ which is to be set to
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+\family typewriter
+parselog=listerrors
+\family default
-\begin_inset ERT
-status inlined
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+.
+ This will run any errors that are generated by the
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
+ process through the
+\begin_inset Quotes eld
\end_inset
+listerrors
+\begin_inset Quotes erd
+\end_inset
+ program.
\end_layout
\begin_layout Standard
-\noindent
+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
-\series bold
-\size small
-The Adventure of the Empty House
-\series default
+listerrors
+\begin_inset Quotes erd
+\end_inset
-\newline
-by
-\noun on
-Sir Arthur Conan Doyle
+ program.
\end_layout
\begin_layout Standard
+The build will normally take place in LyX's temporary directory, so the
+ files produced by the conversion will be in that directory.
+ LyX will copy out what it regards as the `main' file, but the
+\family typewriter
+Noweb->Program
+\family default
+ conversion may produce several files, and so most of these would then be
+ deleted when LyX was closed.
+ The present solution is to use a `copier',
+\begin_inset Foot
+status collapsed
+\begin_layout Plain Layout
+See section
+\emph on
+Copiers
+\emph default
+ of the
+\emph on
+Customization
+\emph default
+ manual for information on these.
+\end_layout
-\size small
-It was in the spring of the year 1894 that all London was interested, and
- the fashionable world dismayed, by the murder of the Honourable Ronald
- Adair under most unusual and inexplicable circumstances.
- The public has already learned those particulars of the crime which came
- out in the police investigation, but a good deal was suppressed upon that
- occasion, since the case for the prosecution was so overwhelmingly strong
- that it was not necessary to bring forward all the facts.
- Only now, at the end of nearly ten years, am I allowed to supply those
- missing links which make up the whole of that remarkable chain.
- The crime was of interest in itself, but that interest was as nothing to
- me compared to the inconceivable sequel, which afforded me the greatest
- shock and surprise of any event in my adventurous life.
- Even now, after this long interval, I find myself thrilling as I think
- of it, and feeling once more that sudden flood of joy, amazement, and 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_inset
+
+ in this case, the
+\family typewriter
+ext_copy.py
+\family default
+ script in its default mode, so that the entire contents of the temporary
+ directory is copied.
+ More will get copied than is needed, to be sure, but nothing will be lost.
+ If, however, you know what extensions the generated files will have, this
+ can be improved by using the
+\family typewriter
+-e
+\family default
+ option to
+\family typewriter
+ext_copy
+\family default
+.
+ This option takes a comma-separated list of extensions to copy.
+ So, for example, if the conversion will generate only files with the extensions
+
+\family typewriter
+.c
+\family default
+ and
+\family typewriter
+.h
+\family default
+, then the correct definition would be:
\end_layout
-\begin_layout Standard
-
-
-\begin_inset ERT
-status inlined
+\begin_layout LyX-Code
+python -tt $$s/scripts/ext_copy.py -e c,h $$i $$o
+\end_layout
\begin_layout Standard
+The result will be that only files with these two extensions will be copied
+ out.
+\end_layout
-\backslash
-end{multicols}
+\begin_layout Paragraph
+Build instructions in the document
\end_layout
+\begin_layout Standard
+The last piece of the integration between LyX and noweb is the
+\begin_inset Quotes eld
\end_inset
+build-script
+\begin_inset Quotes erd
+\end_inset
-\end_layout
-
-\begin_layout Subsubsection
+ 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
-Multiple columns
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+ above uses the notangle command to look for this scrap (called
+\begin_inset Quotes eld
+\end_inset
-The same pattern is used when you want more than two columns:
-\end_layout
+build-script
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+) and runs its contents through
+\begin_inset Quotes eld
+\end_inset
+sh
+\begin_inset Quotes erd
+\end_inset
-\begin_inset ERT
-status inlined
+.
+\end_layout
\begin_layout Standard
-
-\backslash
-begin{multicols}{3}
+Typically, such a scrap would look something like this:
\end_layout
+\begin_layout LyX-Code
+<<build-script>>=
+\begin_inset Newline newline
\end_inset
+#!/bin/sh
+\begin_inset Newline newline
+\end_inset
-\end_layout
-\begin_layout Standard
+\begin_inset Newline newline
+\end_inset
+if [ -z "${NOWEB_SOURCE}" ]
+\begin_inset Newline newline
+\end_inset
-\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
+then
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
+ NOWEB_SOURCE=myfile.nw
+\begin_inset Newline newline
+\end_inset
+fi
+\begin_inset Newline newline
+\end_inset
-\begin_inset ERT
-status inlined
+[...
+ code to extract files ...]
+\begin_inset Newline newline
+\end_inset
-\begin_layout Standard
+[...
+ code to compile files ...]
+\begin_inset Newline newline
+\end_inset
-\backslash
-end{multicols}
+@
\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
-\end_layout
-
-\begin_layout Standard
+ program for some illustrations of how all of these pieces go together or
+ in
+\emph on
+LIBDIR/examples/noweb2lyx.lyx.
-You can have have more than 3 columns if you want to, but that might not
- be very pleasant for the eye.
+\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
-
-Columns inside columns
+Configuring LyX
\end_layout
\begin_layout Standard
+All the Literate Programming support is configured by the
+\family sans
+Tools\SpecialChar \menuseparator
+Preferences
+\family default
+ panel in the
+\begin_inset Quotes eld
+\end_inset
-You can even have columns inside columns:
+Conversion
+\begin_inset Quotes erd
+\end_inset
+
+ tab.
+ The important parts are:
\end_layout
-\begin_layout Standard
+\begin_layout Description
+the
+\begin_inset space ~
+\end_inset
-\begin_inset ERT
-status inlined
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
+literate
+\begin_inset Quotes erd
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+\begin_inset space ~
\end_inset
-
+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
+\begin_inset space ~
+\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.
+\family sans
+Program
+\family default
+
+\begin_inset space ~
+\end_inset
+
+format This is an empty format whose sole purpose is to be the endpoint
+ of a conversion (which then allows us to set up a converter for it).
\end_layout
-\begin_layout Standard
+\begin_layout Description
+\family sans
+NoWeb
+\family default
+->
+\family sans
+LaTeX
+\family default
+ This converter performs the
+\begin_inset Quotes eld
+\end_inset
-\begin_inset ERT
-status inlined
+weaving
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+ of the literate document.
+ For Noweb, it is set to
+\begin_inset Quotes eld
+\end_inset
-\backslash
-begin{multicols}{2}
-\end_layout
+\family typewriter
+noweave -delay -index $$i > $$o
+\family default
+
+\begin_inset Quotes erd
\end_inset
\end_layout
-\begin_layout Standard
+\begin_layout Description
+\family sans
+NoWeb
+\family default
+->
+\family sans
+Program
+\family default
+ This performs the
+\begin_inset Quotes eld
+\end_inset
-\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
+tangling step
+\begin_inset Quotes erd
+\end_inset
-\begin_layout Standard
+.
+ 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
-\begin_inset ERT
-status inlined
+, with Flags set to
+\begin_inset Quotes eld
+\end_inset
-\begin_layout Standard
-\backslash
-end{multicols}
-\end_layout
+\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
-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
+server-goto-file-row" function, to be used with ddd/gdb or other debugger.
-\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
+When debugging code with ddd/gdb, it is possible to invoke a text editor
+ at the current execution position with a single key stroke.
+ The default ddd configuration for that is shift-ctrl-V.
+ It happens that you can define the editor command line invocation in ddd
+ by accessing the
+\family sans
+Edit\SpecialChar \menuseparator
+Preferences\SpecialChar \menuseparator
+Helpers
+\family default
+ dialog and changing the "Edit Sources" entry.
+\end_layout
\begin_layout Standard
+I take advantage of the new created LyX server function and this ddd feature,
+ and set
+\begin_inset Quotes eld
+\end_inset
-\backslash
-end{multicols}
-\end_layout
-
+Edit Sources
+\begin_inset Quotes erd
\end_inset
+ to:
+\end_layout
+\begin_layout LyX-Code
+echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
\end_layout
\begin_layout Standard
-
-Please do read the file
-\family typewriter
-examples/multicol.lyx
-\family default
- for more advanced examples including column and header spacing, vertical
- separator lines, and more.
+With 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 Section
-
-Numbering in the
+\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
-Enumerate
+Preferences
\family default
- Paragraph Environment
-\begin_inset OptArg
-status collapsed
+ (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
-\begin_layout Standard
-Numbering in Enumerate
-\end_layout
+\family typewriter
+/home/<your-home-directory>/.lyx/lyxpipe
+\family default
+\begin_inset Quotes erd
\end_inset
\end_layout
\begin_layout Standard
+Read the LyX server documentation in the
+\emph on
+Customization Manual
+\emph default
+ for further information.
+\end_layout
-by
-\noun on
-John Weiss
+\begin_layout Subsubsection
+Toolbar extensions
\end_layout
\begin_layout Standard
-
-
-\begin_inset VSpace bigskip
+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
-\noindent
-The default numbering for the
+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
-Enumerate
+View
\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
-
-\begin_layout LyX-Code
+\SpecialChar \menuseparator
+\family sans
+Update
+\family default
+\SpecialChar \menuseparator
-\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-Roman{enumi}.}
+\family sans
+DVI
+\family default
+ and the other for
+\family sans
+View\SpecialChar \menuseparator
+DVI
+\family default
+ File menu entries.
+ Here is how it looks like:
\end_layout
\begin_layout LyX-Code
+Toolbar
+\end_layout
+\begin_layout LyX-Code
+ Layouts
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumii}.}
+\begin_layout LyX-Code
+ Icon "layout Standard"
\end_layout
\begin_layout LyX-Code
+ Icon "layout Section"
+\end_layout
+\begin_layout LyX-Code
+ Icon "layout LaTeX"
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-arabic{enumiii}.}
+\begin_layout LyX-Code
+ Icon "layout LyX-Code"
\end_layout
\begin_layout LyX-Code
+ Icon "layout Scrap"
+\end_layout
+\begin_layout LyX-Code
+ Separator
+\end_layout
-\backslash
-renewcommand{
-\backslash
-labelenumiv}{
-\backslash
-alph{enumiv}.)}
+\begin_layout LyX-Code
+ Icon "buffer-view"
\end_layout
-\begin_layout Standard
+\begin_layout LyX-Code
+ Icon "buffer-typeset"
+\end_layout
-\SpecialChar \ldots{}
- which changes the numbering scheme to uppercase Roman numerals, uppercase
- letters, Arabic numbers, and lowercase letter.
+\begin_layout LyX-Code
+ Icon "build-program"
\end_layout
-\begin_layout Standard
+\begin_layout LyX-Code
+ Separator
+\end_layout
-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
+\begin_layout LyX-Code
+.
+\end_layout
-I.
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+.
+\end_layout
+\begin_layout LyX-Code
.
- 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
+\end_layout
-I.
-\begin_inset Quotes erd
-\end_inset
+\begin_layout LyX-Code
+End
+\end_layout
-,\InsetSpace ~
+\begin_layout Subsubsection
+Colors customization
+\end_layout
-\begin_inset Quotes erd
-\end_inset
+\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.
+\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 CommandInset label
+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
+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
-As you can see in the example, there is a label command for each nesting
- level,
-\family typewriter
+\begin_layout Section
+Multiple Columns
+\end_layout
-\backslash
-labelenumi
-\family default
- \SpecialChar \ldots{}
-
-\family typewriter
+\begin_layout Standard
+by
+\noun on
+Lars Gullik Bjønnes
+\end_layout
-\backslash
-labelenumiv
-\family default
-, as well as a counter,
+\begin_layout Subsection
+Purpose
+\end_layout
+
+\begin_layout Standard
+The aim for this chapter
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+Editor's note: Lars' original chapter was a masterful description of how
+ to use the
\family typewriter
-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
-
-\backslash
-roman{}
+multicol
\family default
-,
-\family typewriter
+ 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
-alph{}
+begin{multicols}{2}
\family default
-, and
+ at the point where you want the two column layout to start, and then
\family typewriter
\backslash
-Alph{}
+end{multicols}
\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.
+ where you want it to end.
+ Like this:
\end_layout
\begin_layout Standard
+\begin_inset ERT
+status open
-You can get really fancy with these.
- For example:
-\end_layout
-
-\begin_layout LyX-Code
+\begin_layout Plain Layout
\backslash
-renewcommand{
-\backslash
-labelenumi}{
-\backslash
-#
-\backslash
-Alph{enumi}
-\backslash
-#}
+begin{multicols}{2}
\end_layout
-\begin_layout LyX-Code
+\end_inset
-\backslash
-renewcommand{
-\backslash
-labelenumii}{
-\backslash
-Alph{enumi}.
-\backslash
-arabic{enumii}}
\end_layout
-\begin_layout LyX-Code
+\begin_layout Standard
+\noindent
+
+\series bold
+\size small
+The Adventure of the Empty House
+\series default
+\begin_inset Newline newline
+\end_inset
-\backslash
-renewcommand{
-\backslash
-labelenumiii}{
-\backslash
-alph{enumiii}+}
+by
+\noun on
+Sir Arthur Conan Doyle
+\end_layout
+
+\begin_layout Standard
+
+\size small
+It was in the spring of the year 1894 that all London was interested, and
+ the fashionable world dismayed, by the murder of the Honourable Ronald
+ 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 open
+
+\begin_layout Plain Layout
\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 open
-\begin_inset Quotes erd
-\end_inset
+\begin_layout Plain Layout
-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
+\begin_layout Standard
-Extra Space Between Table Rows
+\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
+\begin_inset ERT
+status open
-by
-\noun on
-Mike Ressler
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
+\backslash
+end{multicols}
+\end_layout
-\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
-\noindent
-LaTeX allows you to put a bit of extra space between rows in a table by
- giving an optional argument to the end-of-row specifier (
-\family typewriter
-
-\backslash
-
-\backslash
+You can have more than 3 columns if you want to, but that might not be very
+ pleasant for the eye.
+\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 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 open
+\begin_layout Plain Layout
-\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
+\end_inset
-\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 Standard
+\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 open
+\begin_layout Plain Layout
-\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
-
-\begin_layout Standard
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Dolomite
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+\size footnotesize
+The youth moved in the best society–had, so far as was known, no enemies
+ and no particular vices.
+ He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
+ had been broken off by mutual consent some months before, and there was
+ no sign that it had left any very profound feeling behind it.
+ For the rest {sic} the man's life moved in a narrow and conventional circle,
+ for his habits were quiet and his nature unemotional.
+ Yet it was upon this easy-going young aristocrat that death came, in most
+ strange and unexpected form, between the hours of ten and eleven-twenty
+ on the night of March 30, 1894.
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+\begin_inset ERT
+status open
+\begin_layout Plain Layout
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Quartz
+
+\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
-Graphite
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+\size footnotesize
+Ronald Adair was fond of cards–playing continually, but never for such stakes
+ as would hurt him.
+ He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
+ It was shown that, after dinner on the day of his death, he had played
+ a rubber of whist at the latter club.
+ He had also played there in the afternoon.
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
+\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 collapsed
+status open
+
+\begin_layout Plain Layout
-\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
+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
+\begin_layout Section
+Numbering in the
+\family sans
+Enumerate
+\family default
+ Paragraph Environment
+\begin_inset OptArg
+status collapsed
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Limestone
+\begin_layout Plain Layout
+Numbering in Enumerate
\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
-Sandstone
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
-
+by
+\noun on
+John Weiss
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+\begin_inset VSpace bigskip
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Granite
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\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
+\begin_layout LyX-Code
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Andesite
+\backslash
+renewcommand{
+\backslash
+labelenumi}{
+\backslash
+Roman{enumi}.}
\end_layout
-\end_inset
-</cell>
-</row>
-</lyxtabular>
+\begin_layout LyX-Code
-\end_inset
+\backslash
+renewcommand{
+\backslash
+labelenumii}{
+\backslash
+Alph{enumii}.}
+\end_layout
+\begin_layout LyX-Code
+\backslash
+renewcommand{
+\backslash
+labelenumiii}{
+\backslash
+arabic{enumiii}.}
\end_layout
-\begin_layout Standard
+\begin_layout LyX-Code
-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:
+\backslash
+renewcommand{
+\backslash
+labelenumiv}{
+\backslash
+alph{enumiv}.)}
\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
+\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
+I.
+\begin_inset Quotes erd
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Minerals
-\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
+,
+\begin_inset space ~
+\end_inset
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Calcite
-\end_layout
+\begin_inset Quotes erd
+\end_inset
+A.
+\begin_inset Quotes erd
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,
+\begin_inset space ~
+\end_inset
-\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
+1.
+\begin_inset Quotes erd
\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+,
+\begin_inset space ~
+\end_inset
-\end_layout
+\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
-Quartz
+>.
+
\end_layout
-\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+As you can see in the example, there is a label command for each nesting
+ level,
+\family typewriter
+\backslash
+labelenumi
+\family default
+ \SpecialChar \ldots{}
+
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Graphite
-\end_layout
-
+\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
+ commands,
+\family typewriter
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
+\backslash
+arabic{}
+\family default
+,
+\family typewriter
-\begin_inset ERT
-status collapsed
+\backslash
+roman{}
+\family default
+,
+\family typewriter
-\begin_layout Standard
+\backslash
+Roman{}
+\family default
+,
+\family typewriter
\backslash
+alph{}
+\family default
+, and
+\family typewriter
\backslash
-[-1ex]
+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
-
- Rocks
+\begin_layout Standard
+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
+\begin_layout LyX-Code
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Limestone
+\backslash
+renewcommand{
+\backslash
+labelenumii}{
+\backslash
+Alph{enumi}.
+\backslash
+arabic{enumii}}
\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
+labelenumiii}{
+\backslash
+alph{enumiii}+}
+\end_layout
+\begin_layout LyX-Code
-\family roman
-\series medium
-\shape up
-\size normal
-\emph off
-\bar no
-\noun off
-\color none
-Sandstone
+\backslash
+renewcommand{
+\backslash
+labelenumiv}{(
+\backslash
+roman{enumiv})}
\end_layout
-\end_inset
-</cell>
-</row>
-<row>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-
\begin_layout Standard
+produces the somewhat out of hand numbering scheme: <
+\begin_inset Quotes eld
+\end_inset
-\end_layout
+#A#
+\begin_inset Quotes erd
+\end_inset
+,
+\begin_inset space ~
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+\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
+A.1
+\begin_inset Quotes erd
+\end_inset
+,
+\begin_inset space ~
\end_inset
-</cell>
-<cell alignment="center" valignment="top" topline="true" usebox="none">
-\begin_inset Text
-\begin_layout Standard
+\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
+a+
+\begin_inset Quotes erd
+\end_inset
+,
+\begin_inset space ~
\end_inset
-</cell>
-</row>
-</lyxtabular>
+
+\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
-
Dropped Capitals
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
\noindent
-
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
newfont{
\begin_layout Standard
\noindent
-
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
hangindent=3.3em
\begin_inset Quotes erd
\end_inset
----those large capital letters which begin each new chapter or section.
+—those large capital letters which begin each new chapter or section.
Implementing them with plain LyX/LaTeX is straightforward (assuming you
know some plain TeX!) but does require a lot of work and many iterations,
as you can see by all the ugly TeX-mode stuff at the beginning of this
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
-status inlined
+status open
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
verb+
\end_layout
\begin_layout Section
-
Non-standard Paragraph Shapes
\end_layout
\begin_layout Standard
-
by
\noun on
Mike Ressler
\end_layout
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
-
\begin_layout Standard
-
-
\begin_inset ERT
-status inlined
+status collapsed
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
begin{sloppypar}
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
newdimen
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
setlength{
\begin_layout Standard
\noindent
-
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
parshape 19 0.45
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.40
\backslash
varunit 0.300
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.35
\backslash
varunit 0.293
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.30
\backslash
varunit 0.300
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.25
\backslash
varunit 0.317
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.20
\backslash
varunit 0.342
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.15
\backslash
varunit 0.373
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.10
\backslash
varunit 0.410
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.05
\backslash
varunit 0.453
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.00
\backslash
varunit 0.500
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.05
\backslash
varunit 0.453
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.10
\backslash
varunit 0.410
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.15
\backslash
varunit 0.373
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.20
\backslash
varunit 0.342
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.25
\backslash
varunit 0.317
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.30
\backslash
varunit 0.300
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.35
\backslash
varunit 0.293
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.40
\backslash
varunit 0.300
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+
0.45
\backslash
varunit 0.332
varunit
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
\end_layout
which will benefit from such handcrafting.
\end_layout
-
\begin_layout Standard
-
-
\begin_inset VSpace bigskip
\end_inset
\end_layout
\begin_layout Standard
-
The syntax is
\family typewriter
\end_layout
\begin_layout Standard
-
-
\begin_inset ERT
-status inlined
+status collapsed
+
+\begin_layout Plain Layout
-\begin_layout Standard
\backslash
end{sloppypar}
\end_layout
\begin_layout Section
-
Summary
\end_layout
\begin_layout Standard
-
As you can see, the examples in this section range from the useful to the
whimsical.
While I don't expect that anyone will ever need the paragraph shape demonstrate
projects / lyx.git / blobdiff