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.tex978
1 files changed, 528 insertions, 450 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 98320e6a3ab..1d19af010aa 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-2017
+% Copyright (c) Markus Kohm, 2011-2018
%
% 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-2017
+% Copyright (c) Markus Kohm, 2011-2018
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,32 +46,32 @@
% ======================================================================
\KOMAProvidesFile{scrjura.tex}%
- [$Date: 2017-05-08 11:47:04 +0200 (Mon, 08 May 2017) $
+ [$Date: 2018-03-30 11:57:25 +0200 (Fri, 30 Mar 2018) $
KOMA-Script guide (chapter: scrjura)]
-\translator{Alexander Willand\and Markus Kohm}
+\translator{Alexander Willand\and Markus Kohm\and Karl Hagen}
-% Date of the translated German file: 2017-05-08
+% Date of the translated German file: 2018-02-06
-\chapter{Support for the Law Office by \Package{scrjura}}
+\chapter{Support for the Law Office with \Package{scrjura}}
\labelbase{scrjura}
\BeginIndexGroup
\BeginIndex{Package}{scrjura}
-In case you'd like to write a contract\Index{contract}, the bylaws of a
-company or of the club, an act of law or a whole commentary, the package
-\Package{scrjura} will provide typographical support. Despite the fact that
-\Package{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.
+If you want to write a contract\Index{contract}, the articles of association
+for a company or an association, a law, or a legal commentary, the package
+\Package{scrjura} will provide typographical support. Although
+\Package{scrjura} is intended to provide general help for legal documents, the
+contract is the central element of the package. Particular attention is paid
+to clauses, titles, and numbered provisions\,---\,if there are several of
+them in a clause\,---, 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.
+The package has been developed in cooperation with Dr Alexander Willand of
+Karlsruhe. Many of its features go back to constructive inquiries from Prof
+Heiner Richter of the Hochschule Stralsund University of Applied Sciences.
-Note\textnote{Attention!} that the package cooperates with
+Note\textnote{Attention!} that the package works with
\Package{hyperref}\IndexPackage{hyperref}. Nevertheless, \Package{hyperref}
has to be loaded after \Package{scrjura} as usual.
@@ -82,29 +82,30 @@ has to be loaded after \Package{scrjura} as usual.
\section{Table of Contents}
\label{sec:scrjura.toc}
-The package \Package{scrjura} provides entries into the table of contents.
+The headings of clauses can also be added automatically to the table of
+contents, if desired.
\begin{Declaration}
\OptionVName{juratotoc}{simple switch}%
\OptionVName{juratotoc}{level number}
\end{Declaration}
-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
+Clauses\Index{clause} are shown in the table of contents only if their
+\PName{level number} is less than or equal to the
\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
+\important{\DescRef{maincls.counter.tocdepth}}\IndexCounter{tocdepth} counter
+(see \autoref{sec:maincls.toc}, \DescPageRef{maincls.counter.tocdepth}). By
+default, the \PName{level number} is 10000, which is also used if the option
+is switched off with the \PName{simple
+switch}\important{\OptionValue{juratotoc}{false}} (see
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}). Because the
-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 \DescRef{maincls.counter.tocdepth}
-has default values as well, clauses are shown with all \KOMAScript{} classes.%
+\DescRef{maincls.counter.tocdepth} counter usually has a one-digit value,
+clause entries are therefore not normally displayed in the table of contents.
+
+If you switch on the option using the \PName{simple switch}%
+\important{\OptionValue{juratotoc}{true}}, the \PName{level number} 2 is used
+so that clauses are shown in the table of contents on the same level as
+subsections. For the default setting of \DescRef{maincls.counter.tocdepth},
+clauses are then shown in all \KOMAScript{} classes.%
\EndIndexGroup
@@ -112,9 +113,10 @@ has default values as well, clauses are shown with all \KOMAScript{} classes.%
\OptionVName{juratocindent}{indent}%
\OptionVName{juratocnumberwidth}{number width}
\end{Declaration}
-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}.%
+These two options can be used to determine the indentation for the clause
+entries in the table of contents as well as the space reserved for the numbers
+there. The defaults are the same as for subsection entries in
+\Class{scrartcl}.%
\EndIndexGroup
@@ -123,24 +125,24 @@ values for the subsection entries in \Class{scrartcl}.%
\BeginIndexGroup
\BeginIndex{}{contract}
-The main mechanism of \Package{scrjura} only work inside of the contract
-environment.
+The essential mechanisms of \Package{scrjura} are available only inside the
+contract environment.
\begin{Declaration}
\begin{Environment}{contract}\end{Environment}
\end{Declaration}
-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 \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.%
+Currently, this is the one and only environment for \Package{scrjura}. Using
+it activates automatic numbering of paragraphs and the
+\DescRef{\LabelBase.cmd.Clause} and \DescRef{\LabelBase.cmd.SubClause}
+commands, which will be documented below, are given concrete form.
+
+The\textnote{Attention!} \DescRef{\LabelBase.env.contract} environment must
+not be nested within itself. Within a document, however, you can use the
+environment several times. The clauses within these environments are treated
+as if they were within a single environment. As a result, ending the
+environment really only temporarily interrupts it, and the old environment is
+continued by the beginning of a new environment. However, you cannot end the
+environment within a clause.%
\EndIndexGroup
@@ -151,15 +153,14 @@ The whole document becomes a contract if you use this option while loading the
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.%
+\important{\DescRef{\LabelBase.cmd.documentclass}}. The document then behaves
+exactly as if it contained one \DescRef{\LabelBase.env.contract} environment.
+
+Note\textnote{Attention!} that you cannot set the \Option{contract} option
+with \DescRef{\LabelBase.cmd.KOMAoption} or
+\DescRef{\LabelBase.cmd.KOMAoptions}. Thus you cannot switch the option off
+again. Instead, you should use a \DescRef{\LabelBase.env.contract} environment
+directly.%
\EndIndexGroup
@@ -167,42 +168,48 @@ environment directly.%
\label{sec:scrjura.clause}
\index{section|seealso{clause}}
-With \Package{scrjura} clauses\footnote{%
- In English, the word ``section'' also is used in an act of law or in an
- 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}.
+Clauses\footnote{%
+ In English, a ``clause'' in a legal document is a section, paragraph, or
+ phrase that relates to a particular point. Although it is common in English
+ to also use the terms ``article'' or ``section'' for what we here call a
+ ``clause'', we use the latter term throughout to avoid confusion with the
+ \Class{article} class and the \DescRef{maincls.cmd.section} and
+ \DescRef{maincls.cmd.paragraph} sectioning divisions of most document
+ classes.} in a legal sense are defined in \Package{scrjura} only within
+contracts, that is inside the \DescRef{\LabelBase.env.contract} environment or
+other environments declared with
+\DescRef{\LabelBase.cmd.DeclareNewJuraEnvironment} (see
+\autoref{sec:\LabelBase.newenv},
+\DescPageRef{\LabelBase.cmd.DeclareNewJuraEnvironment}).
\begin{Declaration}
\Macro{Clause}\OParameter{options}%
\Macro{SubClause}\OParameter{options}
\end{Declaration}
-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
-contrast to this the command \Macro{SubClause} creates the heading of a clause
-with the last number used by \Macro{Clause} and adds a lowercase
-letter. \Macro{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 \PName{options} a list separated by commas of
-properties. An overview over possible properties is provided by
-\autoref{tab:scrjura.Clause.options}. For the most important of them we will
-go into the details.
+These are the most important commands inside of a contract. Without using any
+additional \PName{options}, \Macro{Clause} creates the heading of a clause,
+which consists of the sign »\S«, followed by its number. In contrast,
+\Macro{SubClause} creates the heading of a clause with the last number used by
+\Macro{Clause} and adds a lower-case letter. \Macro{SubClause} is mainly
+intended for cases where an act or a contract is amended and not only are
+clauses changed or deleted but new clauses are inserted between existing ones
+without completely changing the numbering.
+
+Both commands accept a a comma-separated list of \PName{options}. An overview
+of the available properties is shown in \autoref{tab:scrjura.Clause.options}.
+The most important of them will be discussed in more detail.
\begin{table}
- \caption{Possible properties for the optional argument of \Macro{Clause} and
+ \caption{Available properties for the optional argument of \Macro{Clause} and
\Macro{SubClause}}
\label{tab:scrjura.Clause.options}
\begin{desctabular}
\entry{\Option{dummy}}{%
- The heading will not be printed but counted in the automatic numbering.%
+ The heading will not be printed but is counted in the automatic
+ numbering.%
}%
\entry{\OptionVName{head}{running head}}{%
- If running heads are available, \PName{running head} is used instead of
+ If running heads are active, this \PName{running head} is used instead of
the clause \PName{title}.%
}%
\entry{\Option{nohead}}{%
@@ -221,150 +228,149 @@ go into the details.
Changes the vertical \PName{skip} after the clause heading.%
}%
\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.%
+ The clause \PName{title} will be printed in addition to the clause
+ number. This is also used as the default for the \PName{running head}
+ and the \PName{entry} in the table of contents.%
}%
\entry{\OptionVName{tocentry}{entry}}{%
- Independent from the clause \PName{title}, an \PName{entry} into the
+ Regardless of 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
+By default, a skip of two lines is inserted before the heading and a skip of
+one line afterwards. You can change the size of these skips with the
\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
+\Option{postskip} options. The new values apply not only to the current
+clause but from the current clause until the end of the current contract
+environment. You can also make the appropriate settings in advance with
\begin{flushleft}\quad\small
\textbf{\Macro{setkeys}}\PParameter{contract}%
\PParameter{preskip=\PName{skip},\\
\normalsize\quad\small
\hspace{11.5em}postskip=\PName{skip}}
\end{flushleft}
-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 \DescRef{\LabelBase.cmd.KOMAoptions} or
+regardless of the specific clause and outside of a contract environment. You
+can also set these options inside the preamble after loading
+\Package{scrjura}, but you cannot set them while loading the package or by
+using \DescRef{\LabelBase.cmd.KOMAoptions} or
\DescRef{\LabelBase.cmd.KOMAoption}.
\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 \DescRef{\LabelBase.cmd.setkomafont}%
+By default, clause headings use the font style
+\Macro{sffamily}\Macro{bfseries}\Macro{large}. You can change this font style
+at any time using the
+\FontElement{contract.Clause}\important{\FontElement{contract.Clause}} element
+with \DescRef{\LabelBase.cmd.setkomafont}%
\important[i]{\DescRef{\LabelBase.cmd.setkomafont},
- \DescRef{\LabelBase.cmd.addtokomafont}} and
+\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.%
+\DescRef{\LabelBase.env.contract} environment, you can also use
+\FontElement{Clause}\important{\FontElement{Clause}} instead of
+\FontElement{contract.Clause}.%
\EndIndex{FontElement}{Clause}%
\EndIndex{FontElement}{contract.Clause}
-With the options \Option{title}\important[i]{\Option{title}, \Option{head},
- \Option{tocentry}}, \Option{head}, and \Option{tocentry} a clause may get in
-addition to the number a title. It\textnote{Attention!} 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 \Option{head}
-and \Option{tocentry} cause an empty entry. If one would like to avoid an
-entry, the options \Option{nohead}\important[i]{\Option{nohead},
- \Option{notocentry}} and \Option{notocentry} have to be used.
-
-Instead of the running numbers the option
-\Option{number}\important{\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 \PName{number} have to
-be protected with \Macro{protect}. It\textnote{Attention!} is recommended only
-to use numbers and letters as assignment to \Option{number}.
-
-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}
+With the \Option{title}\important[i]{\Option{title}, \Option{head},
+ \Option{tocentry}}, \Option{head}, and \Option{tocentry} options, you can
+title a clause in addition to the number. You\textnote{Attention!} should put
+the value of each options inside curly brackets. Otherwise, for example,
+commas which are meant to be part of the value will be confused with the
+delimiters between different options. Empty values for \Option{head} and
+\Option{tocentry} cause empty entries. If you want to avoid an entry, use the
+\Option{nohead}\important[i]{\Option{nohead}, \Option{notocentry}} and
+\Option{notocentry} options.
+
+Instead of consecutive numbers, you can also set a clause number manually with
+the \Option{number}\important{\Option{number}} option. However, this does not
+affect the numbers of the subsequent clauses. Empty numbers are not possible.
+Fragile commands inside \PName{number} have to be protected with
+\Macro{protect}. You\textnote{Attention!} should use only numbers and letters
+as a \Option{number}.
+
+With the \Option{dummy}\important{\Option{dummy}} option, you can suppress the
+output of the whole heading of a clause. The automatic numbering, however,
+will still count this clause. In this way, you can skip an automatically
+numbered clause with\textnote{Example}
\begin{lstcode}
\Clause{dummy}
\end{lstcode}
-in case the clause has been deleted in a later version of a contract.
+in case the clause corresponding 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.%
+Note\textnote{Attention!} that the \Option{dummy} option only accepts the
+values \PValue{true} and \PValue{false}. All other values are usually ignored,
+but can lead to an error message in the worst case scenario.%
\EndIndexGroup
\begin{Declaration}
\Macro{Clauseformat}\Parameter{number}
\end{Declaration}
-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
+As already mentioned, clauses and subclauses are normally numbered. The number
+is formatted with the help of the \Macro{Clauseformat} command, which expects
+the number as the only argument. The default is the following:
\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.%
+This produces the section mark, \Macro{S}\IndexCmd{S} (\S), followed by a
+non-breaking space and the number. If you redefine this command, be sure it
+remains expandable.%
\EndIndexGroup
\begin{Declaration}
\OptionVName{juratitlepagebreak}{simple switch}
\end{Declaration}%
-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
+Usually, page breaks are prohibited within heading of all kinds. However, some
+lawyers require page breaks within clause headings. You can allow such a break
+by using \Option{juratitlepagebreak}\important{\Option{juratitlepagebreak}}.
+You can find the available values for \PName{simple switch} in
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}.%
\EndIndexGroup
\begin{Declaration}
\OptionVName{clausemark}{value}
\end{Declaration}%
-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 \PName{values} and their meaning are listed in
-\autoref{tab:scrjura.clausemark}.%
+Since clauses are a subordinate structure with independent numbering, they do
+not produce running heads by default. You can, however, create running heads
+with various settings. You can find the available \PName{values} and their
+meanings in \autoref{tab:scrjura.clausemark}.%
%
\begin{table}
- \caption{Possible values for option \Option{clausemark} for activation of
+ \caption{Available values for the \Option{clausemark} option to activate
running heads}%
\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.%
- \IndexOption{clausemark~=\PValue{both}}%
+ \IndexOption{clausemark~=\textKValue{both}}%
}%
\entry{\PValue{false}, \PValue{off}, \PValue{no}}{%
Clauses do not generate marks for running heads and therefore do not
change running heads.%
- \IndexOption{clausemark~=\PValue{false}}%
+ \IndexOption{clausemark~=\textKValue{false}}%
}%
\entry{\PValue{forceboth}}{%
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}}%
+ \IndexOption{clausemark~=\textKValue{forceboth}}%
}%
\entry{\PValue{forceright}}{%
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}}%
+ \IndexOption{clausemark~=\textKValue{forceright}}%
}%
\entry{\PValue{right}}{%
Clauses generate right marks for running heads, if the document provides
automatic running heads.%
- \IndexOption{clausemark~=\PValue{right}}%
+ \IndexOption{clausemark~=\textKValue{right}}%
}%
\end{desctabular}
\end{table}
@@ -374,17 +380,16 @@ possible \PName{values} and their meaning are listed in
\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
-\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},
+\BeginIndex{}{paragraph>numbering}%
+Within clauses, \Package{scrjura} usually numbers paragraphs automatically.
+With this, the paragraphs provide a powerful structuring element, similar to
+\DescRef{maincls.cmd.paragraph} or \DescRef{maincls.cmd.subparagraph} in
+normal documents. For this reason, contracts usually use a vertical skip
+between paragraphs. The \Package{scrjura} package does not provide its own
+mechanism for this. Instead, it uses the \DescRef{maincls.option.parskip}%
+\IndexOption{parskip}\important{\DescRef{maincls.option.parskip}} option of
+the \KOMAScript{} classes (see \autoref{sec:maincls.parmarkup},
\DescPageRef{maincls.option.parskip}).
@@ -392,27 +397,33 @@ for this. Instead, it uses the option \DescRef{maincls.option.parskip}%
\OptionVName{parnumber}{value}
\end{Declaration}
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}%
+\OptionValue{parnumber}{true}. Sometimes you may need to disable the automatic
+numbering. You can do this with \OptionValue{parnumber}{false}%
\important{\OptionValue{parnumber}{false}}%
-\IndexOption{parnumber~=\PValue{false}}. In this case the numbering of
-sentences will be reseted.
+\IndexOption{parnumber~=\textKValue{false}}. In this case, only the sentence
+numbering is reset.
-To realise this way of numbering paragraphs it has been necessary to gear into
-the paragraph building mechanism of \LaTeX. In rare cases there is a negative
-impact, which can be avoided by switching to \OptionValue{parnumber}{manual}%
+To implement this option, it has been necessary to hook into the
+paragraph-building mechanism of \LaTeX. In some rare cases, this can have a
+negative effect. If so, you can undo the change with
+\OptionValue{parnumber}{manual}%
\important{\OptionValue{parnumber}{manual}}%
-\IndexOption{parnumber~=\PValue{manual}}. On the other hand \LaTeX itself
-sometimes undoes the change. In those cases one has to activate it again with
-\OptionValue{parnumber}{auto}%
+\IndexOption{parnumber~=\textKValue{manual}}. On the other hand, \LaTeX{}
+itself sometimes undoes the change. In those cases you can activate it again
+with \OptionValue{parnumber}{auto}%
\important{\OptionValue{parnumber}{auto}}%
-\IndexOption{parnumber~=\PValue{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
-\LaTeX{} runs to get the correct, automatic paragraph numbering.%
+\IndexOption{parnumber~=\textKValue{auto}}.
+
+Clauses that consist of a single paragraph do not automatically receive a
+paragraph number. For this to work, there must not be two clauses with an
+identical number in a document. However should you ever need such numbering,
+you should switch to another contract environment (see
+\DescRef{\LabelBase.cmd.DeclareNewJuraEnvironment},
+\autoref{sec:\LabelBase.newenv},
+\DescPageRef{\LabelBase.cmd.DeclareNewJuraEnvironment}).
+Note\textnote{Attention!} 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 before the automatic paragraph numbering is correct.%
\EndIndexGroup
@@ -422,20 +433,43 @@ is not available before the end of the clause. Therefore you need a least two
\Macro{parformat}%
\Macro{parformatseparation}
\end{Declaration}%
-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}
-provides the format, which is \Macro{thepar} in rounded brackets. For
-numbering a paragraph manually, use \Macro{parformat} as well. It makes sense
-to call \Macro{parformat} with a following \Macro{nobreakspace} or a tilde.
-
-The\ChangedAt{v0.7}{\Package{scrjura}} output of \Macro{parformat} is followed
-by one or more delimiter(s). These are provided by
-\Macro{parformatseparation}, which currently consists of
-\Macro{nonbreakspace}, the non-breakable inter word distance.
-
-Package\textnote{Attention!} \Package{scrjura} assumes internally, that
-\Macro{thepar} is an arabic number. Don't redefine!%
+For numbering the paragraphs inside a clause we use the \Counter{par} counter.
+The output of \Macro{thepar} will display an Arabic number, because the
+default is \Macro{arabic}\PParameter{par}. \Macro{parformat} provides the
+format, which is \Macro{thepar} in rounded brackets. When numbering a
+paragraph manually, you should also use \Macro{parformat}. It makes sense to
+call \Macro{parformat} with a subsequent \Macro{parformatseparation}, or at
+least a \Macro{nobreakspace} or tilde.
+
+With\ChangedAt{v0.7}{\Package{scrjura}} automatic numbering, \Macro{parformat}
+is followed by \Macro{parformatseparation}, which currently consists of
+\Macro{nonbreakspace}, the non-breakable space.
+
+\BeginIndex{FontElement}{parnumber}\LabelFontElement{parnumber}%
+The paragraph number is usually printed using the currently active font.
+However, you can change this default for the \FontElement{parnumber} element
+at any time with \DescRef{\LabelBase.cmd.setkomafont}%
+\important[i]{\DescRef{\LabelBase.cmd.setkomafont},
+\DescRef{\LabelBase.cmd.addtokomafont}} and
+\DescRef{\LabelBase.cmd.addtokomafont} (see
+\autoref{sec:\LabelBase.textmarkup},
+\DescPageRef{\LabelBase.cmd.setkomafont}).%
+\EndIndex{FontElement}{parnumber}%
+
+Note\textnote{Attention!} that \Package{scrjura} assumes internally that
+\Macro{thepar} is an Arabic number. Therefore you should definitely not
+redefine it!%
+\EndIndexGroup
+
+
+\begin{Declaration}
+ \Macro{withoutparnumber}
+\end{Declaration}
+If the paragraph number is not printed, \Package{scrjura} executes the
+\Macro{withoutparnumber} command at the beginning of the new paragraph. The
+initial definition of this command is empty. This means it is a kind of dummy
+command that does nothing. It has been implemented because of a user request.
+Most users can ignore this command.%
\EndIndexGroup
@@ -443,23 +477,23 @@ Package\textnote{Attention!} \Package{scrjura} assumes internally, that
\Macro{ellipsispar}\OParameter{number}%
\Macro{parellipsis}
\end{Declaration}
-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
-in the counter of the paragraphs. The package \Package{scrjura} provides the
-command \Macro{ellipsispar} to do this.
-
-By default \Macro{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
+Sometimes\ChangedAt{v0.7}{\Package{scrjura}}\,---\,particularly in comparative
+commentaries\,---\,it is desirable to omit paragraphs but to mark the
+omission. Those omitted paragraphs\Index{paragraph>omission} should be taken
+into account by the paragraph counter. The package \Package{scrjura} provides
+the command \Macro{ellipsispar} to do this.
+
+By default, \Macro{ellipsispar} omits precisely one paragraph. Using the
+optional argument, you can omit multiple paragraphs. In any case, the output
+shows just one unnumbered paragraph, which consists only of the ellipsis
defined by \Macro{parellipsis}. The automatic numbering of paragraphs takes
the \PName{number} of omitted paragraphs into account.
\begin{Example}
- Supposed you are writing a »comment« of the German\footnote{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
- \Package{scrjura}.} penal code, but only paragraph 3 of §~2. Nevertheless
- you'd like to hint at the omission. This can be done this way:
+ Suppose you are writing a comment on the German\footnote{Please remember,
+ this translation does not refer to an existing law but is only an example
+ of how you might realise such a commentary with \Package{scrjura}.} penal
+ code, but only on paragraph 3 of \S~2. Nevertheless, you'd like to indicate
+ the omission indirectly. You can do this with:
\begin{lstcode}
\documentclass[parskip=half]{scrartcl}
\usepackage{scrjura}
@@ -468,9 +502,9 @@ the \PName{number} of omitted paragraphs into account.
\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.
+ If the law that applies at the time the criminal act is
+ committed is changed before the verdict, then the most
+ lenient law shall be applicable.
\ellipsispar[3]
\end{contract}
@@ -480,8 +514,8 @@ the \PName{number} of omitted paragraphs into account.
\end{Example}
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}.%
+such a command is defined. If not, \Macro{dots} is used. You can redefine
+\Macro{parellipsis} at any time with \Macro{renewcommand}.%
\EndIndexGroup
%
\EndIndexGroup
@@ -490,38 +524,38 @@ used. \Macro{parellipsis} may be redefined with \Macro{renewcommand}.%
\subsection{Sentences}
\label{sec:scrjura.sentence}
-\BeginIndexGroup
+\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
-\Package{scrjura}, an automatic numbering is cumbersome and error-prone and
-has not been implemented yet.
+Paragraphs in contracts consist of one or more sentences, some of which may
+also be numbered. However, as automatic numbering is cumbersome and
+error-prone, it has not yet been implemented in
+\Package{scrjura}. Semi-automatic numbering, however, is supported.
\begin{Declaration}
\Counter{sentence}%
\Macro{thesentence}%
\Macro{Sentence}
\end{Declaration}
-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.
+Manual numbering of sentences is done with the \Macro{Sentence} command. It
+adds one to the \Counter{sentence} counter. By default, \Macro{thesentence}
+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}:%
+to define a shorthand for \Macro{Sentence}:%
\phantomsection\label{sec:scrjura.shorthandexample}%
\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:
+With this definition, any space after \lstinline|'S| will be ignored. You can
+even use the dot as an abbreviation for a dot and a new sentence number:
\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}).%
+For details regarding \Macro{useshorthands} and \Macro{defineshorthands},
+please consult the manual of the \Package{babel} package (see
+\cite{package:babel}). You can find an example of their application in
+\autoref{sec:scrjura.example}, \autopageref{sec:scrjura.example}.%
\EndIndexGroup
%
\EndIndexGroup
@@ -529,12 +563,13 @@ of the package \Package{babel} (see \cite{package:babel}).%
\EndIndexGroup
-\section{Cross References}
+\section{Cross-References}
\label{sec:scrjura.ref}
-The conventional mechanism to set cross references using
+The conventional mechanism to set cross-references using
\Macro{label}\IndexCmd{label}\important{\Macro{label}}, \Macro{ref}, and
-\Macro{pageref} does not suffice. \Package{scrjura} provides more commands.
+\Macro{pageref} does not suffice for clauses, paragraphs, and sentences.
+Therefore \Package{scrjura} provides additional commands.
\begin{Declaration}
\Macro{ref}\Parameter{label}%
@@ -544,8 +579,8 @@ The conventional mechanism to set cross references using
\end{Declaration}
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}.%
+\Macro{refS} a short text, and \Macro{refN} an abbreviated, numeric form.
+\Macro{ref} defaults to \Macro{refL}.%
\EndIndexGroup
@@ -553,9 +588,9 @@ form. \Macro{ref} defaults to \Macro{refL}.%
\Macro{refClause}\Parameter{label}%
\Macro{refClauseN}\Parameter{label}
\end{Declaration}
-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.%
+These commands reference a clause without displaying the paragraph or
+sentences. \Macro{refClause} puts a section mark (\S) in front of the
+reference, while \Macro{refClauseN} does not.%
\EndIndexGroup
@@ -565,14 +600,15 @@ the reference, while \Macro{refClauseN} does not.%
\Macro{refParS}\Parameter{label}%
\Macro{refParN}\OParameter{number format}\Parameter{label}
\end{Declaration}
-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 \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}.%
+You can reference just a paragraph with \Macro{refParL}, \Macro{refParS} and
+\Macro{refParN}. The differences between the forms correspond to the
+differences between \DescRef{\LabelBase.cmd.refL},
+\DescRef{\LabelBase.cmd.refN} and \DescRef{\LabelBase.cmd.refS}. A feature
+worth noting is the optional argument of \Macro{refParN}. Usually the numeric
+reference to a paragraph uses a Roman number. You can, however, specify a
+different \PName{number format} in the optional argument. This option
+primarily makes sense to use Arabic numbers. By default, \Macro{refPar} is
+\Macro{refParL}.%
\EndIndexGroup
@@ -582,9 +618,9 @@ numbers. \Macro{refPar} defaults to \Macro{refParL}.%
\Macro{refSentenceS}\Parameter{label}%
\Macro{refSentenceN}\Parameter{label}
\end{Declaration}
-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
+You can reference a sentence with \Macro{refSentenceL}, \Macro{refSentenceS},
+or \Macro{refSentenceN}. Again, there is a long text form, a short text form,
+and a numerical form. By default, \Macro{refSentence} is
\Macro{refSentenceL}.%
\EndIndexGroup
@@ -593,87 +629,88 @@ a short text form and a numerical form. \Macro{refSentence} defaults to
\OptionVName{ref}{value}
\end{Declaration}
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}.%
+and \DescRef{\LabelBase.cmd.refSentence} depend on the \PName{value} of the
+\Option{ref} option. The defaults are \DescRef{\LabelBase.cmd.refL},
+\DescRef{\LabelBase.cmd.refParL} and \DescRef{\LabelBase.cmd.refSentenceL}.
+You can find the available values and their meaning in
+\autoref{tab:scrjura.ref}.%
%
\begin{table}
%\begin{desclist}
% \desccaption
\caption[{%
- Possible values for option \Option{ref} to configure the cross reference
+ Available values for the\Option{ref} option to configure the cross-reference
format%
}]{%
- Possible values for option \Option{ref} to configure the cross reference
- format of \DescRef{\LabelBase.cmd.ref}, \DescRef{\LabelBase.cmd.refPar},
- and \DescRef{\LabelBase.cmd.refSentence}%
+ Available values for the \Option{ref} option to configure the
+ cross-reference 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}}%
+ A combination of \PValue{parlong} and \PValue{sentencelong}.%
+ \IndexOption{ref~=\textKValue{long}}%
}%
\entry{\PValue{numeric}}{%
- Combination of \PValue{parnumeric} and \PValue{sentencenumeric}.%
- \IndexOption{ref~=\PValue{numeric}}%
+ A combination of \PValue{parnumeric} and \PValue{sentencenumeric}.%
+ \IndexOption{ref~=\textKValue{numeric}}%
}%
\entry{\PValue{clauseonly}, \PValue{onlyclause}, \PValue{ClauseOnly},
\PValue{OnlyClause}}{%
- Combination of \PValue{paroff} and \PValue{sentenceoff}; note that
+ A 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}}%
+ produce empty results!%
+ \IndexOption{ref~=\textKValue{long}}%
}%
\entry{\PValue{parlong}, \PValue{longpar}, \PValue{ParL}}{%
Paragraphs are referenced in long textual form.%
- \IndexOption{ref~=\PValue{parlong}}%
+ \IndexOption{ref~=\textKValue{parlong}}%
}%
\entry{\PValue{parnumeric}, \PValue{numericpar}, \PValue{ParN}}{%
Paragraphs are referenced in simple numerical form.%
- \IndexOption{ref~=\PValue{parnumeric}}%
+ \IndexOption{ref~=\textKValue{parnumeric}}%
}%
\entry{\PValue{paroff}, \PValue{nopar}}{%
- Paragraphs have not reference. Note that \DescRef{\LabelBase.cmd.refPar}
- has an empty result!%
- \IndexOption{ref~=\PValue{paroff}}%
+ Paragraphs have no reference. Note that \DescRef{\LabelBase.cmd.refPar}
+ produces an empty result!%
+ \IndexOption{ref~=\textKValue{paroff}}%
}%
\entry{\PValue{parshort}, \PValue{shortpar}, \PValue{ParS}}{%
Paragraphs are referenced in short textual form.%
- \IndexOption{ref~=\PValue{parshort}}%
+ \IndexOption{ref~=\textKValue{parshort}}%
}%
\entry{\PValue{sentencelong}, \PValue{longsentence}, \PValue{SentenceL}}{%
Sentences are referenced in long textual form.%
- \IndexOption{ref~=\PValue{parlong}}%
+ \IndexOption{ref~=\textKValue{parlong}}%
}%
\entry{\PValue{sentencenumeric}, \PValue{numericsentence},
\PValue{SentenceN}}{%
Sentences are referenced in simple numeric form.%
- \IndexOption{ref~=\PValue{sentencenumeric}}%
+ \IndexOption{ref~=\textKValue{sentencenumeric}}%
}%
\entry{\PValue{sentenceoff}, \PValue{nosentence}}{%
Sentences have no reference. Note that
- \DescRef{\LabelBase.cmd.refSentence} has an empty result!%
- \IndexOption{ref~=\PValue{sentenceoff}}%
+ \DescRef{\LabelBase.cmd.refSentence} produces an empty result!%
+ \IndexOption{ref~=\textKValue{sentenceoff}}%
}%
\entry{\PValue{sentenceshort}, \PValue{shortsentence},
\PValue{SentenceS}}{%
Sentences are referenced in short textual form.%
- \IndexOption{ref~=\PValue{sentenceshort}}%
+ \IndexOption{ref~=\textKValue{sentenceshort}}%
}%
\entry{\PValue{short}}{%
- Combination if \PValue{parshort} and \PValue{sentenceshort}.%
- \IndexOption{ref~=\PValue{value}}%
+ A combination of \PValue{parshort} and \PValue{sentenceshort}.%
+ \IndexOption{ref~=\textKValue{value}}%
}%
\end{desctabular}
\end{table}
\begin{Example}
- Supposed you would like to reference to paragraphs in the form ``paragraph 1
- in clause 1''. As scrjura lacks of a predefined command for this, you have
- to build your own definitions out of what's given:%
+ Suppose you always want to reference paragraphs in the form ``paragraph 1
+ in clause 1''. As there is no predefined command for this, you have
+ to create your own definition from the available options. You can achieve
+ this easily with:%
\begin{lstcode}
\newcommand*{\refParM}[1]{%
paragraph~\refParN[arabic]{#1}
@@ -684,14 +721,14 @@ see \autoref{tab:scrjura.ref}.%
\DescRef{\LabelBase.cmd.refParL}.%
\end{Example}%
-\hyperref[tab:scrjura.refexamples]{Table~\ref*{tab:scrjura.refexamples}}
-provides examples of the output of the fundamental commands, not configured.%
+You can find examples of results of the basic commands in
+\autoref{tab:scrjura.refexamples}.%
%
\begin{table}
\KOMAoptions{captions=topbeside}%
\setcapindent{0pt}%
- \begin{captionbeside}{Example outputs of the \Option{ref}-independent cross
- reference commands}[l]
+ \begin{captionbeside}{Example outputs of the \Option{ref}-independent
+ cross-reference commands}[l]
\begin{tabular}[t]{ll}
\toprule
Command & Example output \\
@@ -720,65 +757,111 @@ provides examples of the output of the fundamental commands, not configured.%
\section{Additional Environments}
\label{sec:scrjura.newenv}
-There are users of \Package{scrjura} who use it to draft neither contracts nor
-commentaries on certain acts of law, but a compilation of,
-e.\,g., different laws, which does not necessarly use the section prefix (\S)
-before the title of each clause. Maybe somebody would like to write
-something like ``Art. XY'' and needed an indpendent counter for each
-contract environment.
+Some users do not use \Package{scrjura} to draft contracts or commentaries on
+individual laws but to examine different types of laws, which may not
+necessarily use the section prefix (\S) before the title of each clause but
+perhaps something like ``Art.'' or ``IAS'', and so forth. An independent
+counter is also required for each of these different clause types.
\begin{Declaration}
\Macro{DeclareNewJuraEnvironment}\Parameter{name}\OParameter{options}%
\Parameter{start commands}\Parameter{end commands}
\end{Declaration}
-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
-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 \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[\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[\OptionVName{SubClause}{instruction}:] See explanation for
- \Option{Clause} above.
-\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[\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
- instructions as \PName{instruction}.
-\end{description}
+You\ChangedAt{v0.9}{\Package{scrjura}} can use this command to define new and
+independent environments for contracts or other legal texts. The argument
+\PName{name} is the name of the new environment, of course. The \PName{start
+commands} are 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 like the \DescRef{\LabelBase.env.contract} environment, but with its
+own counters. It is possible to set \PName{options} in a comma-separated list.
+See \autoref{tab:\LabelBase.DeclareNewJuraEnvironment} for the currently
+supported \PName{options}.
+
+\begin{desclist}
+ \desccaption{Options provided by \Macro{DeclareNewJuraEnvironment} for new
+ contract environments\label{tab:\LabelBase.DeclareNewJuraEnvironment}}%
+ {Options of \Macro{DeclareNewJuraEnvironment} (\emph{continued})}%
+ \entry{\OptionVName{Clause}{command}}{%
+ Defines the \PName{command} to which the \DescRef{\LabelBase.cmd.Clause}
+ command is mapped within the environment. This \PName{command}, like the
+ one documented for \DescRef{\LabelBase.env.contract}, expects exactly one
+ argument. To use it correctly requires advanced knowledge of the
+ \Package{scrjura}'s internal functioning. Furthermore, the requirements
+ for the \PName{command} may change in future versions. Therefore it is
+ recommended not to use this option!%
+ }%
+ \entry{\OptionVName{ClauseFont}{commands}}{%
+ \leavevmode\BeginIndex{FontElement}{\PName{Name}.Clause}%
+ \LabelFontElement{\PName{Name}.Clause}%
+ If this option is used, a new
+ \FontElement{\PName{Name}.Clause}\IndexFontElement{\PName{Name}.Clause}
+ element is defined using
+ \DescRef{maincls-experts.cmd.newkomafont}\IndexCmd{newkomafont}, with the
+ \PName{commands} used as its default setting. If the element was
+ previously defined as an alias (see
+ \DescRef{maincls-experts.cmd.aliaskomafont} in
+ \autoref{sec:maincls-experts.experts},
+ \DescPageRef{maincls-experts.cmd.aliaskomafont}), it will become an
+ independent element instead. If it has already been defined as an
+ independent element, \DescRef{\LabelBase.cmd.setkomafont} is used to set
+ the \PName{commands} a new font settings. Please note the limitations for
+ font settings in \autoref{sec:\LabelBase.textmarkup},
+ \DescPageRef{\LabelBase.cmd.setkomafont}.
+ \EndIndex{FontElement}{\PName{Name}.Clause}%
+ }%
+ \entry{\OptionVName{SubClause}{command}}{%
+ Defines the \PName{command} to which the
+ \DescRef{\LabelBase.cmd.SubClause} command is mapped within the
+ environment. This \PName{command}, like the one documented for
+ \DescRef{\LabelBase.env.contract}, expects exactly one argument. To use it
+ correctly requires advanced knowledge of the \Package{scrjura}'s internal
+ functioning. Furthermore, the requirements for the \PName{command} may
+ change in future versions. Therefore it is recommended not to use this
+ option!%
+ }%
+ \entry{\OptionVName{Sentence}{command}}{%
+ Defines the \PName{command} to which the
+ \DescRef{\LabelBase.cmd.Sentence} is mapped within the environment. This
+ \PName{command} must not have an argument. Typically it should add one to
+ the \Counter{sentence}\IndexCounter{sentence} (using
+ \Macro{refstepcounter}\IndexCmd{refstepcounter}) counter and display it
+ appropriately. It is particularly important to avoid adding unwanted
+ spaces.%
+ }%
+ \entry{\OptionVName{ClauseNumberFormat}{command}}{%
+ Formats the numbers of clauses within the environment. The \PName{command}
+ should expect exactly one argument: the number of the clause. If the
+ \PName{command} implements a series of commands and the number is the last
+ argument of a that series, you can directly use the series of commands as
+ \PName{command}.%
+ }
+\end{desclist}
\begin{Example}
- To define the environment we mentioned in the preface of this section,
- for articles, it is sufficient to write:
+ To define the environment for articles we mentioned in the preface of this
+ section, it is sufficient to write:
\begin{lstcode}
- \DeclareNewJuraEnvironment{Artikel}[ClauseNumberFormat=Art.]{}{}
+ \DeclareNewJuraEnvironment{Article}[ClauseNumberFormat=Art.]{}{}
\end{lstcode}
- In case paragraphs have to be separated by space between the
- paragraphs, \Package{scrjura} together with a \KOMAScript{} document class
- allows to write:
+ If we are using a \KOMAScript{} class and want to separate the paragraphs in
+ this environment with space instead of using paragraph indentation, we can
+ use:
\begin{lstcode}
- \DeclareNewJuraEnvironment{Artikel}[ClauseNumberFormat=Art.~]
+ \DeclareNewJuraEnvironment{Article}[ClauseNumberFormat=Art.~]
{\KOMAoptions{parskip}}{}
\end{lstcode}
- In cross references will ``Art.'' be used instead of ``\S'', of course.%
+ In cross-references, ``Art.'' will of course be used instead of ``\S''.%
+
+ The new environment is used like \DescRef{\LabelBase.env.contract}:
+\begin{lstcode}
+ \begin{Article}
+ \Clause
+ Human dignity is inviolable. To respect and protect people is a
+ duty of all state authority.
+ \end{Article}
+\end{lstcode}
\end{Example}%
\EndIndexGroup
@@ -786,19 +869,19 @@ supported:
\section{Support for Different Languages}
\label{sec:scrjura.babel}
-The package \Package{scrjura} has been developed in cooperation with an German
-lawyer. Therefore primarily it has provided the languages \PValue{german},
+The \Package{scrjura} package has been developed in cooperation with a German
+lawyer. Therefore it initially supported only 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 \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
-for languages \PValue{english}, \PValue{american}, \PValue{british},
-\PValue{canadian}, \PValue{USenglish}, and \PValue{UKenglish}.
+\Package{babel}\important{\Package{babel}}\IndexPackage{babel}. Users can
+easily make changes by using \DescRef{scrbase.cmd.providecaptionname} (see
+\autoref{sec:scrbase.languageSupport},
+\DescPageRef{scrbase.cmd.providecaptionname}). If you have definitive
+information about the correct legal terms and conventions of a language,
+please contact the \KOMAScript{} author. Support for English has been added in
+this way, and so \Package{scrjura} now also provides terms for the languages
+\PValue{english}, \PValue{american}, \PValue{british}, \PValue{canadian},
+\PValue{USenglish}, and \PValue{UKenglish}.
\begin{Declaration}
\Macro{parname}%
@@ -807,13 +890,12 @@ for languages \PValue{english}, \PValue{american}, \PValue{british},
\Macro{sentenceshortname}
\end{Declaration}
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
+of the terms and their English defaults are shown in
+\autoref{tab:scrjura.captionnames}. The package itself defines them by using
\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.%
+\Macro{begin}\PParameter{document} only if other requirements have not already
+been met. If you use \Package{scrjura} with an unsupported language, the
+package will throw an error.%
%
\begin{table}
\KOMAoptions{captions=topbeside}%
@@ -845,164 +927,163 @@ package throws an error.%
\section{A Detailed Example}
\label{sec:scrjura.example}
-Remember the letter from \autoref{cha:scrlttr2}. A club member has written to
-the board because of the general meeting that is regulated by the club
-statutes. Such club statutes are a kind of contract and you can realise them
-using \Package{scrjura}.\footnote{Please note, the example is still in German
- and has to be translated. Currently we have had not enough manpower to do
- the translation. Nevertheless, the contents of the example does not matter
- but the technical realisation.}
+You may remember the letter from \autoref{cha:scrlttr2}, in which a club
+member wanted to remind the board about an overdue meeting that was prescribed
+by the club's by-laws. Such club by-laws are a kind of contract, and you can
+create them using \Package{scrjura}.
\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
+indentation is usual in club by-laws, we load the class with option
\OptionValueRef{maincls}{parskip}{half} (see \autoref{sec:maincls.parmarkup},
\DescPageRef{maincls.option.parskip}).
\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.
+The club rules are in British English. Therefore we load the \Package{babel}
+package with the \Option{british} option too.
\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).
+We make some default font settings and load the \Package{textcomp} package
+because it provides an improved section mark (\S) and\,---\,something that may
+be useful in other circumstances\,---\,a usable Euro symbol for some fonts.
-\lstinputcode[{moretexcs=SelectInputMappings,xleftmargin=2em,%
- 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[{moretexcs=SelectInputMappings,xleftmargin=2em,%
+% linerange=11-15}]{scrjuraexample.tex}%
+Although it is not relevant for English, if we were writing an another
+language, we would want to input non-ASCII characters directly. To do so, we
+could let \LaTeX{} detect the input encoding with the \Package{selinput} or
+set it with the \Package{inputenc} packages.
\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}.
+ linerange=11-11}]{scrjuraexample.tex}%
+Later in the document, we want lists numbered not with Arabic numbers but with
+lower-case letters. We can do this easily with the \Package{enumerate} package.
\lstinputcode[{moretexcs={useshorthands,defineshorthand},%
xleftmargin=2em,%
- linerange=19-27}]{scrjuraexample.tex}%
-Now, it is time for \Package{scrjura}. With option
-\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
+ linerange=13-21}]{scrjuraexample.tex}%
+Now it is time for \Package{scrjura}. The
+\OptionValueRef{\LabelBase}{clausemark}{forceboth} option forces clauses to
+create left and right 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 the \PageStyle{myheadings} page style. 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 \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.
+Later, we also want a table of contents with the clauses. This can be achieved
+with the \DescRef{\LabelBase.option.juratotoc} option. Doing so we will see
+that the default width for these numbers is insufficient for the clause
+numbers in the table of contents. With
+\OptionValueRef{\LabelBase}{juratocnumberwidth}{2.5em}, we reserve more space.
-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.
+The definition of shorthands has already been explained in
+\autoref{sec:scrjura.shorthandexample}. In this example we do the same thing
+to simplify the input.
\lstinputcode[{xleftmargin=2em,%
- linerange=29-29}]{scrjuraexample.tex}%
-It is time to begin the document.
+ linerange=23-23}]{scrjuraexample.tex}%
+It is time to begin the actual document.
\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
+ linerange=25-29}]{scrjuraexample.tex}%
+Like other documents, the by-laws have a title. We created it with the usual
+\KOMAScript{} commands (see \autoref{sec:maincls.titlepage}, starting on
\autopageref{sec:maincls.titlepage}).
\lstinputcode[{xleftmargin=2em,%
- linerange=37-37}]{scrjuraexample.tex}%
-As already stated, we want to have a table of contents.
+ linerange=31-31}]{scrjuraexample.tex}%
+As already mentioned, we want to create a table of contents.
\lstinputcode[{xleftmargin=2em,%
- linerange=39-43}]{scrjuraexample.tex}%
-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.
+ linerange=33-37}]{scrjuraexample.tex}%
+Preambles are not unusual in club by-laws. Here we use
+\DescRef{maincls.cmd.addsec} to create one because we want it to have an entry
+in the table of contents.
\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}.
+ linerange=39-39}]{scrjuraexample.tex}%
+Here we use a small trick. The articles of the club by-laws should be numbered
+with upper-case letters instead of Arabic numbers, just as
+the appendix sections of an article using \Class{scrartcl} are.
\lstinputcode[{xleftmargin=2em,%
- linerange=47-49}]{scrjuraexample.tex}%
+ linerange=41-43}]{scrjuraexample.tex}%
We begin the contract with the first article.
\lstinputcode[{xleftmargin=2em,%
- linerange=50-59}]{scrjuraexample.tex}%
+ linerange=44-54}]{scrjuraexample.tex}%
The first clause has a number and a title. We will do the same with all
following clauses.
-The first paragraph of the clause is very usual. Because it is not the only
-paragraph, the output is done with a number before the text. Note that the
-numbering of the first paragraph needs at least two \LaTeX{} runs like you
-will for the table of contents.
+The first paragraph of the clause contains nothing unusual. Because it is not
+the only paragraph, every paragraph will be automatically preceded by a
+paragraph number. Note that the numbering the first paragraph requires at
+least two \LaTeX{} runs. Since this is the case for the table of contents as
+well, this does not create any additional problems.
-In the second paragraph we have two sentences. Here we can see the short hands
-\texttt{'S} and \texttt{'.} in action. The first one does only generate the
-sentence number. The second one does not only print the full stop but also the
+In the second paragraph we have two sentences. Here we can see the shorthands
+\texttt{'S} and \texttt{'.} in action. The first one only generates the
+sentence number. The second one generates not only the full stop but also the
sentence number. With this, both sentences are numbered.
\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.
+ linerange=55-70}]{scrjuraexample.tex}%
+The second clause: again this contains several paragraphs, some of which
+include several sentences. The second paragraph also has a numbered list. In
+the last paragraph, we set a label, because we want to reference it later.
\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
-\OptionValueRef{\LabelBase}{ref}{nosentence} globally.
+ linerange=72-78}]{scrjuraexample.tex}%
+The third clause contains something special: a cross-reference. Here we use
+the long form with clause, paragraph, and sentence. If we decided later that
+sentences should not be included in the reference, we could use the
+\OptionValueRef{\LabelBase}{ref}{nosentence} option to set this globally.
\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
+ linerange=80-81}]{scrjuraexample.tex}%
+Here we have a special kind of clause. In earlier versions of the club by-laws,
+this was a real clause, but it was later removed. However, the
numbering of the following clauses should not be changed by removing this
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.
+a label even though the clause will not be printed.
\lstinputcode[{xleftmargin=2em,%
- linerange=88-92}]{scrjuraexample.tex}%
-Another article starts. To avoid problems with the paragraph numbering we
+ linerange=82-86}]{scrjuraexample.tex}%
+Another article begins. To avoid problems with the paragraph numbering, we
interrupt the \DescRef{\LabelBase.env.contract} environment.
\lstinputcode[{xleftmargin=2em,%
- linerange=93-93}]{scrjuraexample.tex}%
-The first clause of the next article also has been removed.
+ linerange=87-87}]{scrjuraexample.tex}%
+The first clause of the next article also has been deleted.
\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.
+ linerange=89-98}]{scrjuraexample.tex}%
+Here we have a real clause again. We cross-reference one of the deleted
+clauses and also set a label.
\lstinputcode[{xleftmargin=2em,%
- linerange=107-112}]{scrjuraexample.tex}%
+ linerange=100-104}]{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,
+clause but added one without renumbering the following clauses. To do so,
we use \DescRef{\LabelBase.cmd.SubClause}. Therefore the clause number is the
same like the previous one but with an appended ``a''.
\lstinputcode[{xleftmargin=2em,%
- linerange=114-134}]{scrjuraexample.tex}%
+ linerange=106-126}]{scrjuraexample.tex}%
The other clauses of this article are very usual. You already know all the
features used for them.
\lstinputcode[{xleftmargin=2em,%
- linerange=136-150}]{scrjuraexample.tex}%
-More articles with known features are following.
+ linerange=128-141}]{scrjuraexample.tex}%
+There follows another article no special features.
\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}.%
+ linerange=143-143}]{scrjuraexample.tex}%
+Then the \LaTeX{} document ends. You can see first three pages in
+\autoref{fig:scrjura.example}.%
%
\begin{figure}
\setcapindent{0pt}%
@@ -1014,10 +1095,10 @@ document in \autoref{fig:scrjura.example}.%
height=.49\textheight,keepaspectratio]{scrjuraexample}}\par
\smallskip}
\begin{captionbeside}[{%
- Example: Three pages from the front of the example club statutes of
+ Example: First three pages of the example club by-laws of
\protect\autoref{sec:scrjura.example}%
}]{%
- Three pages from the front of the example club statutes of
+ First three pages of the example club by-laws of
\protect\autoref{sec:scrjura.example}%
}%
[l]
@@ -1031,10 +1112,10 @@ document in \autoref{fig:scrjura.example}.%
\frame{\includegraphics[page=2,width=.482\textwidth]{scrjuraexample}}\par
\smallskip}
\begin{captionbeside}[{%
- Example: Three pages from the front of the example club statutes of
+ Example: First three pages of the example club by-laws of
\protect\autoref{sec:scrjura.example}%
}]{%
- Three pages from the front of the example club statutes of
+ First three pages of the example club by-laws of
\protect\autoref{sec:scrjura.example}%
}%
[l]
@@ -1048,15 +1129,14 @@ document in \autoref{fig:scrjura.example}.%
\section{State of Development}
\label{sec:scrjura.draft}
-Since \KOMAScript~3.24 package \Package{scrjura} shares the version number of
-the classes and other important packages of \KOMAScript. Nevertheless, you
-should note: Neither the cooperation with other packages nor the cooperation
-of the \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.%
+Since \KOMAScript~3.24, the \Package{scrjura} package has shared the version
+number of the classes and other important packages of \KOMAScript.
+Nevertheless, you should note that so far, the interaction of the
+\DescRef{\LabelBase.env.contract} environment with the many different settings
+possible with other \LaTeX{} environments, packages, or classes has not been
+tested. The main reason for this is that \Package{scrjura} is very specialised
+and far beyond the author's ordinary practice. So the author mostly relies on
+detailed user feedback.%
\EndIndexGroup
\endinput
@@ -1068,6 +1148,4 @@ to send such feedback.%
%%% ispell-local-dictionary: "en_GB"
%%% TeX-PDF-mode: t
%%% TeX-master: "guide.tex"
-%%% End:
-
-% LocalWords: reseted
+%%% End: