0% found this document useful (0 votes)
210 views20 pages

L Tex2 Svmono Document Class Version 5.X Reference Guide For Monographs

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
210 views20 pages

L Tex2 Svmono Document Class Version 5.X Reference Guide For Monographs

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 20

LATEX2ε SVMono Document Class Version 5.

x
Reference Guide
for
Monographs

© 2018, Springer Nature


All rights reserved.

Contents

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
2 SVMono Class Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1 Initializing the SVMono Class . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 SVMono Class Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.3 Required and Recommended Packages . . . . . . . . . . . . . . . . . . 7
2.4 SVMono Commands and Environments in Text Mode . . . . . 9
2.5 SVMono Commands in Math Mode . . . . . . . . . . . . . . . . . . . . 12
2.6 SVMono Theorem-Like Environments . . . . . . . . . . . . . . . . . . 13
2.7 SVMono Commands for the Figure and Table Environments 15
2.8 SVMono Environments for Exercises, Problems . . . . . . . . . .
and Solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.9 SVMono Special Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
2.10 SVMono Commands for Styling References . . . . . . . . . . . . . . 19
2.11 SVMono Commands for Styling the Index . . . . . . . . . . . . . . . 19
2.12 SVMono Commands for Styling the Table of Contents . . . . . 20
References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1
1 Introduction

This reference guide gives a detailed description of the LATEX2ε SVMono document
class Version 5.x and its special features designed to facilitate the preparation of
scientific books for Springer Nature. It always comes as part of the SVMono tool
package and should not be used on its own.

The components of the SVMono tool package are:

• The Springer LATEX class SVMono.cls, MakeIndex styles svind.ist,


svindd.ist, BibTeX styles spmpsci.bst, spphys.bst, spbasic.bst
as well as the templates with preset class options, packages and coding
examples;

Tip: Copy all these files to your working directory, run LATEX2ε , BibTeX and
MakeIndex—as is applicable— and and produce your own example *.dvi file;
rename the template files as you see fit and use them for your own input.

• Author Instructions with style and coding instructions.

Tip: Follow these instructions to set up your files, to type in your text and
to obtain a consistent formal style in line with the Springer Nature layout
specifications; use these pages as checklists before you submit your manuscript
data.

• The Reference Guide describing SVMono features with regards to their


functionality.

Tip: Use it as a reference if you need to alter or enhance the default settings
of the SVMono document class and/or the templates.

The documentation in the Springer SVMono tool package is not intended to be a


general introduction to LATEX2ε or TEX. For this we refer you to [1–3].

Should we refer in this tool package to standard tools or packages that are not installed
on your system, please consult the Comprehensive TEX Archive Network (CTAN) at
[4–6].

SVMono was derived from the LATEX2ε book.cls and article.cls.

2
The main differences from the standard document classes article.cls and
book.cls are the presence of

• multiple class options,

• a number of newly built-in environments for individual text structures like


theorems, exercises, lemmas, proofs, etc.,

• enhanced environments for the layout of figures and captions, and

• new declarations, commands and useful enhancements of standard


environments to facilitate your math and text input and to ensure their output
is in line with the Springer Nature layout standards.

Nevertheless, text, formulae, figures, and tables are typed using the standard LATEX2ε
commands. The standard sectioning commands are also used.

Always give a \label where possible and use \ref for cross-referencing. Such
cross-references may then be converted to hyperlinks in any electronic version of
your book.

The \cite and \bibitem mechanism for bibliographic references is also obligatory.

2 SVMono Class Features

2.1 Initializing the SVMono Class

To use the document class, enter

\documentclass [options] {svmono}

at the beginning of your input.

2.2 SVMono Class Options

Choose from the following list of SVMono class options if you need to alter the
default layout settings of the SVMono document class. Please note that the optional
features should only be chosen if instructed so by the editor of your book.

3
Page Style

default twoside, single-spaced output, contributions starting always on a


recto page
referee produces double-spaced output for proofreading
footinfo generates a footline with name, date, . . . at the bottom of each
page
norunningheads suppresses any headers and footers

