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.tex60
1 files changed, 39 insertions, 21 deletions
diff --git a/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex b/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
index a6690178e18..37615431be5 100644
--- a/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
+++ b/Master/texmf-dist/doc/latex/jmlr/jmlr-manual.tex
@@ -11,7 +11,7 @@
pdftitle={jmlr: LaTeX2e Classes for the Journal of Machine Learning Research},
pdfkeywords={LaTeX,jmlr}]{hyperref}
-\CheckSum{3806}
+\CheckSum{3918}
\OnlyDescription
\newcommand*{\appopt}[1]{\texttt{-{}-#1}}
@@ -25,7 +25,7 @@ Learning Research}
\author{Nicola L. C. Talbot\\[10pt]
\url{http://theoval.cmp.uea.ac.uk/~nlct/}}
- \date{2011-03-24 (version 1.11)}
+ \date{2012-01-05 (version 1.12)}
\maketitle
\tableofcontents
@@ -55,6 +55,25 @@ authors should ensure that their articles can compile with
PDF\LaTeX. \sectionref{sec:jmlrbook} describes how to use the
\clsfmt{jmlrbook} class.
+\begin{important}
+Note that the \clsfmt{jmlr} (and therefore \clsfmt{jmlrbook}) class automatically loads
+the \sty{hyperref} package, but some packages need to be loaded
+before \sty{hyperref}.
+\end{important}
+
+Anything that needs to be done before \sty{hyperref} is loaded can be specified
+by defining the command
+\begin{definition}[\DescribeMacro{\jmlrprehyperref}]
+\cs{jmlrprehyperref}
+\end{definition}
+\emph{before} the class is loaded. For
+example, to load the packages \styfmt{foo} and \styfmt{bar} before
+\sty{hyperref}, you can do:
+\begin{verbatim}
+\newcommand{\jmlrprehyperref}{\usepackage{foo,bar}}
+\documentclass{jmlr}
+\end{verbatim}
+
The \app{makejmlrbook} Perl script can be used to make a book that
uses the \clsfmt{jmlrbook} class. In addition to creating the print
and online versions of the book, it will compile the individual
@@ -106,8 +125,6 @@ Proceedings.
\item[{\clsopt[bottom]{tablecaption}}] in a \env{table} environment,
\ics{floatconts} puts the caption at the bottom.
-\item[\clsopt{prehyperref}=\marg{stuff}] Does \meta{stuff} before
-loading \sty{hyperref}.
\end{description}
\subsection{Title Information}
@@ -168,6 +185,13 @@ using the following commands:
\end{definition}
This specifies the article's title. A short title for the page
header can be supplied via the optional argument \meta{short title}.
+If you want to force a line break in the title, use
+\begin{definition}[\DescribeMacro{\titlebreak}]
+\cs{titlebreak}
+\end{definition}
+instead of \cs{newline} or \verb|\\| as this will ensure that the
+line break doesn't also end up in the table of contents or bookmarks
+when the article is included in a book.
\begin{definition}[\DescribeMacro{\editor}]
\cs{editor}\marg{name}
@@ -184,12 +208,13 @@ editor, use:
This specifies the author. The specifications \meta{author specs}
are a bit different to \sty{jmlr2e} and \sty{jmlrwcp2e}. Use
\begin{definition}[\DescribeMacro{\Name}]
-\cs{Name}\marg{author's name}
+\cs{Name}\oarg{abbreviated name}\marg{author's name}
\end{definition}
to specify the author's name. Note that if the surname contains a
space it must be grouped (enclosed in braces \{\}). Similarly if
the initial letter of each forename is a diacritic it must be
-grouped. (See below for examples.)
+grouped. If the abbreviation of the name doesn't get parsed
+properly you can override the default using the optional argument. (See below for examples.)
\begin{definition}[\DescribeMacro{\Email}]
\cs{Email}\marg{author's email}
\end{definition}
@@ -246,6 +271,14 @@ forename initials so grouping is required.
\addr Address 2
}
\end{verbatim}
+
+\item[Example 4] The author is actually a company so there's no
+first name and surname:
+\begin{verbatim}
+\author{\Name[Some Company, Ltd]{Some Company, Ltd}\Email{xyz:some.com}\\
+ \addr Address
+}
+\end{verbatim}
\end{description}
\subsection{Font Changing Commands}
@@ -945,21 +978,6 @@ Use this option for the print version without hyperlinks.
\item[\clsopt{7x10}] Set the paper size to $7\times10$ inches.
-\item[\clsopt{prehyperref}=\marg{stuff}] The \clsfmt{jmlr} class
-automatically loads
-the \sty{hyperref} package, but some packages need to be loaded
-before \sty{hyperref}. This information can be specified using
-the \clsopt{prehyperref} option. This is a key=value option. For
-example, to load the packages \styfmt{foo} and \styfmt{bar} before
-\sty{hyperref}, you can do:
-\begin{verbatim}
-\documentclass[prehyperref={\usepackage{foo,bar}}]{jmlrbook}
-\end{verbatim}
-or:
-\begin{verbatim}
-\documentclass[prehyperref={\usepackage{foo}\usepackage{bar}}]{jmlrbook}
-\end{verbatim}
-
\item[\clsopt{10pt}] Use 10pt as the normal text size.
\item[\clsopt{11pt}] Use 11pt as the normal text size (default).
\item[\clsopt{12pt}] Use 12pt as the normal text size.