summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex')
-rw-r--r--Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex101
1 files changed, 68 insertions, 33 deletions
diff --git a/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex b/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
index b5b004bfddf..a6690178e18 100644
--- a/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
+++ b/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
@@ -11,9 +11,11 @@
pdftitle={jmlr: LaTeX2e Classes for the Journal of Machine Learning Research},
pdfkeywords={LaTeX,jmlr}]{hyperref}
-\CheckSum{3348}
+\CheckSum{3806}
\OnlyDescription
+\newcommand*{\appopt}[1]{\texttt{-{}-#1}}
+
\begin{document}
\MakeShortVerb{"}
\DeleteShortVerb{\|}
@@ -23,7 +25,7 @@ Learning Research}
\author{Nicola L. C. Talbot\\[10pt]
\url{http://theoval.cmp.uea.ac.uk/~nlct/}}
- \date{2011-01-05 (version 1.10)}
+ \date{2011-03-24 (version 1.11)}
\maketitle
\tableofcontents
@@ -72,7 +74,7 @@ Note that unlike the \sty{jmlr2e} and \sty{jmlrwcp2e} packages,
this class file does not load the obsolete \sty{epsfig} package.
The \clsfmt{jmlrbook} class additionally loads the \cls{combine} class
-and the following packages: \sty{combnat} and \sty{setspace}.
+and the following packages: \sty{combnat}, \sty{setspace} and \sty{fink}.
The \app{makejmlrbook} script requires Perl, \TeX\ and \TeX4ht.
@@ -884,16 +886,17 @@ University of Chicago Press, 1996.
\section{Guidelines for Production Editors}
\label{sec:jmlrbook}
-The \clsfmt{jmlrbook} class can be used to combine articles that
-use the \clsfmt{jmlr} document class into a book. The following sample
+The \clsfmt{jmlrbook} class can be used to combine articles that use
+the \clsfmt{jmlr} document class into a book. The following sample
files are provided: \texttt{paper1/paper1.tex},
\texttt{paper2/paper2.tex}, \texttt{paper3/paper3.tex},
-\texttt{jmlr-sample.tex}, \texttt{jmlrwcp-sample.tex} and
-\texttt{jmlrbook-sample.tex}. All but the last named one are
-articles using the \clsfmt{jmlr} class. The last one
-(\texttt{jmlrbook-sample.tex}) uses the \clsfmt{jmlrbook} class file to
-combine the articles into a book. Note that no modifications are
-needed to the files using the \clsfmt{jmlr} class when they are
+\texttt{jmlr-sample.tex}, \texttt{jmlrwcp-sample.tex},
+\texttt{jmlrbook-sample.tex} and \texttt{proceedings-sample.tex}.
+All but the last two are articles using the \clsfmt{jmlr} class. The
+last two (\texttt{jmlrbook-sample.tex} and
+\texttt{proceedings-sample.tex}) uses the \clsfmt{jmlrbook} class
+file to combine the articles into a book. Note that no modifications
+are needed to the files using the \clsfmt{jmlr} class when they are
imported into the book. They can either be compiled as stand-alone
articles or with the entire book.
@@ -1068,7 +1071,7 @@ style and sets the page numbering to lower case Roman numerals.
This environment may be used by the author signing off at the end of a chapter such as the
foreword. Within the environment use:
\begin{definition}[\DescribeMacro{\Author}]
-\cs{author}\marg{details}
+\cs{Author}\marg{details}
\end{definition}
for the author's details. More than one \cs{Author} should be used
if there is more than one author. Example:
@@ -1081,6 +1084,24 @@ University of No Where}
\end{authorsignoff}
\end{verbatim}
+\begin{definition}[\DescribeEnv{preface}]
+\cs{begin}\{preface\}\oarg{filename}
+\end{definition}
+This environment may be used to typeset the preface. This starts a
+new chapter using
+\begin{verbatim}
+\chapter{\prefacename}
+\end{verbatim}
+\DescribeMacro{\prefacename}where \cs{prefacename} defaults to
+``Preface''. This environment should typically go in the front
+matter and is provided to allow \app{makejmlrbook} create a
+standalone document for the preface. The optional argument is the
+filename (without any extension or path) that will be used by
+\app{makejmlrbook}. This defaults to \texttt{preface} but, to
+conform with JMLR guidelines, should be changed to the surname of
+the first author (editor) followed by the final two digits of the
+year. See the JMLR website for further details of the guidelines.
+
\begin{definition}[\DescribeEnv{signoff}]
\cs{begin}\{signoff\}\oarg{team name}\marg{date}\\
\meta{editor list}\\
@@ -1088,9 +1109,11 @@ University of No Where}
\end{definition}
This environment may be used by the editorial team when signing off
a chapter such as the preface. If the optional argument is omitted,
-\qt{The Editorial Team} is used.
+\qt{The Editorial Team} is used. If you are using the \env{preface}
+environment described above, the \env{signoff} environment must go
+inside the \env{preface} environment.
-Within the environment use:
+Within the \env{signoff} environment use:
\begin{definition}[\DescribeMacro{\Editor}]
\cs{Editor}\marg{details}
\end{definition}
@@ -1374,7 +1397,11 @@ chance of this occurring, the \clsfmt{jmlr} class loads some commonly
used packages. For example, it loads the \sty{algorithm2e}
package with the \pkgoptfmt{algo2e} and \pkgoptfmt{ruled} options and
provides the \env{algorithm} environment in addition to
-\sty{algorithm2e}'s \env{algorithm2e} environment.
+\sty{algorithm2e}'s \env{algorithm2e} environment. Different
+versions of the same package can also be a problem. To help
+counteract the problem caused by different papers using different
+versions of the \sty{algorithm2e} package, \sty{jmlrbook} defines
+most of the old style commands if they don't exist.
Articles that use different input encodings can also cause a
problem. For example, if one article uses \texttt{utf8} and another
@@ -1407,6 +1434,7 @@ links to the abstracts and PDFs of individual articles. Note that
for it to work properly, the articles must be imported using
\cs{importarticle}, \cs{importpaper} or \cs{importpubpaper}, and
the imported articles must use the \clsfmt{jmlr} class.
+Note that I have only tested \app{makejmlrbook} on Linux.
On UNIX style systems, the script can be invoked from a terminal
using:
@@ -1435,36 +1463,43 @@ will be placed.
The options to \app{makejmlrbook} are as follows:
\begin{description}
-\item[--online] Generate the color on-line version (default).
-\item[--noonline] Don't generate the color on-line version.
-\item[--print] Generate the grayscale print version (default).
-\item[--noprint] Don't generate the grayscale print version.
-\item[--html] Generate the HTML files and the individual article
+\item[\appopt{online}] Generate the color on-line version (default).
+\item[\appopt{noonline}] Don't generate the color on-line version.
+\item[\appopt{print}] Generate the grayscale print version (default).
+\item[\appopt{noprint}] Don't generate the grayscale print version.
+\item[\appopt{html}] Generate the HTML files and the individual article
PDFs (default).
-\item[--nohtml] Don't generate the HTML files and the individual
+\item[\appopt{nohtml}] Don't generate the HTML files and the individual
article PDFs.
-\item[--logourl \meta{url}] Make the logo on the HTML index page link
+\item[\appopt{logourl} \meta{url}] Make the logo on the HTML index page link
to \meta{url}.
-\item[--batchtex] Run \TeX\ in batch mode.
-\item[--nobatchtex] Don't run \TeX\ in batch mode (default).
-\item[--quieter] Reduce chatter to STDOUT (doesn't eliminate
+\item[\appopt{extractpreface}] Extract the preface as a standalone document
+with links in the HTML index. (Only has an effect if combined with
+\appopt{html} option.) This will only work if the preface has been put
+inside the \env{preface} environment with the \env{signoff}
+environment that each editor with \ics{Editor}.
+\item[\appopt{noextractpreface}] Don't try extracting the preface.
+(Default.)
+\item[\appopt{batchtex}] Run \TeX\ in batch mode.
+\item[\appopt{nobatchtex}] Don't run \TeX\ in batch mode (default).
+\item[\appopt{quieter}] Reduce chatter to STDOUT (doesn't eliminate
all messages). This also runs \TeX\ in batch mode.
-\item[--noquieter] Don't reduce messages to STDOUT (default).
-\item[--version] Display the version number and exit.
-\item[--help] List all available options.
+\item[\appopt{noquieter}] Don't reduce messages to STDOUT (default).
+\item[\appopt{version}] Display the version number and exit.
+\item[\appopt{help}] List all available options.
\end{description}
There are also some more advanced options, but these haven't been
fully tested:
\begin{description}
-\item[--latexapp \meta{name}] Application used to call \LaTeX.
+\item[\appopt{latexapp} \meta{name}] Application used to call \LaTeX.
Defaults to \qt{pdflatex}.
-\item[--latexopt \meta{string}] Options to pass to \LaTeX.
-\item[--format \meta{string}] Output format (defaults to \qt{pdf}).
+\item[\appopt{latexopt} \meta{string}] Options to pass to \LaTeX.
+\item[\appopt{format} \meta{string}] Output format (defaults to \qt{pdf}).
This may need to be changed if you change the \LaTeX\ application.
-\item[--bibtexapp \meta{name}] Application use to process the
+\item[\appopt{bibtexapp} \meta{name}] Application use to process the
bibliography. Defaults to \qt{bibtex}.
-\item[--bibtexopt \meta{string}] Options to pass to Bib\TeX.
+\item[\appopt{bibtexopt} \meta{string}] Options to pass to Bib\TeX.
\end{description}
\StopEventually{\clearpage\phantomsection