N.B. If you want to use both options, you must type referee before footinfo.

Body Font Size

default 10 pt
11pt, 12pt are ignored

Language for Fixed LATEX Texts

In the SVMono class we have changed a few standard LATEX texts (e.g. Figure to Fig.
in figure captions) and assigned names to newly defined theorem-like environments
so that they conform with Springer Nature style requirements.

default English
deutsch translates fixed LATEX texts into their German equivalent
francais same as above for French

Text Style

default plain text


graybox automatically activates the packages color and framed
and places a box with 15 percent gray shade in the background
of the text when you use the SVMono environment
\begin{svgraybox}...\end{svgraybox}, see Sects. 2.3, 2.4.

Equations Style

default centered layout, vectors boldface (math style)


vecphys produces boldface italic vectors (physics style)
when \vec-command is used
vecarrow depicts vectors with an arrow above when \vec-command
is used

4
Numbering and Layout of Headings

default all section headings down to subsubsection level are numbered,


second and subsequent lines in a multiline numbered heading are
indented; Paragraph and Subparagraph headings are displayed but not
numbered; figures, tables and equations are numbered chapterwise,
individual theorem-like environments are counted consecutively
throughout the book.

nosecnum suppresses any section numbering; figures, tables and equations are
counted chapterwise displaying the chapter counter, if applicable.

nochapnum suppresses the chapter numbering only, subsequent section headings


as well as figures, tables and equations are numbered chapterwise but
without chapter counter.

nonum suppresses any numbering of any headings; tables, figures, equations


are counted consecutively throughout the book.
\chapter* must not be used since all subsequent numbering will go bananas . . .
Warning !
Numbering of Figures, Tables and Equations

default chapter-wise numbering

numart numbers figures, tables, equations consecutively (not chapterwise)


throughout the whole text, as in the standard article document class

Numbering and Counting of Built-in Theorem-Like Environments

default each built-in theorem-like environment gets its own counter


without any chapter or section prefix and is counted
consecutively throughout the book

envcountchap Each built-in environment gets its own counter and is numbered
chapterwise. To be selected as default setting for a book with
numbered chapters.

envcountsect each built-in environment gets its own counter and is numbered
sectionwise

envcountsame all built-in environments follow a single counter without


any chapter or section prefix, and are counted consecutively
throughout the book
envcountresetchap each built-in environment gets its own counter without any
chapter or section prefix but with the counter reset for each
chapter

5
envcountresetsect each built-in environment gets its own counter without any
chapter or section prefix but with the counter reset for each
section

N.B.1 When the option envcountsame is combined with the options


envcount-resetchap or envcountresetsect all predefined environments get the same
counter; but the counter is reset for each chapter or section.
N.B.2 When the option envcountsame is combined with the options envcountchap
or envcountsect all predefined environments get a common counter with a chapter
or section prefix; but the counter is reset for each chapter or section.

N.B.3 We have designed a new easy-to-use mechanism to define your own


environments.

N.B.4 Be careful not to use layout options that contradict the parameter of the selected
Warning ! environment option and vice versa.
Use the Springer class option

nospthms only if you want to suppress all defined theorem-like environments


and use the theorem environments of original LATEX package or other
theorem packages instead. (Please check this with your editor.)

References

default the list of references is set as an unnumbered chapter starting on a new


