summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-09-18 23:48:11 +0000
committerKarl Berry <karl@freefriends.org>2012-09-18 23:48:11 +0000
commit6dbf95e6f69a899e605c2261656ccda22df60e4e (patch)
tree0ccaa4f57f270e37b1013418e3ccb3de95b3bdcf
parent18bcd998ac1d2e58f992953b84366906ff3f86eb (diff)
chemnum (18sep12)
git-svn-id: svn://tug.org/texlive/trunk@27728 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/README4
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdfbin944066 -> 944596 bytes
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex586
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdfbin934683 -> 934698 bytes
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex506
-rw-r--r--Master/texmf-dist/tex/latex/chemnum/chemnum.sty7
6 files changed, 823 insertions, 280 deletions
diff --git a/Master/texmf-dist/doc/latex/chemnum/README b/Master/texmf-dist/doc/latex/chemnum/README
index 455aec52ce8..05b3daf261d 100644
--- a/Master/texmf-dist/doc/latex/chemnum/README
+++ b/Master/texmf-dist/doc/latex/chemnum/README
@@ -1,4 +1,4 @@
-chemnum v0.5d
+chemnum v0.5e
a comprehensive approach for the numbering of chemical compounds
Basically one main command is provided, \cmpd{<label name>}. With
@@ -12,7 +12,7 @@ chemnum also needs the packages etoolbox, psfrag and textgreek or bm
to be fully functioning.
Clemens NIEDERBERGER
-2012/08/15
+2012/09/17
http://www.mychemistry.eu/
contact@mychemistry.eu
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf
index b5534b65456..0d26ef5ab06 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex
index 1b6cfa46f06..b28cc59db17 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex
@@ -107,15 +107,27 @@
\selectlanguage{ngerman}\cmpdreset
\section{Ein sehr kurzes Readme}
-\chemnum \CNversion\ steht unter der \LaTeX\ Project Public License Version 1.3 oder später. (\url{http://www.latex-project.org/lppl.txt})
+\chemnum \CNversion\ steht unter der \LaTeX\ Project Public License Version 1.3
+oder später. (\url{http://www.latex-project.org/lppl.txt})
-\chemnum ruft intern die Pakete \paket*{expl3} und \paket{xparse} auf. \paket{xparse} ist Teil des \paket{l3packages}-Bundles, \paket*{expl3} ist Teil des \paket{l3kernel}-Bundles. Das heißt, \chemnum benötigt \LaTeX3-Un\-ter\-stüt\-zung.
+\chemnum ruft intern die Pakete \paket*{expl3} und \paket{xparse} auf. \paket{xparse}
+ist Teil des \paket{l3packages}-Bundles, \paket*{expl3} ist Teil des
+\paket{l3kernel}-Bundles. Das heißt, \chemnum benötigt \LaTeX3-Un\-ter\-stüt\-zung.
-\chemnum benötigt außerdem die Pakete \paket{etoolbox} und \paket{psfrag} und entweder das Paket \paket{textgreek} oder das Paket \paket{bm}, abhängig von den Paketoptionen (siehe Abschnitt~\ref{sec:package_options}).
+\chemnum benötigt außerdem die Pakete \paket{etoolbox} und \paket{psfrag} und
+entweder das Paket \paket{textgreek} oder das Paket \paket{bm}, abhängig von den
+Paketoptionen (siehe Abschnitt~\ref{sec:package_options}).
\section{Neues und ein Wort der Entschuldigung}
\subsection{Version 0.4}
-Mit dem Update auf v0.4 hat sich einiges bei den Optionen getan. Es gibt ein paar neue, ein paar von den alten haben andere Namen. Sie haben einheitlichere Namen erhalten, die meines Erachtens intuitiver ihre jeweilige Funktion widerspiegeln. Dadurch kann es sein, dass Ihre mit einer früheren Version von \chemnum erstellten Dokumente nicht mehr reibungslos kompilieren. Dafür möchte ich mich entschuldigen. \chemnum befindet sich noch in der Entwicklungsphase. Ist erst einmal v1.0 erreicht, wird es solche Änderungen nicht mehr\footnote{oder nur in größten Ausnahmefällen} geben.
+Mit dem Update auf v0.4 hat sich einiges bei den Optionen getan. Es gibt ein paar
+neue, ein paar von den alten haben andere Namen. Sie haben einheitlichere Namen
+erhalten, die meines Erachtens intuitiver ihre jeweilige Funktion widerspiegeln.
+Dadurch kann es sein, dass Ihre mit einer früheren Version von \chemnum erstellten
+Dokumente nicht mehr reibungslos kompilieren. Dafür möchte ich mich entschuldigen.
+\chemnum befindet sich noch in der Entwicklungsphase. Ist erst einmal v1.0 erreicht,
+wird es solche Änderungen nicht mehr\footnote{oder nur in größten Ausnahmefällen}
+geben.
Diese Optionen haben neue Namen:
\begin{center}
@@ -143,49 +155,90 @@ Diese Optionen sind neu:
\end{tabular}
\end{center}
-Ebenfalls neu ist die Art und Weise, wie Sublabel-Listen und -Bereiche eingegeben werden. Der Option \key{sub-list} entfällt deshalb. Näheres siehe Abschnitt~\ref{ssec:sub_ranges}.
+Ebenfalls neu ist die Art und Weise, wie Sublabel-Listen und -Bereiche eingegeben
+werden. Der Option \key{sub-list} entfällt deshalb. Näheres siehe Abschnitt~\ref{ssec:sub_ranges}.
-Dann gibt es nun die Möglichkeit, klickbare Links zu den Labeln herzustellen, vorausgesetzt Sie haben \paket{hyperref} eingebunden, siehe Abschnitt~\ref{sec:hyperref}.
+Dann gibt es nun die Möglichkeit, klickbare Links zu den Labeln herzustellen,
+vorausgesetzt Sie haben \paket{hyperref} eingebunden, siehe Abschnitt~\ref{sec:hyperref}.
\subsection{Version 0.5}
-Ab v0.5 gibt es die Option \key{ref-pos}, die Ihnen erlaubt, die Positionierungs-Optionen des Befehls \cmd{psfrag} zu ändern, der von \cmd{cmpdref} intern verwendet wird, siehe S.\,\pageref{ssec:marker_in_bildern}.
+Ab v0.5 gibt es die Option \key{ref-pos}, die Ihnen erlaubt, die Positionierungs-Optionen
+des Befehls \cmd{psfrag} zu ändern, der von \cmd{cmpdref} intern verwendet wird,
+siehe S.\,\pageref{ssec:marker_in_bildern}.
-\achtung{Die Reihenfolge der optionalen Argumente des Befehls \cmd{cmpdref} hat sich geändert, siehe S.\,\pageref{ssec:cmpdref}!}
+\achtung{Die Reihenfolge der optionalen Argumente des Befehls \cmd{cmpdref} hat
+sich geändert, siehe S.\,\pageref{ssec:cmpdref}!}
\section{Paketoptionen}\label{sec:package_options}\secidx{Paketoptionen}
\chemnum hat eine Paketoption.
\begin{beschreibung}
\Option{textgreek}{artemisia/\default{cbgreek}/euler/false} Default: \code{false}
\end{beschreibung}
-Damit können Sie sowohl einen der drei Stile des \paket{textgreek}-Pakets wählen\footnote{Zu Details siehe Dokumentation des \paket*{textgreek}-Pakets.} oder \chemnum ohne \paket{textgreek} laden. Dieses Dokument wurde mit \verb+\usepackage[textgreek]{chemnum}+ gesetzt.
+Damit können Sie sowohl einen der drei Stile des \paket{textgreek}-Pakets wählen\footnote{Zu
+Details siehe Dokumentation des \paket*{textgreek}-Pakets.} oder \chemnum ohne
+\paket{textgreek} laden. Dieses Dokument wurde mit \verb+\usepackage[textgreek]{chemnum}+
+gesetzt.
\secidx*{Paketoptionen}
\section{Motivation}
-Soweit mir bekannt ist, gab es bislang drei Pakete, die das Nummerieren von Verbindungen erleichtern sollen. Sie alle haben ihre Schwächen.
+Soweit mir bekannt ist, gab es bislang drei Pakete, die das Nummerieren von
+Verbindungen erleichtern sollen. Sie alle haben ihre Schwächen.
+
+Das erste, \paket{chemcono}, hat für diesen Zweck Bibliographie-Befehle umdefiniert.
+Dort müs\-sen Verbindungen in einer Art Literaturliste definiert werden. Dadurch
+kann dann im Text auf sie referenziert werden. Da es die "`Verbindungs-Bibliothek"'
+immer mit ausgibt, schlägt der Paket-Autor folgendes vor:
-Das erste, \paket{chemcono}, hat für diesen Zweck Bibliographie-Befehle umdefiniert. Dort müs\-sen Verbindungen in einer Art Literaturliste definiert werden. Dadurch kann dann im Text auf sie referenziert werden. Da es die "`Verbindungs-Bibliothek"' immer mit ausgibt, schlägt der Paket-Autor folgendes vor:
\begin{zitat}[Stefan Schulz]
After compilation and printout, discard the last page.
\end{zitat}
Ganz offensichtlich ist das keine perfekte Lösung.
-Das zweite, \paket{chemcompounds}, ist enstanden, weil der Paket-Autor ebenfalls mit den Schwä\-chen von \paket{chemcono} nicht mehr arbeiten wollte. Bei der Erstellung des Pakets hielt er sich stark an den gleichen prinzipiellen Mechanismus wie \paket{chemcono}.
+Das zweite, \paket{chemcompounds}, ist enstanden, weil der Paket-Autor ebenfalls
+mit den Schwä\-chen von \paket{chemcono} nicht mehr arbeiten wollte. Bei der Erstellung
+des Pakets hielt er sich stark an den gleichen prinzipiellen Mechanismus wie \paket{chemcono}.
+
\begin{zitat}[Stephan Schenk]
- When taking a closer look at the chemcono package, I realised that the only thing one has to do is to get rid of everything which produces text. Thus, as a basis I used the mechanism of \verb=\bibitem= and \verb=\cite= in pretty much the same way as \paket{chemcono} does by extracting the corresponding code from \verb=article.cls= and \verb=latex.ltx= but deleting any unnecessary commands producing output. I also introduced several lines of code to make the printing of the compound names more customisable.
+ When taking a closer look at the chemcono package, I realised that the only thing
+ one has to do is to get rid of everything which produces text. Thus, as a basis I
+ used the mechanism of \verb=\bibitem= and \verb=\cite= in pretty much the same way
+ as \paket{chemcono} does by extracting the corresponding code from \verb=article.cls=
+ and \verb=latex.ltx= but deleting any unnecessary commands producing output. I
+ also introduced several lines of code to make the printing of the compound names
+ more customisable.
\end{zitat}
+
Manche Schwächen hat auch dieses Paket:
\begin{enumerate}
- \item Verbindungen müssen in der Regel mit \verb=\declarecompound= deklariert werden. Sie müs\-sen es auf jeden Fall, wenn man Label der Art \cmpd{bsp.one} haben möchte. Dann muss man die La\-bel sogar von Hand vergeben, was den Sinn einer automatischen Nummerierung untergräbt.
+ \item Verbindungen müssen in der Regel mit \verb=\declarecompound= deklariert
+ werden. Sie müs\-sen es auf jeden Fall, wenn man Label der Art \cmpd{bsp.one}
+ haben möchte. Dann muss man die La\-bel sogar von Hand vergeben, was den Sinn
+ einer automatischen Nummerierung untergräbt.
+ %
\item Das Layout lässt sich nicht einzeln ändern, sondern nur für alle Label.
- \item Die Nummerierung kann nicht zurückgesetzt werden. Obwohl das in der allermeisten Fällen \emph{weder nötig noch zu empfehlen ist}, kann es Einzelfälle geben, in denen solches Verhalten gewünscht ist.
- \item Eine Liste mehrerer Verbindungen \verb=\compound{a,b,c}= kann nicht oder nur um\-ständ\-lich eigenen Vorstellungen angepasst werden.
+ %
+ \item Die Nummerierung kann nicht zurückgesetzt werden. Obwohl das in der
+ allermeisten Fällen \emph{weder nötig noch zu empfehlen ist}, kann es Einzelfälle
+ geben, in denen solches Verhalten gewünscht ist.
+ %
+ \item Eine Liste mehrerer Verbindungen \verb=\compound{a,b,c}= kann nicht oder
+ nur um\-ständ\-lich eigenen Vorstellungen angepasst werden.
\end{enumerate}
-Dann gibt es noch \paket{bpchem}, das Befehle ähnlich den Befehlen \verb=\label= und \verb=\ref= zur Ver\-fü\-gung stellt: \verb=\CNlabel{}=, \verb=\CNlabelnoref{}= und \verb=\CNref{}=. Außerdem hat es Befehle für Sublabel: \verb=\CNlabelsub{}{}=, \verb=\CNlabelsubnoref{}{}= und \verb=\CNrefsub{}{}=. Damit ist es flexibler als die anderen, stellt allerdings kaum Möglichkeiten zur Personalisierung bereit, Listen sind nicht möglich und die Tatsache, dass es verschiedene Befehle für Label und Label mit Sublabeln gibt, ist ebenfalls nicht die beste Lösung.
+Dann gibt es noch \paket{bpchem}, das Befehle ähnlich den Befehlen \verb=\label=
+und \verb=\ref= zur Ver\-fü\-gung stellt: \verb=\CNlabel{}=, \verb=\CNlabelnoref{}=
+und \verb=\CNref{}=. Außerdem hat es Befehle für Sublabel: \verb=\CNlabelsub{}{}=,
+\verb=\CNlabelsubnoref{}{}= und \verb=\CNrefsub{}{}=. Damit ist es flexibler als die
+anderen, stellt allerdings kaum Möglichkeiten zur Personalisierung bereit, Listen
+sind nicht möglich und die Tatsache, dass es verschiedene Befehle für Label und
+Label mit Sublabeln gibt, ist ebenfalls nicht die beste Lösung.
-\chemnum soll diese Schwächen beheben. Dafür wurden alle Befehle vollständig neu geschrieben. Allerdings wurden Ideen von \paket{chemcompounds} aufgegriffen was Dar\-stel\-lungs\-mög\-lich\-kei\-ten wie Begrenzer \usw betrifft.
+\chemnum soll diese Schwächen beheben. Dafür wurden alle Befehle vollständig neu
+geschrieben. Allerdings wurden Ideen von \paket{chemcompounds} aufgegriffen was
+Dar\-stel\-lungs\-mög\-lich\-kei\-ten wie Begrenzer \usw betrifft.
-Wenn Ihnen irgendwelche fehlenden Features auf"|fallen, geben Sie mir bitte Bescheid, indem Sie mir eine E-Mail senden.
+Wenn Ihnen irgendwelche fehlenden Features auf"|fallen, geben Sie mir bitte Bescheid,
+indem Sie mir eine E-Mail senden.
\section{Verbindungen Nummerieren}\label{sec:nummerieren}
\subsection{Basisbefehl}\secidx{Basisbefehl}\cmpdreset
@@ -193,41 +246,63 @@ Der eigentliche Befehl des Pakets ist
\begin{beschreibung}
\Befehl{cmpd}{<label name>}
\end{beschreibung}
-Beim ersten Aufruf mit \code{<label name>} wird das Label erzeugt und gespeichert (= deklariert) und ausgegeben. Bei jedem weiteren Aufruf wird nun dieses Label verwendet.
+Beim ersten Aufruf mit \code{<label name>} wird das Label erzeugt und gespeichert
+(= deklariert) und ausgegeben. Bei jedem weiteren Aufruf wird nun dieses Label
+verwendet.
\begin{beispiel}
- Verbindungen \cmpd{a} und \cmpd{b} werden deklariert und k\"onnen nun jederzeit wieder aufgerufen werden: \cmpd{a}. Es ist keine vorherige Deklarierung n\"otig. Die Substanzen wie \cmpd{c} werden in der Reihenfolge ihres ersten Erscheinens im Text nummeriert.\par
+ Verbindungen \cmpd{a} und \cmpd{b} werden deklariert und k\"onnen nun jederzeit
+ wieder aufgerufen werden: \cmpd{a}. Es ist keine vorherige Deklarierung n\"otig.
+ Die Substanzen wie \cmpd{c} werden in der Reihenfolge ihres ersten Erscheinens
+ im Text nummeriert.\par
Noch einmal: \cmpd{b}, \cmpd{a}, \cmpd{c}.
\end{beispiel}
-Falls es nötig sein sollte, eine Verbindung zu deklarieren, ohne ein Label auszugeben, kann man an entsprechender Stelle
+Falls es nötig sein sollte, eine Verbindung zu deklarieren, ohne ein Label
+auszugeben, kann man an entsprechender Stelle
\begin{beschreibung}
\Befehl[cmpda]{cmpd*}\ma{<label name>}\label{cmd:unsichtbares_label}
\end{beschreibung}
verwenden. Dadurch wird ein entsprechendes Label deklariert aber nicht ausgegeben.
-\achtung{Dieser Befehl wird nicht benötigt, wenn man \cmd{cmpdinit} verwendet, siehe Abschnitt~\ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).}
+\achtung{Dieser Befehl wird nicht benötigt, wenn man \cmd{cmpdinit} verwendet,
+siehe Abschnitt~\ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).}
\begin{beispiel}
- Die versteckte Version\cmpd*{d} erzeugt zwar das Label, schreibt es aber nicht aus. Der n\"achste \cmpd{e} f\"uhrt die Z\"ahlung einfach weiter. Mit \cmpd{d} kann nat\"urlich auf das erzeugte Label zur\"uckgegriffen werden.
+ Die versteckte Version\cmpd*{d} erzeugt zwar das Label, schreibt es aber nicht
+ aus. Der n\"achste \cmpd{e} f\"uhrt die Z\"ahlung einfach weiter. Mit \cmpd{d}
+ kann nat\"urlich auf das erzeugte Label zur\"uckgegriffen werden.
\end{beispiel}
-Als Label-Namen können Sie im Prinzip einsetzen, was Sie wollen, außer den als Trennzeichen verwendeten Symbolen (siehe Abschnitt~\ref{ssec:unterlabel}, Abschnitt~\ref{ssec:listen}, Abschnitt~\ref{ssec:sub_ranges} und Abschnitt~\ref{ssec:trenner}). Sie sollten allerdings darauf achten, dass der Name keine Leerzeichen enthält. Das führt zwar nicht unbedingt zu einem Fehler, könnte aber verschiedenen Labeln die gleiche Nummer zuweisen.
+Als Label-Namen können Sie im Prinzip einsetzen, was Sie wollen, außer den als
+Trennzeichen verwendeten Symbolen (siehe Abschnitt~\ref{ssec:unterlabel},
+Abschnitt~\ref{ssec:listen}, Abschnitt~\ref{ssec:sub_ranges} und Abschnitt~\ref{ssec:trenner}).
+Sie sollten allerdings darauf achten, dass der Name keine Leerzeichen enthält.
+Das führt zwar nicht unbedingt zu einem Fehler, könnte aber verschiedenen Labeln
+die gleiche Nummer zuweisen.
\lstset{showspaces=true}
\begin{beispiel}
- \cmpd{aa }, \cmpd{a a }, \cmpd{a a}, \cmpd{ a a}, \cmpd{ aa} und \cmpd{ aa } erzeugen alle das gleiche Label. So, wie auch \cmpd{aa }, \cmpd{a a}, \cmpd{ aa} und \cmpd{aa}.
+ \cmpd{aa }, \cmpd{a a }, \cmpd{a a}, \cmpd{ a a}, \cmpd{ aa} und \cmpd{ aa }
+ erzeugen alle das gleiche Label. So, wie auch \cmpd{aa }, \cmpd{a a}, \cmpd{ aa}
+ und \cmpd{aa}.
\end{beispiel}
\lstset{showspaces=false}\secidx*{Basisbefehl}
\subsection{Sublabel}\label{ssec:unterlabel}\secidx{Sublabel}
-Möchte man Label der Form \cmpd{a.one} erzeugen, geschieht das nach folgender Syntax:
+Möchte man Label der Form \cmpd{a.one} erzeugen, geschieht das nach folgender
+Syntax:
\begin{beschreibung}
\Befehl{cmpd}{<label name>.<subname>}
\end{beschreibung}
-Dabei muss \code{<label name>} der gleiche bleiben, \code{<subname>} variiert. Diese Syntax bedeutet, dass der Punkt \code{.} weder Teil von \code{<label name>} noch von \code{<subname>} sein darf. An Stelle des Punktes können Sie auch ein anderes Zeichen verwenden, siehe Abschnitt~\ref{sssec:sub-input-sep}.
+Dabei muss \code{<label name>} der gleiche bleiben, \code{<subname>} variiert.
+Diese Syntax bedeutet, dass der Punkt \code{.} weder Teil von \code{<label name>}
+noch von \code{<subname>} sein darf. An Stelle des Punktes können Sie auch ein
+anderes Zeichen verwenden, siehe Abschnitt~\ref{sssec:sub-input-sep}.
\begin{beispiel}
- \cmpd{f.one} und \cmpd{f.two} sind eng verwandt, genauso \cmpd{g.one} und \cmpd{g.two}. Nat\"urlich bliebt auch hier bei sp\"aterem Aufruf das Label gleich: \cmpd{g.two} und \cmpd{f.one}.
+ \cmpd{f.one} und \cmpd{f.two} sind eng verwandt, genauso \cmpd{g.one} und \cmpd{g.two}.
+ Nat\"urlich bliebt auch hier bei sp\"aterem Aufruf das Label gleich: \cmpd{g.two}
+ und \cmpd{f.one}.
\end{beispiel}
Diese Syntax funtioniert auch, wenn der Hauptname bereits vergeben wurde.
@@ -240,43 +315,61 @@ Genauso kann der Hauptname von kombiniert vergebenen Labeln einzeln aufgerufen w
\cmpd{f} und \cmpd{g}
\end{beispiel}
-Wie Sie ein Label der Art \cmpd{f.{one,two}} erzeugen können,wird in Abschnitt~\ref{ssec:sub_ranges} erklärt.
+Wie Sie ein Label der Art \cmpd{f.{one,two}} erzeugen können,wird in
+Abschnitt~\ref{ssec:sub_ranges} erklärt.
\secidx*{Sublabel}
\subsection{Listen}\label{ssec:listen}\secidx{Listen}
-Tatsächlich wurde bislang nur die halbe Wahrheit über den Befehl erzählt. Er kann auch für mehrere Label auf einmal verwendet werden.
+Tatsächlich wurde bislang nur die halbe Wahrheit über den Befehl erzählt. Er kann
+auch für mehrere Label auf einmal verwendet werden.
Die richtige Beschreibung des Befehls lautet also eher:
\begin{beschreibung}
\Befehl{cmpd}{<(possibly comma separated list of) label name(s)>}
\end{beschreibung}
-Das bedeutet, dass in der Voreinstellung das Komma nicht Teil des Label-Namens sein kann, es sei denn versteckt in geschweiften Klammern. Sie können das ändern, siehe Abschnitt~\ref{sssec:list-input-sep} (S.\,\pageref{sssec:list-input-sep}).
+Das bedeutet, dass in der Voreinstellung das Komma nicht Teil des Label-Namens
+sein kann, es sei denn versteckt in geschweiften Klammern. Sie können das ändern,
+siehe Abschnitt~\ref{sssec:list-input-sep} (S.\,\pageref{sssec:list-input-sep}).
\begin{beispiel}
- Mehrere Label k\"onnen einfach durch Kommata getrennt eingegeben werden. Dann wird eine Liste wie \cmpd{a, b, c, e, g.two} ausgegeben.
+ Mehrere Label k\"onnen einfach durch Kommata getrennt eingegeben werden. Dann
+ wird eine Liste wie \cmpd{a, b, c, e, g.two} ausgegeben.
\end{beispiel}
\secidx*{Listen}
\subsection{Listen und Bereiche von Sublabeln}\label{ssec:sub_ranges}\index{Sublabel!Listen}\index{Sublabel!Bereiche}
-Manchmal kann es nützlich oder erwünscht sein, ein Label mit einem Bereich von Sublabeln anzuzeigen. Nehmen wir an, Sie haben die Verbindungen \cmpd{q.one,q.two,q.three,q.four,q.five}, die sich \zB in ihren Substituenten unterscheiden. Unter Umständen möchte man auf alle gleichzeitig verweisen: \cmpd[cmpd-all]{q}.
+Manchmal kann es nützlich oder erwünscht sein, ein Label mit einem Bereich von
+Sublabeln anzuzeigen. Nehmen wir an, Sie haben die Verbindungen
+\cmpd{q.one,q.two,q.three,q.four,q.five}, die sich \zB in ihren Substituenten
+unterscheiden. Unter Umständen möchte man auf alle gleichzeitig verweisen:
+\cmpd[cmpd-all]{q}.
Das Prinzip ist recht intuitiv -- Sie geben einfach eine Liste von Sublabeln ein:
\begin{beispiel}
Liste von Labeln: \cmpd{q.one, q.two, q.three, q.four, q.five}\\
Label mit Sublabel-Liste: \cmpd{q.{one,two,three,four,five}}
\end{beispiel}
-Da die Subliste in der Voreinstellung ebenfalls mit Komma getrennt eingegeben wird, müssen Sie die Subliste in geschweiften Klammern eingeben.
+Da die Subliste in der Voreinstellung ebenfalls mit Komma getrennt eingegeben
+wird, müssen Sie die Subliste in geschweiften Klammern eingeben.
-Sie können auf diese Weise auch Bereiche von Sublabeln darstellen. Als Marker zwischen den Namen der beiden Sublabel werden zwei Punkte \verb=..= verwendet.
+Sie können auf diese Weise auch Bereiche von Sublabeln darstellen. Als Marker
+zwischen den Namen der beiden Sublabel werden zwei Punkte \verb=..= verwendet.
\begin{beispiel}
\cmpd{q.{two..four}}\\
\cmpd{q.{one,three..five}}\\
\cmpd{q.{one..three,five}}
\end{beispiel}
-Durch die Eingabe stehen Ihnen in der Voreinstellungen für Sublabel-Namen weder das Komma noch die zwei Punkte als Teils des Namens zur Verfügung. Wie Sie andere Symbole als Marker verwenden, damit Sie sie doch verwenden können, steht in den Abschnitten~\ref{sssec:range-input-sep} und \ref{sssec:list-input-sep}. In Abschnitt~\ref{sssec:input-sep-bsp} wird ein Beispiel gezeigt, wie eine geänderte Eingabe aussehen könnte.
+Durch die Eingabe stehen Ihnen in der Voreinstellungen für Sublabel-Namen weder
+das Komma noch die zwei Punkte als Teils des Namens zur Verfügung. Wie Sie andere
+Symbole als Marker verwenden, damit Sie sie doch verwenden können, steht in den
+Abschnitten~\ref{sssec:range-input-sep} und \ref{sssec:list-input-sep}. In
+Abschnitt~\ref{sssec:input-sep-bsp} wird ein Beispiel gezeigt, wie eine geänderte
+Eingabe aussehen könnte.
-\chemnum stellt eine Option (siehe Abschnitt~\ref{sec:cmpdsetup} zur näheren Erläuterung) zur Verfügung, mit denen alle Sublabel als Bereich ausgegeben werden können
+\chemnum stellt eine Option (siehe Abschnitt~\ref{sec:cmpdsetup} zur näheren
+Erläuterung) zur Verfügung, mit denen alle Sublabel als Bereich ausgegeben werden
+können
\begin{beschreibung}
\Option{cmpd-all}{\default{true}/false}
\end{beschreibung}
@@ -284,9 +377,13 @@ Durch die Eingabe stehen Ihnen in der Voreinstellungen für Sublabel-Namen weder
\cmpd[cmpd-all]{q}
\end{beispiel}
-Damit der Key die richtigen Sublabel verwenden kann, müssen diese deklariert worden sein. Daher werden sie aus der Datei \verb=\jobname.cmpd= (angenommen Ihre Quelldatei heißt \verb=\jobname.tex=) gelesen. Das bedeutet, dass Sie zweimal (oder öfter) kompilieren müssen, bis alle Labels richtig dargestellt werden.
+Damit der Key die richtigen Sublabel verwenden kann, müssen diese deklariert worden
+sein. Daher werden sie aus der Datei \verb=\jobname.cmpd= (angenommen Ihre Quelldatei
+heißt \verb=\jobname.tex=) gelesen. Das bedeutet, dass Sie zweimal (oder öfter)
+kompilieren müssen, bis alle Labels richtig dargestellt werden.
-Verwendet man Label mit Sublabel-Bereichen, dann möchte man vielleicht an anderer Stelle \emph{nur} das Sublabel ausgeben. Das ist möglich mit folgender Option:
+Verwendet man Label mit Sublabel-Bereichen, dann möchte man vielleicht an anderer
+Stelle \emph{nur} das Sublabel ausgeben. Das ist möglich mit folgender Option:
\begin{beschreibung}
\Option{sub-only}{\default{true}/false}
\end{beschreibung}
@@ -303,22 +400,34 @@ Verwendet man Label mit Sublabel-Bereichen, dann möchte man vielleicht an ander
\end{tabular}
\end{beispiel}
-Bereiche von Sublabeln benötigen eine gewisse Sorgfalt. Man muss erstens genau wissen, welches Label das kleinere und welches das größere ist, und zweitens, welche Label in einem Bereich dazwischen liegen. \chemnum kann Ihnen diese Sorgfalt nicht abnehmen. Daher kann es passieren, dass Sie Label wie diese erhalten, wenn Sie nicht aufpassen:
+Bereiche von Sublabeln benötigen eine gewisse Sorgfalt. Man muss erstens genau
+wissen, welches Label das kleinere und welches das größere ist, und zweitens,
+welche Label in einem Bereich dazwischen liegen. \chemnum kann Ihnen diese Sorgfalt
+nicht abnehmen. Daher kann es passieren, dass Sie Label wie diese erhalten, wenn
+Sie nicht aufpassen:
\begin{beispiel}
\cmpd{q.{five..three}} or \cmpd{q.{three,one,four}}.
\end{beispiel}
\section{Label zentral initialisieren}\label{sec:cmpdinit}\secidx{Label initialisieren}
-Die in diesem Abschnitt beschriebenen Befehle sind für den Einsatz von \chemnum nicht nötig, stellen aber Funktionen bereit, die der ein oder andere Anwender nützlich finden könnte.
+Die in diesem Abschnitt beschriebenen Befehle sind für den Einsatz von \chemnum
+nicht nötig, stellen aber Funktionen bereit, die der ein oder andere Anwender
+nützlich finden könnte.
\subsection{Verwendung}
\subsubsection{Haupt-Label}
-Vielleicht vermissen Sie ja den \verb=\declarecompound=-Befehl von \paket{chemcompounds}. Schließlich hat man dadurch am Beginn einen Überblick, welche Namen man bereits vergeben hat. Und man wird durch eine Fehlermeldung unter Umständen gewarnt, wenn man ein falsches Label setzt\footnote{\zB aufgrund eines Schreibfehlers}. Dieses Verhalten lässt sich mit den folgenden Befehlen realisieren.
+Vielleicht vermissen Sie ja den \verb=\declarecompound=-Befehl von \paket{chemcompounds}.
+Schließlich hat man dadurch am Beginn einen Überblick, welche Namen man bereits
+vergeben hat. Und man wird durch eine Fehlermeldung unter Umständen gewarnt, wenn
+man ein falsches Label setzt\footnote{\zB aufgrund eines Schreibfehlers}. Dieses
+Verhalten lässt sich mit den folgenden Befehlen realisieren.
\begin{beschreibung}
\Befehl{cmpdinit}{<comma separated list of label names>}
\Befehl[cmpdinita]{cmpdinit*}{<comma separated list of label names>}
\end{beschreibung}
-Alle Verbindungen, die innerhalb dieses Befehls gesetzt werden, werden \emph{in der verwendeten Reihenfolge} initialisiert. Verwendet man ein Label, das nicht in der Liste enthalten ist, wird eine Warnung ausgegeben.
+Alle Verbindungen, die innerhalb dieses Befehls gesetzt werden, werden \emph{in
+der verwendeten Reihenfolge} initialisiert. Verwendet man ein Label, das nicht
+in der Liste enthalten ist, wird eine Warnung ausgegeben.
\cmpdreset
\begin{beispiel}
@@ -334,9 +443,13 @@ Alle Verbindungen, die innerhalb dieses Befehls gesetzt werden, werden \emph{in
{}*************************************************
\end{mdframed}
-Beachten Sie, dass Sie bei Labeln mit Sublabeln \emph{nur den Hauptnamen} initialisieren können und sollten. Dadurch sind dann \emph{alle} Verbindungen mit gleichem Hauptnamen initialisiert.
+Beachten Sie, dass Sie bei Labeln mit Sublabeln \emph{nur den Hauptnamen}
+initialisieren können und sollten. Dadurch sind dann \emph{alle} Verbindungen mit
+gleichem Hauptnamen initialisiert.
-\cmd[cmpdinita]{cmpdinit*} gibt die gleiche Warnung aus, allerdings werden die Nummern noch nicht vergeben, sondern erst bei Verwendung im Text und in der im Text verwendeten Reihenfolge.
+\cmd[cmpdinita]{cmpdinit*} gibt die gleiche Warnung aus, allerdings werden die
+Nummern noch nicht vergeben, sondern erst bei Verwendung im Text und in der im
+Text verwendeten Reihenfolge.
\cmpdreset
\begin{beispiel}
@@ -352,12 +465,17 @@ Beachten Sie, dass Sie bei Labeln mit Sublabeln \emph{nur den Hauptnamen} initia
{}*************************************************
\end{mdframed}
-Wenn Sie also eigene Label vergeben wollen oder müssen (siehe Seite \pageref{ssec:own_labels}) und die Label geschlossen initialisieren wollen, sollten Sie \cmd[cmpda]{cmpdinit*} verwenden, da dort bei der Initialisierung \emph{keine} Label vergeben werden.
+Wenn Sie also eigene Label vergeben wollen oder müssen (siehe Seite~\pageref{ssec:own_labels})
+und die Label geschlossen initialisieren wollen, sollten Sie \cmd[cmpda]{cmpdinit*}
+verwenden, da dort bei der Initialisierung \emph{keine} Label vergeben werden.
-Der Befehl kann mehrfach verwendet werden, mit oder ohne \verb=*=. Sinnvoll ist aber wohl eine \emph{einmalige} Verwendung, vielleicht in der Dokumentenpräambel nach dem \chemnum-Setup (siehe Abschnitt~\ref{sec:cmpdsetup}).
+Der Befehl kann mehrfach verwendet werden, mit oder ohne \verb=*=. Sinnvoll ist
+aber wohl eine \emph{einmalige} Verwendung, vielleicht in der Dokumentenpräambel
+nach dem \chemnum-Setup (siehe Abschnitt~\ref{sec:cmpdsetup}).
\subsubsection{Sublabel}
-Wenn Sie zusätzlich auch für jede Label-Sublabel-Kombination gewarnt werden wollen oder die Reihenfolge im Voraus festlegen wollen, dann können Sie
+Wenn Sie zusätzlich auch für jede Label-Sublabel-Kombination gewarnt werden wollen
+oder die Reihenfolge im Voraus festlegen wollen, dann können Sie
\begin{beschreibung}
\Befehl{cmpdinit}[\key{init-sub}{true}]{<comma separated list of label names>}
\end{beschreibung}
@@ -380,13 +498,17 @@ verwenden. So werden Sie auch in diesen Fällen gewarnt.
\end{mdframed}
\subsection{Fehler statt Warnung}
-Wenn Sie lieber eine Fehler-Meldung anstelle einer Warnung mögen, können Sie das realisieren, indem Sie \cmd{cmpdinit} folgendermaßen aufrufen:
+Wenn Sie lieber eine Fehler-Meldung anstelle einer Warnung mögen, können Sie das
+erreichen, indem Sie \cmd{cmpdinit} folgendermaßen aufrufen:
\begin{beschreibung}
\Befehl{cmpdinit}[\key{init-strict}{true}]{<comma separated list ...>}
\end{beschreibung}
-Die Verwendung \key{init-strict}{false} entspricht der Verwendung ohne optionalem Argument. Die Option kann natürlich auch bei der Stern-Variante eingesetzt werden
+Die Verwendung \key{init-strict}{false} entspricht der Verwendung ohne optionalem
+Argument. Die Option kann natürlich auch bei der Stern-Variante eingesetzt werden
-Durch \key{init-strict}{true} wird der \LaTeX-Lauf mit einer entsprechenden Fehlermeldung abgebrochen, wenn man einen Label-Namen verwendet, der nicht initialisiert wurde.
+Durch \key{init-strict}{true} wird der \LaTeX-Lauf mit einer entsprechenden
+Fehlermeldung abgebrochen, wenn man einen Label-Namen verwendet, der nicht
+initialisiert wurde.
Natürlich können Sie \cmd{cmpdinit} auch mit beiden Optionen aufrufen
\begin{beschreibung}
@@ -395,30 +517,49 @@ Natürlich können Sie \cmd{cmpdinit} auch mit beiden Optionen aufrufen
oder \cmd{cmpdsetup} verwenden, siehe Abschnitt~\ref{sec:cmpdsetup}.
\subsection{Personalisierte Eingabe}
-Wenn Sie andere Eingabezeichen für \key{sub-input-sep} (siehe Seite \pageref{sssec:sub-input-sep}) oder \key{sublist-input-sep} (siehe Seite \pageref{sssec:list-input-sep}) ausgewählt haben, müssen Sie sie mit \key{sub-init}{true} ebenfalls verwenden.
+Wenn Sie andere Eingabezeichen für \key{sub-input-sep} (siehe Seite~\pageref{sssec:sub-input-sep})
+oder \key{sublist-input-sep} (siehe Seite \pageref{sssec:list-input-sep}) ausgewählt
+haben, müssen Sie sie mit \key{sub-init}{true} ebenfalls verwenden.
-Die Änderung der Listen-Eingabe \key{list-input-sep} (siehe Seite \pageref{sssec:list-input-sep}) wirkt sich auf \cmd{cmpdinit} nicht aus. Wenn Sie die Eingabe dort ebenfalls ändern wollen, verwenden Sie \key{init-input-sep}, siehe Seite \pageref{sssec:init-input-sep}.
+Die Änderung der Listen-Eingabe \key{list-input-sep} (siehe Seite~\pageref{sssec:list-input-sep})
+wirkt sich auf \cmd{cmpdinit} nicht aus. Wenn Sie die Eingabe dort ebenfalls
+ändern wollen, verwenden Sie \key{init-input-sep}, siehe Seite~\pageref{sssec:init-input-sep}.
\subsection{Warum initialisieren?}
-Wie zu Beginn dieses Abschnitts erwähnt, ist die Initialisierung von Labeln nicht nötig. Es gibt jedoch Gründe, warum man \cmd{cmpdinit} vielleicht trotzdem verwenden möchte.
+Wie zu Beginn dieses Abschnitts erwähnt, ist die Initialisierung von Labeln nicht
+nötig. Es gibt jedoch Gründe, warum man \cmd{cmpdinit} vielleicht trotzdem
+verwenden möchte.
\begin{enumerate}
- \item Der Einsatz von \cmd[cmpdinita]{cmpdinit*} ist eine Möglichkeit, den Überblick darüber zu behalten, welche Label man verwendet hat. Man bekommt eine Warnung/Fehlermeldung, wenn man ein bestehendes falsch geschrieben hat. Abhängig davon, wieviele Labels man verwendet (oder verwenden muss) kann das aber viel zusätzliche Arbeit bedeuten.
- \item Der Einsatz von \cmd{cmpdinit} bewirkt erst einmal dasselbe wie \cmd[cmpdinita]{cmpdinit*}, deklariert aber \emph{zusätzlich} die Label in der vorgegebenen Reihenfolge. Damit wird die Verwendung von \cmd[cmpda]{cmpd*} (Abschnitt~\ref{cmd:unsichtbares_label}) und \cmd[cmpdb]{cmpd+} (Abschnitt~\ref{cmd:cmpd_plus}) überflüssig. Man hat damit direkte Kontrolle, welche Verbindung welche Nummer erhält.
+ \item Der Einsatz von \cmd[cmpdinita]{cmpdinit*} ist eine Möglichkeit, den
+ Überblick darüber zu behalten, welche Label man verwendet hat. Man bekommt eine
+ Warnung/Fehlermeldung, wenn man ein bestehendes falsch geschrieben hat. Abhängig
+ davon, wieviele Labels man verwendet (oder verwenden muss) kann das aber viel
+ zusätzliche Arbeit bedeuten.
+ \item Der Einsatz von \cmd{cmpdinit} bewirkt erst einmal dasselbe wie
+ \cmd[cmpdinita]{cmpdinit*}, deklariert aber \emph{zusätzlich} die Label in der
+ vorgegebenen Reihenfolge. Damit wird die Verwendung von \cmd[cmpda]{cmpd*}
+ (Abschnitt~\ref{cmd:unsichtbares_label}) und \cmd[cmpdb]{cmpd+}
+ (Abschnitt~\ref{cmd:cmpd_plus}) überflüssig. Man hat damit direkte Kontrolle,
+ welche Verbindung welche Nummer erhält.
\end{enumerate}
\secidx*{Label initialisieren}
-% TODO: übersetzen
\section{Zurücksetzen des Zählers}\label{sec:cmpdreset}\secidx{Zurücksetzen des Zählers}
Es ist möglich, mit folgendem Befehl
\begin{beschreibung}
\Befehl{cmpdreset}[<number>]
\end{beschreibung}
-den Zähler wieder zurückzusetzen. Ohne Argument wird er auf \verb=1= gesetzt und entspricht damit \cmd{cmpdreset}[1]. Dieser Befehl wirkt sich global aus, nicht nur lokal innerhalb einer Gruppe -- im Gegensatz zu den meisten anderen vorgestellten Befehlen.
+den Zähler wieder zurückzusetzen. Ohne Argument wird er auf \verb=1= gesetzt und
+entspricht damit \cmd{cmpdreset}[1]. Dieser Befehl wirkt sich global aus, nicht
+nur lokal innerhalb einer Gruppe -- im Gegensatz zu den meisten anderen
+vorgestellten Befehlen.
\begin{beispiel}
\cmpdreset Die Verbindungen werden jetzt wieder von 1 gez\"ahlt: \cmpd{h, i, j}
\end{beispiel}
-\achtung{Sie sollten mit diesem Befehl sehr vorsichtig umgehen! In der Regel ist es nicht zu empfehlen, den Zähler zurückzusetzen. Dadurch können ein und dieselbe Nummer an verschiedene Verbindungen vergeben werden!}
+\achtung{Sie sollten mit diesem Befehl sehr vorsichtig umgehen! In der Regel ist
+es nicht zu empfehlen, den Zähler zurückzusetzen. Dadurch können ein und dieselbe
+Nummer an verschiedene Verbindungen vergeben werden!}
\begin{beispiel}
Gleiche Nummern: \cmpd{a}, \cmpd{h}
@@ -427,25 +568,43 @@ den Zähler wieder zurückzusetzen. Ohne Argument wird er auf \verb=1= gesetzt u
\section{Besondere Verwendung}\secidx{besondere Verwendung}
\subsection{Abschnitts-Titel}
-Die Verwendung von \cmd{cmpd} in einer Überschrift scheint auf den ersten Blick kein Problem zu sein. Es gibt keine Fehler und der Output sieht wie erwartet aus:
+Die Verwendung von \cmd{cmpd} in einer Überschrift scheint auf den ersten Blick
+kein Problem zu sein. Es gibt keine Fehler und der Output sieht wie erwartet aus:
\begin{beispiel}[code only]
\section{Compound \cmpd[cmpd-delim]{b}}
\ldots
\end{beispiel}
-Wenn man allerdings \verb=\tableofcontents= verwendet -- was ziemlich wahrscheinlich ist, wie ich vermute --, geschieht etwas unerwünschtes: da das Inhaltsverzeichnis am Anfang des Dokuments geschrieben wird, wird das Label beim Erscheinen im Inhaltsverzeichnis deklariert, anstatt an der Stelle im Text, an der es zuerst erscheint. Es gibt zwei Möglichkeiten, das zu umgehen:
+Wenn man allerdings \verb=\tableofcontents= verwendet -- was ziemlich wahrscheinlich
+ist, wie ich vermute --, geschieht etwas unerwünschtes: da das Inhaltsverzeichnis am
+Anfang des Dokuments geschrieben wird, wird das Label beim Erscheinen im
+Inhaltsverzeichnis deklariert, anstatt an der Stelle im Text, an der es zuerst
+erscheint. Es gibt zwei Möglichkeiten, das zu umgehen:
\begin{enumerate}
- \item Sie deklarieren die Label in der Präambel mit \cmd{cmpdinit}{} (siehe Seite \pageref{sec:cmpdinit}).
- \item Sie verwenden \cmd[cmpdb]{cmpd+}, um das Label zu setzen. Damit wird das Label von der Datei \verb=\jobname.cmpd= ausgelesen (vorausgesetzt ihre Hauptdatei heißt \verb=\jobname.tex=). Das bedeutet, dass \emph{mindestens zwei}, unter Umständen mehr \LaTeX\ Durchläufe nötig sind, bis alle Labels richtig gesetzt sind.
+ \item Sie deklarieren die Label in der Präambel mit \cmd{cmpdinit}{} (siehe
+ Seite~\pageref{sec:cmpdinit}).
+ \item Sie verwenden \cmd[cmpdb]{cmpd+}, um das Label zu setzen. Damit wird das
+ Label von der Datei \verb=\jobname.cmpd= ausgelesen (vorausgesetzt ihre
+ Hauptdatei heißt \verb=\jobname.tex=). Das bedeutet, dass \emph{mindestens zwei},
+ unter Umständen mehr \LaTeX\ Durchläufe nötig sind, bis alle Labels richtig
+ gesetzt sind.
\end{enumerate}
-Das gleiche gilt für jede andere Liste von beweglichen Argumenten, die \emph{vor} dem Erscheinen des Labels im Text eingesetzt wird.
+Das gleiche gilt für jede andere Liste von beweglichen Argumenten, die \emph{vor}
+dem Erscheinen des Labels im Text eingesetzt wird.
Der Befehl\label{cmd:cmpd_plus}
\begin{beschreibung}
\Befehl[cmpdb]{cmpd+}\ma{<label name>}
\end{beschreibung}
-liest den Labelnamen, der ausgegeben werden soll, aus der Datei \verb=\jobname.cmpd=. Damit ist er sozusagen das Gegenteil von \cmd[cmpda]{cmpd*}, da das Label nicht deklariert sondern nur referenziert und ausgegeben wird. Damit man also \cmd[cmpdb]{cmpd+}{<label>} einsetzen kann, muss \verb=<label>= entweder mit \cmd{cmpd}{<label>} oder \cmd[cmpda]{cmpd*}{<label>} (davor oder danach) deklariert worden sein. \cmd[cmpdb]{cmpd+} ist nützlich, wenn ein Label in einem beweglichen Argument wie in \verb=\section{}= eingesetzt werden soll.
+liest den Labelnamen, der ausgegeben werden soll, aus der Datei \verb=\jobname.cmpd=.
+Damit ist er sozusagen das Gegenteil von \cmd[cmpda]{cmpd*}, da das Label nicht
+deklariert sondern nur referenziert und ausgegeben wird. Damit man also
+\cmd[cmpdb]{cmpd+}{<label>} einsetzen kann, muss \verb=<label>= entweder mit
+\cmd{cmpd}{<label>} oder \cmd[cmpda]{cmpd*}{<label>} (davor oder danach) deklariert
+worden sein. \cmd[cmpdb]{cmpd+} ist nützlich, wenn ein Label in einem beweglichen
+Argument wie in \verb=\section{}= eingesetzt werden soll.
-\achtung{Er wird nicht benötigt, wenn} \cmd{cmpdinit} \textbf{verwendet wird, siehe Abschnitt~\ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).}
+\achtung{Er wird nicht benötigt, wenn} \cmd{cmpdinit} \textbf{verwendet wird, siehe
+Abschnitt~\ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).}
\begin{beispiel}
\subsubsection{Test-\"Uberschrift mit Verbindungslabel \cmpd+[cmpd-delim]{f.one}}
@@ -454,7 +613,10 @@ liest den Labelnamen, der ausgegeben werden soll, aus der Datei \verb=\jobname.c
\end{beispiel}
\subsection{Gleitumgebungen}\cmpdinit*{float1,float2}
-Die Verwendung von \cmd{cmpd} in Gleitumgebungen sollte kein Problem darstellen: die Labels werden in der Reihenfolge deklariert, wie Sie im Code auftauchen, eingeschlossen die Gleitumgebungen. Um auf der sicheren Seite zu sein, können Sie natürlich dennoch \cmd[cmpdb]{cmpd+} verwenden.
+Die Verwendung von \cmd{cmpd} in Gleitumgebungen sollte kein Problem darstellen:
+die Labels werden in der Reihenfolge deklariert, wie Sie im Code auftauchen,
+eingeschlossen die Gleitumgebungen. Um auf der sicheren Seite zu sein, können Sie
+natürlich dennoch \cmd[cmpdb]{cmpd+} verwenden.
\begin{beispiel}[code and float]
% preamble:
% \usepackage{chemscheme}
@@ -468,15 +630,20 @@ Die Verwendung von \cmd{cmpd} in Gleitumgebungen sollte kein Problem darstellen:
\end{scheme}
\end{beispiel}
-Es funktioniert auch alles wie gewünscht, wenn die Gleitumgebung vor den aktuellen Code rutscht, etwa mit der Option \oa{t}.
+Es funktioniert auch alles wie gewünscht, wenn die Gleitumgebung vor den aktuellen
+Code rutscht, etwa mit der Option \oa{t}.
\cmpdinit*{Alc,EtherBr,cpd}
\subsection{Schemata externer Programme}\label{ssec:cmpdref}\secidx{Schemata externer Programme}
-Wenn Sie Ihre Schemata mit externen Programmen wie \zB \prog{ChemDraw} oder \prog{Marvin\-Sketch} erstellen und dort ebenfalls \chemnum einsetzen wollen, dann können Sie das mit
+Wenn Sie Ihre Schemata mit externen Programmen wie \zB \prog{ChemDraw} oder
+\prog{Marvin\-Sketch} erstellen und dort ebenfalls \chemnum einsetzen wollen,
+dann können Sie das mit
\begin{beschreibung}
\Befehl{cmpdref}[<tag>]\oa{<options>}\ma{<label name>}
\end{beschreibung}
-tun. Dieser Befehl ist vom Befehl \verb=\schemeref= des Pakets \paket{chemscheme} inspiriert und funktioniert letztlich gleich. Sie erstellen das Schema und speichern es mit temporären Labeln als \verb=eps=-Datei.
+tun. Dieser Befehl ist vom Befehl \verb=\schemeref= des Pakets \paket{chemscheme}
+inspiriert und funktioniert letztlich gleich. Sie erstellen das Schema und
+speichern es mit temporären Labeln als \verb=eps=-Datei.
\achtung{Mit v0.5 hat sich die Reihenfolge der optionalen Argumente verändert!}
\begin{beispiel}[code and float]
@@ -494,11 +661,20 @@ tun. Dieser Befehl ist vom Befehl \verb=\schemeref= des Pakets \paket{chemscheme
\caption{Schema mit automatisierten Labeln.}
\end{scheme}
\end{beispiel}
-Sie nummerieren also im Schema die Substanzen mit \textsf{TMP1}, \textsf{TMP2} \usw durch. Diese Marker werden dann durch die entsprechenden Label ersetzt. Dafür verwendet \chemnum genau wie \paket{chemscheme} den Befehl \verb=\psfrag= des \paket{psfrag}-Pakets. Damit er funktioniert, müssen Sie also entweder über \prog{latex}, \prog{dvips}, \prog{ps2pdf} kompilieren, oder \zB das Paket \paket{auto-pst-pdf} zusammen mit \hologo{pdfLaTeX} einsetzen. \hologo{XeLaTeX} wird leider nicht funktionieren, \hologo{LuaLaTeX} voraussichtlich ebensowenig, wurde aber vom Autor nicht getestet.
-
-In jedem Fall ist es wichtig, dass der Marker als \emph{Text} im \verb=eps= gespeichert ist.
-
-Mit den Optionen, die in Abschnitt~\ref{sec:cmpdsetup} vorgestellt werden, können Sie die Label hier auch personalisieren.
+Sie nummerieren also im Schema die Substanzen mit \textsf{TMP1}, \textsf{TMP2}
+\usw durch. Diese Marker werden dann durch die entsprechenden Label ersetzt. Dafür
+verwendet \chemnum genau wie \paket{chemscheme} den Befehl \verb=\psfrag= des
+\paket{psfrag}-Pakets. Damit er funktioniert, müssen Sie also entweder über
+\prog{latex}, \prog{dvips}, \prog{ps2pdf} kompilieren, oder \zB das Paket
+\paket{auto-pst-pdf} zusammen mit \hologo{pdfLaTeX} einsetzen. \hologo{XeLaTeX}
+wird leider nicht funktionieren, \hologo{LuaLaTeX} voraussichtlich ebensowenig,
+wurde aber vom Autor nicht getestet.
+
+In jedem Fall ist es wichtig, dass der Marker als \emph{Text} im \verb=eps=
+gespeichert ist.
+
+Mit den Optionen, die in Abschnitt~\ref{sec:cmpdsetup} vorgestellt werden, können
+Sie die Label hier auch personalisieren.
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
@@ -510,7 +686,8 @@ Mit den Optionen, die in Abschnitt~\ref{sec:cmpdsetup} vorgestellt werden, könn
\end{scheme}
\end{beispiel}
-Sie können auch beliebigen Text ersetzen. Dafür gibt es das zweite optionale Argument.
+Sie können auch beliebigen Text ersetzen. Dafür gibt es das zweite optionale
+Argument.
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
@@ -541,37 +718,55 @@ Natürlich funktioniert das mit Sublabeln nach dem gewohnten Muster:
\section{Verwendung mit \textsf{hyperref}}\label{sec:hyperref}\secidx{Verwendung mit \textsf{hyperref}}[Verwendung mit hyperref]
\subsection{Grundprinzip}
-Wenn Sie das Paket \paket{hyperref} eingebunden haben, können Sie die Label zu klickbaren Links im \prog{pdf} machen.
+Wenn Sie das Paket \paket{hyperref} eingebunden haben, können Sie die Label zu
+klickbaren Links im \prog{pdf} machen.
\begin{beschreibung}
\Option{hyper-use}{\default{true}/false}
\end{beschreibung}
-Wenn Sie diese Option (siehe Abschnitt~\ref{sec:cmpdsetup} für nähere Informationen) auf \texttt{true} setzen, dann wird beim ersten Einsatz eines Labels danach ein Ziel festgelegt und bei jedem weiteren ein Link zu diesem Ziel erzeugt. Das funktioniert allerdings nur, solange das Label \emph{ohne} Liste oder Bereich von Sublabeln gesetzt wird. Auch ein mit \cmd[cmpda]{cmpd*} gesetztes Label kann nicht als Ziel markiert werden.
+Wenn Sie diese Option (siehe Abschnitt~\ref{sec:cmpdsetup} für nähere Informationen)
+auf \texttt{true} setzen, dann wird beim ersten Einsatz eines Labels danach ein
+Ziel festgelegt und bei jedem weiteren ein Link zu diesem Ziel erzeugt. Das
+funktioniert allerdings nur, solange das Label \emph{ohne} Liste oder Bereich von
+Sublabeln gesetzt wird. Auch ein mit \cmd[cmpda]{cmpd*} gesetztes Label kann nicht
+als Ziel markiert werden.
\begin{beispiel}
\cmpdsetup{hyper-use}
- Bei der ersten Verwendung wird das Ziel festgelegt: \cmpd{a.two,b,c,d,e,f}, Bei der n\"achsten dann ein Link gesetzt: \cmpd{a.two,d,e}.
+ Bei der ersten Verwendung wird das Ziel festgelegt: \cmpd{a.two,b,c,d,e,f}, Bei
+ der n\"achsten dann ein Link gesetzt: \cmpd{a.two,d,e}.
- Das funktioniert nur bei Labeln ohne Sublabel-Liste oder -Bereich: \cmpd{a,f.{one,two},c}. Da \cmpd{a.two} und \cmpd{a} zwei unterschiedliche Bedeutungen haben, haben sie auch unterschiedliche Linkziele.
+ Das funktioniert nur bei Labeln ohne Sublabel-Liste oder -Bereich:
+ \cmpd{a,f.{one,two},c}. Da \cmpd{a.two} und \cmpd{a} zwei unterschiedliche
+ Bedeutungen haben, haben sie auch unterschiedliche Linkziele.
\end{beispiel}
\subsection{Gezielter Einsatz}
-Der automatisierte Einsatz ist vielleicht nicht der, den man möchte. Vielleicht reicht es, an ein oder zwei Stellen einen Verweis zu erzeugen. Das kann mit folgenden Keys erfolgen.
+Der automatisierte Einsatz ist vielleicht nicht der, den man möchte. Vielleicht
+reicht es, an ein oder zwei Stellen einen Verweis zu erzeugen. Das kann mit
+folgenden Keys erfolgen.
\begin{beschreibung}
\Option{hyper-target}{<link name>}
\Option{hyper-link}{<link name>}
\end{beschreibung}
-Mit \key{hyper-target} kann man ein Ziel festsetzen. \textbf{Achtung}: wenn Sie diesen Key mit einer Liste einsetzen, dann erhält \emph{jedes} Label den gleichen Linkzielnamen und \paket{hyperref} wird eine Warnung
+Mit \key{hyper-target} kann man ein Ziel festsetzen. \textbf{Achtung}: wenn Sie
+diesen Key mit einer Liste einsetzen, dann erhält \emph{jedes} Label den gleichen
+Linkzielnamen und \paket{hyperref} wird eine Warnung
\begin{mdframed}\ttfamily
- destination with the same identifier (name\{<link name>\}) has been already used, duplicate ignored
+ destination with the same identifier (name\{<link name>\}) has been already used,
+ duplicate ignored
\end{mdframed}
ausgeben.
-Mit \key{hyper-link} kann man nun einen Link auf dieses Ziel erzeugen. \textbf{Achtung}: wenn Sie diesen Key mit einer Liste einsetzen, wird \emph{jedes} Label auf das gleiche Ziel verweisen.
+Mit \key{hyper-link} kann man nun einen Link auf dieses Ziel erzeugen.
+\textbf{Achtung}: wenn Sie diesen Key mit einer Liste einsetzen, wird \emph{jedes}
+Label auf das gleiche Ziel verweisen.
\begin{beispiel}
- Einen Link setzen \cmpd[hyper-link=mylink,cmpd-all]{f} und das entsprechende Ziel dazu nicht vergessen \cmpd[hyper-target=mylink,cmpd-all]{f}.
+ Einen Link setzen \cmpd[hyper-link=mylink,cmpd-all]{f} und das entsprechende Ziel
+ dazu nicht vergessen \cmpd[hyper-target=mylink,cmpd-all]{f}.
\end{beispiel}
-Wenn Sie \key{hyper-link} einsetzen, ohne das entsprechende \key{hyper-target} festgelegt zu haben, dann wird \paket{hyperref} eine Warnung
+Wenn Sie \key{hyper-link} einsetzen, ohne das entsprechende \key{hyper-target}
+festgelegt zu haben, dann wird \paket{hyperref} eine Warnung
\begin{mdframed}\ttfamily
name\{<link name>\} has been referenced but does not exist, replaced by a fixed one
\end{mdframed}
@@ -580,7 +775,8 @@ ausgeben.
\section{Personalisieren}\label{sec:cmpdsetup}
\subsection{Das Prinzip}\label{ssec:prinzip}
-Das Personalisieren geschieht mit einem Schlüssel-Wert-System. Einstellungen können dabei entweder zentral über
+Das Personalisieren geschieht mit einem Schlüssel-Wert-System. Einstellungen können
+dabei entweder zentral über
\begin{beschreibung}
\Befehl{cmpdsetup}{key1 = value1, key2 = value2}
\end{beschreibung}
@@ -590,25 +786,35 @@ oder lokal direkt beim Befehl
\end{beschreibung}
vorgenommen werden.
-Wenn Sie Optionen ohne Wertzuweisung verwenden \cmd{cmpdsetup}{key1,key2}, werden De\-faultwerte\label{opt:default} verwendet. Diese sind \emph{nicht} unbedingt leer und stimmen auch \emph{nicht} unbedingt mit der Voreinstellung des Pakets überein.
+Wenn Sie Optionen ohne Wertzuweisung verwenden \cmd{cmpdsetup}{key1,key2}, werden
+De\-faultwerte\label{opt:default} verwendet. Diese sind \emph{nicht} unbedingt leer
+und stimmen auch \emph{nicht} unbedingt mit der Voreinstellung des Pakets überein.
-Die Optionen sind in verschiedene Klassen\label{key_classes} unterteilt, die auf ihren Verwendungsbereich hindeuten. Sie folgen alle der Form \verb+<class>-key = <value>+:
+Die Optionen sind in verschiedene Klassen\label{key_classes} unterteilt, die auf
+ihren Verwendungsbereich hindeuten. Sie folgen alle der Form \verb+<class>-key = <value>+:
\begin{itemize}
- \item \code{cmpd}: Optionen, die damit beginnen, wirken sich auch das Label insgesamt oder speziell auf das Hauptlabel aus.
- \item \code{sub}, \code{sublist}, \code{subref}: Diese Optionen haben mit den Sublabeln direkt zu tun.
+ \item \code{cmpd}: Optionen, die damit beginnen, wirken sich auch das Label
+ insgesamt oder speziell auf das Hauptlabel aus.
+ \item \code{sub}, \code{sublist}, \code{subref}: Diese Optionen haben mit den
+ Sublabeln direkt zu tun.
\item \code{list}: Optionen, die die Ausgabe der Listen ändern.
\item \code{ref}: Optionen, die speziell mit \cmd{cmpdref} zu tun haben.
- \item \code{hyper}: Optionen, die mit der Verwendung von \paket{hyperref} zu tun haben.
+ \item \code{hyper}: Optionen, die mit der Verwendung von \paket{hyperref} zu tun
+ haben.
\item \code{init}: Optionen, die mit der Initialisierung von Labeln zu tun haben.
\end{itemize}
\subsection{Schriftstil}\label{ssec:schriftstil}\secidx{Schriftstil}
-Um den Stil zu ändern, mit dem die Nummern geschrieben werden, verwenden Sie folgende Optionen:
+Um den Stil zu ändern, mit dem die Nummern geschrieben werden, verwenden Sie
+folgende Optionen:
\begin{beschreibung}
\Option{cmpd-style}{<style>}
\option{cmpd-weight}{bold/normal} Default = \code{bold}
\end{beschreibung}
-Da es nicht unüblich ist, Schemata serifenlos zu setzen, während der Text mit Serifen gesetzt wird, ist es möglich, für \cmd{cmpdref} einen eigenen Stil festzulegen. In der Voreinstellung werden mit \cmd{cmpdref} erzeugte Label mit \lstinline+\sffamily+ gesetzt.
+Da es nicht unüblich ist, Schemata serifenlos zu setzen, während der Text mit
+Serifen gesetzt wird, ist es möglich, für \cmd{cmpdref} einen eigenen Stil festzulegen.
+In der Voreinstellung werden mit \cmd{cmpdref} erzeugte Label mit \lstinline+\sffamily+
+gesetzt.
\begin{beispiel}
% preamble:
% \usepackage[normalem]{ulem}
@@ -620,7 +826,9 @@ Da es nicht unüblich ist, Schemata serifenlos zu setzen, während der Text mit
\cmpd{a, b, f.two, k}\\ % kursiv und unterstrichen
\cmpd[cmpd-weight=normal]{a, b, f.two, k}
\end{beispiel}
-Dass die Schriftstärke separat eingestellt wird, hat seine Ursache bei den griechischen Labeln (siehe Abschnitt~\ref{ssec:counter}). Abhängig von der Paketoption muss die Schriftstärke dort unterschiedlich realisiert werden.
+Dass die Schriftstärke separat eingestellt wird, hat seine Ursache bei den
+griechischen Labeln (siehe Abschnitt~\ref{ssec:counter}). Abhängig von der
+Paketoption muss die Schriftstärke dort unterschiedlich realisiert werden.
\secidx*{Schriftstil}
\subsection{Eigene Labels}\label{ssec:own_labels}\secidx{Eigene Labels}
@@ -631,28 +839,39 @@ Mit der Option
kann man eigene Labels vergeben.
\begin{beispiel}
- Eigenes Label: \cmpd[cmpd-label = XYZ]{l}, wird bei einer Liste an \emph{alle neuen} vergeben! \cmpd[cmpd-label = XYZ]{l, a, m}
+ Eigenes Label: \cmpd[cmpd-label = XYZ]{l}, wird bei einer Liste an \emph{alle
+ neuen} vergeben! \cmpd[cmpd-label = XYZ]{l, a, m}
\end{beispiel}
\secidx*{Eigene Labels}
\subsection{Marker in Bildern}\secidx{Marker in Bildern}\label{ssec:marker_in_bildern}
-Es gibt ein paar Optionen, die die Labels in externen Bildern betreffen, die mit \cmd{cmpdref} platziert werden.
+Es gibt ein paar Optionen, die die Labels in externen Bildern betreffen, die mit
+\cmd{cmpdref} platziert werden.
\begin{beschreibung}
- \option{ref-marker}{<marker>} Ändert den Default-Marker, der ersetzt werden soll. Default = \code{TMP}
+ \option{ref-marker}{<marker>} Ändert den Default-Marker, der ersetzt werden soll.
+ Default = \code{TMP}
\option{ref-pos}{\{<tex-pos>\}\{<ps-pos>\}} Default = \code{bb}
- \option{ref-style}{<style>} Ändert das Format des Labels in externen Schemata. Default = \verb=\sffamily=
+ \option{ref-style}{<style>} Ändert das Format des Labels in externen Schemata.
+ Default = \verb=\sffamily=
\end{beschreibung}
-Mit der Option \key{ref-pos} können Sie die Art der Platzierung ändern, die \cmd{cmpdref} verwendet. Der Befehl \cmd{psfrag}, der intern verwendet wird, hat zwei Optionen dafür. Die erste bestimmt, wie der \TeX-Ersatz platziert wird, die zweite, wie der Ersatz in die Box gesetzt wird, die durch den Marker enstanden ist. Zu Details lesen Sie bitte die Dokumentation des \paket{psfrag}-Pakets.
+Mit der Option \key{ref-pos} können Sie die Art der Platzierung ändern, die
+\cmd{cmpdref} verwendet. Der Befehl \cmd{psfrag}, der intern verwendet wird, hat
+zwei Optionen dafür. Die erste bestimmt, wie der \TeX-Ersatz platziert wird, die
+zweite, wie der Ersatz in die Box gesetzt wird, die durch den Marker enstanden
+ist. Zu Details lesen Sie bitte die Dokumentation des \paket{psfrag}-Pakets.
\secidx*{Marker in Bildern}
\subsection{Zähler}\label{ssec:counter}\secidx{Zähler}
Wenn Sie mögen, können Sie auch das Zählerformat \cmpd{a.one} ändern.
\begin{beschreibung}
- \option{cmpd-counter}{arabic/alph/Alph/greek/Greek/roman/Roman/Symbol} Default = \code{arabic}
- \option{sub-counter}{arabic/alph/Alph/greek/Greek/roman/Roman/Symbol} Default = \code{alph}
+ \option{cmpd-counter}{arabic/alph/Alph/greek/Greek/roman/Roman/Symbol} Default
+ = \code{arabic}
+ \option{sub-counter}{arabic/alph/Alph/greek/Greek/roman/Roman/Symbol} Default
+ = \code{alph}
\end{beschreibung}
-Bitte beachten Sie: ein Ändern des Zählerformats wirkt sich nur auf \emph{noch nicht erzeugte} Label aus!
+Bitte beachten Sie: ein Ändern des Zählerformats wirkt sich nur auf \emph{noch
+nicht erzeugte} Label aus!
\begin{beispiel}
\cmpdsetup{cmpd-counter = Alph, sub-counter = arabic}
\cmpd{a, b, f.two, k}\\ % keine Wirkung bei bereits erzeugten Labeln!
@@ -663,7 +882,8 @@ Bitte beachten Sie: ein Ändern des Zählerformats wirkt sich nur auf \emph{noch
\secidx*{Zähler}
\subsection{Begrenzer}\secidx{Begrenzer}
-Sie können sowohl den einzelnen Nummern wie auch eine ganze Liste mit Begrenzern versehen. Dafür gibt es die Optionen:
+Sie können sowohl den einzelnen Nummern wie auch eine ganze Liste mit Begrenzern
+versehen. Dafür gibt es die Optionen:
\begin{beschreibung}
\option{cmpd-delim}{<odelim><cdelim>} Benötigen \emph{zwei} Token als Wert!
\option{list-delim}{<odelim><cdelim>} Benötigen \emph{zwei} Token als Wert!
@@ -675,7 +895,9 @@ Sie können sowohl den einzelnen Nummern wie auch eine ganze Liste mit Begrenzer
\cmpdsetup{cmpd-delim = ()}
\cmpd{a, b, f.two, k} % eingeklammert
\end{beispiel}
-Wenn Sie \cmd{cmpd}[\key{cmpd-delim}]{<label>} schreiben, also keinen Wert spezifizieren, werden \verb=()= verwendet. Dasselbe gilt für \key{list-delim}. Beachten Sie, dass die Listenbegrenzer erst ab \emph{zwei} Labeln verwendet werden.
+Wenn Sie \cmd{cmpd}[\key{cmpd-delim}]{<label>} schreiben, also keinen Wert
+spezifizieren, werden \verb=()= verwendet. Dasselbe gilt für \key{list-delim}.
+Beachten Sie, dass die Listenbegrenzer erst ab \emph{zwei} Labeln verwendet werden.
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
\cmpd[list-delim = {[}{]}]{a, b, f.two, k}\\ % eingeklammert
@@ -684,10 +906,12 @@ Wenn Sie \cmd{cmpd}[\key{cmpd-delim}]{<label>} schreiben, also keinen Wert spezi
\cmpd{a, b, f.two, k}\\ % eingeklammert
\cmpd{a} % KEINE Liste!
\end{beispiel}
-Wenn Sie generell die Label eingeklammert verwenden, aber ein einzelnes einmal ohne Klammern verwenden wollen, haben Sie mehrere Möglichkeiten:
+Wenn Sie generell die Label eingeklammert verwenden, aber ein einzelnes einmal
+ohne Klammern verwenden wollen, haben Sie mehrere Möglichkeiten:
\begin{beispiel}
\cmpdsetup{cmpd-delim}
- Normal \cmpd{b}, \cmpd{c}, \cmpd{d.one}, aber manchmal so \cmpd[cmpd-delim = ]{e} oder so \cmpd-{e}.
+ Normal \cmpd{b}, \cmpd{c}, \cmpd{d.one}, aber manchmal so \cmpd[cmpd-delim = ]{e}
+ oder so \cmpd-{e}.
\end{beispiel}
Mit
\begin{beschreibung}\label{cmd:ohne_begrenzer}
@@ -702,18 +926,21 @@ kann man die Klammern eines Labels schnell entfernen (nicht jedoch die der Liste
\cmpd-{a, b, f.two, k} % einfach eingeklammert
\end{beispiel}
-Durch leere Argumente, \cmd{cmpdsetup}{\key{cmpd-delim}{ }} und \cmd{cmpdsetup}{\key{list-delim}{ }}, können Sie die Voreinstellung wieder herstellen.
+Durch leere Argumente, \cmd{cmpdsetup}{\key{cmpd-delim}{ }} und
+\cmd{cmpdsetup}{\key{list-delim}{ }}, können Sie die Voreinstellung wieder herstellen.
\secidx*{Begrenzer}
\subsection{Suffix und Präfix}\secidx{Suffix und Präfix}
-Falls Sie wollen, können sie sowohl einzelnen Labeln als auch den Listen Prä- und Suffixe geben.
+Falls Sie wollen, können sie sowohl einzelnen Labeln als auch den Listen Prä-
+und Suffixe geben.
\begin{beschreibung}
\Option{cmpd-prefix}{<prefix>}
\Option{cmpd-suffix}{<prefix>}
\Option{list-prefix}{<prefix>}
\Option{list-suffix}{<prefix>}
\end{beschreibung}
-Wie bei den Begrenzern gilt: Listen-Attribute werden erst bei einer Liste -- also zwei oder mehr Labeln -- verwendet.
+Wie bei den Begrenzern gilt: Listen-Attribute werden erst bei einer Liste -- also
+zwei oder mehr Labeln -- verwendet.
Beispiel für die Label-Attribute:
\begin{beispiel}
@@ -748,7 +975,11 @@ geändert werden.
\subsection{Trennzeichen}\label{ssec:trenner}\secidx{Trennzeichen}
\subsubsection{Bei Labeln -- Eingabe}\label{sssec:sub-input-sep}\index{Trennzeichen!Label!Input}
-Als Voreinstellung verwendet \chemnum den Punkt \code{.} als Zeichen, um Hauptlabelnamen von Sublabelnamen zu unterscheiden. Sie können das Symbol nach Belieben ändern. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@= sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen Trennsymbole (siehe folgende Abschnitte) nicht die gleichen Zeichen zu verwenden.
+Als Voreinstellung verwendet \chemnum den Punkt \code{.} als Zeichen, um
+Hauptlabelnamen von Sublabelnamen zu unterscheiden. Sie können das Symbol nach
+Belieben ändern. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@=
+sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen
+Trennsymbole (siehe folgende Abschnitte) nicht die gleichen Zeichen zu verwenden.
\begin{beschreibung}
\option{sub-input-sep}{<separator>} Default = \code{.}
\end{beschreibung}
@@ -760,10 +991,15 @@ Als Voreinstellung verwendet \chemnum den Punkt \code{.} als Zeichen, um Hauptla
\cmpd[sub-input-sep= &]{f&one, g&two}\\
\cmpd[sub-input-sep= *]{f*one, g*two}
\end{beispiel}
-Sie sollten -- nicht nur aus Gründen der Konsistenz -- nur \emph{einmal} am Anfang ihres Dokuments entscheiden, welches Symbol Sie verwenden. Und zwar \emph{bevor} Sie \verb=\tableofcontents= einsetzen. Am besten in der Präambel. Ansonsten kann \verb=\tableofcontents= nicht wissen, welchen Symbol Sie verwenden und Label im Inhaltsverzeichnis können falsch dargestellt werden.
+Sie sollten -- nicht nur aus Gründen der Konsistenz -- nur \emph{einmal} am Anfang
+ihres Dokuments entscheiden, welches Symbol Sie verwenden. Und zwar \emph{bevor}
+Sie \verb=\tableofcontents= einsetzen. Am besten in der Präambel. Ansonsten kann
+\verb=\tableofcontents= nicht wissen, welchen Symbol Sie verwenden und Label im
+Inhaltsverzeichnis können falsch dargestellt werden.
\subsubsection{Bei Labeln -- Ausgabe}\index{Trennzeichen!Label!Output}
-Haben Sie Label mit Sublabeln, können Sie dort auch ein Trenn-Symbol verwenden. Das erscheint dann zwischen Hauptlabel und Sublabel.
+Haben Sie Label mit Sublabeln, können Sie dort auch ein Trenn-Symbol verwenden.
+Das erscheint dann zwischen Hauptlabel und Sublabel.
\begin{beschreibung}
\Option{sub-output-sep}{<separator>}
\end{beschreibung}
@@ -776,7 +1012,11 @@ Haben Sie Label mit Sublabeln, können Sie dort auch ein Trenn-Symbol verwenden.
\end{beispiel}
\subsubsection{Bei Sublabeln -- Eingabe}\label{sssec:range-input-sep}\index{Trennzeichen!Sublabel!Input}
-Für die Eingabe eines Bereiches von Sublabeln verwendet \chemnum in der Voreinstellung zwei Punkte \code{..}. Sie können aber eine beliebige andere Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@= sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen Trennsymbole nicht die gleichen Zeichen zu verwenden.
+Für die Eingabe eines Bereiches von Sublabeln verwendet \chemnum in der Voreinstellung
+zwei Punkte \code{..}. Sie können aber eine beliebige andere Eingabe wählen. Die
+Zeichen \verb=% #= können Sie nicht verwenden und \verb=@= sollten Sie nicht
+verwenden. Außerdem sollten Sie darauf achten, für die anderen Trennsymbole nicht
+die gleichen Zeichen zu verwenden.
\begin{beschreibung}
\option{subrange-input-sep}{<separator>} Default = \code{..}
\end{beschreibung}
@@ -787,7 +1027,8 @@ Für die Eingabe eines Bereiches von Sublabeln verwendet \chemnum in der Voreins
\end{beispiel}
\subsubsection{Bei Sublabeln -- Ausgabe}\index{Trennzeichen!Sublabel!Output}
-Vielleicht gefällt Ihnen die Ausgabe \cmpd[cmpd-all]{q} nicht und Sie wollen den Bereich anders darstellen? Das geht mit dieser Option:
+Vielleicht gefällt Ihnen die Ausgabe \cmpd[cmpd-all]{q} nicht und Sie wollen den
+Bereich anders darstellen? Das geht mit dieser Option:
\begin{beschreibung}
\option{subrange-output-sep}{<separator>} Default = \verb|--|
\end{beschreibung}
@@ -798,7 +1039,11 @@ Vielleicht gefällt Ihnen die Ausgabe \cmpd[cmpd-all]{q} nicht und Sie wollen de
\end{beispiel}
\subsubsection{Bei Listen -- Eingabe}\label{sssec:list-input-sep}\index{Trennzeichen!Listen!Input}
-Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Default wird hier das Komma \code{,} verwendet. Sie können aber eine beliebige andere Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@= sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen Trennsymbole nicht die gleichen Zeichen zu verwenden.
+Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Default
+wird hier das Komma \code{,} verwendet. Sie können aber eine beliebige andere
+Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@=
+sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen
+Trennsymbole nicht die gleichen Zeichen zu verwenden.
\begin{beschreibung}
\option{list-input-sep}{<separator>} Default = \code{,}
\option{sub-input-sep}{<separator>} Default = \code{,}
@@ -810,14 +1055,16 @@ Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Def
\cmpdsetup{list-input-sep = ;}
\cmpd{a; b; f.two; k}
\end{beispiel}
-Das ermöglicht Ihnen \zB, IUPAC-Namen als Label-Namen zu verwenden\footnote{Vielen Dank an Christina Lüdigk, die dieses Feature in gewisser Weise vorgeschlagen hat.}.
+Das ermöglicht Ihnen \zB, IUPAC-Namen als Label-Namen zu verwenden\footnote{Vielen
+Dank an Christina Lüdigk, die dieses Feature in gewisser Weise vorgeschlagen hat.}.
\begin{beispiel}
\cmpdsetup{list-input-sep=;}
\cmpd{1,3-dichlorocyclohexanol}
\end{beispiel}
\subsubsection{Bei Listen -- Ausgabe}\label{sssec:list-output-sep}\index{Trennzeichen!Listen!Output}
-Auch bei Listen lässt sich ein Trennsymbol festlegen, das bestimmt, wie einzelne Label voneinander getrennt werden. Per Default ist das das Komma.
+Auch bei Listen lässt sich ein Trennsymbol festlegen, das bestimmt, wie einzelne
+Label voneinander getrennt werden. Per Default ist das das Komma.
\begin{beschreibung}
\option{list-output-sep}{<separator>} Default = \code{,}
\option{sub-output-sep}{<separator>} Default = \code{,}
@@ -831,7 +1078,9 @@ Auch bei Listen lässt sich ein Trennsymbol festlegen, das bestimmt, wie einzeln
\end{beispiel}
\subsubsection{Bei Listen -- letzter Trenner}\label{sssec:last-sep}\index{Trennzeichen!Listen!letzter Trenner}
-Der letzte Trenner bei Listen, derjenige zwischen dem vorletzten und letzten aufgelisteten Label, ist ein besonderer Fall. Hierfür gibt es zwei Optionen, mit dem er angepasst werden kann.
+Der letzte Trenner bei Listen, derjenige zwischen dem vorletzten und letzten
+aufgelisteten Label, ist ein besonderer Fall. Hierfür gibt es zwei Optionen, mit
+dem er angepasst werden kann.
\begin{beschreibung}
\Option{list-last-sep}{<separator>}
\option{list-lang}{US/GB/DE/FR/ES/IT} Default = \code{US}
@@ -844,7 +1093,9 @@ Der letzte Trenner bei Listen, derjenige zwischen dem vorletzten und letzten auf
\cmpd[list-lang = ES]{a, b, f.two, k} \cmpd[list-lang = ES]{a, b}\\
\cmpd[list-lang = IT]{a, b, f.two, k} \cmpd[list-lang = IT]{a, b}
\end{beispiel}
-Wie Sie sehen, verwendet die Spracheinstellung \verb=US= per Default das Harvard-Komma, alle anderen Sprachen verwenden es nicht. Mehr zur Sprach-Unterstützung und zum Harvard-Komma finden Sie in Abschnitt~\ref{sec:language_support}.
+Wie Sie sehen, verwendet die Spracheinstellung \verb=US= per Default das Harvard-Komma,
+alle anderen Sprachen verwenden es nicht. Mehr zur Sprach-Unterstützung und zum
+Harvard-Komma finden Sie in Abschnitt~\ref{sec:language_support}.
Sie können den letzten Trenner mit \key{list-last-sep} auch individuell festlegen.
\begin{beispiel}
@@ -855,7 +1106,8 @@ Sie können den letzten Trenner mit \key{list-last-sep} auch individuell festleg
\cmpd[list-last-sep = empty]{a, b, f.two, k}
\end{beispiel}
-Eine spezielle Option ist \key{list-last-sep}{empty}. Wird er verwendet, wird überall der Trenner eingesetzt, der mit \key{list-output-sep} festgelegt wurde.
+Eine spezielle Option ist \key{list-last-sep}{empty}. Wird er verwendet, wird
+überall der Trenner eingesetzt, der mit \key{list-output-sep} festgelegt wurde.
\begin{beispiel}
\cmpdsetup{list-last-sep = empty}%
\cmpd{a, b, f.two, k}\\
@@ -864,13 +1116,17 @@ Eine spezielle Option ist \key{list-last-sep}{empty}. Wird er verwendet, wird ü
\end{beispiel}
\subsubsection{Bei \code{\textbackslash\textcolor{code}{cmpdinit}} -- Eingabe}\label{sssec:init-input-sep}\index{Trennzeichen!cmpdinit@\textcolor{code}{\code{\textbackslash cmpdinit}}}
-Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Default wird hier das Komma \code{,} verwendet. Sie können aber eine beliebige andere Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@= sollten Sie nicht verwenden.
+Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Default
+wird hier das Komma \code{,} verwendet. Sie können aber eine beliebige andere
+Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \verb=@=
+sollten Sie nicht verwenden.
\begin{beschreibung}
\option{init-input-sep}{<separator>} Default = \code{,}
\end{beschreibung}
\subsubsection{Ein Beispiel}\label{sssec:input-sep-bsp}
-Im folgenden sehen Sie ein kleines Beispiel, wie eine personalisierte Variante der Trennzeichen aussehen könnte.
+Im folgenden sehen Sie ein kleines Beispiel, wie eine personalisierte Variante
+der Trennzeichen aussehen könnte.
\begin{beispiel}
\cmpdsetup{
sub-input-sep = ! ,
@@ -884,7 +1140,12 @@ Im folgenden sehen Sie ein kleines Beispiel, wie eine personalisierte Variante d
\section{Sprachunterstützung}\label{sec:language_support}\secidx{Sprachunterstützung}
\subsection{Zusammenarbeit mit \textsf{babel}}
-\chemnum unterstützt die Sprachauswahl durch das \paket{babel}-Paket für eine Reihe von Sprachen. Dies geschieht mit Hilfe des \paket*{translator} Pakets, falls es vorhanden ist. Kann \paket*{translator} nicht geladen werden, muss die Sprachunterstützung von Hand vorgenommen werden, siehe Abschnitt~\ref{sssec:last-sep}. Die Einstellung von Hand funktioniert natürlich auch, wenn \paket*{translator} geladen wurde.
+\chemnum unterstützt die Sprachauswahl durch das \paket{babel}-Paket für eine
+Reihe von Sprachen. Dies geschieht mit Hilfe des \paket*{translator} Pakets, falls
+es vorhanden ist. Kann \paket*{translator} nicht geladen werden, muss die
+Sprachunterstützung von Hand vorgenommen werden, siehe Abschnitt~\ref{sssec:last-sep}.
+Die Einstellung von Hand funktioniert natürlich auch, wenn \paket*{translator}
+geladen wurde.
\begin{beispiel}
\selectlanguage{ngerman}DE: \cmpd{r,s,t} \selectlanguage{german}\cmpd{r,s,t}\\
\selectlanguage{naustrian}AU: \cmpd{r,s,t} \selectlanguage{austrian}\cmpd{r,s,t}\\
@@ -897,16 +1158,37 @@ Im folgenden sehen Sie ein kleines Beispiel, wie eine personalisierte Variante d
\selectlanguage{spanish}ES: \cmpd{r,s,t}\\
\selectlanguage{italian}IT: \cmpd{r,s,t}
\end{beispiel}
-Bei weitem nicht alle Sprachen werden unterstützt, schon allein aus Machbarkeitsgründen. Falls Ihnen eine Sprache fehlen sollte, senden Sie mir bitte eine E-Mail\footnote{\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}} mit der dazugehörigen \paket{babel} Option und der richtigen Übersetzung, und ich werde sie gerne hinzufügen.
+Bei weitem nicht alle Sprachen werden unterstützt, schon allein aus Machbarkeitsgründen.
+Falls Ihnen eine Sprache fehlen sollte, senden Sie mir bitte eine
+E-Mail\footnote{\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}} mit
+der dazugehörigen \paket{babel} Option und der richtigen Übersetzung, und ich
+werde sie gerne hinzufügen.
\subsection{Harvard-Komma}\label{ssec:harvard-comma}\secidx{Harvard-Komma}
-Im US-Amerikanischen ist die Verwendung des sogenannten Harvard- oder Oxford-Kommas weit verbreitet, im Britischen und in anderen europäischen Sprachen ist sie eher unüblich.
+Im US-Amerikanischen ist die Verwendung des sogenannten Harvard- oder Oxford-Kommas
+weit verbreitet, im Britischen und in anderen europäischen Sprachen ist sie eher
+unüblich.
\begin{zitat}[\href{http://en.wikipedia.org/wiki/Serial_comma}{\protect\Wikipedia}, 2011/11/07]
- The serial comma (also known as the Oxford comma or Harvard comma, and sometimes referred to as the series comma) is the comma used immediately before a coordinating conjunction (usually and or or, and sometimes nor) preceding the final item in a list of three or more items. For example, a list of three countries can be punctuated as either "Portugal, Spain, and France" (with the serial comma) or as "Portugal, Spain and France" (without the serial comma).
-
- Opinions vary among writers and editors on the usage or avoidance of the serial comma. In American English, the serial comma is standard usage in non-journalistic writing that follows the \name{Chicago Manual of Style}. Journalists, however, usually follow the AP Stylebook, which advises against it. It is used less often in British English, where it is standard usage to leave it out, with some notable exceptions such as \name{Fowler's Modern English Usage}. In many languages (e.g., French, German, Italian, Polish, Spanish), the serial comma is not the norm and may even go against punctuation rules. It may be recommended in many cases, however, to avoid ambiguity or to aid prosody.
+ The serial comma (also known as the Oxford comma or Harvard comma, and sometimes
+ referred to as the series comma) is the comma used immediately before a coordinating
+ conjunction (usually and or or, and sometimes nor) preceding the final item in
+ a list of three or more items. For example, a list of three countries can be
+ punctuated as either "Portugal, Spain, and France" (with the serial comma) or
+ as "Portugal, Spain and France" (without the serial comma).
+
+ Opinions vary among writers and editors on the usage or avoidance of the serial
+ comma. In American English, the serial comma is standard usage in non-journalistic
+ writing that follows the \name{Chicago Manual of Style}. Journalists, however,
+ usually follow the AP Stylebook, which advises against it. It is used less often
+ in British English, where it is standard usage to leave it out, with some notable
+ exceptions such as \name{Fowler's Modern English Usage}. In many languages (e.g.,
+ French, German, Italian, Polish, Spanish), the serial comma is not the norm and
+ may even go against punctuation rules. It may be recommended in many cases, however,
+ to avoid ambiguity or to aid prosody.
\end{zitat}
-\chemnum verwendet das Harvard-Komma bei der Verwendung von American English, nicht aber bei anderen Sprachen. Sie haben jedoch die Möglichkeit, das Harvard-Komma mit der Option
+\chemnum verwendet das Harvard-Komma bei der Verwendung von American English, nicht
+aber bei anderen Sprachen. Sie haben jedoch die Möglichkeit, das Harvard-Komma mit
+der Option
\begin{beschreibung}
\Option{list-serial-comma}{\default{true}/false}
\end{beschreibung}
@@ -915,7 +1197,9 @@ nach Belieben zu (De-)Aktivieren.
\selectlanguage{ngerman}DE: \cmpd[list-serial-comma]{r,s,t} vs. \cmpd{r,s,t}\\
\selectlanguage{american}US: \cmpd[list-serial-comma=false]{r,s,t} vs. \cmpd{r,s,t}
\end{beispiel}
-Wenn Sie die Spracheinstellung manuell vornehmen, beachten Sie, dass dabei auf die Voreinstellung der Sprache zurückgesetzt wird. Daher sollte \key{list-serial-comma} \emph{nach} \key{list-lang} verwendet werden.
+Wenn Sie die Spracheinstellung manuell vornehmen, beachten Sie, dass dabei auf
+die Voreinstellung der Sprache zurückgesetzt wird. Daher sollte \key{list-serial-comma}
+\emph{nach} \key{list-lang} verwendet werden.
\begin{beispiel}
falsch: \cmpdsetup{list-serial-comma=false, list-lang=US}\cmpd{r,s,t}\\
richtig: \cmpdsetup{list-lang=US, list-serial-comma=false}\cmpd{r,s,t}
@@ -935,7 +1219,7 @@ Im folgenden sind alle verfügbaren Optionen aufgelistet.
cmpd-style & & & macro \\
cmpd-weight & bold & bold & choice \\
cmpd-label & & & literal \\
- cmpd-delim\color{black}$^\mathrm{a}$ & () & & literal \\
+ cmpd-delim\color{black}$^\mathrm{a}$ & () & & literal \\
cmpd-odelim & & & literal \\
cmpd-cdelim & & & literal \\
cmpd-prefix & & & literal \\
@@ -980,27 +1264,39 @@ Im folgenden sind alle verfügbaren Optionen aufgelistet.
\end{center}
\subsection{Befehle}
-Im folgenden werden alle von \chemnum definierten Befehle und deren Varianten aufgelistet.
+Im folgenden werden alle von \chemnum definierten Befehle und deren Varianten
+aufgelistet.
\begin{center}
\label{tab:commands}
\begin{longtabu*} to \linewidth {X[l]X[p]}\toprule
\bfseries Befehl & \bfseries Beschreibung \tabularnewline\midrule
- \cmd*{cmpd}[<keyval>]{<labels>} & Hauptbefehl, erzeugt und schreibt Label oder Liste von Labeln, siehe Seite \pageref{sec:nummerieren}ff. \tabularnewline
- \cmd*[cmpda]{cmpd*}{<labels>} & unsichtbar, erzeugt Label, siehe Seite \pageref{cmd:unsichtbares_label} \tabularnewline
- \cmd*[cmpdc]{cmpd-}[<keyval>]{<labels>} & ohne Begrenzer, siehe Seite \pageref{cmd:ohne_begrenzer} \tabularnewline
- \cmd*[cmpdd]{cmpd+-}[<keyval>]{<labels>} & Label wird aus Hilfsdatei gelesen, siehe Seite \pageref{cmd:cmpd_plus} \tabularnewline\midrule
- \cmd*{cmpdinit}[<keyval]{<labels>} & Label initialisieren und erzeugen, siehe Seite \pageref{sec:cmpdinit}f. \tabularnewline
- \cmd*[cmpdinita]{cmpdinit*}[<keyval]{<labels>} & Label initialisieren, siehe Seite \pageref{sec:cmpdinit}f. \tabularnewline\midrule
- \cmd*{cmpdref}[<keyval>][<marker>]{} & temporäre Label in \texttt{eps}-Dateien durch Label ersetzen, siehe Seite \pageref{ssec:cmpdref} \tabularnewline
- \cmd*[cmpdrefc]{cmpdref-}[<keyval>][<marker>]{} & temporäre Label in \texttt{eps}-Dateien durch Label ohne Begrenzer ersetzen, siehe Seite \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule
- \cmd*{cmpdreset}[<num>] & Zähler zurücksetzen, siehe Seite \pageref{sec:cmpdreset} \tabularnewline\midrule
- \cmd*{cmpdsetup}{<keyval>} & \chemnum einstellen, siehe Seite \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule
+ \cmd*{cmpd}[<keyval>]{<labels>} & Hauptbefehl, erzeugt und
+ schreibt Label oder Liste von Labeln, siehe Seite \pageref{sec:nummerieren}ff. \tabularnewline
+ \cmd*[cmpda]{cmpd*}{<labels>} & unsichtbar, erzeugt Label,
+ siehe Seite \pageref{cmd:unsichtbares_label} \tabularnewline
+ \cmd*[cmpdc]{cmpd-}[<keyval>]{<labels>} & ohne Begrenzer, siehe
+ Seite \pageref{cmd:ohne_begrenzer} \tabularnewline
+ \cmd*[cmpdd]{cmpd+-}[<keyval>]{<labels>} & Label wird aus Hilfsdatei gelesen,
+ siehe Seite \pageref{cmd:cmpd_plus} \tabularnewline\midrule
+ \cmd*{cmpdinit}[<keyval]{<labels>} & Label initialisieren und erzeugen,
+ siehe Seite \pageref{sec:cmpdinit}f. \tabularnewline
+ \cmd*[cmpdinita]{cmpdinit*}[<keyval]{<labels>} & Label initialisieren, siehe
+ Seite \pageref{sec:cmpdinit}f. \tabularnewline\midrule
+ \cmd*{cmpdref}[<keyval>][<marker>]{} & temporäre Label in \code{eps}-Dateien
+ durch Label ersetzen, siehe Seite \pageref{ssec:cmpdref} \tabularnewline
+ \cmd*[cmpdrefc]{cmpdref-}[<keyval>][<marker>]{} & temporäre Label in \code{eps}-Dateien
+ durch Label ohne Begrenzer ersetzen, siehe Seite \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule
+ \cmd*{cmpdreset}[<num>] & Zähler zurücksetzen, siehe
+ Seite \pageref{sec:cmpdreset} \tabularnewline\midrule
+ \cmd*{cmpdsetup}{<keyval>} & \chemnum einstellen, siehe
+ Seite \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule
\end{longtabu*}%
\end{center}
\appendix
\addsec{Dank}
-Ich möchte Joseph \name{Wright} und Russell \name{Hewitt} danken, die mir wertvolle Vorschläge und Feedback gaben, um \chemnum zu verbessern.
+Ich möchte Joseph \name{Wright} und Russell \name{Hewitt} danken, die mir wertvolle
+Vorschläge und Feedback gaben, um \chemnum zu verbessern.
\printindex
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf
index b179779c904..ed0609e1a49 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
index fc6c9ff3f04..61e4700dcf8 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
@@ -106,15 +106,25 @@
\selectlanguage{english}\cmpdreset
\section{A very short readme}
-\chemnum \CNversion\ underlies the \LaTeX\ Project Public License Version 1.3 or later. (\url{http://www.latex-project.org/lppl.txt})
+\chemnum \CNversion\ underlies the \LaTeX\ Project Public License Version 1.3 or
+later. (\url{http://www.latex-project.org/lppl.txt})
-\chemnum internally loads the packages \paket*{expl3} and \paket{xparse}. \paket{xparse} is part of the \paket{l3packages} bundle, \paket*{expl3} is part of the \paket{l3kernel} bundle. This means, \chemnum needs \LaTeX3 Support.
+\chemnum internally loads the packages \paket*{expl3} and \paket{xparse}.
+\paket{xparse} is part of the \paket{l3packages} bundle, \paket*{expl3} is part
+of the \paket{l3kernel} bundle. This means, \chemnum needs \LaTeX3 Support.
-\chemnum also needs the packages \paket{etoolbox}, \paket{psfrag} and either \paket{textgreek} or \paket{bm}, see section~\ref{sec:package_options}.
+\chemnum also needs the packages \paket{etoolbox}, \paket{psfrag} and either
+\paket{textgreek} or \paket{bm}, see section~\ref{sec:package_options}.
\section{News and a word of apology}
\subsection{Version 0.4}
-In the update to v0.4 there have been some changes made with the options. There are a few new ones and some of the old ones got new names. They now have consistent names which in my opinion better reflect their function. This means that your documents set with an older version of \chemnum might not compile any more without errors. I am sorry for that. \chemnum still is actively developped. Once it reaches v1.0, such changes won't be made any more\footnote{Or only in absolutely necessary cases.}.
+In the update to v0.4 there have been some changes made with the options. There
+are a few new ones and some of the old ones got new names. They now have consistent
+names which in my opinion better reflect their function. This means that your
+documents set with an older version of \chemnum might not compile any more without
+errors. I am sorry for that. \chemnum still is actively developped. Once it reaches
+v1.0, such changes won't be made any more\footnote{Or only in absolutely necessary
+cases.}.
These options have new names:
\begin{center}
@@ -132,24 +142,32 @@ These ones are new:
\begin{center}
\begin{tabular}{ll}\toprule
\bfseries key & \bfseries short info \\\midrule
- \key{sublist-output-sep} & list separation in the output of labels like \cmpd{bsp.{one,two}}, see page \pageref{sssec:list-output-sep}. \\
- \key{sublist-input-sep} & list separation in the input of labels like \cmpd{bsp.{one,two}}, see page \pageref{sssec:list-input-sep}. \\
+ \key{sublist-output-sep} & list separation in the output of labels like
+ \cmpd{bsp.{one,two}}, see page \pageref{sssec:list-output-sep}. \\
+ \key{sublist-input-sep} & list separation in the input of labels like
+ \cmpd{bsp.{one,two}}, see page \pageref{sssec:list-input-sep}. \\
\key{init-input-sep} & input in \cmd{cmpdinit}, see page \pageref{sssec:init-input-sep}. \\
\key{hyper-use} & usage of hyperlinks, see page \pageref{sec:hyperref}. \\
\key{hyper-target} & \\
\key{hyper-link} & \\
- \key{ref-style} & Output of labels with \cmd{cmpdref}, see pages \pageref{ssec:cmpdref} and \pageref{ssec:schriftstil}. \\\bottomrule
+ \key{ref-style} & Output of labels with \cmd{cmpdref}, see
+ pages \pageref{ssec:cmpdref} and \pageref{ssec:schriftstil}. \\\bottomrule
\end{tabular}
\end{center}
-Also new is the way how lists and ranges of sublabels are input. The option \key{sub-list} no longer exists. More on this in section~\ref{ssec:sub_ranges}.
+Also new is the way how lists and ranges of sublabels are input. The option
+\key{sub-list} no longer exists. More on this in section~\ref{ssec:sub_ranges}.
-Then there is the possibility of creating hyperlinked labels together with the package \paket{hyperref}, see section~\ref{sec:hyperref}.
+Then there is the possibility of creating hyperlinked labels together with the
+package \paket{hyperref}, see section~\ref{sec:hyperref}.
\subsection{Version 0.5}
-With v0.5 there is a new option \key{ref-pos} which allows to change the positioning options of the \cmd{psfrag} command that is used by the \cmd{cmpdref} command internally, see p.\,\pageref{ssec:marker_in_bildern}.
+With v0.5 there is a new option \key{ref-pos} which allows to change the positioning
+options of the \cmd{psfrag} command that is used by the \cmd{cmpdref} command
+internally, see p.\,\pageref{ssec:marker_in_bildern}.
-\achtung{The optional arguments of \cmd{cmpdref} have changed their order, see p.\,\pageref{ssec:cmpdref}!}
+\achtung{The optional arguments of \cmd{cmpdref} have changed their order, see
+p.\,\pageref{ssec:cmpdref}!}
\section{Package options}\label{sec:package_options}\secidx{Package options}
\chemnum has one package option.
@@ -160,29 +178,56 @@ This document was set with \verb+\usepackage[textgreek]{chemnum}+.
\secidx*{Package options}
\section{Motivation}
-As far as I know there are three packages that are meant to help with numbering chemical compounds. All of them have their weaknesses.
+As far as I know there are three packages that are meant to help with numbering
+chemical compounds. All of them have their weaknesses.
-The first one -- \paket{chemcono} -- redefined bibliography commands for that purpose. Compounds have to be declared in what is called \verb=\theffbibliography=. Then one can reference them with \verb=\fcite=. However, it produces a list of compounds in the text. So the package author suggests:
+The first one -- \paket{chemcono} -- redefined bibliography commands for that
+purpose. Compounds have to be declared in what is called \verb=\theffbibliography=.
+Then one can reference them with \verb=\fcite=. However, it produces a list of
+compounds in the text. So the package author suggests:
\begin{zitat}[Stefan Schulz]
After compilation and printout, discard the last page.
\end{zitat}
Obviously that's not a perfect solution.
-The second one -- \paket{chemcompounds} -- was written, because the author didn't want to work with the weaknesses of \paket{chemcono} any more. When he wrote the package he basically used the same mechanism to create the labels as \paket{chemcono} did.
+The second one -- \paket{chemcompounds} -- was written, because the author didn't
+want to work with the weaknesses of \paket{chemcono} any more. When he wrote the
+package he basically used the same mechanism to create the labels as \paket{chemcono}
+did.
\begin{zitat}[Stephan Schenk]
- When taking a closer look at the chemcono package, I realised that the only thing one has to do is to get rid of everything which produces text. Thus, as a basis I used the mechanism of \verb=\bibitem= and \verb=\cite= in pretty much the same way as \paket{chemcono} does by extracting the corresponding code from \verb=article.cls= and \verb=latex.ltx= but deleting any unnecessary commands producing output. I also introduced several lines of code to make the printing of the compound names more customisable.
+ When taking a closer look at the chemcono package, I realised that the only thing
+ one has to do is to get rid of everything which produces text. Thus, as a basis I
+ used the mechanism of \verb=\bibitem= and \verb=\cite= in pretty much the same way
+ as \paket{chemcono} does by extracting the corresponding code from \verb=article.cls=
+ and \verb=latex.ltx= but deleting any unnecessary commands producing output. I
+ also introduced several lines of code to make the printing of the compound names
+ more customisable.
\end{zitat}
Some points still left me unsatisfied, though:
\begin{enumerate}
- \item Compounds usually need to be declared with \verb=\declarecompound=. They need to be declared in any case if you need a label like \cmpd{bsp.one}. Then, one even needs to choose the label by hand, what somehow undermines the automatic numbering principle.
+ \item Compounds usually need to be declared with \verb=\declarecompound=. They
+ need to be declared in any case if you need a label like \cmpd{bsp.one}. Then,
+ one even needs to choose the label by hand, what somehow undermines the automatic
+ numbering principle.
\item The layout can't be changed for a single label but only for all.
- \item The numbers can't be reset. \emph{Although in most cases this is neither necessary nor can it be recommended}, there can be individual cases where this would be useful.
- \item A list of several compounds \verb=\compound{a,b,c}= can only be customized with more effort than what would be convenient.
+ \item The numbers can't be reset. \emph{Although in most cases this is neither
+ necessary nor can it be recommended}, there can be individual cases where this
+ would be useful.
+ \item A list of several compounds \verb=\compound{a,b,c}= can only be customized
+ with more effort than what would be convenient.
\end{enumerate}
-Then there is \paket{bpchem}, which provides commands similar to \verb=\label= \verb=\ref=: \verb=\CNlabel{}=, \verb=\CNlabelnoref{}= and \verb=\CNref{}=. It provides commands for sublabels, too: \verb=\CNlabelsub{}{}=, \verb=\CNlabelsubnoref{}{}= and \verb=\CNrefsub{}{}=. This makes it more flexible than the others regarding sublabels. However, it barely provides possibilities to customize the labels, lists are not possible and the fact that there are different commands for labels and sublabels isn't the best solution, either.
+Then there is \paket{bpchem}, which provides commands similar to \verb=\label=
+\verb=\ref=: \verb=\CNlabel{}=, \verb=\CNlabelnoref{}= and \verb=\CNref{}=. It
+provides commands for sublabels, too: \verb=\CNlabelsub{}{}=, \verb=\CNlabelsubnoref{}{}=
+and \verb=\CNrefsub{}{}=. This makes it more flexible than the others regarding sublabels.
+However, it barely provides possibilities to customize the labels, lists are not
+possible and the fact that there are different commands for labels and sublabels
+isn't the best solution, either.
-\chemnum is intended to fill these gaps. For this all commands have been written from scratch. Some of the ideas of \paket{chemcompounds} \eg regarding delimiters and layout have been picked up, though.
+\chemnum is intended to fill these gaps. For this all commands have been written
+from scratch. Some of the ideas of \paket{chemcompounds} \eg regarding delimiters
+and layout have been picked up, though.
If you notice any feature missing, please let me know by sending me an email.
@@ -192,29 +237,41 @@ The main command of this package is this one:
\begin{beschreibung}
\Befehl{cmpd}{<label name>}
\end{beschreibung}
-When \code{<label name>} is used the first time, the label is created, saved (= declared) and printed. Each further use just prints the label.
+When \code{<label name>} is used the first time, the label is created, saved (=
+declared) and printed. Each further use just prints the label.
\begin{beispiel}
- Compounds \cmpd{a} and \cmpd{b} are declared and can be used any time: \cmpd{a}. No pre-declaring is necessary. Compounds like \cmpd{c} are numbered in the order they appear in the text.\par
+ Compounds \cmpd{a} and \cmpd{b} are declared and can be used any time: \cmpd{a}.
+ No pre-declaring is necessary. Compounds like \cmpd{c} are numbered in the order
+ they appear in the text.\par
Once again: \cmpd{b}, \cmpd{a}, \cmpd{c}.
\end{beispiel}
-If it is necessary to declare a compound without printing the label, this is possible with
+If it is necessary to declare a compound without printing the label, this is
+possible with
\begin{beschreibung}
\Befehl[cmpda]{cmpd*}\ma{<label name>}\label{cmd:unsichtbares_label}
\end{beschreibung}
This declares the label but doesn't print anything.
-\achtung{This command is not needed when \cmd{cmpdinit} is used, see section~\ref{sec:cmpdinit} (pages~\pageref{sec:cmpdinit}ff).}
+\achtung{This command is not needed when \cmd{cmpdinit} is used, see
+section~\ref{sec:cmpdinit} (pages~\pageref{sec:cmpdinit}ff).}
\begin{beispiel}
- The hidden version\cmpd*{d} declares the label but doesn't print anything. The next \cmpd{e} continues to count with the next number. With \cmpd{d} the label can be used, of course.
+ The hidden version\cmpd*{d} declares the label but doesn't print anything. The
+ next \cmpd{e} continues to count with the next number. With \cmpd{d} the label
+ can be used, of course.
\end{beispiel}
-You can pretty much use what you like for a label name except for the separator symbols (see sections~\ref{ssec:unterlabel}, \ref{ssec:listen}, \ref{ssec:sub_ranges} and \ref{ssec:trenner}). You shouldn't leave blanks in the name, though. This may not cause an error at all, but \emph{could} declare different compounds with the same name.
+You can pretty much use what you like for a label name except for the separator
+symbols (see sections~\ref{ssec:unterlabel}, \ref{ssec:listen}, \ref{ssec:sub_ranges}
+and \ref{ssec:trenner}). You shouldn't leave blanks in the name, though. This may
+not cause an error at all, but \emph{could} declare different compounds with the
+same name.
\lstset{showspaces=true}
\begin{beispiel}
- \cmpd{aa }, \cmpd{a a }, \cmpd{a a}, \cmpd{ a a}, \cmpd{ aa} and \cmpd{ aa } all have the same label. As well as \cmpd{aa }, \cmpd{a a}, \cmpd{ aa} and \cmpd{aa}.
+ \cmpd{aa }, \cmpd{a a }, \cmpd{a a}, \cmpd{ a a}, \cmpd{ aa} and \cmpd{ aa }
+ all have the same label. As well as \cmpd{aa }, \cmpd{a a}, \cmpd{ aa} and \cmpd{aa}.
\end{beispiel}
\lstset{showspaces=false}\secidx*{Main command}
@@ -223,9 +280,13 @@ If you want a label like \cmpd{a.one}, you need to use the following syntax:
\begin{beschreibung}
\Befehl{cmpd}{<label name>.<subname>}
\end{beschreibung}
-\code{<label name>} is the main name which stays the same, \code{<subname>} varies. This syntax means that the point \code{.} \emph{cannot} be a part of \code{<label name>} or \code{<subname>}. Instead of the point you also can use another symbol, see section~\ref{sssec:sub-input-sep}.
+\code{<label name>} is the main name which stays the same, \code{<subname>} varies.
+This syntax means that the point \code{.} \emph{cannot} be a part of \code{<label name>}
+or \code{<subname>}. Instead of the point you also can use another symbol, see
+section~\ref{sssec:sub-input-sep}.
\begin{beispiel}
- \cmpd{f.one} and \cmpd{f.two} are related, as are \cmpd{g.one} and \cmpd{g.two}. Of course, these labels can be used again: \cmpd{g.two} and \cmpd{f.one}.
+ \cmpd{f.one} and \cmpd{f.two} are related, as are \cmpd{g.one} and \cmpd{g.two}.
+ Of course, these labels can be used again: \cmpd{g.two} and \cmpd{f.one}.
\end{beispiel}
This also works, if the main name has already been used.
@@ -238,7 +299,8 @@ The same way the main name of combined labels can be used solely.
\cmpd{f} and \cmpd{g}
\end{beispiel}
-How you can create a label like \cmpd{f.{one,two}} is explained in section~\ref{ssec:sub_ranges}.
+How you can create a label like \cmpd{f.{one,two}} is explained in
+section~\ref{ssec:sub_ranges}.
\secidx*{Sublabel}
\subsection{Lists}\label{ssec:listen}\secidx{Lists}
@@ -248,34 +310,48 @@ The right description would be something like:
\begin{beschreibung}
\Befehl{cmpd}{<(possibly comma separated list of) label name(s)>}
\end{beschreibung}
-This means that with default settings the comma can't be part of the label name unless hidden in braces. You can change that, see section~\ref{sssec:list-input-sep} on page~\pageref{sssec:list-input-sep}. Section~\ref{sssec:input-sep-bsp} shows an example how a changed input could look like.
+This means that with default settings the comma can't be part of the label name
+unless hidden in braces. You can change that, see section~\ref{sssec:list-input-sep}
+on page~\pageref{sssec:list-input-sep}. Section~\ref{sssec:input-sep-bsp} shows
+an example how a changed input could look like.
\begin{beispiel}
- More than one label can be put inside \verb=\cmpd=, separated by commas. Then a list like \cmpd{a, b, c, e, g.two} is printed.
+ More than one label can be put inside \verb=\cmpd=, separated by commas. Then a
+ list like \cmpd{a, b, c, e, g.two} is printed.
\end{beispiel}
-The Harvard comma (see~\ref{ssec:harvard-comma}) in \code{, and} between \cmpd{e} and \cmpd{g.two} suggests that there are options to customize the list, see sections~\ref{ssec:trenner} and \ref{sec:language_support}.
+The Harvard comma (see~\ref{ssec:harvard-comma}) in \code{, and} between \cmpd{e}
+and \cmpd{g.two} suggests that there are options to customize the list, see
+sections~\ref{ssec:trenner} and \ref{sec:language_support}.
\secidx*{Lists}
\subsection{Lists and ranges of sublabels}\label{ssec:sub_ranges}\index{Sublabel!lists}\index{Sublabel!ranges}
-Sometimes it can be useful to display a label with a list or a range of sublabels. Suppose you have compounds \cmpd{q.one,q.two,q.three,q.four,q.five} which for example differ in their substituents. It can be useful to refer to them all at once: \cmpd[cmpd-all]{q}.
+Sometimes it can be useful to display a label with a list or a range of sublabels.
+Suppose you have compounds \cmpd{q.one,q.two,q.three,q.four,q.five} which for
+example differ in their substituents. It can be useful to refer to them all at
+once: \cmpd[cmpd-all]{q}.
The syntax is rather intuitive -- you just input a list of sublabels:
\begin{beispiel}
list of labels: \cmpd{q.one, q.two, q.three, q.four, q.five}\\
label with list of sublabels: \cmpd{q.{one,two,three,four,five}}
\end{beispiel}
-Since the sublist is input with a comma in the default setting, you have to put them into braces.
+Since the sublist is input with a comma in the default setting, you have to put
+them into braces.
-Using this syntax you also can create ranges of sublabels. As a marker to indicate the range \chemnum uses two points \verb=..=.
+Using this syntax you also can create ranges of sublabels. As a marker to indicate
+the range \chemnum uses two points \verb=..=.
\begin{beispiel}
\cmpd{q.{two..four}}\\
\cmpd{q.{one,three..five}}\\
\cmpd{q.{one..three,five}}
\end{beispiel}
-This means you can neither use the comma nor the two points as part of a sublabel name. How you can use other markers for the input you can read in sections~\ref{sssec:range-input-sep} and \ref{sssec:list-input-sep}.
+This means you can neither use the comma nor the two points as part of a sublabel
+name. How you can use other markers for the input you can read in
+sections~\ref{sssec:range-input-sep} and \ref{sssec:list-input-sep}.
-\chemnum provides an option (see section~\ref{sec:cmpdsetup} for more details), with which all sublabels of a main label can be printed as range.
+\chemnum provides an option (see section~\ref{sec:cmpdsetup} for more details),
+with which all sublabels of a main label can be printed as range.
\begin{beschreibung}
\Option{cmpd-all}{\default{true}/false}
\end{beschreibung}
@@ -283,9 +359,13 @@ This means you can neither use the comma nor the two points as part of a sublabe
\cmpd[cmpd-all]{q}
\end{beispiel}
-In order to get the right sublabels the command needs to know, which sublabels have been declared. This means that they're read from the \verb=\jobname.cmpd= file (supposing your source file is called \verb=\jobname.tex=). So you may need to compile twice (or more) until the labels are printed right.
+In order to get the right sublabels the command needs to know, which sublabels
+have been declared. This means that they're read from the \verb=\jobname.cmpd=
+file (supposing your source file is called \verb=\jobname.tex=). So you may need
+to compile twice (or more) until the labels are printed right.
-If one uses label with sublabel ranges, one might want to use \emph{only} the sublabels in a different place. This is possible with this option:
+If one uses label with sublabel ranges, one might want to use \emph{only} the
+sublabels in a different place. This is possible with this option:
\begin{beschreibung}
\Option{sub-only}{\default{true}/false}
\end{beschreibung}
@@ -302,22 +382,31 @@ If one uses label with sublabel ranges, one might want to use \emph{only} the su
\end{tabular}
\end{beispiel}
-Ranges of sublabels require some care. For one thing one has to know which sublabel is the lower one and which is the higher one. Then one has to know which labels are in between them and what do they represent. As \chemnum can't take care for you, you need to do that for yourself if you want to avoid labels like these:
+Ranges of sublabels require some care. For one thing one has to know which
+sublabel is the lower one and which is the higher one. Then one has to know which
+labels are in between them and what do they represent. As \chemnum can't take care
+for you, you need to do that for yourself if you want to avoid labels like these:
\begin{beispiel}
\cmpd{q.{five..three}} or \cmpd{q.{three,one,four}}.
\end{beispiel}
\section{Initialize labels at once}\label{sec:cmpdinit}\secidx{Initialize labels}
-The commands described in this section are not essential for the usage of \chemnum, but provide additional functionality that some users might find useful.
+The commands described in this section are not essential for the usage of \chemnum,
+but provide additional functionality that some users might find useful.
\subsection{Usage}
\subsubsection{Main labels}
-Perhaps you're missing \paket{chemcompounds}' command \verb=\declarecompound= already. For one thing one has a summary of all used label names. And one may be warned if one uses an uninitialized label name\footnote{for instance due to a typing error}. This behaviour can be realized with these commands:
+Perhaps you're missing \paket{chemcompounds}' command \verb=\declarecompound=
+already. For one thing one has a summary of all used label names. And one may be
+warned if one uses an uninitialized label name\footnote{for instance due to a
+typing error}. This behaviour can be realized with these commands:
\begin{beschreibung}
\Befehl{cmpdinit}{<comma separated list of label names>}
\Befehl[cmpdinita]{cmpdinit*}{<comma separated list of label names>}
\end{beschreibung}
-All compounds set inside \cmd{cmpdinit} are initialized and declared \emph{in the given order}. If one uses a label name that's not in the list, \chemnum produces a warning message.
+All compounds set inside \cmd{cmpdinit} are initialized and declared \emph{in the
+given order}. If one uses a label name that's not in the list, \chemnum produces
+a warning message.
\cmpdreset
\begin{beispiel}
@@ -333,9 +422,11 @@ All compounds set inside \cmd{cmpdinit} are initialized and declared \emph{in th
{}*************************************************
\end{mdframed}
-Please note that for labels with sublabels only the \emph{main name} can and should be initialized. This initializes all compounds with the same main name.
+Please note that for labels with sublabels only the \emph{main name} can and
+should be initialized. This initializes all compounds with the same main name.
-\cmd[cmpdinita]{cmpdinit*} also produces a warning but doesn't declare the labels. They are declared when you first use them in the order of appearance in the text.
+\cmd[cmpdinita]{cmpdinit*} also produces a warning but doesn't declare the labels.
+They are declared when you first use them in the order of appearance in the text.
\cmpdreset
\begin{beispiel}
@@ -351,12 +442,17 @@ Please note that for labels with sublabels only the \emph{main name} can and sho
{}*************************************************
\end{mdframed}
-If you need to use own labels (see page \pageref{ssec:own_labels}) but still want to initialize all labels at once, you should use \cmd[cmpdinita]{cmpdinit*}{}, because then no labels are declared when they're initialized.
+If you need to use own labels (see page \pageref{ssec:own_labels}) but still want
+to initialize all labels at once, you should use \cmd[cmpdinita]{cmpdinit*}{},
+because then no labels are declared when they're initialized.
-This command can be used several times, with or without \verb=*=. A useful way would be a single usage, though, proposedly in the preamble of your document after the \chemnum setup (see section~\ref{sec:cmpdsetup}).
+This command can be used several times, with or without \verb=*=. A useful way
+would be a single usage, though, proposedly in the preamble of your document after
+the \chemnum setup (see section~\ref{sec:cmpdsetup}).
\subsubsection{Sublabels}
-If you'd like a warning for label-sublabel combinations as well, or want to preset their order, you can use
+If you'd like a warning for label-sublabel combinations as well, or want to preset
+their order, you can use
\begin{beschreibung}
\Befehl{cmpdinit}[\key{init-sub}{true}]{<comma separated list of label names>}
\end{beschreibung}
@@ -379,13 +475,16 @@ This will give you a warning in these cases, too.
\end{mdframed}
\subsection{Error instead of warning}
-If you want \chemnum to produce an error instead of a warning when you use an unititialized label name, you can use \cmd{cmpdinit} like this:
+If you want \chemnum to produce an error instead of a warning when you use an
+unititialized label name, you can use \cmd{cmpdinit} like this:
\begin{beschreibung}
\Befehl{cmpdinit}[\key{init-strict}{true}]{<comma separated list ...>}
\end{beschreibung}
-A usage of \key{init-strict}{false} would be the usage without optional argument. Of course the *-version has the same option.
+A usage of \key{init-strict}{false} would be the usage without optional argument.
+Of course the *-version has the same option.
-With \key{init-strict}{true} the \LaTeX\ run will be aborted with a corresponding error message, if a label name is used that hasn't been initialized before.
+With \key{init-strict}{true} the \LaTeX\ run will be aborted with a corresponding
+error message, if a label name is used that hasn't been initialized before.
Of course you can use \cmd{cmpdinit} with both options
\begin{beschreibung}
@@ -394,15 +493,28 @@ Of course you can use \cmd{cmpdinit} with both options
or use \cmd{cmpdsetup}, see section~\ref{sec:cmpdsetup}.
\subsection{Customized input}
-When you're using other tokens for \key{sub-input-sep} (page \pageref{sssec:sub-input-sep}) or \key{sublist-input-sep} (page \pageref{sssec:list-input-sep}), you have to use them with \cmd{cmpdinit} as well.
+When you're using other tokens for \key{sub-input-sep} (page~\pageref{sssec:sub-input-sep})
+or \key{sublist-input-sep} (page~\pageref{sssec:list-input-sep}), you have to
+use them with \cmd{cmpdinit} as well.
-A change of \key{list-input-sep} (page \pageref{sssec:list-input-sep}) doesn't affect \cmd{cmpdinit}. If you want to change the input of \cmd{cmpdinit} you need to use \key{init-input-sep}, see section~\ref{sssec:init-input-sep} on page~\pageref{sssec:init-input-sep}.
+A change of \key{list-input-sep} (page \pageref{sssec:list-input-sep}) doesn't
+affect \cmd{cmpdinit}. If you want to change the input of \cmd{cmpdinit} you need
+to use \key{init-input-sep}, see section~\ref{sssec:init-input-sep} on
+page~\pageref{sssec:init-input-sep}.
\subsection{Why initiate labels?}
-As mentioned in the beginning of this section the initiation of labels is not required. There are two possible reasons, why one would like to use them, anyway.
+As mentioned in the beginning of this section the initiation of labels is not
+required. There are two possible reasons, why one would like to use them, anyway.
\begin{enumerate}
- \item The use of \cmd[cmpdinita]{cmpdinit*} is a way to keep track of which labels you have used and gives you a warning/error message if you use a new one or just have mispelled an existing one. Depending on the number of labels you (have to) use, this can be lots of additional work, though.
- \item The use of \cmd{cmpdinit} does the same thing as \cmd[cmpdinita]{cmpdinit*} \emph{and} declares all the labels in the given order. So if you use it, you won't have to use \cmd[cmpda]{cmpd*} (section~\ref{cmd:unsichtbares_label}) and \cmd[cmpdb]{cmpd+} (section~\ref{cmd:cmpd_plus}). This gives you direct control, which number is given to which compound.
+ \item The use of \cmd[cmpdinita]{cmpdinit*} is a way to keep track of which labels
+ you have used and gives you a warning/error message if you use a new one or just
+ have mispelled an existing one. Depending on the number of labels you (have to)
+ use, this can be lots of additional work, though.
+ \item The use of \cmd{cmpdinit} does the same thing as \cmd[cmpdinita]{cmpdinit*}
+ \emph{and} declares all the labels in the given order. So if you use it, you
+ won't have to use \cmd[cmpda]{cmpd*} (section~\ref{cmd:unsichtbares_label}) and
+ \cmd[cmpdb]{cmpd+} (section~\ref{cmd:cmpd_plus}). This gives you direct control,
+ which number is given to which compound.
\end{enumerate}
\secidx*{Initialize labels}
@@ -411,12 +523,16 @@ With the command
\begin{beschreibung}
\Befehl{cmpdreset}[<number>]
\end{beschreibung}
-it is possible to reset the counter. Without argument it is reset to \verb=1=. So \cmd{cmpdreset} and \cmd{cmpdreset}[1] are the same. Unlike most other \chemnum commands its impact is not only inside the local \TeX\ group but resets the counter globally.
+it is possible to reset the counter. Without argument it is reset to \verb=1=. So
+\cmd{cmpdreset} and \cmd{cmpdreset}[1] are the same. Unlike most other \chemnum
+commands its impact is not only inside the local \TeX\ group but resets the
+counter globally.
\begin{beispiel}
\cmpdreset The numbering starts with 1 again: \cmpd{h, i, j}
\end{beispiel}
-\achtung{You should be careful with how you use this command! Usually it cannot be recommended to reset the counter. Different compounds can get the same label!}
+\achtung{You should be careful with how you use this command! Usually it cannot
+be recommended to reset the counter. Different compounds can get the same label!}
\begin{beispiel}
Same label: \cmpd{a}, \cmpd{h}
@@ -425,25 +541,41 @@ it is possible to reset the counter. Without argument it is reset to \verb=1=. S
\section{Special usage}\secidx{Special usage}
\subsection{Moving arguments -- section titles}
-Using \cmd{cmpd} inside a section title in the first instant doesn't seem to be a problem. This doesn't give any errors and the output looks like expected:
+Using \cmd{cmpd} inside a section title in the first instant doesn't seem to be
+a problem. This doesn't give any errors and the output looks like expected:
\begin{beispiel}[code only]
\section{Compound \cmpd[cmpd-delim]{b}}
\ldots
\end{beispiel}
-However, if you use \verb=\tableofcontents= -- which is rather probable, I guess -- something unwanted happens: because the table of contents is at the beginning of the document, the label is declared in the table of contents instead of at the first appearance in the text. There are two ways to circumvent this:
+However, if you use \verb=\tableofcontents= -- which is rather probable, I
+guess -- something unwanted happens: because the table of contents is at the
+beginning of the document, the label is declared in the table of contents instead
+of at the first appearance in the text. There are two ways to circumvent this:
\begin{enumerate}
- \item You declare your labels in the order you want with \cmd{cmpdinit}{}= (see page \pageref{sec:cmpdinit}) in the preamble or the beginning of the document.
- \item You use \cmd[cmpdb]{cmpd+} to set the label. It will read the label from the file \verb=<jobname>.cmpd= (supposing your main file is called \verb=<jobname>.tex=). This means \emph{at least two}, maybe more \LaTeX\ runs are necessary until all labels are set.
+ \item You declare your labels in the order you want with \cmd{cmpdinit}{}= (see
+ page~\pageref{sec:cmpdinit}) in the preamble or the beginning of the document.
+ \item You use \cmd[cmpdb]{cmpd+} to set the label. It will read the label from
+ the file \verb=<jobname>.cmpd= (supposing your main file is called \verb=<jobname>.tex=).
+ This means \emph{at least two}, maybe more \LaTeX\ runs are necessary until
+ all labels are set.
\end{enumerate}
-The same is true for any other list of moving arguments that is created \emph{before} the actual appearance of the label in the text.
+The same is true for any other list of moving arguments that is created \emph{before}
+the actual appearance of the label in the text.
The command\label{cmd:cmpd_plus}
\begin{beschreibung}
\Befehl[cmpdb]{cmpd+}\ma{<label name>}
\end{beschreibung}
-reads the label name that is to be printed from \verb=\jobname.cmpd=. In a way this is the opposite of \cmd[cmpda]{cmpd*} since it doesn't declare a label but only references and prints it. So in order to use \cmd[cmpdb]{cmpd+}{<label>}, \verb=<label>= must have been declared, either with \cmd{cmpd}{<label>} or with \cmd[cmpda]{cmpd*}{<label>}. It doesn't matter, if this declaration is done before or after the usage of \cmd[cmpdb]{cmpd+}. This command is useful, if the label is used inside a moving argument like in \verb=\section{}=.
+reads the label name that is to be printed from \verb=\jobname.cmpd=. In a way
+this is the opposite of \cmd[cmpda]{cmpd*} since it doesn't declare a label but
+only references and prints it. So in order to use \cmd[cmpdb]{cmpd+}{<label>},
+\verb=<label>= must have been declared, either with \cmd{cmpd}{<label>} or with
+\cmd[cmpda]{cmpd*}{<label>}. It doesn't matter, if this declaration is done before
+or after the usage of \cmd[cmpdb]{cmpd+}. This command is useful, if the label is
+used inside a moving argument like in \verb=\section{}=.
-\achtung{It is not needed when \cmd{cmpdinit} is used, see section~\ref{sec:cmpdinit} (pages~\pageref{sec:cmpdinit}\,ff).}
+\achtung{It is not needed when \cmd{cmpdinit} is used, see section~\ref{sec:cmpdinit}
+(pages~\pageref{sec:cmpdinit}\,ff).}
\begin{beispiel}
\subsubsection{Test section title with compound label \cmpd+[cmpd-delim]{f.one}}
@@ -452,7 +584,9 @@ reads the label name that is to be printed from \verb=\jobname.cmpd=. In a way t
\end{beispiel}
\subsection{Floating environments}\cmpdinit*{float1,float2}
-The usage of \cmd{cmpd} inside a float shouldn't be a problem: labels are declared in the order the floating environment appears in the code. However, to be on the safe side you can of course use \cmd[cmpdb]{cmpd+} here as well.
+The usage of \cmd{cmpd} inside a float shouldn't be a problem: labels are declared
+in the order the floating environment appears in the code. However, to be on the
+safe side you can of course use \cmd[cmpdb]{cmpd+} here as well.
\begin{beispiel}[code and float]
% preamble:
% \usepackage{chemscheme}
@@ -465,17 +599,22 @@ The usage of \cmd{cmpd} inside a float shouldn't be a problem: labels are declar
\end{scheme}
\end{beispiel}
-This also works, of the floating environment is placed before the code, for instance by using the option \verb=[t]=.
+This also works, of the floating environment is placed before the code, for
+instance by using the option \verb=[t]=.
\cmpdinit*{Alc,EtherBr,cpd}
\subsection{Schemes created by external programs}\label{ssec:cmpdref}\secidx{Schemes by external programs}
-If you create your schemes by external programs like for \eg \prog{ChemDraw} or \prog{Marvin\-Sketch}, and want to use \chemnum with them as well, you can use this command:
+If you create your schemes by external programs like for \eg \prog{ChemDraw} or
+\prog{Marvin\-Sketch}, and want to use \chemnum with them as well, you can use
+this command:
\begin{beschreibung}
\Befehl{cmpdref}[<options>]\oa{<tag>}\ma{<label name>}
\end{beschreibung}
\achtung{With v0.5 the order of the optional arguments has changed!}
-This command is inspired by the \verb=\schemeref= command from the package \paket{chemscheme}. It works in a very similar way. You create the scheme and save it with temporary labels as an \verb=eps= file.
+This command is inspired by the \verb=\schemeref= command from the package
+\paket{chemscheme}. It works in a very similar way. You create the scheme and save
+it with temporary labels as an \verb=eps= file.
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
@@ -491,9 +630,16 @@ This command is inspired by the \verb=\schemeref= command from the package \pake
\caption{Scheme with automated labels.}
\end{scheme}
\end{beispiel}
-So you nummerate the compounds with \textsf{TMP1}, \textsf{TMP2} \etc These markers will then be replaced with the corresponding labels. Like \paket{chemscheme} \chemnum uses the \cmd{psfrag} command of the \paket{psfrag} package to do that. This means you have to either compile via \prog{latex}, \prog{dvips}, \prog{ps2pdf}, or for instance use the package \paket{auto-pst-pdf} to be able to use \hologo{pdfLaTeX}. It doesn't work with \hologo{XeLaTeX}, neither probably with \hologo{LuaLaTeX}, the author didn't test that, though.
+So you nummerate the compounds with \textsf{TMP1}, \textsf{TMP2} \etc These markers
+will then be replaced with the corresponding labels. Like \paket{chemscheme} \chemnum
+uses the \cmd{psfrag} command of the \paket{psfrag} package to do that. This means
+you have to either compile via \prog{latex}, \prog{dvips}, \prog{ps2pdf}, or for
+instance use the package \paket{auto-pst-pdf} to be able to use \hologo{pdfLaTeX}.
+It doesn't work with \hologo{XeLaTeX}, neither probably with \hologo{LuaLaTeX},
+the author didn't test that, though.
-In each case it is important that the marker is saved as \emph{text} in the \verb=eps= file.
+In each case it is important that the marker is saved as \emph{text} in the \verb=eps=
+file.
You can customize the labels with the options presented in section~\ref{sec:cmpdsetup}.
\begin{beispiel}[code and float]
@@ -539,44 +685,61 @@ Of course sublabels work in the known way:
\section{Usage with \paket{hyperref}}\label{sec:hyperref}\secidx[Usage with hyperref]{Usage with \textsf{hyperref}}
\subsection{Basics}
-If you are using the package \paket{hyperref} you can make hyperlinked labels in your \prog{pdf}.
+If you are using the package \paket{hyperref} you can make hyperlinked labels in
+your \prog{pdf}.
\begin{beschreibung}
\Option{hyper-use}{\default{true}/false}
\end{beschreibung}
-Setting this option (see section~\ref{sec:cmpdsetup} for more information) to \texttt{true}, the next usage of a label will create a link target and the ones after that will create links to this target. This only works if the label does \emph{not} contain a list or range of sublabels. Also a label set with \cmd[cmpda]{cmpd*} can't be marked as target.
+Setting this option (see section~\ref{sec:cmpdsetup} for more information) to
+\code{true}, the next usage of a label will create a link target and the ones
+after that will create links to this target. This only works if the label does
+\emph{not} contain a list or range of sublabels. Also a label set with \cmd[cmpda]{cmpd*}
+can't be marked as target.
\begin{beispiel}
\cmpdsetup{hyper-use}
- The first time targets are created: \cmpd{a.two,b,c,d,e,f}. Then links are created: \cmpd{a.two,d,e}.
+ The first time targets are created: \cmpd{a.two,b,c,d,e,f}. Then links are created:
+ \cmpd{a.two,d,e}.
- This doesn't work with labels containing a list of sublabels: \cmpd{a,f.{one,two},c}. Since \cmpd{a.two} and \cmpd{a} are different labels they have different link targets.
+ This doesn't work with labels containing a list of sublabels: \cmpd{a,f.{one,two},c}.
+ Since \cmpd{a.two} and \cmpd{a} are different labels they have different link targets.
\end{beispiel}
\subsection{Selected usage}
-Maybe the automated use isn't what you want or need. Maybe is is enough to create a hyperlink in one or two places. This can be achieved with two options:
+Maybe the automated use isn't what you want or need. Maybe is is enough to create
+a hyperlink in one or two places. This can be achieved with two options:
\begin{beschreibung}
\Option{hyper-target}{<link name>}
\Option{hyper-link}{<link name>}
\end{beschreibung}
-With \key{hyper-target} you can set the target. \textbf{Caution}: if you use this option with a list \emph{every} label of the list will get the same link name and \paket{hyperref} will warn you:
+With \key{hyper-target} you can set the target. \textbf{Caution}: if you use this
+option with a list \emph{every} label of the list will get the same link name and
+\paket{hyperref} will warn you:
\begin{mdframed}\ttfamily
- destination with the same identifier (name\{<link name>\}) has been already used, duplicate ignored
+ destination with the same identifier (name\{<link name>\}) has been already used,
+ duplicate ignored
\end{mdframed}
-\key{hyper-link} creates a link for the denominated target. \textbf{Caution}: if you use this option with a list \emph{every} label of the list will refer to the same target.
+\key{hyper-link} creates a link for the denominated target. \textbf{Caution}: if
+you use this option with a list \emph{every} label of the list will refer to the
+same target.
\begin{beispiel}
- Create a link \cmpd[hyper-link=mylink,cmpd-all]{f} but don't forget the corresponding target: \cmpd[hyper-target=mylink,cmpd-all]{f}.
+ Create a link \cmpd[hyper-link=mylink,cmpd-all]{f} but don't forget the
+ corresponding target: \cmpd[hyper-target=mylink,cmpd-all]{f}.
\end{beispiel}
-If you use \key{hyper-link} without the corresponding \key{hyper-target} \paket{hyperref} will issue a warning:
+If you use \key{hyper-link} without the corresponding \key{hyper-target}
+\paket{hyperref} will issue a warning:
\begin{mdframed}\ttfamily
- name\{<link name>\} has been referenced but does not exist, replaced by a fixed one
+ name\{<link name>\} has been referenced but does not exist, replaced by a fixed
+ one
\end{mdframed}
\secidx*[Usage with hyperref]{Usage with \textsf{hyperref}}
\section{Customization}\label{sec:cmpdsetup}
\subsection{The principle}
-\chemnum is customized with a key-value system. They can either be used for all following commands with
+\chemnum is customized with a key-value system. They can either be used for all
+following commands with
\begin{beschreibung}
\Befehl{cmpdsetup}{key1 = value1, key2 = value2}
\end{beschreibung}
@@ -585,9 +748,12 @@ or only for a single command directly with
\Befehl{cmpd}[key1 = value1, key2 = value2]{<label name>}
\end{beschreibung}
-If you use keys without values like \cmd{cmpdsetup}{key1,key2}, default values\label{opt:default} are used. These are \emph{not} necessarily empty are \emph{not} necessarily the default setting of \chemnum.
+If you use keys without values like \cmd{cmpdsetup}{key1,key2}, default values\label{opt:default}
+are used. These are \emph{not} necessarily empty are \emph{not} necessarily the
+default setting of \chemnum.
-The options are divided in to different classes\label{key_classes}, which indicate the scope they're used for. They all follow the form \verb+<class>-option = <value>+:
+The options are divided in to different classes\label{key_classes}, which indicate
+the scope they're used for. They all follow the form \verb+<class>-option = <value>+:
\begin{itemize}
\item \code{cmpd}: These options change the whole label or the main label.
\item \code{sub}, \code{sublist}, \code{subref}: These options have an impact on sublabels.
@@ -616,7 +782,9 @@ you can change the style with which the labels are printed.
\cmpd{a, b, f.two, k}\\ % underlined and in italics
\cmpd[cmpd-weight=normal]{a, b, f.two, k}
\end{beispiel}
-The separate handling of the bold face is because of the greek labels (see section~\ref{ssec:counter}). Depending on the package option \texttt{textgreek}, the bold face must realized differently.
+The separate handling of the bold face is because of the greek labels (see
+section~\ref{ssec:counter}). Depending on the package option \code{textgreek},
+the bold face must realized differently.
\secidx*{Font style}
\subsection{Own labels}\label{ssec:own_labels}\secidx{Own labels}
@@ -627,18 +795,25 @@ With the key
one can choose the label associated with the label name.
\begin{beispiel}
- Own label: \cmpd[cmpd-label = XYZ]{l}; in a list \emph{all new compounds} get this label! \cmpd[cmpd-label = XYZ]{l, a, m}
+ Own label: \cmpd[cmpd-label = XYZ]{l}; in a list \emph{all new compounds} get
+ this label! \cmpd[cmpd-label = XYZ]{l, a, m}
\end{beispiel}
\secidx*{Own labels}
\subsection{Markers in images}\secidx{Markers in images}\label{ssec:marker_in_bildern}
There are several options that affect labels in external images placed with \cmd{cmpdref}.
\begin{beschreibung}
- \option{ref-marker}{<marker>} This changes the default marker that is to be replaced. Default = \code{TMP}
+ \option{ref-marker}{<marker>} This changes the default marker that is to be
+ replaced. Default = \code{TMP}
\option{ref-pos}{\{<tex-pos>\}\{<ps-pos>\}} Default = \code{bb}
- \option{ref-style}{<style>} change the format of the labels in external schemes. Default = \verb=\sffamily=
+ \option{ref-style}{<style>} change the format of the labels in external schemes.
+ Default = \verb=\sffamily=
\end{beschreibung}
-With \key{ref-pos} you can change the default way how \cmd{cmpdref} places the label. The command \cmd{psfrag} that is used internally has two options for that. The first one determines the position of the \TeX-replacement, the second one how it is placed in the box from the marker that is replaced. For details please refer to the documentation of \paket{psfrag}.
+With \key{ref-pos} you can change the default way how \cmd{cmpdref} places the
+label. The command \cmd{psfrag} that is used internally has two options for that.
+The first one determines the position of the \TeX-replacement, the second one how
+it is placed in the box from the marker that is replaced. For details please refer
+to the documentation of \paket{psfrag}.
\secidx*{Markers in images}
\subsection{Counter}\label{ssec:counter}\secidx{Counter}
@@ -671,7 +846,11 @@ Both single labels and whole lists can get delimiters. This is done with the opt
\cmpdsetup{cmpd-delim = ()}
\cmpd{a, b, f.two, k} % in braces
\end{beispiel}
-Please be aware that the default values (see pages \pageref{opt:default} and \pageref{ssec:keys_uebersicht}) of \key{cmpd-delim} and \key{list-delim} and the default setting of \chemnum are \emph{not} the same. By default \chemnum doesn't use delimiters. Also please note that the list delimiters only are used if \cmd{cmpd} contains at least two label names.
+Please be aware that the default values (see pages~\pageref{opt:default} and
+\pageref{ssec:keys_uebersicht}) of \key{cmpd-delim} and \key{list-delim} and the
+default setting of \chemnum are \emph{not} the same. By default \chemnum doesn't
+use delimiters. Also please note that the list delimiters only are used if \cmd{cmpd}
+contains at least two label names.
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
\cmpd[list-delim = {[}{]}]{a, b, f.two, k}\\ % in braces
@@ -680,10 +859,12 @@ Please be aware that the default values (see pages \pageref{opt:default} and \pa
\cmpd{a, b, f.two, k}\\ % in braces
\cmpd{a} % NOT a list!
\end{beispiel}
-If you generally use labels in braces but want to use a single one without braces, you have several possibilities:
+If you generally use labels in braces but want to use a single one without braces,
+you have several possibilities:
\begin{beispiel}
\cmpdsetup{cmpd-delim = ()}
- normally: \cmpd{b}, \cmpd{c}, \cmpd{d.one}, but sometimes so \cmpd[cmpd-delim = ]{e} or so \cmpd-{e}.
+ normally: \cmpd{b}, \cmpd{c}, \cmpd{d.one}, but sometimes so \cmpd[cmpd-delim = ]{e}
+ or so \cmpd-{e}.
\end{beispiel}
With
\begin{beschreibung}\label{cmd:ohne_begrenzer}
@@ -698,18 +879,21 @@ the braces of single labels can easily be removed (but not the ones of a list).
\cmpd-{a, b, f.two, k} % braced once
\end{beispiel}
-Using \cmd{cmpdsetup}{\key{cmpd-delim}{ }} and \cmd{cmpdsetup}{\key{list-delim}{ }} will restore the default behaviour.
+Using \cmd{cmpdsetup}{\key{cmpd-delim}{ }} and \cmd{cmpdsetup}{\key{list-delim}{ }}
+will restore the default behaviour.
\secidx*{Delimiters}
\subsection{Suffix and prefix}\secidx{Suffix and prefix}
-If you want to, you can also add a prefix and/or a suffix to a compound and/or a list.
+If you want to, you can also add a prefix and/or a suffix to a compound and/or a
+list.
\begin{beschreibung}
\Option{cmpd-prefix}{<prefix>}
\Option{cmpd-suffix}{<prefix>}
\Option{list-prefix}{<prefix>}
\Option{list-suffix}{<prefix>}
\end{beschreibung}
-The same rule as for the delimiters applies: list attributes are only used with lists, \ie at least with two items.
+The same rule as for the delimiters applies: list attributes are only used with
+lists, \ie at least with two items.
An example for the label attributes:
\begin{beispiel}
@@ -743,7 +927,10 @@ It can be changed with
\subsection{Separators}\label{ssec:trenner}\secidx{Separators}
\subsubsection{Labels -- input}\label{sssec:sub-input-sep}\index{Separators!labels!input}
-As a default setting \chemnum use the point \code{.} as a marker to separate main labels from sublabels. You can change that as you like. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \verb=@=. Furthermore you should be careful to use different symbols for the other separators (see the next sections).
+As a default setting \chemnum use the point \code{.} as a marker to separate main
+labels from sublabels. You can change that as you like. Tokens you \emph{can't use}
+are \verb=, % #= and \emph{you shouldn't} use \verb=@=. Furthermore you should be
+careful to use different symbols for the other separators (see the next sections).
\begin{beschreibung}
\option{sub-input-sep}{<separator>} Default = \code{.}
\end{beschreibung}
@@ -755,7 +942,12 @@ As a default setting \chemnum use the point \code{.} as a marker to separate mai
\cmpd[sub-input-sep= &]{f&one, g&two}\\
\cmpd[sub-input-sep= *]{f*one, g*two}
\end{beispiel}
-You should -- not only for the sake of consistency -- decide only \emph{once} in the beginning of your document \emph{before} the \verb=\tableofcontents= or in the preamble, which marker you use. Otherwise, the \verb=\tableofcontents= won't know the marker anymore and your labels might be at least displayed wrong in the table of contents. Also you need to setup the marker \emph{before} you use it with \cmd{cmpd} or \cmd{cmpdinit} etc.
+You should -- not only for the sake of consistency -- decide only \emph{once} in
+the beginning of your document \emph{before} the \verb=\tableofcontents= or in
+the preamble, which marker you use. Otherwise, the \verb=\tableofcontents= won't
+know the marker anymore and your labels might be at least displayed wrong in the
+table of contents. Also you need to setup the marker \emph{before} you use it with
+\cmd{cmpd} or \cmd{cmpdinit} etc.
\subsubsection{Labels -- output}\index{Separators!labels!output}
You can separate the labels from the sublabels if you like to.
@@ -771,7 +963,11 @@ You can separate the labels from the sublabels if you like to.
\end{beispiel}
\subsubsection{Sublabels -- input}\label{sssec:range-input-sep}\index{Separators!subabels!input}
-As a default setting \chemnum use two points \code{..} as a marker to detect two sublabels as end and beginning of a range. But you can choose any tokens you like to do that. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \verb=@=. Furthermore you should be careful to use different symbols for the other separators.
+As a default setting \chemnum use two points \code{..} as a marker to detect two
+sublabels as end and beginning of a range. But you can choose any tokens you like
+to do that. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't}
+use \verb=@=. Furthermore you should be careful to use different symbols for the
+other separators.
\begin{beschreibung}
\option{subrange-input-sep}{<separator>} Default = \code{..}
\end{beschreibung}
@@ -782,7 +978,8 @@ As a default setting \chemnum use two points \code{..} as a marker to detect two
\end{beispiel}
\subsubsection{Sublabels -- output}\index{Separators!subabels!output}
-Maybe you don't like the output of \cmpd[cmpd-all]{q} and you want it displayed differently? Then you need this key:
+Maybe you don't like the output of \cmpd[cmpd-all]{q} and you want it displayed
+differently? Then you need this key:
\begin{beschreibung}
\option{subrange-output-sep}{<separator>} Default = \verb|--|
\end{beschreibung}
@@ -793,7 +990,11 @@ Maybe you don't like the output of \cmpd[cmpd-all]{q} and you want it displayed
\end{beispiel}
\subsubsection{Lists -- input}\label{sssec:list-input-sep}\index{Separators!lists!input}
-If you like you can change the list input separator for both main label lists and lists of sublabels. In both cases \chemnum uses the comma \code{,} as default. You can change that as you like. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \verb=@=. Furthermore you should be careful to use different symbols for the other separators.
+If you like you can change the list input separator for both main label lists and
+lists of sublabels. In both cases \chemnum uses the comma \code{,} as default. You
+can change that as you like. Tokens you \emph{can't use} are \verb=, % #= and
+\emph{you shouldn't} use \verb=@=. Furthermore you should be careful to use
+different symbols for the other separators.
\begin{beschreibung}
\option{list-input-sep}{<separator>} Default = \code{,}
\option{sub-input-sep}{<separator>} Default = \code{,}
@@ -805,14 +1006,16 @@ If you like you can change the list input separator for both main label lists an
\cmpdsetup{list-input-sep = ;}
\cmpd{a; b; f.two; k}
\end{beispiel}
-With this you can for example use IUPAC names as label names\footnote{Thanks to Christina L\"udigk who in a way suggested this feature.}.
+With this you can for example use IUPAC names as label names\footnote{Thanks to
+Christina L\"udigk who in a way suggested this feature.}.
\begin{beispiel}
\cmpdsetup{list-input-sep=;}
\cmpd{1,3-dichlorocyclohexanole}
\end{beispiel}
\subsubsection{Lists -- output}\label{sssec:list-output-sep}\index{Separators!lists!output}
-You can change the separator symbol with which lists are printed as well. \chemnum uses the comma for both cases in the default setting.
+You can change the separator symbol with which lists are printed as well. \chemnum
+uses the comma for both cases in the default setting.
\begin{beschreibung}
\option{list-output-sep}{<separator>} Default = \code{,}
\option{sub-output-sep}{<separator>} Default = \code{,}
@@ -826,12 +1029,13 @@ You can change the separator symbol with which lists are printed as well. \chemn
\end{beispiel}
\subsubsection{Lists -- last separator}\label{sssec:last-sep}\index{Separators!list!last seperator}
-The last separator in the main label list is a special case. \chemnum provides two options with which it can be customized.
+The last separator in the main label list is a special case. \chemnum provides
+two options with which it can be customized.
\begin{beschreibung}
\Option{list-last-sep}{<separator>}
\option{list-lang}{US/GB/DE/FR/ES/IT} Default = \code{US}
\end{beschreibung}
-% There is the option \key{list-lang}, which changes language dependent settings. You can choose between \verb=US= (default), \verb=GB=, \verb=DE=, \verb=FR=, \verb=ES= and \verb=IT=.
+
\begin{beispiel}
\cmpd[list-lang = US]{a, b, f.two, k} \cmpd[list-lang = US]{a, b}\\
\cmpd[list-lang = GB]{a, b, f.two, k} \cmpd[list-lang = GB]{a, b}\\
@@ -840,7 +1044,9 @@ The last separator in the main label list is a special case. \chemnum provides t
\cmpd[list-lang = ES]{a, b, f.two, k} \cmpd[list-lang = ES]{a, b}\\
\cmpd[list-lang = IT]{a, b, f.two, k} \cmpd[list-lang = IT]{a, b}
\end{beispiel}
-As you can see the language \key{list-lang}{US} uses the Harvard comma, all other languages don't. You'll find more on language support and the Harvard comma in section~\ref{sec:language_support}.
+As you can see the language \key{list-lang}{US} uses the Harvard comma, all other
+languages don't. You'll find more on language support and the Harvard comma in
+section~\ref{sec:language_support}.
With the key \key{list-last-sep} you also can set the last separator individually.
\begin{beispiel}
@@ -851,7 +1057,8 @@ With the key \key{list-last-sep} you also can set the last separator individuall
\cmpd[list-last-sep = empty]{a, b, f.two, k}
\end{beispiel}
-\key{list-last-sep}{empty} is a special value. If it is used, the separator set with \key{list-output-sep} is used for the whole list.
+\key{list-last-sep}{empty} is a special value. If it is used, the separator set
+with \key{list-output-sep} is used for the whole list.
\begin{beispiel}
\cmpdsetup{list-last-sep = empty}%
\cmpd{a, b, f.two, k}\\
@@ -860,7 +1067,10 @@ With the key \key{list-last-sep} you also can set the last separator individuall
\end{beispiel}
\subsubsection{\code{\textbackslash\textcolor{code}{cmpdinit}} -- input}\label{sssec:init-input-sep}\index{Separators!cmpdinit@\textcolor{code}{\code{\textbackslash cmpdinit}}}
-When you've changed the separator for \cmd{cmpd} you might want to change it for \cmd{cmpdinit} as well. \chemnum uses the comma in the default setting. You can change that as you like. Sie können aber eine beliebige andere Eingabe wählen. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \verb=@=.
+When you've changed the separator for \cmd{cmpd} you might want to change it for
+\cmd{cmpdinit} as well. \chemnum uses the comma in the default setting. You can
+change that as you like. Sie können aber eine beliebige andere Eingabe wählen.
+Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \verb=@=.
\begin{beschreibung}
\option{init-input-sep}{<separator>} Default = \code{,}
\end{beschreibung}
@@ -880,7 +1090,12 @@ A small example how a customized input could look like:
\section{Language support}\label{sec:language_support}\secidx{Language support}
\subsection{Cooperation with \textsf{babel}}
-\chemnum supports the language choice made with the \paket{babel} package for a number of languages. This is done with the \verb=\translate= command of the \paket*{translator} package, if it is available. If \paket*{translator} cannot be loaded, language support must be done manually, see section~\ref{sssec:last-sep}. Manual language settings can of course still be done if \paket*{translator} has been loaded.
+\chemnum supports the language choice made with the \paket{babel} package for a
+number of languages. This is done with the \verb=\translate= command of the
+\paket*{translator} package, if it is available. If \paket*{translator} cannot
+be loaded, language support must be done manually, see section~\ref{sssec:last-sep}.
+Manual language settings can of course still be done if \paket*{translator} has
+been loaded.
\begin{beispiel}
\selectlanguage{ngerman}DE: \cmpd{r,s,t}\\
\selectlanguage{english}EN: \cmpd{r,s,t}\\
@@ -890,16 +1105,35 @@ A small example how a customized input could look like:
\selectlanguage{spanish}ES: \cmpd{r,s,t}\\
\selectlanguage{italian}IT: \cmpd{r,s,t}
\end{beispiel}
-If you find a language missing, please send me an email\footnote{\href{mailto:contact@mychemistry.eu}{contatc@mychemistry.eu}} with the corresponding \textsf{babel} option and the right translation, and I will gladly add it.
+If you find a language missing, please send me an
+email\footnote{\href{mailto:contact@mychemistry.eu}{contatc@mychemistry.eu}} with
+the corresponding \textsf{babel} option and the right translation, and I will
+gladly add it.
\subsection{Harvard comma}\label{ssec:harvard-comma}\secidx{Harvard comma}
-In American English the so-called Harvard comma is quite commonly used. In British English and other European languages it is rather uncommon.
+In American English the so-called Harvard comma is quite commonly used. In British
+English and other European languages it is rather uncommon.
\begin{zitat}[\href{http://en.wikipedia.org/wiki/Serial_comma}{\protect\Wikipedia}, 2011/11/07]
- The serial comma (also known as the Oxford comma or Harvard comma, and sometimes referred to as the series comma) is the comma used immediately before a coordinating conjunction (usually and or or, and sometimes nor) preceding the final item in a list of three or more items. For example, a list of three countries can be punctuated as either "Portugal, Spain, and France" (with the serial comma) or as "Portugal, Spain and France" (without the serial comma).
-
- Opinions vary among writers and editors on the usage or avoidance of the serial comma. In American English, the serial comma is standard usage in non-journalistic writing that follows the \name{Chicago Manual of Style}. Journalists, however, usually follow the AP Stylebook, which advises against it. It is used less often in British English, where it is standard usage to leave it out, with some notable exceptions such as \name{Fowler's Modern English Usage}. In many languages (e.g., French, German, Italian, Polish, Spanish), the serial comma is not the norm and may even go against punctuation rules. It may be recommended in many cases, however, to avoid ambiguity or to aid prosody.
+ The serial comma (also known as the Oxford comma or Harvard comma, and sometimes
+ referred to as the series comma) is the comma used immediately before a coordinating
+ conjunction (usually and or or, and sometimes nor) preceding the final item in a
+ list of three or more items. For example, a list of three countries can be
+ punctuated as either "Portugal, Spain, and France" (with the serial comma) or as
+ "Portugal, Spain and France" (without the serial comma).
+
+ Opinions vary among writers and editors on the usage or avoidance of the serial
+ comma. In American English, the serial comma is standard usage in non-journalistic
+ writing that follows the \name{Chicago Manual of Style}. Journalists, however,
+ usually follow the AP Stylebook, which advises against it. It is used less often
+ in British English, where it is standard usage to leave it out, with some notable
+ exceptions such as \name{Fowler's Modern English Usage}. In many languages (e.g.,
+ French, German, Italian, Polish, Spanish), the serial comma is not the norm and
+ may even go against punctuation rules. It may be recommended in many cases,
+ however, to avoid ambiguity or to aid prosody.
\end{zitat}
-\chemnum uses the Harvard comma when American English is used and doesn't, when other languages are used. However, you have the possibility to disable or enable the Harvard comma as you wish:
+\chemnum uses the Harvard comma when American English is used and doesn't, when
+other languages are used. However, you have the possibility to disable or enable
+the Harvard comma as you wish:
\begin{beschreibung}
\Option{list-serial-comma}{\default{true}/false}
@@ -909,7 +1143,9 @@ In American English the so-called Harvard comma is quite commonly used. In Briti
\selectlanguage{ngerman}DE: \cmpd[list-serial-comma]{r,s,t} vs. \cmpd{r,s,t}\\
\selectlanguage{american}US: \cmpd[list-serial-comma=false]{r,s,t} vs. \cmpd{r,s,t}
\end{beispiel}
-If you choose the language manually, please note that this resets the default behaviour for that language. This means you have to use \key{list-serial-comma} \emph{after} \key{list-lang}.
+If you choose the language manually, please note that this resets the default
+behaviour for that language. This means you have to use \key{list-serial-comma}
+\emph{after} \key{list-lang}.
\begin{beispiel}
wrong: \cmpdsetup{list-serial-comma=false, list-lang=US}\cmpd{r,s,t}\\
right: \cmpdsetup{list-lang=US, list-serial-comma=false}\cmpd{r,s,t}
@@ -974,27 +1210,39 @@ In this section all options are listed.
\end{center}
\subsection{Commands}
-In this section all commands provided by \chemnum as well as their variants are listed.
+In this section all commands provided by \chemnum as well as their variants are
+listed.
\begin{center}
\label{tab:commands}
\begin{tabu*} to \linewidth {X[l]X[p]}\toprule
\bfseries command & \bfseries description \tabularnewline\midrule
- \cmd*{cmpd}[<keyval>]{<labels>} & basic command, declares and prints labels or lists of labels, see pages \pageref{sec:nummerieren}ff. \tabularnewline
- \cmd*[cmpda]{cmpd*}{<labels>} & invisible, declares label, see page \pageref{cmd:unsichtbares_label} \tabularnewline
- \cmd*[cmpdc]{cmpd-}[<keyval>]{<labels>} & without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline
- \cmd*[cmpdd]{cmpd+-}[<keyval>]{<labels>} & label is read from auxiliary file, see page \pageref{cmd:cmpd_plus} \tabularnewline\midrule
- \cmd*{cmpdinit}[<keyval>]{<labels>} & initialise and declare labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline
- \cmd*[cmpdinita]{cmpdinit*}[<keyval>]{<labels>} & initialise labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline\midrule
- \cmd*{cmpdref}[<keyval>]\oa[<marker>]\ma{<label>} & replace temporary markers in \texttt{eps} files by labels, see page \pageref{ssec:cmpdref} \tabularnewline
- \cmd*[cmpdrefc]{cmpdref-}[<keyval>]\oa[<marker>]\ma{<label>} & replace temporary markers in \texttt{eps} files by labels without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule
- \cmd*{cmpdreset}[<num>] & reset counter, siehe page \pageref{sec:cmpdreset} \tabularnewline\midrule
- \cmd*{cmpdsetup}{<keyval>} & setup \chemnum, siehe pages \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule
+ \cmd*{cmpd}[<keyval>]{<labels>} & basic command, declares
+ and prints labels or lists of labels, see pages \pageref{sec:nummerieren}ff. \tabularnewline
+ \cmd*[cmpda]{cmpd*}{<labels>} & invisible, declares label,
+ see page \pageref{cmd:unsichtbares_label} \tabularnewline
+ \cmd*[cmpdc]{cmpd-}[<keyval>]{<labels>} & without delimiters, see
+ page \pageref{cmd:ohne_begrenzer} \tabularnewline
+ \cmd*[cmpdd]{cmpd+-}[<keyval>]{<labels>} & label is read from auxiliary
+ file, see page \pageref{cmd:cmpd_plus} \tabularnewline\midrule
+ \cmd*{cmpdinit}[<keyval>]{<labels>} & initialise and declare labels,
+ see pages \pageref{sec:cmpdinit}f. \tabularnewline
+ \cmd*[cmpdinita]{cmpdinit*}[<keyval>]{<labels>} & initialise labels, see
+ pages \pageref{sec:cmpdinit}f. \tabularnewline\midrule
+ \cmd*{cmpdref}[<keyval>]\oa[<marker>]\ma{<label>} & replace temporary markers
+ in \code{eps} files by labels, see page \pageref{ssec:cmpdref} \tabularnewline
+ \cmd*[cmpdrefc]{cmpdref-}[<keyval>]\oa[<marker>]\ma{<label>} & replace temporary
+ markers in \code{eps} files by labels without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule
+ \cmd*{cmpdreset}[<num>] & reset counter, see
+ page \pageref{sec:cmpdreset} \tabularnewline\midrule
+ \cmd*{cmpdsetup}{<keyval>} & setup \chemnum, see
+ pages \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule
\end{tabu*}
\end{center}
\appendix
\addsec{Credits}
-I would like to thank Joseph \name{Wright} and Russell \name{Hewitt} who provided me with valuable feedback and suggestions to improve \chemnum.
+I would like to thank Joseph \name{Wright} and Russell \name{Hewitt} who provided
+me with valuable feedback and suggestions to improve \chemnum.
\printindex
diff --git a/Master/texmf-dist/tex/latex/chemnum/chemnum.sty b/Master/texmf-dist/tex/latex/chemnum/chemnum.sty
index 6e10487e00c..f531564d0f6 100644
--- a/Master/texmf-dist/tex/latex/chemnum/chemnum.sty
+++ b/Master/texmf-dist/tex/latex/chemnum/chemnum.sty
@@ -3,7 +3,6 @@
% - a comprehensive approach for the numbering of chemical compounds
% -----------------------------------------------------------------------------
% - Clemens NIEDERBERGER
-% - 2012/08/15
% - contact@mychemistry.eu
% -----------------------------------------------------------------------------
% - If you have any ideas, questions, suggestions or bugs to report, please
@@ -31,8 +30,8 @@
\ProvidesExplPackage
{chemnum}
- {2012/08/15}
- {0.5d}
+ {2012/09/17}
+ {0.5e}
{An approach for the numbering of chemical compounds}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -1391,7 +1390,6 @@
% \cmpdinit*[strict=<bool>]{<comma separated list of label names>}
\NewDocumentCommand \cmpdinit { s o m }
{
- \bool_set_false:N \l_chemnum_cmpd_init_strict_bool
\bool_set_true:N \l_chemnum_cmpd_initiated_bool
\IfBooleanTF #1
{ \bool_set_false:N \l_chemnum_cmpd_init_declare_bool }
@@ -1678,6 +1676,7 @@ HISTORY:
for possible reasons why
2012/07/24 version 0.5c - adapted to changes in l3kernel
2012/08/15 version 0.5d - fixed bug in \cmpdref
+ 2012/09/17 version 0.5e - fixed bug in \cmpdinit
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% TODO:
- add a possibility to \ref{} the compounds