Chapter 10: KOMA-Script Features for other Classes with Package scrextend
276
cleardoublepage=page style
cleardoublepage=current
With this option, you may define the page style of the interleaf pages created by the
\cleardoublepage
,
\cleardoubleoddpage
, or
\cleardoubleevenpage
to break until the
wanted page. Every already defined page style (see
section 10.9
from
page 275
and
chap-
ter 5
from
page 225
) may be used. Besides this, cleardoublepage=current is valid. This
case is the default until KOMA-Script 2.98c and results in interleaf page without changing the
page style. Since KOMA-Script 3.00 the default follows the recommendation of most typogra-
phers and has been changed to blank interleaf pages with page style empty unless you switch
compatibility to an earlier version (see option
version
,
section 10.2
,
page 266
).
Example: Assume you want interleaf pages almost empty but with pagination. This means
you want to use page style plain. You may use following to achieve this:
\KOMAoptions{cleardoublepage=plain}
More information about page style plain may be found at
section 3.12
,
page 78
.
\clearpage
\cleardoublepage
\cleardoublepageusingstyle{page style }
\cleardoubleemptypage
\cleardoubleplainpage
\cleardoublestandardpage
\cleardoubleoddpage
\cleardoubleoddpageusingstyle{page style }
\cleardoubleoddemptypage
\cleardoubleoddplainpage
\cleardoubleoddstandardpage
\cleardoubleevenpage
\cleardoubleevenpageusingstyle{page style }
\cleardoubleevenemptypage
\cleardoubleevenplainpage
\cleardoubleevenstandardpage
The L
A
TEX kernel contains the \clearpage command, which takes care that all not yet output
floats are output, and then starts a new page. There exists the instruction \cleardoublepage
which works like \clearpage but which, in the double-sided layouts (see layout option twoside
in
section 2.4
,
page 38
) starts a new right-hand page. An empty left page in the current page
style is output if necessary.
With \cleardoubleoddstandardpage, KOMA-Script works as described above. The
\cleardoubleoddplainpage
command changes the page style of the empty left page to plain
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
277
in order to suppress the running head. Analogously, the page style empty is applied to the
empty page with \cleardoubleoddemptypage, suppressing the page number as well as the
running head. The page is thus entirely empty. If another page style is wanted for the
interleaf page is may be set with the argument of \cleardoubleoddusingpagestyle. Every
already defined page style (see
chapter 5
) may be used.
Sometimes chapters should not start on the right-hand page but the left-hand page.
This is in contradition to the classic typography; nevertheless, it may be suitable, e. g.,
if the double-page spread of the chapter start is of special contents. KOMA-Script there-
for provides the commands \cleardoubleevenstandardpage, \cleardoubleevenplainpage,
\cleardoubleevenemptypage
, and \cleardoubleevenpageusingstyle, which are equivalent
to the odd-page commands.
However, the approach used by the KOMA-Script commands \cleardoublestandardpage,
\cleardoubleemptypage
, \cleardoubleplainpage, and \cleardoublepageusingstyle is
dependent on the option cleardoublepage described above and is similar to one of the corre-
sponding commands above. The same is valid for the standard command \cleardoublepage,
that may be either \cleardoubleoddpage or \cleardoubleevenpage.
Example: Assume you want to set next in your document a double-page spread with a picture
at the left-hand page and a chapter start at the right-hand page. The picture
should have the same size as the text area without any head line or pagination.
If the last chapter ends with a left-hand page, an interleaf page has to be added,
which should be completely empty.
First you will use
\KOMAoptions{cleardoublepage=empty}
to make interleaf pages empty. You may use this setting at the document pream-
ble already. As an alternative you may set it as the optional argument of
\documentclass
.
At the relevant place in your document, you’ll write:
\ cleardoubleevenemptypage
\thispagestyle{empty}
\includegraphics[width=\textwidth,%
height=\textheight,%
keepaspectratio]%
{picture}
\chapter{Chapter Headline}
The first of these lines switches to the next left page. If needed it also adds a
completely blank right-hand page. The second line makes sure that the following
left-hand page will be set using page style empty too. From third down to sixth line,
an external picture of wanted size will be loaded without deformation. Package
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
278
graphicx will be needed for this command. The last line starts a new chapter on
the next page which will be a right-hand one.
The commands \cleardoubleoddpage respective \cleardoubleevenpage leads to the next
odd respectively even page. The page style of an interleaf page will be set depending on option
cleardoublepage
.
10.11. Footnotes
All of what is described in
section 3.14
is generally applicable. So if you have alread read and
understood
section 3.14
you can switch to
section 10.12
,
page 282
.
Package scrextend supports all the footnote features of the KOMA-Script classes. Neverthe-
less, by default the footnotes are under full control of the used class. This changes as soon as
command
\deffootnote
(see
page 280
) has been used.
Package scrextend does not provide settings for the separation line above the footnotes.
footnotes=setting
At several classes footnotes will be marked with a tiny superscript number in text by default.
If more than one footnote falls at the same place, one may think that it is only one footnote
with a very large number instead of multiple footnotes (i. e., footnote 12 instead of footnotes
1 and 2). Using footnotes=multiple will separate multiple footnotes immediately next to
each other by a separator string. The predefined separator at
\multfootsep
is a single comma
without space. The whole mechanism is compatible with package footmisc, Version 5.3d (see
[
Fai11
]). It is related not only to footnotes placed using
\footnote
, but
\footnotemark
too.
Command
\KOMAoptions
or
\KOMAoption
may be used to switch back to the default
footnotes=nomultiple
at any time. If any problems using another package that influences
footnotes occur, it is recommended not to use the option anywhere and not to change the
setting
anywhere inside the document.
A summary of the available setting values of footnotes may be found at
table 3.11
,
page 85
.
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
279
\footnote[number ]{text }
\footnotemark[number ]
\footnotetext[number ]{text }
\multiplefootnoteseparator
\multfootsep
Similar to the standard classes, footnotes in KOMA-Script are produced with the
\footnote
command, or alternatively the paired usage of the commands \footnotemark
and \footnotetext. As in the standard classes, it is possible that a page break occurs within
a footnote. Normally this happens if the footnote mark is placed so near the bottom of a page
as to leave L
A
TEX no choice but to break the footnote onto the next page. KOMA-Script ,
unlike the standard classes, can recognize and separate consecutive footnotes automatically.
See the previously documented option
footnotes
for this.
If you want to set the separator manually, you may use \multiplefootnoteseparator.
Note that this command should not be redefined, because it has been defined not only to be
the separator string but also the type style, i. e., font size and superscript. The separator
string without type style may be found at \multfootsep. The predefined default is
\newcommand*{\multfootsep}{,}
and may be changed by redefining the command.
Example: Assume you want to place two footnotes following a single word. First you may
try
Word\ footnote{1st footnote}\ footnote{2nd footnote}
for this. Assume that the footnotes will be numbered with 1 and 2. Now the reader
may think it’s a single footnote 12, because the 2 immediately follows the 1. You
may change this using
\KOMAoptions{footnotes=multiple}
which would switch on the automatic recognition of footnote sequences. As an
alternative you may use
Word\footnote{1st footnote}%
\multiplefootnoteseparator
\footnote{2nd footnote}
This should give you the wanted result even if the automatic solution would fail
or could not be used.
Further, assume you want the footnotes separated not only by a single comma,
but by a comma and a white space. In this case you may redefine
\renewcommand*{\multfootsep}{,\nobreakspace}
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
280
at the document preamble. \nobreakspace instead of a usual space character has
been used in this case to avoid paragraph or at least page breaks within footnote
sequences.
\footref{reference }
Sometimes there are single footnotes to multiple text passages. The least sensible way to
typeset this would be to repeatedly use
\footnotemark
with the same manually set number.
The disadvantages of this method would be that you have to know the number and manually fix
all the
\footnotemark
commands, and if the number changes because of adding or removing
a footnote before, each
\footnotemark
would have to be changed. Because of this, KOMA-
Script provides the use of the \label mechanism in such cases. After simply setting a \label
inside the footnote, \footref may be used to mark all the other text passages with the same
footnote mark.
Example: Maybe you have to mark each trade name with a footnote which states that it is
a registered trade name. You may write, e. g.,
Company SplishSplash\footnote{This is a registered trade name.
All rights are reserved.\label{refnote}}
produces not only SplishPlump\footref{refnote}
but also SplishPlash\footref{refnote}.
This will produce the same footnote mark three times, but only one footnote
text. The first footnote mark is produced by
\footnote
itself, and the following
two footnote marks are produced by the additional \footref commands. The
footnote text will be produced by
\footnote
.
Because of setting the additional footnote marks using the \label mechanism, changes of the
footnote numbers will need at least two L
A
TEX runs to ensure correct numbers for all \footref
marks.
\deffootnote[mark width ]{indent }{parindent }{definition }
\deffootnotemark{definition }
\thefootnotemark
Footnotes are formatted slightly differently in KOMA-Script to in the standard classes. As
in the standard classes the footnote mark in the text is depicted using a small superscripted
number. The same formatting is used in the footnote itself. The mark in the footnote is
type-set right-aligned in a box with width mark width . The first line of the footnote follows
directly.
All following lines will be indented by the length of indent . If the optional parameter
mark width
is not specified, it defaults to indent . If the footnote consists of more than one
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
281
paragraph, then the first line of a paragraph is indented, in addition to indent , by the value
of parindent .
Figure 3.1
illustrates the layout parameters. The default configuration of the KOMA-Script
classes is:
\deffootnote[1em]{1.5em}{1em}
{\textsuperscript{\thefootnotemark}}
\textsuperscript
controls both the superscript and the smaller font size. Command
\thefootnotemark
is the current footnote mark without any formatting. Package scrextend
in contrast to this does not change the default footnote settings of the used class. Loading
the package does not change any type style of footnote marks or footnote text in general. You
have to copy the above shown source to use the default settings of the KOMA-Script classes
with scrextend. This may be done immediately after loading package scrextend.
Thefont element footnote determines the font of the footnote including the footnote mark.
Using the element footnotelabel the font of the footnote mark can be changed separately
with the commands
\setkomafont
and
\addtokomafont
(see
section 10.6
,
page 269
). Please
refer also to
table 3.2
,
page 58
. Default setting is no change in the font. With scrextend the
elements may change the fonts only if the footnotes are handled by the package, i. g., after
using \deffootnote.
The footnote mark in the text is defined separately from the mark in front of the actual
footnote. This is done with \deffootnotemark. Default setting is:
\deffootnotemark{%
\textsuperscript{\thefootnotemark}}
In the above the font for the element footnotereference is applied (see
table 3.2
,
page 58
).
Thus the footnote marks in the text and in the footnote itself are identical. The font can be
changed with the commands
\setkomafont
and
\addtokomafont
(see
section 10.6
,
page 269
)
after usage of \deffootnotemark.
Example: A feature often asked for is footnote marks which are neither in superscript nor in
a smaller font size. They should not touch the footnote text but be separated by
a small space. This can be accomplished as follows:
\deffootnote{1em}{1em}{\thefootnotemark\ }
The footnote mark and the following space are therefore set right-aligned into a
box of width 1 em. The following lines of the footnote text are also indented by
1 em from the left margin.
Another often requested footnote layout is left-aligned footnote marks. These can
be obtained with:
\deffootnote{1.5em}{1em}{%
\makebox[1.5em][l]{\thefootnotemark}}
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
282
If you want however only to change the font for all footnotes, for example to sans
serif, you can solve this problem simply by using the commands
\setkomafont
and
\addtokomafont
(see
section 10.6
,
page 269
):
\setkomafont{footnote}{\sffamily}
\setfootnoterule[thickness ]{length }
Generally
v3.06
a horizontal rule will be placed between the text area and the footnote area.
But normally this rule is not as long as the width of the typing area. With Command
\setfootnoterule
you may change the thickness and the width of that rule. Thereby the
parameters thickness and length will be evaluated not at definition time but when setting
the rule itself. If optional argument thickness ha been omitted the thickness of the rule will
not be changed. Empty arguments thickness or length are also allowed and do not change
the corresponding parameter. Using implausible values may result in warning messages not
only setting the arguments but also when KOMA-Script uses the parameters.
With element footnoterule the color
v3.07
of the rule may be changed using the commands
\setkomafont
and
\addtokomafont
for element footnoterule (see
section 10.6
,
page 269
).
Default is no change of font or color. For color changes a color package like xcolor would be
needed.
10.12. Dicta
What is written in
section 3.17
applies, mutatis mutandis. However, scrextend does not support
the commands
\setchapterpreamble
and
\setpartpreamble
. You should read the manual
of the used class, if you want to know, if that class does support similar commands. So if you
have alread read and understood
section 3.17
you can jump to
section 10.13
on
page 283
.
Sometimes you may find a dictum, a kind of smart slogan or excerpt, often ragged left above
or below the heading of a chapter or section. The text and the source of the slogan often use
special styles.
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
283
\dictum[author ]{dictum }
\dictumwidth
\dictumauthorformat{author }
\dictumrule
\raggeddictum
\raggeddictumtext
\raggeddictumauthor
The command \dictum inserts such a dictum. The dictum together with an optional author is
inserted in a \parbox (see [
Tea05b
]) of width \dictumwidth. Yet \dictumwidth is not a length
which can be set with \setlength. It is a macro that can be redefined using \renewcommand.
Default setting is 0.3333\textwidth, which is a third of the textwidth. The box itself is
positioned with the command \raggeddictum. Default here is \raggedleft, that is, right
justified. The command \raggeddictum can be redefined using \renewcommand.
Within the box the dictum is set using \raggeddictumtext.
Default setting is
\raggedright
, that is, left justified. Similarly to \raggeddictum this can be redefined with
\renewcommand
. The output uses the default font setting for the element dictum, which can be
changed with the commands
\setkomafont
and
\addtokomafont
(see
section 10.6
,
page 269
).
Default settings are listed in
table 3.16
,
page 109
.
If there is an author name, it is separated from the dictum by a rule to the full width of
the \parbox. This
v3.10
rule is defined as vertical object to command \dictumrule:
\newcommand*{\dictumrule}{\vskip-1ex\hrulefill\par}
The alignment is defined with \raggeddictumauthor. Default is \raggedleft. This
command can also be redefined using \renewcommand. The format of the output is de-
fined with \dictumauthorformat. This macro expects the author as argument. As default
\dictumauthorformat
is defined as:
\newcommand*{\dictumauthorformat}[1]{(#1)}
Thus the author is set enclosed in rounded parentheses. For the element dictumauthor,
a different font than for the element
dictum
can be defined. Default settings are listed in
table 3.16
. Changes can be made using the commands
\setkomafont
and
\addtokomafont
(see
section 10.6
,
page 269
).
10.13. Lists
All of what is described in
section 3.18
is generally applicable. So if you have alread read
and understood
section 3.18
you can switch to
section 10.14
,
page 285
. However, scrextend
does support only the environments
labeling
,
addmargin
and
addmargin*
. All the other list
environments may be supported and controlled by the used class.
Both L
A
TEX and the standard classes offer different environments for lists. Though slightly
changed or extended all these list are of course offered in KOMA-Script as well. In general,
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
284
all lists — even of different kind — can be nested up to four levels. From a typographical
view, anything more would make no sense, as more than three levels can no longer be easily
perceived. The recommended procedure in such a case is to split the large list into several
smaller ones.
Because lists are standard elements of L
A
TEX this section abandons on examples. Neverthe-
less, you may find examples either in
section 3.18
from
page 111
or in almost every introduction
to L
A
TEX.
\begin{labeling}[ delimiter ]{ widest pattern }
\item[keyword ]
. . .
...
\end{labeling}
An additional form of a description list is only available in the KOMA-Script classes and the
package scrextend: the labeling environment. Unlike the
description
environment, you
can provide a pattern whose length determines the indentation of all items. Furthermore,
you can put an optional delimiter between the item and its description. The font
v3.02
which
is responsible for emphasizing the item and the separator can be changed with the com-
mands
\setkomafont
and
\addtokomafont
(see
section 10.6
,
page 269
) for the element
labelinglabel
and labelingseparator (see
table 3.2
,
page 58
).
Originally, this environment was implemented for things like “Precondition, Assertion,
Proof”, or “Given, Required, Solution” that are often used in lecture hand-outs. By now
this environment has found many different applications. For example, the environment for
examples in this guide was defined with the labeling environment.
\begin{addmargin}[left indentation ]{indentation }
. . . \end{addmargin}
\begin{addmargin*}[inner indentation ]{indentation }
. . . \end{addmargin*}
Similar to
quote
and
quotation
which are available at the standard classes and also the
KOMA-Script classes the addmargin environment changes the margin. In contrast to the first
two environments, with addmargin the user can set the width of the indentation. Besides
this, this environment does not change the indentation of the first line nor the vertical spacing
between paragraphs.
If only the obligatory argument indentation is given, both the left and right margin are
expanded by this value. If the optional argument left indentation is given as well, then at
the left margin the value left indentation is used instead of indentation .
The starred addmargin* only differs from the normal version in a two-sided layout. Fur-
thermore, the difference only occurs if the optional argument inner indentation is used.
In this case this value inner indentation is added to the normal inner indentation. For
right-hand pages this is the left margin, for left-hand pages the right margin. Then the value
of indentation determines the width of the opposite margin.
Both versions of this environment take also negative values for all parameters. This has the
effect of expanding the environment into the margin.
Chapter 10: KOMA-Script Features for other Classes with Package scrextend
285
Whether a page is going to be on the left or right side of the book can not be determined
for certain in the first L
A
TEX run. For details please refer to the explanation of the commands
\ifthispageodd
(
section 10.8
,
page 274
) and \ifthispagewasodd (
section 21.1
,
page 441
).
There may be several questions about coexistence of lists and paragraphs. Because of this
additional information may be found at the description of option parskip in
section 21.1
,
page 441
.
Also at the expert part, in
section 21.1
,
page 441
, you may find additional information about page
breaks inside of addmargin*.
10.14. Margin Notes
All of what is described in
section 3.21
is generally applicable. So if you have alread read and
understood
section 3.21
you can switch to
chapter 11
,
page 286
.
Aside from the text area, that normally fills the typing area, usually a marginalia column
may be found. Margin notes will be printed at this area. At lot of them may be found in this
manual.
\marginpar[ margin note left ]{ margin note }
\marginline{margin note }
Usually margin notes in L
A
TEX are inserted with the command \marginpar. They are placed
in the outer margin. In documents with one-sided layout the right border is used. Though
\marginpar
can take an optional different margin note argument in case the output is in
the left margin, margin notes are always set in justified layout. However, experience has
shown that many users prefer left- or right-aligned margin notes instead. To facilitate this,
KOMA-Script offers the command \marginline.
An example for this may be found in
section 3.21
at
page 136
.
Experts and advanced users may find information about problems using \marginpar at
section 21.1
,
page 441
. These are valid for \marginline also.
Chapter 11: Support for the Law Office by scrjura
286
Support for the Law Office by scrjura
In case you’d like to write a contract, the bylaws of a company or of the club, an act of law
or a whole commentary, the package scrjura will provide typographical support. Despite the
fact that scrjura is intended as a broad help for juridical documents, the contract is the central
element of the package. Particular attention is being paid to the clause with numbered title
and numbered paragraphs — if a clause consists of more than one paragraph —, even numbered
sentences, entries in the table of contents and cross references according to German standards.
The package has been developed in cooperation with Dr Alexander Willand, lawyer in
Karlsruhe.
Note that the package cooperates with hyperref. Nevertheless, hyperref has to be loaded
after scrjura as usual.
11.1. Early or late Selection of Options
All of what is described in
section 2.4
is generally applicable. So if you have alread read and
understood
section 2.4
you can switch to
section 11.2
,
page 287
.
In this section a peculiarity of KOMA-Script is presented, which, apart from the scrjura
package, is also relevant to other KOMA-Script packages and classes. Such that the user can
find all information corresponding to a single package or a single class in the relevant chapter,
this section is found almost identically in several chapters. Users who are not only interested
in a particular package or class, but wish to gain an overview of KOMA-Script as a whole,
may read the section in one chapter and may thereafter skip it wherever coming across it in
the document.
\documentclass[option list ]{KOMA - Script class }
\usepackage[option list ]{package list }
In L
A
TEX, provision is made for the user to pass class options as a comma-separated list of
keywords as optional arguments to \documentclass. Apart from being passed to the class,
these options are also passed on to all packages which can understand the options. Provision
is also made for the user to pass optional arguments as a comma-separated list of keywords
as optional arguments to \usepackage. KOMA-Script expands
v3.00
the option mechanism for the
KOMA-Script classes and various packages to use further possibilities. Thus, most KOMA-
Script options can also take a value. An option may have not only the form Option , but
may also have the form option =value . Apart from this difference \documentclass and
\usepackage
function the same in KOMA-Script as described in [
Tea05b
] or any introduction
to L
A
TEX, for example [
OPHS11
].
You should note, that in opposite to the interface described below the options interface of
\documentclass
and \usepackage is not robust. So commands, lengths, counters and such
Chapter 11: Support for the Law Office by scrjura
287
constructs may break inside the optional argument of these commands. Because of this, the
usage of a L
A
TEX length inside the value of an option would cause an error before KOMA-Script
can get the control over the option execution. So, if you want to use a L
A
TEX length, counter
or command a part of the value of an option, you have to use
\KOMAoptions
or
\KOMAoption
.
These commands will be described next.
\KOMAoptions{option list }
\KOMAoption{option }{value list }
KOMA-Script
v3.00
offers most class and package options the opportunity to change the value of
options even after loading of the class or package. One may then change the values of a list of
options at will with the \KOMAoptions command. Each option in the option list has the
form option =value .
Some options also have a default value. If one does not give a value, i. e., gives the option
simply in the form option , then the default value will be used.
Some options can assume several values simultaneously. For such options there exists the
possibility, with the help of \KOMAoption, to pass a single option a list of values. The
individual values are given as a comma-separated value list .
To implement this possibility KOMA-Script uses the commands
\FamilyOptions
and
\FamilyOption
with the family “KOMA”. For more information in these commands see
part II
,
section 12.2
,
page 313
.
11.2. Text Markup
What is described in
section 3.6
applies, mutatis mutandis. So if you have alread read and
understood
section 3.7
you can switch to
page 308
.
L
A
TEX offers different possibilities for logical and direct markup of text. Selection of the font
family commands, as well as choosing the font size and width is supported. More information
about the standard font facilities may be found at [
OPHS11
], [
Tea05b
], and [
Tea05a
].
\setkomafont{element }{commands }
\addtokomafont{element }{commands }
\usekomafont{element }
With
v2.8p
the help of the two commands \setkomafont and \addtokomafont, it is possible to
define the commands that change the characteristics of a given element . Theoretically, all
possible statements including literal text could be used as commands . You should, however,
absolutely limit yourself to those statements that really switch only one font attribute. This
will usually be the commands \normalfont, \rmfamily, \sffamily, \ttfamily, \mdseries,
\bfseries
, \upshape, \itshape, \slshape, and \scshape, as well as the font size commands
\Huge
, \huge, \LARGE, \Large, \large, \normalsize, \small, \footnotesize, \scriptsize,
and \tiny. The description of these commands can be found in [
OPHS11
], [
Tea05b
], or
Chapter 11: Support for the Law Office by scrjura
288
[
Tea05a
]. Color switching commands like \normalcolor (see [
Car05
] and [
Ker07
]) are also
acceptable. The behavior when using other commands, especially those that make redefinitions
or generate output, is not defined. Strange behavior is possible and does not represent a bug.
The command \setkomafont provides a font switching command with a completely new
definition. In contrast to this, the \addtokomafont command merely extends an existing
definition. It is recommended to not use both commands inside the document body, but
only in the document preamble. Usage examples can be found in the paragraphs on the
corresponding element.
With command \usekomafont the current font style may be changed into the font style of
the selected element .
\usefontofkomafont{element }
\useencodingofkomafont{element }
\usesizeofkomafont{element }
\usefamilyofkomafont{element }
\useseriesofkomafont{element }
\useshapeofkomafont{element }
Sometimes
v3.12
and despite the recommendation users use the font setting feature of elements
not only for font settings but for other settings too. In this case it may be useful to
switch only to the font setting of an element but not to those other settings. You may
use \usefontofkomafont in such cases. This will activate the font size and baseline skip, the
font encoding, the font family, the font series, and the font shape of an element, but no further
settings as long as those further settings are local.
You may also switch to one of those attributes only using one of the other commands. Note,
that \usesizeofkomafont will activate both, the font size and the baseline skip.
You should not misunderstand these commands as a legitimation of using all kind of com-
mands at the font setting of an element. Hence this would result in errors sooner or later (see
section 21.3
,
page 444
).
11.3. Table of Contents
The package scrjura provides entries into the table of contents.
juratotoc=simple switch
juratotoc=level number
A clause is being shown in the table of contents only, if its level number is smaller or equal
to the counter
tocdepth
(see
section 3.9
,
page 72
). Default for the level number is 10000,
which as well will be used, if the option is switched off by the simple switch (see
table 2.5
,
page 39
). Because the counter
tocdepth
usually has a one digit value, clause entries are not
shown in the table of contents.
Chapter 11: Support for the Law Office by scrjura
289
If you switch on the option using the simple switch , as a default level number 2 is used,
so that clauses are shown in the table of contents on the same level as subsections. If the
counter
tocdepth
has default values as well, clauses are shown with all KOMA-Script classes.
juratocindent=indent
juratocnumberwidth=number width
These two options can be used to determine the indentation in the table of contents as well
as the reserved space for the numbers there. Defaults are the values for the subsection entries
in scrartcl.
11.4. Environment for Contracts
The main mechanism of scrjura only work inside of the contract environment.
\begin{contract}
. . . \end{contract}
Till this date, this is the one and only environment for legal practitioner provided by scrjura.
Using it will activate the automatic numbering of paragraphs and the commands
\Clause
and
\SubClause
will become a form, which will be documented below.
The environment
contract
must not be nested in itself. Within the document the environ-
ment may be used several times. In this case the clauses within the environment are treated
as if they were within the same environment. Ending the environment means just a break and
with beginning a new environment in the same document the former environment is continued.
A break inside a clause is not possible.
contract
The whole document becomes a contract if you use this option while loading the package with
\usepackage
or as a global option with
\documentclass
. The document behaves as if you
started the contract environment right after the beginning of the document.
Neither you can use this option with
\KOMAoption
nor with
\KOMAoptions
, so that it is not
possible to switch the option off in this way. Please use the
contract
environment directly.
11.4.1. Clauses
With scrjura clauses
1
in a legal sense only exist inside of contracts, meaning inside of the
environment
contract
.
1
In English, the word “section” also is used in an act of law or in an agreement. To distinguish
\section
of most document classes from the section in scrjura, we decided to call the section in the latter simply
“clause”.
Chapter 11: Support for the Law Office by scrjura
290
Table 11.1.: Possible properties for the optional argument of \Clause and \SubClause
dummy
The heading will not be printed but counted in the automatic numbering.
head= running head
If running heads are available, running head is used instead of the clause title .
nohead
The running head stays unchanged.
notocentry
Does not make an entry into the table of contents.
number=number
Uses number for the output of the clause number.
preskip=skip
Changes the vertical skip before the clause heading.
postskip=skip
Changes the vertical skip after the clause heading.
title=title
Additional to the clause number a clause title will be printed. This is also used as
default for the running head and the entry in the table of contents.
tocentry=entry
Independent from the clause title , an entry into the table of contents will be
made, if such entries are activated.
\Clause[options ]
\SubClause[options ]
These are the most important commands inside of a contract. Without using further options
the command \Clause creates the heading of a clause, which consists only of the sign »§«,
followed by its number. In contrast to this the command \SubClause creates the heading
of a clause with the last number used by \Clause and adds a lowercase letter. \SubClause
mainly is intended for cases where an act or a contract is amended and not only clauses are
changed or deleted, but between existing clauses new ones are inserted without changing the
numbering.
Both commands except as options a list separated by commas of properties. An overview
over possible properties is provided by
table 11.1
. For the most important of them we will go
into the details.
Chapter 11: Support for the Law Office by scrjura
291
A skip of two lines is inserted before the heading and afterwards a skip of one line as a
default. Via the options preskip and postskip these skips can be changed. The new values
are not only valid for the current clause but beginning with the actual clause until the end of
the current contract environment. It is possible as well to set these keys in advance by writing
\setkeys{contract}{preskip=skip ,
postskip=skip }
independently from a clause and outside of a contract environment as well. Also it is possible
to set the keys inside of the preamble after loading scrjura. But it is not possible to set these
options while loading the package or by using
\KOMAoptions
or
\KOMAoption
.
The headings use as a default the fonts \sffamily\bfseries\large. The fonts can
be changed using the element contract.Clause with the help of
\setkomafont
and
\addtokomafont
(see
section 3.6
,
page 287
). Inside the
contract
environment instead of
contract.Clause
simply Clause may be used.
With the options title, head, and tocentry a clause may get in addition to the number
a title. It is recommended to put the value of these options inside brackets. Failing this,
e.g., commas may lead to confusion between different options. Empty values for head and
tocentry
cause an empty entry. If one would like to avoid an entry, the options nohead and
notocentry
have to be used.
Instead of the running numbers the option number manually sets the number of a clause.
This will have no impact on the numbers of the subsequent clauses. Empty numbers are
not possible. Fragile commands inside number have to be protected with \protect. It is
recommended only to use numbers and letters as assignment to number.
With the option dummy the output of the whole heading of a clause can be suppressed. The
automatic numbering will count this clause nonetheless. Thus you can skip a clause in the
automatic numbering with
\Clause{dummy}
in case the clause has been deleted in a later version of a contract.
Note, only the values true and false may be used in combination with dummy. All other
values will be ignored, but may throw up an error.
\Clauseformat{number }
As already mentioned the clauses and subclauses usually are being numbered. The format of
the number is done with the help of the command \Clauseformat, which expects as one and
only argument the number. The default is defined as
\newcommand*{\Clauseformat}[1]{\S~#1}
and, as you see, it is only the \S followed by a non-breaking space and the number. In case of
redefinition take care to keep it expandable.
Chapter 11: Support for the Law Office by scrjura
292
Table 11.2.: Possible values for option clausemark for activation of running heads
both
Clauses generate left and right marks for running heads, if the document provides
automatic running heads.
false
, off, no
Clauses do not generate marks for running heads and therefore do not change running
heads.
forceboth
Clauses use
\markboth
to generate left and right marks for running heads even if
the document does not provide automatic running heads for the current page style.
forceright
Clauses use
\markright
to generate right marks for running heads even if the doc-
ument does not provide automatic running heads for the current page style.
right
Clauses generate right marks for running heads, if the document provides automatic
running heads.
juratitlepagebreak=simple switch
Usually a page break inside a heading is prohibited. Some jurists may need page breaks inside
of clause headings. Such a break may be allowed using juratitlepagebreak. The possible
values for simple switch are printed in
table 2.5
,
page 39
.
clausemark=value
Clauses are a kind of inferior structure with an independent numbering they will not have
running headlines as a default. Running headlines are possible and may be created with
alternative properties. The possible values and their meaning are listed in
table 11.2
.
11.4.2. Paragraphs
Within clauses the paragraphs are being numbered automatically. With this, the paragraphs
are a strongly structuring element, similar to
\paragraph
or
\subparagraph
known, e. g.,
from article classes. Contracts usually use a vertical skip between paragraphs. The package
scrjura does not provide its own mechanism for this. Instead, it uses the option
parskip
of
the KOMA-Script classes (see
section 3.10
,
page 74
).
Chapter 11: Support for the Law Office by scrjura
293
parnumber=value
The default numbering of paragraphs is parnumber=auto and parnumber=true. Once in
a while it might be necessary to switch off the automatic numbering. This is done with
parnumber=false
. In this case the numbering of sentences will be reseted.
To realise this way of numbering paragraphs it has been necessary to gear into the paragraph
building mechanism of L
A
TEX. In rare cases there is a negative impact, which can be avoided
by switching to parnumber=manual. On the other hand L
A
TEXitself sometimes undoes the
change. In those cases one has to activate it again with parnumber=auto.
In a clause which consist of only one paragraph, the paragraph usually has no number. This
does only work if there are not two clauses with an identical number in a document. Note that
the number of paragraphs in a clause is not available before the end of the clause. Therefore
you need a least two L
A
TEX runs to get the correct, automatic paragraph numbering.
par
\thepar
\parformat
\parformatseparation
For numbering the paragraphs inside a clause we use the counter par. The output of \thepar
will display an arabic number, because the default is \arabic{par}. \parformat provides
the format, which is \thepar in rounded brackets. For numbering a paragraph manually, use
\parformat
as well. It makes sense to call \parformat with a following \nobreakspace or a
tilde.
The
v0.7
output of \parformat is followed by one or more delimiter(s). These are provided by
\parformatseparation
, which currently consists of \nonbreakspace, the non-breakable inter
word distance.
Package scrjura assumes internally, that \thepar is an arabic number. Don’t redefine!
\ellipsispar[number ]
\parellipsis
Sometimes
v0.7
— particularly in comparisons — it is desirable to omit paragraphs, but to mark
the omission. Those omitted paragraphs shall be included in the counter of the paragraphs.
The package scrjura provides the command \ellipsispar to do this.
By default \ellipsispar omits precisely one paragraph. Using the optional argument
multiple paragraphs may be omitted. In any case the output shows just one not numbered
paragraph, which only consists of the ellipsis defined by \parellipsis. The automatic num-
bering of paragraphs takes the number of omitted paragraphs into account.
Example: Supposed you are writing a »comment« of the German
2
penal code, but only
2
We have decided to translate it into English. But please remember, it is only an example not of existing law
but of a technical realisation with scrjura.
Chapter 11: Support for the Law Office by scrjura
294
paragraph 3 of § 2. Nevertheless you’d like to hint at the omission. This can be
done this way:
\documentclass[parskip=half]{scrartcl}
\usepackage{scrjura}
\begin{document}
\begin{contract}
\Clause{title={Temporal application},number=2}
\ellipsispar[2]
If, subsequent to the commission of a criminal
offence, the law provides for a lighter penalty,
that penalty shall be applicable.
\ellipsispar[3]
\end{contract}
\end{document}
To see the result, just give it a try.
The ellipsis is by default \textellipsis, if such a command is defined. If not, \dots will
be used. \parellipsis may be redefined with \renewcommand.
11.4.3. Sentences
In a contract the paragraphs consist of one or more sentences. In German acts of law it
is common to number the sentences as well. Regarding scrjura, an automatic numbering is
cumbersome and error-prone and has not been implemented yet.
sentence
\thesentence
\Sentence
Manual numbering of sentences is done with the command \Sentence. It adds one to the
counter sentence. As a default, \thesentence is printed as an arabic number.
Using babel offers an easy way to define a short hand for \Sentence:
\useshorthands{’}
\defineshorthand{’S}{\Sentence\ignorespaces}
With this definition any space after ’S will be ignored. It is even possible to use the dot as
abbrevation for dot and new number of the following sentence:
\defineshorthand{’.}{. \Sentence\ignorespaces}
These abbrevations have been tried and tested. For details regarding \useshorthands and
\defineshorthands
please consult the manual of the package babel (see [
BB13
]).
Chapter 11: Support for the Law Office by scrjura
295
11.5. Cross References
The conventional mechanism to set cross references using \label, \ref, and \pageref does
not suffice. scrjura provides more commands.
\ref{label }
\refL{label }
\refS{label }
\refN{label }
The commands \refL, \refS, and \refN give a full reference to clause, paragraph and sen-
tence. \refL is a long text, \refS a short text and \refN an abbreviated, numeric form. \ref
defaults to \refL.
\refClause{label }
\refClauseN{label }
For a cross reference to to a clause without displaying paragraph and sentences as well.
\refClause
puts a section symbol (§) in front of the reference, while \refClauseN does
not.
\refPar{ label }
\refParL{label }
\refParS{label }
\refParN[number format ]{label }
You can make a cross reference to a paragraph using \refParL, \refParS and \refParN. The
differences between the forms correspond to the differences between
\refL
,
\refN
and
\refS
.
A special feature is the optional argument of \refParN. Usually the numeric reference to
a paragraph uses a roman number. The optional argument allows to set a different number
format
, it may make sense to use arabic numbers. \refPar defaults to \refParL.
\refSentence{label }
\refSentenceL{label }
\refSentenceS{label }
\refSentenceN{label }
You can make a cross reference to a sentence with \refSentenceL, \refSentenceS, or
\refSentenceN
. Again we have a long text form, a short text form and a numerical form.
\refSentence
defaults to \refSentenceL.
Chapter 11: Support for the Law Office by scrjura
296
Table 11.3.: Possible values for option ref to configure the cross reference format of
\ref
,
\refPar
,
and
\refSentence
long
Combination of parlong and sentencelong.
numeric
Combination of parnumeric and sentencenumeric.
clauseonly
, onlyclause, ClauseOnly, OnlyClause
Combination of paroff and sentenceoff; note that
\refPar
and
\refSentence
have empty results!
parlong
, longpar, ParL
Paragraphs are referenced in long textual form.
parnumeric
, numericpar, ParN
Paragraphs are referenced in simple numerical form.
paroff
, nopar
Paragraphs have not reference. Note that
\refPar
has an empty result!
parshort
, shortpar, ParS
Paragraphs are referenced in short textual form.
sentencelong
, longsentence, SentenceL
Sentences are referenced in long textual form.
sentencenumeric
, numericsentence, SentenceN
Sentences are referenced in simple numeric form.
sentenceoff
, nosentence
Sentences have no reference. Note that
\refSentence
has an empty result!
sentenceshort
, shortsentence, SentenceS
Sentences are referenced in short textual form.
short
Combination if parshort and sentenceshort.
Chapter 11: Support for the Law Office by scrjura
297
Table 11.4.: Example outputs of
the ref-independent cross refer-
ence commands
Command
Example output
\refL
{label }
§ 1 paragraph 1 sentence 1
\refS
{ label }
§ 1 par. 1 sent. 1
\refN
{label }
Dostları ilə paylaş: |