summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex654
1 files changed, 311 insertions, 343 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex
index a9697cbb2aa..d59fc05acd0 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrjura.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrjura.tex
-% Copyright (c) Markus Kohm, 2011-2016
+% Copyright (c) Markus Kohm, 2011-2017
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrjura.tex
-% Copyright (c) Markus Kohm, 2011-2016
+% Copyright (c) Markus Kohm, 2011-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,15 +46,16 @@
% ======================================================================
\KOMAProvidesFile{scrjura.tex}%
- [$Date: 2016-05-10 14:02:52 +0200 (Tue, 10 May 2016) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (chapter: scrjura)]
\translator{Alexander Willand\and Markus Kohm}
-% Date of translated German version: 2016/05/09
+% Date of the translated German file: 2017-01-02
\chapter{Support for the Law Office by \Package{scrjura}}
\labelbase{scrjura}
+\BeginIndexGroup
\BeginIndex{Package}{scrjura}
In case you'd like to write a contract\Index{contract}, the bylaws of a
@@ -74,7 +75,9 @@ Note\textnote{Attention!} that the package cooperates with
\Package{hyperref}\IndexPackage{hyperref}. Nevertheless, \Package{hyperref}
has to be loaded after \Package{scrjura} as usual.
-\LoadCommon{0} % \section{Frühe oder späte Optionenwahl}
+\LoadCommonFile{options}% \section{Early or late Selection of Options}
+
+\LoadCommonFile{textmarkup}% \section{Text Markup}
\section{Table of Contents}
\label{sec:scrjura.toc}
@@ -82,84 +85,83 @@ has to be loaded after \Package{scrjura} as usual.
The package \Package{scrjura} provides entries into the table of contents.
\begin{Declaration}
- \KOption{juratotoc}\PName{simple switch}\\
- \KOption{juratotoc}\PName{level number}
+ \OptionVName{juratotoc}{simple switch}%
+ \OptionVName{juratotoc}{level number}
\end{Declaration}
-\BeginIndex{Option}{juratotoc~=\PName{simple switch}}%
-\BeginIndex{Option}{juratotoc~=\PName{level number}}%
A clause\Index{clause} is being shown in the table of contents only, if its
-\PName{level number} is smaller or equal to the
-counter \Counter{tocdepth}\important{\Counter{tocdepth}}\IndexCounter{tocdepth}
-(see \autoref{sec:maincls.toc},
-\autopageref{desc:maincls.counter.tocdepth}). Default for the \PName{level
- number} is 10000, which as well will be used, if the option is switched off
-by the \PName{simple switch}\important{\OptionValue{juratotoc}{false}} (see
+\PName{level number} is smaller or equal to the counter
+\DescRef{maincls.counter.tocdepth}%
+\important{\DescRef{maincls.counter.tocdepth}}\IndexCounter{tocdepth} (see
+\autoref{sec:maincls.toc}, \DescPageRef{maincls.counter.tocdepth}). Default
+for the \PName{level number} is 10000, which as well will be used, if the
+option is switched off by the \PName{simple
+ switch}\important{\OptionValue{juratotoc}{false}} (see
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}). Because the
-counter \Counter{tocdepth} usually has a one digit value, clause entries are
-not shown in the table of contents.
+counter \DescRef{maincls.counter.tocdepth} usually has a one digit value,
+clause entries are not shown in the table of contents.
If you switch on the option using the \PName{simple
switch}\important{\OptionValue{juratotoc}{true}}, as a default \PName{level
number} 2 is used, so that clauses are shown in the table of contents on the
-same level as subsections. If the counter \Counter{tocdepth} has default
-values as well, clauses are shown with all \KOMAScript{} classes.%
-\EndIndex{Option}{juratotoc~=\PName{level number}}%
-\EndIndex{Option}{juratotoc~=\PName{simple switch}}%
+same level as subsections. If the counter \DescRef{maincls.counter.tocdepth}
+has default values as well, clauses are shown with all \KOMAScript{} classes.%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{juratocindent}\PName{indent}\\
- \KOption{juratocnumberwidth}\PName{number width}
+ \OptionVName{juratocindent}{indent}%
+ \OptionVName{juratocnumberwidth}{number width}
\end{Declaration}
-\BeginIndex{Option}{juratocindent~=\PName{indent}}%
-\BeginIndex{Option}{juratocnumberwidth~=\PName{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 \Class{scrartcl}.%
-\EndIndex{Option}{juratocnumberwidth~=\PName{number width}}%
-\EndIndex{Option}{juratocindent~=\PName{indent}}%
-
+\EndIndexGroup
\section{Environment for Contracts}
\label{sec:scrjura.contract}
+\BeginIndexGroup
\BeginIndex{}{contract}
The main mechanism of \Package{scrjura} only work inside of the contract
environment.
\begin{Declaration}
- \XMacro{begin}\PParameter{\Environment{contract}}\\
- \dots\\
- \XMacro{end}\PParameter{\XEnvironment{contract}}
+ \begin{Environment}{contract}\end{Environment}
\end{Declaration}
-\BeginIndex{Env}{contract}%
Till this date, this is the one and only environment for legal practitioner
provided by \Package{scrjura}. Using it will activate the automatic numbering
-of paragraphs and the commands \Macro{Clause} and \Macro{SubClause} will
-become a form, which will be documented below.
-
-The\textnote{Attention!} environment \Environment{contract} must not be nested
-in itself. Within the document the environment 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
+of paragraphs and the commands \DescRef{\LabelBase.cmd.Clause} and
+\DescRef{\LabelBase.cmd.SubClause} will become a form, which will be
+documented below.
+
+The\textnote{Attention!} environment \DescRef{\LabelBase.env.contract} must
+not be nested in itself. Within the document the environment 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.%
-\EndIndex{Env}{contract}
+\EndIndexGroup
+
\begin{Declaration}
\Option{contract}
\end{Declaration}
-\BeginIndex{Option}{contract}%
The whole document becomes a contract if you use this option while loading the
-package with \Macro{usepackage}\important{\Macro{usepackage}} or as a global
-option with \Macro{documentclass}\important{\Macro{documentclass}}. The
-document behaves as if you started the contract environment right after the
-beginning of the document.
+package with \DescRef{\LabelBase.cmd.usepackage}%
+\important{\DescRef{\LabelBase.cmd.usepackage}} or as a global option with
+\DescRef{\LabelBase.cmd.documentclass}%
+\important{\DescRef{\LabelBase.cmd.documentclass}}. The document behaves as
+if you started the contract environment right after the beginning of the
+document.
+
+Neither\textnote{Attention!} you can use this option with
+\DescRef{\LabelBase.cmd.KOMAoption} nor with
+\DescRef{\LabelBase.cmd.KOMAoptions}, so that it is not possible to switch the
+option off in this way. Please use the \DescRef{\LabelBase.env.contract}
+environment directly.%
+\EndIndexGroup
-Neither\textnote{Attention!} you can use this option with \Macro{KOMAoption}
-nor with \Macro{KOMAoptions}, so that it is not possible to switch the option
-off in this way. Please use the \Environment{contract} environment directly.%
-\EndIndex{Option}{contract}
\subsection{Clauses}
\label{sec:scrjura.clause}
@@ -167,17 +169,16 @@ off in this way. Please use the \Environment{contract} environment directly.%
With \Package{scrjura} clauses\footnote{%
In English, the word ``section'' also is used in an act of law or in an
- agreement. To distinguish \Macro{section} of most document classes from the
- section in \Package{scrjura}, we decided to call the section in the latter
- simply ``clause''.} in a legal sense only exist inside of contracts, meaning
-inside of the environment \Environment{contract}.
+ agreement. To distinguish \DescRef{maincls.cmd.section} of most document
+ classes from the section in \Package{scrjura}, we decided to call the
+ section in the latter simply ``clause''.} in a legal sense only exist inside
+of contracts, meaning inside of the environment
+\DescRef{\LabelBase.env.contract}.
\begin{Declaration}
- \Macro{Clause}\OParameter{options}\\
+ \Macro{Clause}\OParameter{options}%
\Macro{SubClause}\OParameter{options}
\end{Declaration}
-\BeginIndex{Cmd}{Clause}%
-\BeginIndex{Cmd}{SubClause}%
These are the most important commands inside of a contract. Without using
further \PName{options} the command \Macro{Clause} creates the heading of a
clause, which consists only of the sign »\S«, followed by its number. In
@@ -200,7 +201,7 @@ go into the details.
\entry{\Option{dummy}}{%
The heading will not be printed but counted in the automatic numbering.%
}%
- \entry{\KOption{head}\PName{running head}}{%
+ \entry{\OptionVName{head}{running head}}{%
If running heads are available, \PName{running head} is used instead of
the clause \PName{title}.%
}%
@@ -210,32 +211,34 @@ go into the details.
\entry{\Option{notocentry}}{%
Does not make an entry into the table of contents.%
}%
- \entry{\KOption{number}\PName{number}}{%
+ \entry{\OptionVName{number}{number}}{%
Uses \PName{number} for the output of the clause number.%
}%
- \entry{\KOption{preskip}\PName{skip}}{%
+ \entry{\OptionVName{preskip}{skip}}{%
Changes the vertical \PName{skip} before the clause heading.%
}%
- \entry{\KOption{postskip}\PName{skip}}{%
+ \entry{\OptionVName{postskip}{skip}}{%
Changes the vertical \PName{skip} after the clause heading.%
}%
- \entry{\KOption{title}\PName{title}}{%
+ \entry{\OptionVName{title}{title}}{%
Additional to the clause number a clause \PName{title} will be printed.
This is also used as default for the \PName{running head} and the
\PName{entry} in the table of contents.%
}%
- \entry{\KOption{tocentry}\PName{entry}}{%
+ \entry{\OptionVName{tocentry}{entry}}{%
Independent from the clause \PName{title}, an \PName{entry} into the
table of contents will be made, if such entries are activated.%
}%
\end{desctabular}
\end{table}
-A skip of two lines is inserted before the heading and afterwards a skip of
-one line as a default. Via the options \Option{preskip}\important[i]{\Option{preskip}, \Option{postskip}} and \Option{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
+A skip of two lines is inserted before the heading and afterwards a skip of
+one line as a default. Via the options
+\Option{preskip}\important[i]{\Option{preskip}, \Option{postskip}} and
+\Option{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
\begin{flushleft}\quad\small
\textbf{\Macro{setkeys}}\PParameter{contract}%
\PParameter{preskip=\PName{skip},\\
@@ -245,19 +248,22 @@ environment. It is possible as well to set these keys in advance by writing
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
\Package{scrjura}. But it is not possible to set these options while loading
-the package or by using \Macro{KOMAoptions} or \Macro{KOMAoption}.
+the package or by using \DescRef{\LabelBase.cmd.KOMAoptions} or
+\DescRef{\LabelBase.cmd.KOMAoption}.
-\BeginIndex{FontElement}{contract.Clause}%
-\BeginIndex{FontElement}{Clause}%
+\BeginIndex{FontElement}{contract.Clause}\LabelFontElement{contract.Clause}%
+\BeginIndex{FontElement}{Clause}\LabelFontElement{Clause}%
The headings use as a default the fonts
\Macro{sffamily}\Macro{bfseries}\Macro{large}. The fonts can be changed using
the element
\FontElement{contract.Clause}\important{\FontElement{contract.Clause}} with
-the help of \Macro{setkomafont}\important[i]{\Macro{setkomafont},
- \Macro{addtokomafont}} and \Macro{addtokomafont} (see
-\autoref{sec:maincls.textmarkup},
-\autopageref{desc:maincls.cmd.setkomafont}). Inside the \Environment{contract}
-environment instead of \FontElement{contract.Clause} simply
+the help of \DescRef{\LabelBase.cmd.setkomafont}%
+\important[i]{\DescRef{\LabelBase.cmd.setkomafont},
+ \DescRef{\LabelBase.cmd.addtokomafont}} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see \autoref{sec:maincls.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}). Inside the
+\DescRef{\LabelBase.env.contract} environment instead of
+\FontElement{contract.Clause} simply
\FontElement{Clause}\important{\FontElement{Clause}} may be used.%
\EndIndex{FontElement}{Clause}%
\EndIndex{FontElement}{contract.Clause}
@@ -282,7 +288,7 @@ With the option \Option{dummy}\important{\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\textnote{Example}
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\Clause{dummy}
\end{lstcode}
in case the clause has been deleted in a later version of a contract.
@@ -290,40 +296,38 @@ in case the clause has been deleted in a later version of a contract.
Note\textnote{Attention!}, only the values \PValue{true} and \PValue{false}
may be used in combination with \Option{dummy}. All other values will be
ignored, but may throw up an error.%
-\EndIndex{Cmd}{SubClause}%
-\EndIndex{Cmd}{Clause}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{Clauseformat}\Parameter{number}
\end{Declaration}
-\BeginIndex{Cmd}{Clauseformat}%
As already mentioned the clauses and subclauses usually are being numbered.
The format of the number is done with the help of the command
\Macro{Clauseformat}, which expects as one and only argument the number. The
default is defined as
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt]
+\begin{lstcode}
\newcommand*{\Clauseformat}[1]{\S~#1}
\end{lstcode}
and, as you see, it is only the \Macro{S}\IndexCmd{S} followed by a
non-breaking space and the number. In case of redefinition take care to keep
it expandable.%
-\EndIndex{Cmd}{Clauseformat}%
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{juratitlepagebreak}\PName{simple switch}
+ \OptionVName{juratitlepagebreak}{simple switch}
\end{Declaration}%
-\BeginIndex{Option}{juratitlepagebreak~=\PName{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
\Option{juratitlepagebreak}\important{\Option{juratitlepagebreak}}. The
possible values for \PName{simple switch} are printed in
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}.%
-\EndIndex{Option}{juratitlepagebreak~=\PName{simple switch}}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{clausemark}\PName{value}
+ \OptionVName{clausemark}{value}
\end{Declaration}%
-\BeginIndex{Option}{clausemark~=\PName{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
@@ -336,8 +340,8 @@ possible \PName{values} and their meaning are listed in
\label{tab:scrjura.clausemark}%
\begin{desctabular}
\entry{\PValue{both}}{%
- Clauses generate left and right marks for running heads, if the
- document provides automatic running heads.%
+ Clauses generate left and right marks for running heads, if the document
+ provides automatic running heads.%
\IndexOption{clausemark~=\PValue{both}}%
}%
\entry{\PValue{false}, \PValue{off}, \PValue{no}}{%
@@ -346,15 +350,15 @@ possible \PName{values} and their meaning are listed in
\IndexOption{clausemark~=\PValue{false}}%
}%
\entry{\PValue{forceboth}}{%
- Clauses use \Macro{markbith} to generate left and right marks for
- running heads even if the document does not provide automatic running
- heads for the current page style.%
+ Clauses use \DescRef{maincls.cmd.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.%
\IndexOption{clausemark~=\PValue{forceboth}}%
}%
\entry{\PValue{forceright}}{%
- Clauses use \Macro{markright} to generate right marks for running heads
- even if the document does not provide automatic running heads for the
- current page style.%
+ Clauses use \DescRef{maincls.cmd.markright} to generate right marks for
+ running heads even if the document does not provide automatic running
+ heads for the current page style.%
\IndexOption{clausemark~=\PValue{forceright}}%
}%
\entry{\PValue{right}}{%
@@ -365,27 +369,28 @@ possible \PName{values} and their meaning are listed in
\end{desctabular}
\end{table}
%
-\EndIndex{Option}{clausemark~=\PName{value}}%
+\EndIndexGroup
\subsection{Paragraphs}
\label{sec:scrjura.par}
+\BeginIndexGroup
\BeginIndex{}{paragraph>number}%
Within clauses the paragraphs are being numbered automatically. With this, the
-paragraphs are a strongly structuring element, similar to \Macro{paragraph} or
-\Macro{subparagraph} known, e.\,g., from article classes. Contracts usually
-use a vertical skip between paragraphs. The package \Package{scrjura} does not
-provide its own mechanism for this. Instead, it uses the option
-\Option{parskip}\IndexOption{parskip}\important{\Option{parskip}} of the
+paragraphs are a strongly structuring element, similar to
+\DescRef{maincls.cmd.paragraph} or \DescRef{maincls.cmd.subparagraph} known,
+e.\,g., from article classes. Contracts usually use a vertical skip between
+paragraphs. The package \Package{scrjura} does not provide its own mechanism
+for this. Instead, it uses the option \DescRef{maincls.option.parskip}%
+\IndexOption{parskip}\important{\DescRef{maincls.option.parskip}} of the
\KOMAScript{} classes (see \autoref{sec:maincls.parmarkup},
-\autopageref{desc:maincls.option.parskip}).
+\DescPageRef{maincls.option.parskip}).
\begin{Declaration}
- \KOption{parnumber}\PName{value}
+ \OptionVName{parnumber}{value}
\end{Declaration}
-\BeginIndex{Option}{parnumber~=\PName{value}}%
The default numbering of paragraphs is \OptionValue{parnumber}{auto} and
\OptionValue{parnumber}{true}. Once in a while it might be necessary to switch
off the automatic numbering. This is done with \OptionValue{parnumber}{false}%
@@ -408,18 +413,15 @@ 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
\LaTeX{} runs to get the correct, automatic paragraph numbering.%
-\EndIndex{Option}{parnumber~=\PName{Einstellung}}
+\EndIndexGroup
+
\begin{Declaration}
- \Counter{par}\\
- \Macro{thepar}\\
- \Macro{parformat}\\
+ \Counter{par}%
+ \Macro{thepar}%
+ \Macro{parformat}%
\Macro{parformatseparation}
\end{Declaration}%
-\BeginIndex{Counter}{par}%
-\BeginIndex{Cmd}{thepar}%
-\BeginIndex{Cmd}{parformat}%
-\BeginIndex{Cmd}{parformatseparation}%
For numbering the paragraphs inside a clause we use the counter
\Counter{par}. The output of \Macro{thepar} will display an arabic number,
because the default is \Macro{arabic}\PParameter{par}. \Macro{parformat}
@@ -434,17 +436,13 @@ by one or more delimiter(s). These are provided by
Package\textnote{Attention!} \Package{scrjura} assumes internally, that
\Macro{thepar} is an arabic number. Don't redefine!%
-\EndIndex{Cmd}{parformatseparation}
-\EndIndex{Cmd}{parformat}%
-\EndIndex{Cmd}{thepar}%
-\EndIndex{Counter}{par}%
+\EndIndexGroup
+
\begin{Declaration}
- \Macro{ellipsispar}\OParameter{number}\\
+ \Macro{ellipsispar}\OParameter{number}%
\Macro{parellipsis}
\end{Declaration}
-\BeginIndex{Cmd}{ellipsispar}%
-\BeginIndex{Cmd}{parellipsis}%
Sometimes\ChangedAt{v0.7}{\Package{scrjura}}\,---\,particularly in
comparisons\,---\,it is desirable to omit paragraphs, but to mark the
omission. Those omitted paragraphs\Index{paragraph>omission} shall be included
@@ -484,15 +482,15 @@ the \PName{number} of omitted paragraphs into account.
The ellipsis is by default \Macro{textellipsis}\IndexCmd{textellipsis}, if
such a command is defined. If not, \Macro{dots} will be
used. \Macro{parellipsis} may be redefined with \Macro{renewcommand}.%
-\EndIndex{Cmd}{parellipsis}%
-\EndIndex{Cmd}{ellipsispar}%
+\EndIndexGroup
%
-\EndIndex{}{paragraph>number}%
+\EndIndexGroup
\subsection{Sentences}
\label{sec:scrjura.sentence}
+\BeginIndexGroup
\BeginIndex{}{sentence>number}%
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
@@ -500,13 +498,10 @@ of law it is common to number the sentences as well. Regarding
has not been implemented yet.
\begin{Declaration}
- \Counter{sentence}\\
- \Macro{thesentence}\\
+ \Counter{sentence}%
+ \Macro{thesentence}%
\Macro{Sentence}
\end{Declaration}
-\BeginIndex{Counter}{sentence}%
-\BeginIndex{Cmd}{thesentence}%
-\BeginIndex{Cmd}{Sentence}%
Manual numbering of sentences is done with the command \Macro{Sentence}. It
adds one to the counter \Counter{sentence}. As a default, \Macro{thesentence}
is printed as an arabic number.
@@ -514,28 +509,24 @@ is printed as an arabic number.
Using\textnote{Hint!} \Package{babel}\IndexPackage{babel} offers an easy way
to define a short hand for \Macro{Sentence}:%
\phantomsection\label{sec:scrjura.shorthandexample}%
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt,%
- moretexcs={useshorthands,defineshorthand}]
+\begin{lstcode}[moretexcs={useshorthands,defineshorthand}]
\useshorthands{'}
\defineshorthand{'S}{\Sentence\ignorespaces}
\end{lstcode}
With this definition any space after \lstinline|'S| will be ignored. It is
even possible to use the dot as abbrevation for dot and new number of the
following sentence:
-\begin{lstcode}[belowskip=\dp\strutbox plus 1pt,%
- moretexcs={useshorthands,defineshorthand}]
+\begin{lstcode}[moretexcs={useshorthands,defineshorthand}]
\defineshorthand{'.}{. \Sentence\ignorespaces}
\end{lstcode}
These abbrevations have been tried and tested. For details regarding
\Macro{useshorthands} and \Macro{defineshorthands} please consult the manual
of the package \Package{babel} (see \cite{package:babel}).%
-\EndIndex{Cmd}{Sentence}%
-\EndIndex{Cmd}{thesentence}%
-\EndIndex{Counter}{sentence}%
+\EndIndexGroup
%
-\EndIndex{}{sentence>number}
+\EndIndexGroup
%
-\EndIndex{}{contract}%
+\EndIndexGroup
\section{Cross References}
@@ -546,90 +537,67 @@ The conventional mechanism to set cross references using
\Macro{pageref} does not suffice. \Package{scrjura} provides more commands.
\begin{Declaration}
- \Macro{ref}\Parameter{label}\\
- \Macro{refL}\Parameter{label}\\
- \Macro{refS}\Parameter{label}\\
+ \Macro{ref}\Parameter{label}%
+ \Macro{refL}\Parameter{label}%
+ \Macro{refS}\Parameter{label}%
\Macro{refN}\Parameter{label}
\end{Declaration}
-\BeginIndex{Cmd}{ref}%
-\BeginIndex{Cmd}{refL}%
-\BeginIndex{Cmd}{refS}%
-\BeginIndex{Cmd}{refN}%
The commands \Macro{refL}, \Macro{refS}, and \Macro{refN} give a full
reference to clause, paragraph and sentence. \Macro{refL} is a long text,
\Macro{refS} a short text and \Macro{refN} an abbreviated, numeric
form. \Macro{ref} defaults to \Macro{refL}.%
-\EndIndex{Cmd}{refN}%
-\EndIndex{Cmd}{refS}%
-\EndIndex{Cmd}{refL}%
-\EndIndex{Cmd}{ref}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{refClause}\Parameter{label}\\
+ \Macro{refClause}\Parameter{label}%
\Macro{refClauseN}\Parameter{label}
\end{Declaration}
-\BeginIndex{Cmd}{refClause}%
-\BeginIndex{Cmd}{refClauseN}%
For a cross reference to to a clause without displaying paragraph and
sentences as well. \Macro{refClause} puts a section symbol (\S) in front of
the reference, while \Macro{refClauseN} does not.%
-\EndIndex{Cmd}{refClauseN}%
-\EndIndex{Cmd}{refClause}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{refPar}\Parameter{label}\\
- \Macro{refParL}\Parameter{label}\\
- \Macro{refParS}\Parameter{label}\\
+ \Macro{refPar}\Parameter{label}%
+ \Macro{refParL}\Parameter{label}%
+ \Macro{refParS}\Parameter{label}%
\Macro{refParN}\OParameter{number format}\Parameter{label}
\end{Declaration}
-\BeginIndex{Cmd}{refPar}%
-\BeginIndex{Cmd}{refParL}%
-\BeginIndex{Cmd}{refParS}%
-\BeginIndex{Cmd}{refParN}%
You can make a cross reference to a paragraph using \Macro{refParL},
\Macro{refParS} and \Macro{refParN}. The differences between the forms
-correspond to the differences between \Macro{refL}, \Macro{refN} and
-\Macro{refS}. A special feature is the optional argument of
-\Macro{refParN}. Usually the numeric reference to a paragraph uses a roman
-number. The optional argument allows to set a different \PName{number format},
-it may make sense to use arabic numbers. \Macro{refPar} defaults to
-\Macro{refParL}.%
-\EndIndex{Cmd}{refParN}%
-\EndIndex{Cmd}{refParS}%
-\EndIndex{Cmd}{refParL}%
-\EndIndex{Cmd}{refPar}%
+correspond to the differences between \DescRef{\LabelBase.cmd.refL},
+\DescRef{\LabelBase.cmd.refN} and \DescRef{\LabelBase.cmd.refS}. A special
+feature is the optional argument of \Macro{refParN}. Usually the numeric
+reference to a paragraph uses a roman number. The optional argument allows to
+set a different \PName{number format}, it may make sense to use arabic
+numbers. \Macro{refPar} defaults to \Macro{refParL}.%
+\EndIndexGroup
\begin{Declaration}
- \Macro{refSentence}\Parameter{label}\\
- \Macro{refSentenceL}\Parameter{label}\\
- \Macro{refSentenceS}\Parameter{label}\\
+ \Macro{refSentence}\Parameter{label}%
+ \Macro{refSentenceL}\Parameter{label}%
+ \Macro{refSentenceS}\Parameter{label}%
\Macro{refSentenceN}\Parameter{label}
\end{Declaration}
-\BeginIndex{Cmd}{refSentence}%
-\BeginIndex{Cmd}{refSentenceL}%
-\BeginIndex{Cmd}{refSentenceS}%
-\BeginIndex{Cmd}{refSentenceN}%
You can make a cross reference to a sentence with \Macro{refSentenceL},
\Macro{refSentenceS}, or \Macro{refSentenceN}. Again we have a long text form,
a short text form and a numerical form. \Macro{refSentence} defaults to
\Macro{refSentenceL}.%
-\EndIndex{Cmd}{refSentenceN}%
-\EndIndex{Cmd}{refSentenceS}%
-\EndIndex{Cmd}{refSentenceL}%
-\EndIndex{Cmd}{refSentence}%
+\EndIndexGroup
\begin{Declaration}
- \KOption{ref}\PName{value}
+ \OptionVName{ref}{value}
\end{Declaration}
-\BeginIndex{Option}{ref~=\PName{value}}%
-The results of \Macro{ref}, \Macro{refPar}, and \Macro{refSentence} depend on
-the \PName{value} of option \Option{ref}. Defaults are \Macro{refL},
-\Macro{refParL} and \Macro{refSentenceL}. For possible values and their
-meaning see \autoref{tab:scrjura.ref}.%
+The results of \DescRef{\LabelBase.cmd.ref}, \DescRef{\LabelBase.cmd.refPar},
+and \DescRef{\LabelBase.cmd.refSentence} depend on the \PName{value} of option
+\Option{ref}. Defaults are \DescRef{\LabelBase.cmd.refL},
+\DescRef{\LabelBase.cmd.refParL} and
+\DescRef{\LabelBase.cmd.refSentenceL}. For possible values and their meaning
+see \autoref{tab:scrjura.ref}.%
%
\begin{table}
%\begin{desclist}
@@ -639,66 +607,68 @@ meaning see \autoref{tab:scrjura.ref}.%
format%
}]{%
Possible values for option \Option{ref} to configure the cross reference
- format of \Macro{ref}, \Macro{refPar}, and \Macro{refSentence}%
+ format of \DescRef{\LabelBase.cmd.ref}, \DescRef{\LabelBase.cmd.refPar},
+ and \DescRef{\LabelBase.cmd.refSentence}%
\label{tab:scrjura.ref}%
}%
\begin{desctabular}
- \entry{\PValue{long}}{%
- Combination of \PValue{parlong} and \PValue{sentencelong}.%
- \IndexOption{ref~=\PValue{long}}%
- }%
- \entry{\PValue{numeric}}{%
- Combination of \PValue{parnumeric} and \PValue{sentencenumeric}.%
- \IndexOption{ref~=\PValue{numeric}}%
- }%
- \entry{\PValue{clauseonly}, \PValue{onlyclause},
- \PValue{ClauseOnly}, \PValue{OnlyClause}}{%
- Combination of \PValue{paroff} and \PValue{sentenceoff}; note that
- \Macro{refPar} and \Macro{refSentence} have empty results!%
- \IndexOption{ref~=\PValue{long}}%
- }%
- \entry{\PValue{parlong}, \PValue{longpar}, \PValue{ParL}}{%
- Paragraphs are referenced in long textual form.%
- \IndexOption{ref~=\PValue{parlong}}%
- }%
- \entry{\PValue{parnumeric}, \PValue{numericpar}, \PValue{ParN}}{%
- Paragraphs are referenced in simple numerical form.%
- \IndexOption{ref~=\PValue{parnumeric}}%
- }%
- \entry{\PValue{paroff}, \PValue{nopar}}{%
- Paragraphs have not reference. Note that \Macro{refPar} has an empty
- result!%
- \IndexOption{ref~=\PValue{paroff}}%
- }%
- \entry{\PValue{parshort}, \PValue{shortpar}, \PValue{ParS}}{%
- Paragraphs are referenced in short textual form.%
- \IndexOption{ref~=\PValue{parshort}}%
- }%
- \entry{\PValue{sentencelong}, \PValue{longsentence}, \PValue{SentenceL}}{%
- Sentences are referenced in long textual form.%
- \IndexOption{ref~=\PValue{parlong}}%
- }%
- \entry{\PValue{sentencenumeric}, \PValue{numericsentence},
- \PValue{SentenceN}}{%
- Sentences are referenced in simple numeric form.%
- \IndexOption{ref~=\PValue{sentencenumeric}}%
- }%
- \entry{\PValue{sentenceoff}, \PValue{nosentence}}{%
- Sentences have no reference. Note that \Macro{refSentence} has an empty
- result!%
- \IndexOption{ref~=\PValue{sentenceoff}}%
- }%
- \entry{\PValue{sentenceshort}, \PValue{shortsentence}, \PValue{SentenceS}}{%
- Sentences are referenced in short textual form.%
- \IndexOption{ref~=\PValue{sentenceshort}}%
- }%
- \entry{\PValue{short}}{%
- Combination if \PValue{parshort} and \PValue{sentenceshort}.%
- \IndexOption{ref~=\PValue{value}}%
- }%
+ \entry{\PValue{long}}{%
+ Combination of \PValue{parlong} and \PValue{sentencelong}.%
+ \IndexOption{ref~=\PValue{long}}%
+ }%
+ \entry{\PValue{numeric}}{%
+ Combination of \PValue{parnumeric} and \PValue{sentencenumeric}.%
+ \IndexOption{ref~=\PValue{numeric}}%
+ }%
+ \entry{\PValue{clauseonly}, \PValue{onlyclause}, \PValue{ClauseOnly},
+ \PValue{OnlyClause}}{%
+ Combination of \PValue{paroff} and \PValue{sentenceoff}; note that
+ \DescRef{\LabelBase.cmd.refPar} and \DescRef{\LabelBase.cmd.refSentence}
+ have empty results!%
+ \IndexOption{ref~=\PValue{long}}%
+ }%
+ \entry{\PValue{parlong}, \PValue{longpar}, \PValue{ParL}}{%
+ Paragraphs are referenced in long textual form.%
+ \IndexOption{ref~=\PValue{parlong}}%
+ }%
+ \entry{\PValue{parnumeric}, \PValue{numericpar}, \PValue{ParN}}{%
+ Paragraphs are referenced in simple numerical form.%
+ \IndexOption{ref~=\PValue{parnumeric}}%
+ }%
+ \entry{\PValue{paroff}, \PValue{nopar}}{%
+ Paragraphs have not reference. Note that \DescRef{\LabelBase.cmd.refPar}
+ has an empty result!%
+ \IndexOption{ref~=\PValue{paroff}}%
+ }%
+ \entry{\PValue{parshort}, \PValue{shortpar}, \PValue{ParS}}{%
+ Paragraphs are referenced in short textual form.%
+ \IndexOption{ref~=\PValue{parshort}}%
+ }%
+ \entry{\PValue{sentencelong}, \PValue{longsentence}, \PValue{SentenceL}}{%
+ Sentences are referenced in long textual form.%
+ \IndexOption{ref~=\PValue{parlong}}%
+ }%
+ \entry{\PValue{sentencenumeric}, \PValue{numericsentence},
+ \PValue{SentenceN}}{%
+ Sentences are referenced in simple numeric form.%
+ \IndexOption{ref~=\PValue{sentencenumeric}}%
+ }%
+ \entry{\PValue{sentenceoff}, \PValue{nosentence}}{%
+ Sentences have no reference. Note that
+ \DescRef{\LabelBase.cmd.refSentence} has an empty result!%
+ \IndexOption{ref~=\PValue{sentenceoff}}%
+ }%
+ \entry{\PValue{sentenceshort}, \PValue{shortsentence},
+ \PValue{SentenceS}}{%
+ Sentences are referenced in short textual form.%
+ \IndexOption{ref~=\PValue{sentenceshort}}%
+ }%
+ \entry{\PValue{short}}{%
+ Combination if \PValue{parshort} and \PValue{sentenceshort}.%
+ \IndexOption{ref~=\PValue{value}}%
+ }%
\end{desctabular}
\end{table}
-\EndIndex{Option}{ref~=\PName{Einstellung}}%
\begin{Example}
Supposed you would like to reference to paragraphs in the form ``paragraph 1
@@ -710,7 +680,8 @@ meaning see \autoref{tab:scrjura.ref}.%
in clause~\refClauseN{#1}%
}
\end{lstcode}
- This new command can be used in the same way as \Macro{refParL}.%
+ This new command can be used in the same way as
+ \DescRef{\LabelBase.cmd.refParL}.%
\end{Example}%
\hyperref[tab:scrjura.refexamples]{Table~\ref*{tab:scrjura.refexamples}}
@@ -725,24 +696,25 @@ provides examples of the output of the fundamental commands, not configured.%
\toprule
Command & Example output \\
\midrule
- \Macro{refL}\Parameter{label} & § 1 paragraph 1 sentence 1 \\
- \Macro{refS}\Parameter{label} & § 1 par. 1 sent. 1 \\
- \Macro{refN}\Parameter{label} & § 1 I 1. \\
- \Macro{refClause}\Parameter{label} & § 1 \\
- \Macro{refClauseN}\Parameter{label} & 1 \\
- \Macro{refParL}\Parameter{label} & paragraph 1 \\
- \Macro{refParS}\Parameter{label} & par. 1 \\
- \Macro{refParN}\Parameter{label} & I \\
- \Macro{refParN}\POParameter{arabic}\Parameter{label} & 1 \\
- \Macro{refParN}\POParameter{roman}\Parameter{label} & i \\
- \Macro{refSentenceL}\Parameter{label} & sentence 1 \\
- \Macro{refSentenceS}\Parameter{label} & sent. 1 \\
- \Macro{refSentenceN}\Parameter{label} & 1. \\
+ \DescRef{\LabelBase.cmd.refL}\Parameter{label} & § 1 paragraph 1 sentence 1 \\
+ \DescRef{\LabelBase.cmd.refS}\Parameter{label} & § 1 par. 1 sent. 1 \\
+ \DescRef{\LabelBase.cmd.refN}\Parameter{label} & § 1 I 1. \\
+ \DescRef{\LabelBase.cmd.refClause}\Parameter{label} & § 1 \\
+ \DescRef{\LabelBase.cmd.refClauseN}\Parameter{label} & 1 \\
+ \DescRef{\LabelBase.cmd.refParL}\Parameter{label} & paragraph 1 \\
+ \DescRef{\LabelBase.cmd.refParS}\Parameter{label} & par. 1 \\
+ \DescRef{\LabelBase.cmd.refParN}\Parameter{label} & I \\
+ \DescRef{\LabelBase.cmd.refParN}\POParameter{arabic}\Parameter{label} & 1 \\
+ \DescRef{\LabelBase.cmd.refParN}\POParameter{roman}\Parameter{label} & i \\
+ \DescRef{\LabelBase.cmd.refSentenceL}\Parameter{label} & sentence 1 \\
+ \DescRef{\LabelBase.cmd.refSentenceS}\Parameter{label} & sent. 1 \\
+ \DescRef{\LabelBase.cmd.refSentenceN}\Parameter{label} & 1. \\
\bottomrule
\end{tabular}
\end{captionbeside}
\label{tab:scrjura.refexamples}
\end{table}
+\EndIndexGroup
\section{Additional Environments}
@@ -759,7 +731,6 @@ contract environment.
\Macro{DeclareNewJuraEnvironment}\Parameter{name}\OParameter{options}%
\Parameter{start commands}\Parameter{end commands}
\end{Declaration}
-\BeginIndex{Cmd}{DeclareNewJuraEnvironment}%
This\ChangedAt{v0.9}{\Package{scrjura}} command allows to define new and
independent environments of the type contract. The argument \PName{name} is
the name of the new environment, of course. \PName{start commands} are
@@ -767,30 +738,31 @@ commands which will be executed at the beginning of the environment, as if
they were added directly after \Macro{begin}\Parameter{name}. Correspondingly
\PName{end commands} will be executed at the end of the environment, as if
added directly before \Macro{end}\Parameter{name}. Without any \PName{options}
-the new environment behaves similiar to the \Environment{contract}
+the new environment behaves similiar to the \DescRef{\LabelBase.env.contract}
environment, but with its own counters. It is possible to set \PName{options}
in a comma separated list. Currently the following \PName{options} are
supported:
\begin{description}
-\item[\KOption{Clause}\PName{instruction}:] Defines on which
- \PName{instruction} inside the environment the command \Macro{Clause} is
- being mapped. The \PName{instruction} expects exactly one argument. To use
- it correctly, a deeper knowledge and understanding of the internal functions
- of \Package{scrjura} is needed. Furthermore the requirements for
+\item[\OptionVName{Clause}{instruction}:] Defines on which \PName{instruction}
+ inside the environment the command \DescRef{\LabelBase.cmd.Clause} is being
+ mapped. The \PName{instruction} expects exactly one argument. To use it
+ correctly, a deeper knowledge and understanding of the internal functions of
+ \Package{scrjura} is needed. Furthermore the requirements for
\PName{instruction} may change in future versions. It is recommended not to
use this option.%
-\item[\KOption{SubClause}\PName{instruction}:] See explanation for
+\item[\OptionVName{SubClause}{instruction}:] See explanation for
\Option{Clause} above.
-\item[\KOption{Sentence}\PName{instruction}:] Defines on which
- \PName{instruction} inside the environment the command \Macro{Sentence} is
- being mapped. The \PName{instruction} must not have an argument. Typically
- it should add one to the counter \Counter{sentence}\IndexCounter{sentence}
- (using \Macro{refstepcounter}\IndexCmd{refstepcounter}) and display it
+\item[\OptionVName{Sentence}{instruction}:] Defines on which
+ \PName{instruction} inside the environment the command
+ \DescRef{\LabelBase.cmd.Sentence} is being mapped. The \PName{instruction}
+ must not have an argument. Typically it should add one to the counter
+ \Counter{sentence}\IndexCounter{sentence} (using
+ \Macro{refstepcounter}\IndexCmd{refstepcounter}) and display it
somehow. Please avoid undesirable spaces.
-\item[\KOption{ClauseNumberFormat}\PName{instruction}:] Formats the numbers of
+\item[\OptionVName{ClauseNumberFormat}{instruction}:] Formats the numbers of
clauses. Expects exactly one argument, the number of the clause. If the
- \PName{instruction} implements a series of instructions and the number is the
- last argument of a that series, you may directly use the series of
+ \PName{instruction} implements a series of instructions and the number is
+ the last argument of a that series, you may directly use the series of
instructions as \PName{instruction}.
\end{description}
\begin{Example}
@@ -808,7 +780,7 @@ supported:
\end{lstcode}
In cross references will ``Art.'' be used instead of ``\S'', of course.%
\end{Example}%
-\EndIndex{Cmd}{DeclareNewJuraEnvironment}%
+\EndIndexGroup
\section{Support for Different Languages}
@@ -819,9 +791,9 @@ lawyer. Therefore primarily it has provided the languages \PValue{german},
\PValue{ngerman}, \PValue{austrian}, and \PValue{naustrian}. Nevertheless, it
has been designed to support common language packages like
\Package{babel}\important{\Package{babel}}\IndexPackage{babel}. Users can make
-language adjustments simply using \Macro{providecaptionname} (see
-\autoref{sec:scrbase.languageSupport},
-\autopageref{desc:scrbase.cmd.providecaptionname}). But if you have definite
+language adjustments simply using \DescRef{scrbase.cmd.providecaptionname}
+(see \autoref{sec:scrbase.languageSupport},
+\DescPageRef{scrbase.cmd.providecaptionname}). But if you have definite
information about the correct juristic terms and conventions of a language, it
is recommended to contact the \KOMAScript{} author. This has been happened for
English and therefore in the meantime \Package{scrjura} also provides terms
@@ -829,22 +801,19 @@ for languages \PValue{english}, \PValue{american}, \PValue{british},
\PValue{canadian}, \PValue{USenglish}, and \PValue{UKenglish}.
\begin{Declaration}
- \Macro{parname}\\
- \Macro{parshortname}\\
- \Macro{sentencename}\\
+ \Macro{parname}%
+ \Macro{parshortname}%
+ \Macro{sentencename}%
\Macro{sentenceshortname}
\end{Declaration}
-\BeginIndex{Cmd}{parname}%
-\BeginIndex{Cmd}{parshortname}%
-\BeginIndex{Cmd}{sentencename}%
-\BeginIndex{Cmd}{sentenceshortname}%
These are the language-dependent terms used by \Package{scrjura}. The meaning
of the terms and the English defaults are shown in
\autoref{tab:scrjura.captionnames}. The package itself uses
-\Macro{providecaptionname} inside \Macro{begin}\PParameter{document} to define
-them. So pre-definitions for the same language but before loading
-\Package{scrjura} will not be changed. If you use \Package{scrjura} with a
-language setting currently not supported, the package throws an error.%
+\DescRef{scrbase.cmd.providecaptionname} inside
+\Macro{begin}\PParameter{document} to define them. So pre-definitions for the
+same language but before loading \Package{scrjura} will not be changed. If
+you use \Package{scrjura} with a language setting currently not supported, the
+package throws an error.%
%
\begin{table}
\KOMAoptions{captions=topbeside}%
@@ -870,10 +839,7 @@ language setting currently not supported, the package throws an error.%
\label{tab:scrjura.captionnames}
\end{table}
%
-\EndIndex{Cmd}{sentenceshortname}%
-\EndIndex{Cmd}{sentencename}%
-\EndIndex{Cmd}{parshortname}
-\EndIndex{Cmd}{parname}
+\EndIndexGroup
\section{A Detailed Example}
@@ -887,85 +853,86 @@ using \Package{scrjura}.\footnote{Please note, the example is still in German
the translation. Nevertheless, the contents of the example does not matter
but the technical realisation.}
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=1-2}]{scrjuraexample.tex}%
We use class \Class{scrartcl}. Because paragraph distance instead of paragraph
indentation is usual in club statutes we load the class with option
-\OptionValue{parskip}{half} (see \autoref{sec:maincls.parmarkup},
-\autopageref{desc:maincls.option.parskip}).
+\OptionValueRef{maincls}{parskip}{half} (see \autoref{sec:maincls.parmarkup},
+\DescPageRef{maincls.option.parskip}).
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=4-4}]{scrjuraexample.tex}%
The club rules are in German. Therefore package \Package{babel} with option
\Option{ngerman} is used, too.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange={6-7,9-9}}]{scrjuraexample.tex}%
Default settings for the fonts are made. Additionally package
\Package{textcomp} is loaded, because it does not only provide a usable Euro
sign but also an improved section sign (\S).
\lstinputcode[{moretexcs=SelectInputMappings,xleftmargin=2em,%
- belowskip=\dp\strutbox plus 1pt,%
linerange=11-15}]{scrjuraexample.tex}%
We want to input special characters and umlauts without commands. To do so, we
let \LaTeX{} detect the input encoding. Alternatively we could use package
\Package{inputenc}.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=17-17}]{scrjuraexample.tex}%
Later in the document we want lists numbered not with arabic numbers but with
lower letters. We can do this easily with package \Package{enumerate}.
\lstinputcode[{moretexcs={useshorthands,defineshorthand},%
- belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+ xleftmargin=2em,%
linerange=19-27}]{scrjuraexample.tex}%
Now, it is time for \Package{scrjura}. With option
-\OptionValue{clausemark}{forceboth} we enforce left an right clause marks for
-the running head. On the other hand we do not want \Macro{section} to change
-the marks for the running head. Therefore we use page style
-\Pagestyle{myheadings}. This page style generally does not provide automatic
-running heads.
+\OptionValueRef{\LabelBase}{clausemark}{forceboth} we enforce left an right
+clause marks for the running head. On the other hand we do not want
+\DescRef{maincls.cmd.section} to change the marks for the running
+head. Therefore we use page style \PageStyle{myheadings}. This page style
+generally does not provide automatic running heads.
Later we also want a table of contents with the clauses. This can be achieved
-with option \Option{juratotoc}. Doing so we will see, that the clause number
-width is to large for default of the entry into the table of contents. With
-\OptionValue{juratocnumberwidth}{2.5em} we declare a larger reserved width.
+with option \DescRef{\LabelBase.option.juratotoc}. Doing so we will see, that
+the clause number width is to large for default of the entry into the table of
+contents. With \OptionValueRef{\LabelBase}{juratocnumberwidth}{2.5em} we
+declare a larger reserved width.
The definition of short hands has already been shown in
\autoref{sec:scrjura.shorthandexample}. We also use this to make the input
easier and more readable.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=29-29}]{scrjuraexample.tex}%
It is time to begin the document.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=31-35}]{scrjuraexample.tex}%
Like other documents the statutes have a title. We make it with the usual
\KOMAScript{} commands from \autoref{sec:maincls.titlepage} (see down from
\autopageref{sec:maincls.titlepage}).
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=37-37}]{scrjuraexample.tex}%
As already stated, we want to have a table of contents.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=39-43}]{scrjuraexample.tex}%
-Preambles are not unusual in club statutes. Here we use \Macro{addsec} to
-realise it, because we want to have an entry into the table of contents.
+Preambles are not unusual in club statutes. Here we use
+\DescRef{maincls.cmd.addsec} to realise it, because we want to have an entry
+into the table of contents.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=45-45}]{scrjuraexample.tex}%
Here we use a tiny trick. The articles of the club statutes should be numbered
with uppercase letters instead of arabic numbers. This is the same like the
numbering of appendix sections of an article with \Class{scrartcl}.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=47-49}]{scrjuraexample.tex}%
We begin the contract with the first article.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=50-59}]{scrjuraexample.tex}%
The first clause has a number and a title. We will do the same with all
following clauses.
@@ -980,59 +947,59 @@ In the second paragraph we have two sentences. Here we can see the short hands
sentence number. The second one does not only print the full stop but also the
sentence number. With this, both sentences are numbered.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=60-75}]{scrjuraexample.tex}%
The second clause: also with several paragraphs with one or more
sentences. The second paragraph additionally has a numbered list. At the last
paragraph we used a label, because we want to reference it later.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=77-84}]{scrjuraexample.tex}%
The third clause has something special: a cross reference. Here we use the
long form with clause, paragraph and sentence. If we would decide, that
sentences should not be referenced, we could use option
-\OptionValue{ref}{nosentence} globally.
+\OptionValueRef{\LabelBase}{ref}{nosentence} globally.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=86-87}]{scrjuraexample.tex}%
Here we have a special kind of clauses. In prior versions of the club statutes
this was a real clause. But then it has been removed. Nevertheless, the
numbering of the following clauses should not be changed by removing this
-one. Therefore the \Macro{Clause} statement has not been removed but
-supplemented by option \Option{dummy}. With this, we also can set a label
-despite the clause will not be printed.
+one. Therefore the \DescRef{\LabelBase.cmd.Clause} statement has not been
+removed but supplemented by option \Option{dummy}. With this, we also can set
+a label despite the clause will not be printed.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=88-92}]{scrjuraexample.tex}%
Another article starts. To avoid problems with the paragraph numbering we
-interrupt the \Environment{contract} environment.
+interrupt the \DescRef{\LabelBase.env.contract} environment.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=93-93}]{scrjuraexample.tex}%
The first clause of the next article also has been removed.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=95-104}]{scrjuraexample.tex}%
We have a real clause again. We cross reference one of the removed
clauses and also use a label.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=107-112}]{scrjuraexample.tex}%
Once more, this is a special kind of clause. This time we have not removed a
clause but added one without renumbering of the following clauses. To do so,
-we use \Macro{SubClause}. Therefore the clause number is the same like the
-previous one but with an appended ``a''.
+we use \DescRef{\LabelBase.cmd.SubClause}. Therefore the clause number is the
+same like the previous one but with an appended ``a''.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=114-134}]{scrjuraexample.tex}%
The other clauses of this article are very usual. You already know all the
features used for them.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=136-150}]{scrjuraexample.tex}%
More articles with known features are following.
-\lstinputcode[{belowskip=\dp\strutbox plus 1pt,xleftmargin=2em,%
+\lstinputcode[{xleftmargin=2em,%
linerange=152-152}]{scrjuraexample.tex}%
Then the \LaTeX{} document ends. You can see three pages from the front of the
document in \autoref{fig:scrjura.example}.%
@@ -1087,26 +1054,27 @@ should still regard it as work in progress. Here are the three reasons for
this:
The package has been designed much more general than it can be used
-currently. For example several environments beside \Environment{contract} has
-been expected. Later we find that this one and only environment could be used
-very general. Nevertheless we also find that it could be useful to be able to
-define additional \Environment{contract} environments, e.\,g., for articles of
+currently. For example several environments beside
+\DescRef{\LabelBase.env.contract} has been expected. Later we find that this
+one and only environment could be used very general. Nevertheless we also find
+that it could be useful to be able to define additional
+\DescRef{\LabelBase.env.contract} environments, e.\,g., for articles of
constitutional law. This has been implemented now.
Neither the cooperation with other packages nor the cooperation of the
-\Environment{contract} environment with all kind of \LaTeX{} environments or
-document classes has been tested. The main reason for this is that the package
-is very special and the package author does not have any requirement to use
-it. So all changes, all features, all improvement can only base on detailed
-user feedback and only about two and a half users are willing to send such
-feedback.
+\DescRef{\LabelBase.env.contract} environment with all kind of \LaTeX{}
+environments or document classes has been tested. The main reason for this is
+that the package is very special and the package author does not have any
+requirement to use it. So all changes, all features, all improvement can only
+base on detailed user feedback and only about two and a half users are willing
+to send such feedback.
The low version number should state that things could change. The author
endeavours to preserve compatibility to prior versions. Nevertheless,
sometimes compatibility is less important than usability. So compatibility
cannot be guaranteed.%
%
-\EndIndex{Package}{scrjura}
+\EndIndexGroup
\endinput