recto page, with automatically correct running heads and an entry in the
table of contents. The list itself is set in small print and numbered with
ordinal numbers.
sectrefs sets the reference list as an unnumbered section, e.g. at the end of a
chapter
natbib sorts reference entries in the author-year system (make sure that you
have the natbib package by Patrick W. Daly installed. Otherwise it
can be found at the Comprehensive TEX Archive Network (CTAN...tex-
archive/macros/latex/contrib/supported/natbib/), see [4–6]

Use the Springer class option

oribibl only if you want to set reference numbers in square brackets without
automatic TOC entry etc., as is the case in the original LATEX bibliography
environment. But please note that most page layout features are
nevertheless adjusted to Springer Nature requirements. (Please check
usage of this option with your editor.)

6
2.3 Required and Recommended Packages

SVMono document class has been tested with a number of Standard LATEX tools.
Below we list and comment on a selection of recommended packages for preparing
fully formatted book manuscripts for Springer Nature. If not installed on your system,
the source of all standard LATEX tools and packages is the Comprehensive TEX Archive
Network (CTAN) at [4–6].
Font Selection
default Times font family as default text body font together with
Helvetica clone as sans serif and Courier as typewriter
font.
newtxtext.sty and Supports roman text font provided by a Times clone, sans
newtxmath.sty serif based on a Helvetica clone, typewriter faces, plus
math symbol fonts whose math italic letters are from a
Times Italic clone
If the packages ‘newtxtext.sty and newtxmath.sty’ are not already installed
with your LATEX they can be found at https://ctan.org/tex.archive/ fonts/newtx at the
Comprehensive TEX Archive Network (CTAN), see [4–6].
If Times Roman is not available on your system you may revert to CM fonts. However,
the SVMono layout requires font sizes which are not part of the default set of the
computer modern fonts.

type1cm.sty The type1cm package enhances this default by enabling


scalable versions of the (Type 1) CM fonts. If not already
installed with your LATEX it can be found at ../tex-archive/
macros/latex/contrib/type1cm/ at the Comprehensive TEX Archive
Network (CTAN), see [4–6].

Body Text
When you select the SVMono class option [graybox] the packages framed and
color are required, see Sect. 2.2

framed.sty makes it possible that framed or shaded regions can break across
pages.
color.sty is part of the graphics bundle and makes it possible to selct the
color and define the percentage for the background of the box.

Equations
A useful package for subnumbering each line of an equation array can be found
at ../tex-archive/macros/latex/contrib/supported/subeqnarray/ at the Comprehensive
TEX Archive Network(CTAN), see [4–6].

7
subeqnarray.sty defines the subeqnarray and subeqnarray* environments,
which behave like the equivalent eqnarray and eqnarray*
environments, except that the individual lines are numbered
as 1a, 1b, 1c, etc.

Footnotes

footmisc.sty used with style option [bottom] places all footnotes at the bottom
of the page

Figures

graphicx.sty tool for including graphics files (preferrably eps files)

References

default Reference lists are numbered with the references being cited in the
text by their reference number
natbib.sty sorts reference entries in the author–year system (among other
features). N.B. This style must be installed when the class option
natbib is used, see Sect. 2.2
cite.sty generates compressed, sorted lists of numerical citations: e.g.
[8,11–16]; preferred style for books published in a print version
only

Index

makeidx.sty provides and interprets the command \printindex which


“prints” the externally generated index file *.ind.
multicol.sty balances out multiple columns on the last page of your subject
index, glossary or the like

N.B. Use the MakeIndex program together with one of the following styles

svind.ist for English texts


svindd.ist for German texts

to generate a subject index automatically in accordance with Springer Nature layout


requirements. For a detailed documentation of the program and its usage we refer
you to [1].

8
2.4 SVMono Commands and Environments in Text Mode

Use the environment syntax

\begin{dedication}
text
\end{dedication}

to typeset a dedication or quotation at the very beginning of the in preferred Springer


layout.
Use the new commands

\foreword
\preface

to typeset a Foreword or Preface with automatically generated runnings heads.


Use the new commands

\extrachap{heading}
\Extrachap{heading}

to typeset — in the front or back matter of the book—an extra unnumbered chapter
with your preferred heading and automatically generated runnings heads.
\Extrachap furthermore generates an automated TOC entry.
Use the new command

\partbacktext{text}
to typeset a text on the back side of a part title page.
Use the new command

\chapsubtitle[subtitle]
to typeset a possible subtitle to your chapter title. Beware that this subtitle is not
tranferred automatically to the table of contents.
The command must be placed before the \chapter command.
Alternatively use the \chapter-command to typeset your subtitle together with the
chapter title and separate the two titles by a period or an en-dash. Alternative !
The command must be placed before the \chapter command.

9
Use the new command

\chapauthor[name]
to typeset the author name(s) beneath your chapter title. Beware that the author
name(s) are not tranferred automatically to the table of contents.
The command must be placed before the \chapter command.
Alternatively, if the book has rather the character of a contributed volume as opposed
to a monograph you may want to use the SVMono package with features that better
Alternative ! suit the specific requirements.
Use the new commands

\chaptermark{}
\sectionmark{}

to alter the text of the running heads.


Use the new command

\motto{text}
to include special text, e.g. mottos, slogans, between the chapter heading and the
actual content of the chapter in the preferred Springer layout.
The argument {text} contains the text of your inclusion. It may not contain any
empty lines. To introduce vertical spaces use \\[height].
If needed, the you may indicate an alternative widths in the optional argument.
N.B. The command must be placed before the relevant heading-command.
Use the new commands

\abstract{text}
\abstract*{text}

to typeset an abstract at the beginning of a chapter.


The text of \abstract* will not be depicted in the printed version of the book, but
will be used for compiling html abstracts for the online publication of the individual
chapters www.SpringerLink.com.
Warning !!! Please do not use the standard LATEX environment
\begin{abstract}...\end{abstract} – it will be ignored when used with the
SVMono document class!

10
Use the new commands

\runinhead[title]
\subruninhead[title]

when you want to use unnumbered run-in headings to structure your text.
Use the new environment command

\begin{svgraybox}
text
\end{svgraybox}

to typeset complete paragraphs within a box showing a 15 percent gray shade.


N.B. Make sure to select the SVMono class option [graybox] in order to have all
the required style packages available, see Sects. 2.2, 2.3. Warning !
Use the new environment command

\begin{petit}
text
\end{petit}

to typeset complete paragraphs in small print.


Use the enhanced environment command

\begin{description}[largelabel]
\item[label1] text1
\item[label2] text2
\end{description}

for your individual itemized lists.


The new optional parameter [largelabel] lets you specify the largest item label to
two levels to appear within the list. The texts of all items are indented by the width
of largelabel and the item labels are typeset flush left within this space. Note, the
optional parameter will work only two levels deep.

11
Use the commands

\setitemindent{largelabel}
\setitemitemindent{largelabel}

if you need to customize the indention of your “itemized” or “enumerated”


environments.

2.5 SVMono Commands in Math Mode

Use the new or enhanced symbol commands provided by the SVMono document
class:

\D upright d for differential d


\I upright i for imaginary unit
\E upright e for exponential function
\tens depicts tensors as sans serif upright
\vec depicts vectors as boldface characters instead of the arrow accent

N.B. By default the SVMono document class depicts Greek letters as italics because
they are mostly used to symbolize variables. However, when used as operators,
abbreviations, physical units, etc. they should be set upright.
All upright upper-case Greek letters have been defined in the SVMono document
class and are taken from the TEX alphabet.
Use the command prefix

\var...
with the upper-case name of the Greek letter to set it upright, e.g. \varDelta.
Many upright lower-case Greek letters have been defined in the SVMono document
class and are taken from the PostScript Symbol font.
Use the command prefix

\u...
with the lower-case name of the Greek letter to set it upright, e.g. \umu.
If you need to define further commands use the syntax below as an example:

\newcommand{\ualpha}{\allmodesymb{\greeksym}{a}}

12
2.6 SVMono Theorem-Like Environments

For individual text structures such as theorems, definitions, and examples, the
SVMono document class provides a number of pre-defined environments which
conform with the specific Springer Nature layout requirements.
Use the environment command

\begin{name of environment}[optional material]


text for that environment
\end{name of environment}

for the newly defined environments.


Unnumbered environments will be produced by
claim and proof.
Numbered environments will be produced by
case, conjecture, corollary, definition, example, exercise, lemma, note,
problem, property, proposition, question, remark, solution, and theorem.
The optional argument [optional material] lets you specify additional text which
will follow the environment caption and counter.
N.B. We have designed a new easy-to-use mechanism to define your own
environments.
Use the new symbol command

\qed
to produce an empty square at the end of your proof.
In addition, use the new declaration

\smartqed
to move the position of the predefined qed symbol to be flush right (in text mode). If
you want to use this feature throughout your book the declaration must be set in the
preamble, otherwise it should be used individually in the relevant environment, i.e.
proof.
Example
\begin{proof}
\smartqed
Text
\qed
\end{proof}

13
Furthermore the functions of the standard \newtheorem command have been
enhanced to allow a more flexible font selection. All standard functions though
remain intact (e.g. adding an optional argument specifying additional text after the
environment counter).
Use the mechanism

\spdefaulttheorem{env name}{caption}{cap font}{body font}


to define an environment compliant with the selected class options (see Sect. 2.2)
and designed as the predefined theorem-like environments.
The argument {env name} specifies the environment name; {caption} specifies
the environment’s heading; {cap font} and {body font} specify the font shape
of the caption and the text body.
N.B. If you want to use optional arguments in your definition of a theoremlike
environment as done in the standard \newtheorem command, see below.
Use the mechanism

\spnewtheorem{env name}[numbered like]{caption}{cap font}{body font}


to define an environment that shares its counter with another predefined environment
[numbered like].
The optional argument [numbered like] specifies the environment with which to
share the counter.
N.B. If you select the class option “envcountsame” the only valid “numbered like”
argument is [theorem].
Use the defined mechanism

\spnewtheorem{env name}{caption}[within]{cap font}{body font}


to define an environment whose counter is prefixed by either the chapter or section
number (use [chapter] or [section] for [within]).
Use the defined mechanism

\spnewtheorem*{env name}{caption}{cap font}{body font}


to define an unnumbered environment such as the pre-defined unnumbered
environments claim and proof.

14
Use the defined declaration

\nocaption
in the argument {caption} if you want to skip the environment caption and use an
environment counter only.
Use the defined environment

\begin{theopargself}
...
\end{theopargself}

as a wrapper to any theorem-like environment defined with the mechanism. It


suppresses the brackets of the optional argument specifying additional text after
the environment counter.

2.7 SVMono Commands for the Figure and Table Environments

Use the new declaration

\sidecaption[pos]
to move the figure caption from beneath the figure (default) to the lower lefthand
side of the figure.
The optional parameter [t] moves the figure caption to the upper left-hand side of
the figure
N.B.1 (1) Make sure the declaration \sidecaption follows the \begin{figure}
command, and (2) remember to use the standard \caption{} command for your
caption text.
N.B.2 This declaration works only if the figure width is less than 7.8 cm. The caption
text will be set raggedright if the width of the caption is less than 3.4 cm.
Use the new declaration

\samenumber
within the figure and table environment – directly after the \begin{environment}
command – to give the caption concerned the same counter as its predecessor (useful
for long tables or figures spanning more than one page, see also the declaration
\subfigures below.

15
To arrange multiple figures in a single environment use the newly defined commands

\leftfigure[pos] and \rightfigure[pos]


within a {minipage}{\textwidth} environment. To allow enough space
between two horizontally arranged figures use \hspace{\fill} to separate the
corresponding \includegraphics{} commands. The required space between
vertically arranged figures can be controlled with \\[12pt], for example.
The default position of the figures within their predefined space is flush left. The
optional parameter [c] centers the figure, whereas [r] positions it flush right – use
the optional parameter only if you need to specify a position other than flush left.
Use the newly defined commands

\leftcaption{} and \rightcaption{}


outside the minipage environment to put two figure captions next to each other.
Use the newly defined command

\twocaptionwidth{width}{width}
to overrule the default horizontal space of 5.4 cm provided for each of
the abovedescribed caption commands. The first argument corresponds to
\leftcaption and the latter to \rightcaption.
Use the new declaration

\subfigures
within the figure environment – directly after the \begin{figure} command – to
subnumber multiple captions alphabetically within a single figure-environment.
N.B.: When used in combination with \samenumber the main counter remains the
same and the alphabetical subnumbering is continued. It works properly only when
you stick to the sequence \samenumber\subfigures.
If you do not include your figures as electronic files use the defined command

\mpicplace{width}{height}
to leave the desired amount of space for each figure. This command draws a vertical
line of the height you specified.
Use the new command

\svhline
for setting in tables the horizontal line that separates the table header from the table
content.

16
2.8 SVMono Environments for Exercises, Problems and Solutions

Use the environment command

\begin{prob}
\label{problem:key}
problem text
\end{prob}

to typeset and number each problem individually.


To facilitate the correct numbering of the solutions we have also defined a solution
environment, which takes the problem’s key, i.e. problem:key (see above) as
argument.
Use the environment syntax

\begin{sol}{problem:key}
solution text
\end{sol}

to get the correct (i.e. problem =) solution number automatically.

2.9 SVMono Special Elements

Use the commands

\begin{trailer}{Trailer Head}
...
\end{trailer}

If you want to emphasize complete paragraphs of texts in an Trailer Head.


Use the commands

\begin{question}{Questions}
...
\end{question}

If you want to emphasize complete paragraphs of texts in an Questions.

17
Use the commands

\begin{important}{Important}
...
\end{important}

If you want to emphasize complete paragraphs of texts in an Important.


Use the commands

\begin{warning}{Attention}
...
\end{warning}

If you want to emphasize complete paragraphs of texts in an Attention.


Use the commands

\begin{programcode}{Program Code}
...
\end{programcode}

If you want to emphasize complete paragraphs of texts in an Program Code.


Use the commands

\begin{tips}{Tips}
...
\end{tips}

If you want to emphasize complete paragraphs of texts in an Tips.


Use the commands

\begin{overview}{Overview}
...
\end{overview}

If you want to emphasize complete paragraphs of texts in an Overview.


Use the commands

\begin{backgroundinformation}{Background Information}
...
\end{backgroundinformation}

If you want to emphasize complete paragraphs of texts in an Background


Information.

18
Use the commands

\begin{legaltext}{Legal Text}
...
\end{legaltext}
If you want to emphasize complete paragraphs of texts in an Legal Text.

2.10 SVMono Commands for Styling References

The command

\biblstarthook{text}
allows the inclusion of explanatory text between the bibliography heading and the
actual list of references. The command must be placed before the thebibliography
environment.

2.11 SVMono Commands for Styling the Index

The declaration

\threecolindex
sets the next index following the \threecolindex declaration in three columns.
The Springer declaration

\indexstarthook{text}
allows the inclusion of explanatory text between the index heading and the actual list
of references. The command must be placed before the theindex environment.

2.12 SVMono Commands for Styling the Table of Contents

Use the command

\setcounter{tocdepth}{number}
to alter the numerical depth of your table of contents.

19
Use the macro

\calctocindent
to recalculate the horizontal spacing for large section numbers in the table of contents
set with the following variables:
\tocchpnum for the chapter number
\tocsecnum section number
\tocsubsecnum subsection number
\tocsubsubsecnum subsubsection
\tocparanum paragraph number
Set the sizes of the variables concerned at the maximum numbering appearing in the
current document.
In the preamble set e.g:

\settowidth{\tocchpnum}{36.\enspace}
\settowidth{\tocsecnum}{36.10\enspace}
\settowidth{\tocsubsecnum}{99.88.77}
\calctocindent

References

[1] L. Lamport: LATEX: A Document Preparation System 2nd ed. (Addison-Wesley,


Reading, Ma 1994)

[2] M. Goossens, F. Mittelbach, A. Samarin: The LATEX Companion (Addison-Wesley,


Reading, Ma 1994)

[3] D. E. Knuth: The TEXbook (Addison-Wesley, Reading, Ma 1986) revised to cover


TEX3 (1991)

[4] TEX Users Group (TUG), http://www.tug.org

[5] Deutschsprachige Anwendervereinigung TEX e.V. (DANTE), Heidelberg,


Germany, http://www.dante.de

[6] UK TEX Users’ Group (UK-TuG), http://uk.tug.org

20

You might also like