summaryrefslogtreecommitdiff
path: root/Master/texmf-dist
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist')
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/README4
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum-codehelper.tex96
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.pdfbin963249 -> 992425 bytes
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex648
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.pdfbin1036423 -> 982085 bytes
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex671
-rw-r--r--Master/texmf-dist/tex/latex/chemnum/chemnum.sty483
7 files changed, 1248 insertions, 654 deletions
diff --git a/Master/texmf-dist/doc/latex/chemnum/README b/Master/texmf-dist/doc/latex/chemnum/README
index 1308cec682a..0e721abdcd7 100644
--- a/Master/texmf-dist/doc/latex/chemnum/README
+++ b/Master/texmf-dist/doc/latex/chemnum/README
@@ -1,4 +1,4 @@
-chemnum v0.3e
+chemnum v0.4
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
-2011/12/01
+2011/12/08
http://www.mychemistry.eu/
contact@mychemistry.eu
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum-codehelper.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum-codehelper.tex
index 3583603d3a5..0a1908dc3cc 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum-codehelper.tex
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum-codehelper.tex
@@ -3,7 +3,7 @@
% - a comprehensive approach for the numbering of chemical compounds - %
% ------------------------------------------------------------------------------------- %
% - Clemens NIEDERBERGER - %
-% - 2011/12/01 - %
+% - 2011/12/08 - %
% ------------------------------------------------------------------------------------- %
% - http://www.mychemistry.eu/ - %
% - contact@mychemistry.eu - %
@@ -40,8 +40,14 @@
%
% For creating examples with nice highlighting of code, and so
% on; based on the system used in the listings source (lstsample).
-\usepackage[final]{listings}
-\usepackage{framed}
+\RequirePackage[final]{listings}
+\RequirePackage{framed}
+\RequirePackage{xcolor}
+ \xdefinecolor{code}{rgb}{.6,.25,.15}
+ \xdefinecolor{key}{rgb}{0.02,0.48,0.18}
+ \xdefinecolor{myblue}{rgb}{0.02,0.04,0.48}
+ \xdefinecolor{myred}{rgb}{0.65,0.04,0.07}
+ \xdefinecolor{mygray}{rgb}{0.4,0.4,0.4}
\makeatletter
\lst@RequireAspects{writefile}
\newsavebox{\beispiel@box}
@@ -74,7 +80,7 @@
literate={ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1 {Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1 {ß}{{\ss}}1,
moredelim=[is][\color{red!25!purple}]{!!}{!!},% Hervorhebung
moredelim=[is][\color{black}]{++}{++}, % Hervorhebung der Keywords rückgängig
- commentstyle={\color[named]{Gray}},
+ commentstyle={\color{mygray}},
keywordstyle=\color{code},
texcsstyle=[30]\color{code},
moretexcs=[30]
@@ -96,6 +102,7 @@
CNlabelsubnoref,
CNrefsub,
declarecompound,
+ color,
compound,
compoundprefix,
compoundsuffix,
@@ -103,6 +110,7 @@
includegraphics,
lstinline,
marker,
+ midrule,
penalty,
renewcommand,
schemename,
@@ -126,7 +134,7 @@
}%
}
\newcommand*\beispiel@input[1][\jobname.tmp]{%
- \catcode`\^^M=10\relax
+ \catcode`\^^M=5\relax
\small
\begingroup
\leavevmode
@@ -190,7 +198,7 @@
literate={ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1 {Ä}{{\"A}}1 {Ö}{{\"O}}1 {Ü}{{\"U}}1 {ß}{{\ss}}1,
moredelim=[is][\color{myred}]{!!}{!!},% Hervorhebung
moredelim=[is][\color{black}]{++}{++}, % Hervorhebung der Keywords rückgängig
- commentstyle={\color[named]{Gray}},
+ commentstyle={\color{mygray}},
keywordstyle=\color{code},
texcsstyle=[30]\color{code},
moretexcs=[30]
@@ -208,7 +216,7 @@
CNlabelsubnoref,
CNrefsub,
declarecompound,
- compound,
+ color,
compoundprefix,
compoundsuffix,
fcite,
@@ -221,4 +229,76 @@
theffbibliography,
uline
}
- }% \ No newline at end of file
+ }%
+
+\makeatletter
+\def\GetFileInfo#1{%
+ \def\filename{#1}%
+ \def\@tempb##1 ##2 ##3\relax##4\relax{%
+ \def\filedate{##1}%
+ \def\fileversion{##2}%
+ \def\fileinfo{##3}}%
+ \edef\@tempa{\csname ver@#1.sty\endcsname}%
+ \expandafter\@tempb\@tempa\relax? ? \relax\relax}
+\makeatother
+
+\ExplSyntaxOn
+\DeclareDocumentEnvironment { myquote } { o }
+ {
+ \quote
+ \small\sffamily
+ }
+ {
+ \IfNoValueF { #1 }
+ {
+ \par\noindent
+ \parbox { \linewidth } { \raggedleft \normalfont \itshape #1 }
+ }
+ \endquote
+ }
+
+\NewDocumentCommand \paket { sm }
+ {
+ \textsf { #2 }
+ \cs_if_exist:cF { paket @ #2 }
+ {
+ \cs_new_nopar:cpn { paket @ #2 } { }
+ \IfBooleanF { #1 }
+ { \footnote { CTAN: ~ \href { http://www.ctan.org/pkg/#2/ } { #2 } } }
+ }
+ \index { #2 @ \textsf { #2 } }
+ }
+
+\NewDocumentCommand \key { mg }
+ {
+ \textcolor{key}{ \texttt { #1 } }
+ \IfNoValueF { #2 } { \texttt { ~=~#2 } }
+ \index { #1 @ \textcolor{key}{ \texttt { #1 } } }
+ }
+
+\NewDocumentCommand \cmd { omoog }
+ {
+ \textcolor{code} { \texttt { \textbackslash #2 } }
+ \IfNoValueF { #3 } { \texttt { [ #3 ] } }
+ \IfNoValueF { #4 } { \texttt { [ #4 ] } }
+ \IfNoValueF { #5 } { \texttt { \{ #5 \} } }
+ \index
+ {
+ \IfNoValueTF { #1 } { #2 } { #1 }
+ @ \textcolor { code } { \texttt { \textbackslash #2 } }
+ }
+ }
+
+\NewDocumentCommand \secidx { som }
+ {
+ \IfBooleanTF { #1 }
+ { \index { \IfNoValueTF { #2 } { #3 } { #2 } @ \textbf { #3 } |) } }
+ { \index { \IfNoValueTF { #2 } { #3 } { #2 } @ \textbf { #3 } |( } }
+ }
+
+\NewDocumentCommand \ma { m }
+ { \texttt { \{ #1 \} } }
+
+\NewDocumentCommand \oa { m }
+ { \texttt { [ #1 ] } }
+\ExplSyntaxOff \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.pdf b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.pdf
index 37a2b9d1adb..dc6494ea4fa 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.pdf
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex
index 6c4e04c8f09..80c430458f8 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex
@@ -3,7 +3,7 @@
% - a comprehensive approach for the numbering of chemical compounds - %
% ------------------------------------------------------------------------------------- %
% - Clemens NIEDERBERGER - %
-% - 2011/12/01 - %
+% - 2011/12/08 - %
% ------------------------------------------------------------------------------------- %
% - http://www.mychemistry.eu/ - %
% - contact@mychemistry.eu - %
@@ -29,17 +29,12 @@
% - chemnum_doc_en.tex, chemnum-codehelper.tex, scheme-tmp.eps, scheme-bla.eps, - %
% - README and the derived files chemnum_doc_de.pdf and chemnum_doc_en.pdf - %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\documentclass[DIV11]{scrartcl}
-\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,french,canadien,spanish,italian]{babel}
+\documentclass[DIV11,toc=index]{scrartcl}
+\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,frenchb,canadien,spanish,italian]{babel}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenx}
-\usepackage[dvipsnames]{xcolor}
- \colorlet{code}{RawSienna}
- \colorlet{shadecolor}{yellow!20}
- \definecolor{myblue}{rgb}{0.02,0.04,0.48}
- \definecolor{myred}{rgb}{0.65,0.04,0.07}
\usepackage[textgreek]{chemnum}
-\usepackage{textcomp,microtype,libertine,url,xspace,longtable,tabu,booktabs,chemscheme}
+\usepackage{textcomp,microtype,libertine,url,xspace,longtable,tabu,booktabs,chemscheme,makeidx}
\usepackage[version=3]{mhchem}
\renewcommand*\schemename{Schema}
\usepackage[normalem]{ulem}
@@ -47,6 +42,19 @@
\usepackage{chemfig}
\input{chemnum-codehelper}
+\begin{filecontents}{index_de.ist}
+ preamble "\\begin{theindex}\n Abschnitts\\\"{u}berschriften werden \\textbf{fett}, Pakete \\textsf{serifenlos}, Befehle \\textcolor{code}{braun} und Keys \\textcolor{key}{gr\\\"{u}n} dargestellt.\\newline\n\n"
+ heading_prefix "{\\bfseries "
+ heading_suffix "\\hfil}\\nopagebreak\n"
+ headings_flag 1
+ delim_0 "\\dotfill "
+ delim_1 "\\dotfill "
+ delim_2 "\\dotfill "
+ delim_r "--"
+ suffix_2p "\\nohyperpage{\\,f.}"
+ suffix_3p "\\nohyperpage{\\,ff.}"
+\end{filecontents}
+
\usepackage{hyperref}
\hypersetup{colorlinks=true,
allcolors=myblue,
@@ -61,34 +69,30 @@
pdfcreator={LaTeX}
}
-\newcommand*\changefont[3]{\fontfamily{#1}\fontseries{#2}\fontshape{#3}\selectfont}
-
\ExplSyntaxOn
-\DeclareDocumentEnvironment { myquote } { o }
- {
- \quote
- \small\sffamily %\changefont { cmss } { m } { sl }
- }
+\NewDocumentCommand \keyentry { mmm }
{
- \IfNoValueF { #1 }
- {
- \par\noindent
- \parbox { \linewidth } { \raggedleft \normalfont \itshape #1 }
- }
- \endquote
+ \noindent
+ \textcolor{key}{ \texttt { #1 } }
+ \texttt { ~=~#2 }
+ \hfill Typ:~
+ \texttt { #3 }
+ \index { #1 @ \textcolor{key}{ \texttt { #1 } } }
}
\ExplSyntaxOff
-\newcommand*\chemnum{{\scshape\textcolor{myblue}{chemnum}}\xspace}
-\newcommand*\CNversion{v0.3e\xspace}
-\newcommand*\CNdate{2011/12/01\xspace}
+\GetFileInfo{chemnum}
+\newcommand*\chemnum{{\scshape\textcolor{myblue}{\filename}}\xspace}
+\newcommand*\CNversion{\fileversion\xspace}
+\newcommand*\CNdate{\filedate\xspace}
+\newcommand*\CNinfo{\fileinfo\ with \LaTeXe.}
-\newcommand*\paket[1]{\textsf{#1}\footnote{\url{http://www.ctan.org/pkg/#1}}}
\newcommand*\zB{\mbox{z.\,B.}\xspace}
\newcommand*\bzw{\mbox{bzw.}\xspace}
\newcommand*\usw{\mbox{usw.}\xspace}
-\cmpdinit*{a,aa,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,benzol,r,s,t}
+\cmpdinit*{a,aa,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,benzol,r,s,t,{1,3-dichlorocyclohexanol}}
+\makeindex
\begin{document}
\selectlanguage{ngerman}
\begin{titlepage}
@@ -101,8 +105,9 @@
\vskip.25cm
\normalsize\url{http://www.mychemistry.eu/}\\
\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}
- \begin{center}\Large\color{myblue}
- Ein umfassender Ansatz für das Nummerieren chemischer Verbindungen mit \LaTeXe.
+ \begin{center}
+ \Large\color{myblue} \CNinfo \\[16pt]
+ \normalcolor deutsche Dokumentation
\end{center}
\vskip3cm \cmpdinit*{glucose.alpha, glucose.beta, glucose.chain}
\cmpd*[sub-counter = greek]{glucose.alpha, glucose.beta}\cmpd*{glucose.chain}
@@ -127,21 +132,59 @@
\cmpdreset
\tableofcontents
-\section{Lizenz, Voraussetzungen}
+\section{Ein sehr kurzes Readme}
\chemnum \CNversion steht unter der \LaTeX\ Project Public License Version 1.3 oder später.\newline(\url{http://www.latex-project.org/lppl.txt})
-\chemnum ruft intern die Pakete \textsf{expl3} und \paket{xparse} auf. \textsf{xparse} ist Teil des \paket{l3packages}-Bundles, \textsf{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}).
-\section{Paket-Optionen}\label{sec:package_options}
+In diesem Dokument können Sie leicht zwischen einem \textcolor{code}{\ttfamily\textbackslash befehl}, einem \textcolor{key}{key} und sonstigem \texttt{code} unterscheiden.
+
+\section{Neues und ein Wort der Entschuldigung}
+Mit dem Update auf v0.4 hat sich einiges bei den Keys getan. Es gibt ein paar neue, ein paar von den alten haben andere Namen. Sie haben einheitlichere Namen erhalten, die meiner 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.
+
+Geändert haben sich folgende Keys:
+\begin{center}
+ \begin{tabular}{ll}\toprule
+ \bfseries alter Name & \bfseries neuer Name \\\midrule
+ \key{cmpd-sep} & \key{sub-output-sep} \\
+ \key{sub-marker} & \key{sub-input-sep} \\
+ \key{sub-range-sep} & \key{subrange-output-sep} \\
+ \key{sub-range-marker} & \key{subrange-input-sep} \\
+ \key{strict} & \key{init-strict} \\
+ \key{sub-init} & \key{init-sub} \\\bottomrule
+ \end{tabular}
+\end{center}
+Neu hinzugekommen sind diese:
+\begin{center}
+ \begin{tabular}{ll}\toprule
+ \bfseries Key & \bfseries Info \\\midrule
+ \key{sublist-output-sep} & Aufzählungszeichen in Labeln wie \cmpd{f.{one,two}}, siehe Seite \pageref{sssec:list-output-sep}. \\
+ \key{sublist-input-sep} & Eingabe von Labeln wie \cmpd{f.{one,two}}, siehe Seite \pageref{sssec:list-input-sep}. \\
+ \key{init-input-sep} & Eingabe bei \cmd{cmpdinit}, siehe Seite \pageref{sssec:init-input-sep}. \\
+ \key{hyper-use} & Verwendung von Hyperlinks, siehe Seite \pageref{sec:hyperref}. \\
+ \key{hyper-target} & \\
+ \key{hyper-link} & \\
+ \key{ref-style} & Darstellung von Labels mit \cmd{cmpdref}, siehe Seiten \pageref{ssec:cmpdref} und \pageref{ssec:schriftstil}. \\\bottomrule
+ \end{tabular}
+\end{center}
+
+Ebenfalls neu ist die Art und Weise, wie Sublabel-Listen und -Bereiche eingegeben werden. Der Key \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}.
+
+Diese Dokumentation hat mit v0.4 einen Index bekommen.
+
+\section{Paket-Optionen}\label{sec:package_options}\secidx{Paket-Optionen}
\chemnum hat eine Option.
\begin{framed}
\centering\lstinline+\usepackage[textgreek = <value>]{chemnum}+
\end{framed}
-Damit können Sie sowohl einen der drei Stile des \textsf{textgreek}-Pakets wählen\footnote{Zu Details siehe Dokumentation des \textsf{textgreek}-Pakets.} oder \chemnum ohne \textsf{textgreek} laden. Folgende Werte stehen zur Auswahl: \lstinline=artemisia=, \lstinline=cbgreek=, \lstinline=euler= und \lstinline=false=. Wenn Sie \lstinline=<value>= weglassen, wird \textsf{textgreek} mit dem \lstinline=cbgreek=-Stil geladen. Die Verwendung von \lstinline+\usepackage[textgreek]{chemnum}+ entspricht also \lstinline+\usepackage[textgreek = cbgreek]{chemnum}+. Wenn Sie \chemnum ohne Option verwenden, wird \textsf{textgreek} nicht verwendet. Das entspricht \lstinline+\usepackage[textgreek = false]{chemnum}+, der Voreinstellung.
+Damit können Sie sowohl einen der drei Stile des \textsf{textgreek}-Pakets wählen\footnote{Zu Details siehe Dokumentation des \paket*{textgreek}-Pakets.} oder \chemnum ohne \paket{textgreek} laden. Folgende Werte stehen zur Auswahl: \lstinline=artemisia=, \lstinline=cbgreek=, \lstinline=euler= und \lstinline=false=. Wenn Sie \lstinline=<value>= weglassen, wird \paket{textgreek} mit dem \lstinline=cbgreek=-Stil geladen. Die Verwendung von \lstinline+\usepackage[textgreek]{chemnum}+ entspricht also \lstinline+\usepackage[textgreek = cbgreek]{chemnum}+. Wenn Sie \chemnum ohne Option verwenden, wird \paket{textgreek} nicht verwendet. Das entspricht \lstinline+\usepackage[textgreek = false]{chemnum}+, der Voreinstellung.
Dieses Dokument wurde mit \lstinline+\usepackage[textgreek]{chemnum}+ gesetzt.
+\secidx*{Paket-Optionen}
\section{Motivation}
Soweit mir bekannt ist, gab es bislang drei Pakete, die das Nummerieren von Verbindungen erleichtern sollen. Sie alle haben ihre Schwächen.
@@ -152,9 +195,9 @@ Das erste, \paket{chemcono}, hat für diesen Zweck Bibliographie-Befehle umdefin
\end{myquote}
Ganz offensichtlich ist das keine perfekte Lösung.
-Das zweite, \paket{chemcompounds}, ist enstanden, weil der Paket-Autor ebenfalls mit den Schwä\-chen von \textsf{chemcono} nicht mehr arbeiten wollte. Bei der Erstellung des Pakets hielt er sich stark an den gleichen prinzipiellen Mechanismus wie \textsf{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{myquote}[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 \lstinline=\bibitem= and \lstinline=\cite= in pretty much the same way as \textsf{chemcono} does by extracting the corresponding code from \lstinline=article.cls= and \lstinline=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 \lstinline=\bibitem= and \lstinline=\cite= in pretty much the same way as \paket{chemcono} does by extracting the corresponding code from \lstinline=article.cls= and \lstinline=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{myquote}
Manche Schwächen hat auch dieses Paket:
\begin{enumerate}
@@ -166,18 +209,17 @@ Manche Schwächen hat auch dieses Paket:
Dann gibt es noch \paket{bpchem}, das Befehle ähnlich den Befehlen \lstinline=\label= und \lstinline=\ref= zur Ver\-fü\-gung stellt: \lstinline=\CNlabel{}=, \lstinline=\CNlabelnoref{}= und \lstinline=\CNref{}=. Außerdem hat es Befehle für Sublabel: \lstinline=\CNlabelsub{}{}=, \lstinline=\CNlabelsubnoref{}{}= und \lstinline=\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 \textsf{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.
-\newpage
\section{Verbindungen Nummerieren}\label{sec:nummerieren}
-\subsection{Basisbefehl}
+\subsection{Basisbefehl}\secidx{Basisbefehl}
Der eigentliche Befehl des Pakets ist
\begin{framed}
-\centering\lstinline=\cmpd{<label name>}=
+ \centering\cmd{cmpd}{<label name>}
\end{framed}
-\noindent Beim ersten Aufruf mit \lstinline=<label name>= wird das Label erzeugt und gespeichert (= deklariert) und ausgegeben. Bei jedem weiteren Aufruf wird nun dieses Label verwendet.
+\noindent Beim ersten Aufruf mit \texttt{<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
@@ -186,28 +228,28 @@ Der eigentliche Befehl des Pakets ist
Falls es nötig sein sollte, eine Verbindung zu deklarieren, ohne ein Label auszugeben, kann man an entsprechender Stelle
\begin{framed}\label{cmd:unsichtbares_label}
-\centering\lstinline=\cmpd*{<label name>}=
+ \centering\cmd[cmpda]{cmpd*}{<label name>}
\end{framed}
-\noindent verwenden. Dadurch wird ein entsprechendes Label deklariert aber nicht ausgegeben. \textbf{Dieser Befehl wird nicht benötigt, wenn man} \lstinline=\cmpdinit{}= \textbf{verwendet, siehe Abschnitt \ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).}
+\noindent verwenden. Dadurch wird ein entsprechendes Label deklariert aber nicht ausgegeben. \textbf{Dieser Befehl wird nicht benötigt, wenn man} \cmd{cmpdinit}{} \textbf{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.
\end{beispiel}
-Als Label-Namen können Sie im Prinzip einsetzen, was Sie wollen\footnote{Es gibt ein Einschränkungen, siehe Abschnitt \ref{ssec:listen} (S.\, \pageref{ssec:listen}), Abschnitt \ref{sssec:list-input-sep} (S.\,\pageref{sssec:list-input-sep}), Abschnitt \ref{ssec:unterlabel} (S.\,\pageref{ssec:unterlabel}) und Abschnitt \ref{ssec:sub_label_marker} (S.\,\pageref{ssec:sub_label_marker}).}. 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}.
\end{beispiel}
-\lstset{showspaces=false}
+\lstset{showspaces=false}\secidx*{Basisbefehl}
-\subsection{Sublabel}\label{ssec:unterlabel}
+\subsection{Sublabel}\label{ssec:unterlabel}\secidx{Sublabel}
Möchte man Label der Form \cmpd{a.one} erzeugen, geschieht das nach folgender Syntax:
\begin{framed}
-\centering\lstinline=\cmpd{<label name>.<subname>}=
+ \centering\cmd{cmpd}{<label name>.<subname>}
\end{framed}
-\noindent Dabei muss \lstinline=<label name>= der gleiche bleiben, \lstinline=<subname>= variiert. Diese Syntax bedeutet, dass der Punkt \lstinline=.= weder Teil von \lstinline=<label name>= noch von \lstinline=<subname>= sein darf.
+\noindent Dabei muss \texttt{<label name>} der gleiche bleiben, \texttt{<subname>} variiert. Diese Syntax bedeutet, dass der Punkt \texttt{.} weder Teil von \texttt{<label name>} noch von \texttt{<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}.
@@ -226,30 +268,82 @@ 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[sub-list={one,two}]{f} erzeugen können,wird in Abschnitt \ref{sec:lists_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}
+\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.
Die richtige Beschreibung des Befehls lautet also eher:
\begin{framed}
-\centering\lstinline=\cmpd{<(possibly comma separated list of) label name(s)>}=
+ \centering\cmd{cmpd}{<(possibly comma separated list of) label name(s)>}
\end{framed}
-Das bedeutet, dass in der Voreinstellung das Komma nicht Teil des Label-Namens sein kann, es sei den 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.
\end{beispiel}
+\secidx*{Listen}
-\section{Label zentral initialisieren}\label{sec:cmpdinit}
+\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}.
+
+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.
+
+Sie können auf diese Weise auch Bereiche von Sublabeln darstellen. Als Marker zwischen den Namen der beiden Sublabel werden zwei Punkte \lstinline=..= 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.
+
+\chemnum stellt einen Key (siehe Abschnitt \ref{sec:cmpdsetup} zur näheren Erläuterung) zur Verfügung, mit denen alle Sublabel als Bereich ausgegeben werden können
+\begin{framed}
+ \keyentry{cmpd-all}{true/false}{boolean}
+\end{framed}
+\begin{beispiel}
+ \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 \lstinline=<jobname>.cmpd= (angenommen Ihre Quelldatei heißt \lstinline=<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 folgendem Key:
+\begin{framed}
+ \keyentry{sub-only}{true/false}{boolean}
+\end{framed}
+\begin{beispiel}
+ % use packages `chemfig', `mhchem' and `booktabs'
+ \cmpd*{benzol.H,benzol.Me,benzol.OH,benzol.NH2}
+ \chemname{\chemfig{*6(=-=-(-R)=-)}}{\cmpd[cmpd-all]{benzol}}
+ \begin{tabular}{lll}
+ & \ce{{}-R} & Name \\\midrule
+ \cmpd[sub-only]{benzol.H} & \ce{{}-H} & Benzol \\
+ \cmpd[sub-only]{benzol.Me} & \ce{{}-CH3} & Toluol \\
+ \cmpd[sub-only]{benzol.OH} & \ce{{}-OH} & Phenol \\
+ \cmpd[sub-only]{benzol.NH2} & \ce{{}-NH2} & Anilin
+ \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:
+\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.
\subsection{Verwendung}
\subsubsection{Haupt-Label}
-Vielleicht vermissen Sie ja den \lstinline=\declarecompound=-Befehl von \textsf{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 \lstinline=\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{framed}
-\centering\lstinline=\cmpdinit{<comma separated list of label names>}=
-\centering\lstinline=\cmpdinit*{<comma separated list of label names>}=
+ \centering\cmd{cmpdinit}{<comma separated list of label names>}
+ \centering\cmd[cmpdinita]{cmpdinit*}{<comma separated list of label names>}
\end{framed}
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.
@@ -270,7 +364,7 @@ Alle Verbindungen, die innerhalb dieses Befehls gesetzt werden, werden \emph{in
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.
-\lstinline=\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}
@@ -287,62 +381,67 @@ Beachten Sie, dass Sie bei Labeln mit Sublabeln \emph{nur den Hauptnamen} initia
{}*************************************************
\end{framed}
-Wenn Sie also eigene Label vergeben wollen oder müssen (siehe Seite \pageref{ssec:own_labels}) und die Label geschlossen initialisieren wollen, sollten Sie \lstinline=\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 \lstinline=*=. 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
\begin{framed}
-\centering\lstinline+\cmpdinit[!!sub-init = true!!]{<comma separated list of label names>}+
+ \centering\cmd{cmpdinit}[\key{init-sub}{true}]{<comma separated list of label names>}
\end{framed}
\noindent verwenden. So werden Sie auch in diesen Fällen gewarnt.
\cmpdreset
\begin{beispiel}
- \cmpdinit[sub-init = true]{E.e}
- \cmpd{E.e, E.f}
+ \cmpdinit[init-sub = true]{E.{e,f,g}}
+ \cmpd{E.e, E.h}
\end{beispiel}
\begin{framed}
\small\ttfamily\noindent
{}*************************************************\\
- {}* chemnum warning: "cmpd-sub-init"\\
+ {}* chemnum warning: "cmpd-init-sub"\\
{}* \\
- {}* You used \verb=\cmpdinit= and "{}sub-init = true"{} but didn't initiate sub-compound\\
- {}* "{}E.f"{} on line 1.\\
+ {}* You used \verb=\cmpdinit= and "{}init-sub = true"{} but didn't initiate sub-compound\\
+ {}* "{}E.h"{} on line 1.\\
{}*************************************************
\end{framed}
\subsection{Fehler statt Warnung}
-Wenn Sie lieber eine Fehler-Meldung anstelle einer Warnung mögen, können Sie das realisieren, indem Sie \lstinline=\cmpdinit= folgendermaßen aufrufen:
+Wenn Sie lieber eine Fehler-Meldung anstelle einer Warnung mögen, können Sie das realisieren, indem Sie \cmd{cmpdinit} folgendermaßen aufrufen:
\begin{framed}
-\centering\lstinline+\cmpdinit[!!strict = true!!]{<comma separated list of label names>}+
+ \centering\cmd{cmpdinit}[\key{init-strict}{true}]{<comma separated list of label names>}
\end{framed}
-Die Verwendung \lstinline+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 \lstinline+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 \lstinline=\cmpdinit= auch mit beiden Keys aufrufen:
+Natürlich können Sie \cmd{cmpdinit} auch mit beiden Keys aufrufen
\begin{framed}
-\centering\lstinline+\cmpdinit[strict = true, sub-init = true]{<comma separated list of label names>}+
+ \centering\cmd{cmpdinit}[\key{init-strict}{true}, \key{init-sub}{true}]{<comma separated list of label names>}
\end{framed}
+\noindent 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 \cmd{cmpdinit}[\key{sub-init}{true}] ebenfalls verwenden.
-Wenn Sie einen anderen Sub-Label-Marker ausgewählt haben (siehe Seite \pageref{ssec:sub_label_marker}), müssen Sie mit \lstinline+\cmpdinit[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}.
\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 \lstinline=\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 \lstinline=\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 \lstinline=\cmpdinit= bewirkt erst einmal dasselbe wie \lstinline=\cmpdinit*=, deklariert aber \emph{zusätzlich} die Label in der vorgegebenen Reihenfolge. Damit wird die Verwendung von \lstinline=\cmpd*= (Abschnitt \ref{cmd:unsichtbares_label}) und \lstinline=\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}
-\section{Zurücksetzen des Zählers}\label{sec:cmpdreset}
+\section{Zurücksetzen des Zählers}\label{sec:cmpdreset}\secidx[zuruecksetzen]{Zurücksetzen des Zählers}
Es ist möglich, mit folgendem Befehl
\begin{framed}
-\centering\lstinline=\cmpdreset[<number>]=
+ \centering\cmd{cmpdreset}[<number>]
\end{framed}
-\noindent den Zähler wieder zurückzusetzen. Ohne Argument wird er auf \verb=1= gesetzt und entspricht damit \lstinline=\cmpdreset[1]=. Dieser Befehl wirkt sich global aus, nicht nur lokal innerhalb einer Gruppe -- im Gegensatz zu den meisten anderen vorgestellten Befehlen.
+\noindent 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
@@ -354,26 +453,27 @@ Es ist möglich, mit folgendem Befehl
\begin{beispiel}
Gleiche Nummern: \cmpd{a}, \cmpd{h}
\end{beispiel}
+\secidx*[zuruecksetzen]{Zurücksetzen des Zählers}
\section{Besondere Verwendung}
\subsection{Abschnitts-Titel}
-Die Verwendung von \lstinline=\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 \lstinline=\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 \lstinline=\cmpdinit{}= (siehe Seite \pageref{sec:cmpdinit}).
- \item Sie verwenden \lstinline=\cmpd+=, um das Label zu setzen. Damit wird das Label von der Datei \lstinline=<jobname>.cmpd= ausgelesen (vorausgesetzt ihre Hauptdatei heißt \lstinline=<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 \lstinline=<jobname>.cmpd= ausgelesen (vorausgesetzt ihre Hauptdatei heißt \lstinline=<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.
Der Befehl\label{cmd:cmpd_plus}
\begin{framed}
-\centering\lstinline=\cmpd+{<label name>}=
+ \centering\cmd[cmpdb]{cmpd+}{<label name>}
\end{framed}
-liest den Labelnamen, der ausgegeben werden soll, aus der Datei \lstinline=<jobname>.cmpd=. Damit ist er sozusagen das Gegenteil von \lstinline=\cmpd*=, da das Label nicht deklariert sondern nur referenziert und ausgegeben wird. Damit man also \lstinline=\cmpd+{<label>}= einsetzen kann, muss \lstinline=<label>= entweder mit \lstinline=\cmpd{<label>}= oder \lstinline=\cmpd*{<label>}= (davor oder danach) deklariert worden sein. \lstinline=\cmpd+= ist nützlich, wenn ein Label in einem beweglichen Argument wie in \lstinline=\section{}= eingesetzt werden soll. \textbf{Er wird nicht benötigt, wenn} \lstinline=\cmpdinit{}= \textbf{verwendet wird, siehe Abschnitt \ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).}
+liest den Labelnamen, der ausgegeben werden soll, aus der Datei \lstinline=<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 \lstinline=<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 \lstinline=\section{}= eingesetzt werden soll. \textbf{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}}
@@ -382,7 +482,7 @@ liest den Labelnamen, der ausgegeben werden soll, aus der Datei \lstinline=<jobn
\end{beispiel}
\subsection{Gleitumgebungen}\cmpdinit*{float1,float2}
-Die Verwendung von \lstinline=\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 \lstinline=\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}
@@ -396,13 +496,13 @@ Die Verwendung von \lstinline=\cmpd= in Gleitumgebungen sollte kein Problem dars
\end{scheme}
\end{beispiel}
-Es funktioniert auch alles wie gewünscht, wenn die Gleitumgebung vor den aktuellen Code rutscht, etwa mit der Option \lstinline=[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}
+\subsection{Schemata externer Programme}\label{ssec:cmpdref}\secidx{Schemata externer Programme}
Wenn Sie Ihre Schemata mit externen Programmen wie \zB \textsc{ChemDraw} oder \textsc{Marvin\-Sketch} erstellen und dort ebenfalls \chemnum einsetzen wollen, dann können Sie das mit
\begin{framed}
-\centering\lstinline=\cmpdref[<keyval>][<tag>]{<label name>}=
+ \centering\cmd{cmpdref}[<keyval>][<tag>]{<label name>}=
\end{framed}
tun. Dieser Befehl ist vom Befehl \lstinline=\schemeref= des Pakets \paket{chemscheme} inspiriert und funktioniert letztlich gleich. Sie erstellen das Schema und speichern es mit temporären Labeln als \lstinline=eps=-Datei.
\begin{beispiel}[code and float]
@@ -420,7 +520,7 @@ tun. Dieser Befehl ist vom Befehl \lstinline=\schemeref= des Pakets \paket{chems
\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 \textsf{chemscheme} den Befehl \lstinline=\psfrag=. Damit er funktioniert, müssen Sie also entweder über \textsc{latex}, \textsc{dvips}, \textsc{ps2pdf} kompilieren, oder \zB das Paket \paket{auto-pst-pdf} zusammen mit \textsc{pdflatex} einsetzen. \textsc{xelatex} wird leider nicht funktionieren, \textsc{lualatex} voraussichtlich ebensowenig, wurde aber vom Autor nicht getestet.
+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 \lstinline=\psfrag= des \paket{psfrag}-Pakets. Damit er funktioniert, müssen Sie also entweder über \textsc{latex}, \textsc{dvips}, \textsc{ps2pdf} kompilieren, oder \zB das Paket \paket{auto-pst-pdf} zusammen mit \textsc{pdflatex} einsetzen. \textsc{xelatex} wird leider nicht funktionieren, \textsc{lualatex} voraussichtlich ebensowenig, wurde aber vom Autor nicht getestet.
In jedem Fall ist es wichtig, dass der Marker als \emph{Text} im \lstinline=eps= gespeichert ist.
@@ -428,8 +528,9 @@ Mit den Keys, die in Abschnitt \ref{sec:cmpdsetup} vorgestellt werden, können S
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
- \cmpdref[cmpd-style=\bf\sf\textcolor{green}]{Alc} % ersetzt TMP1
- \cmpdref[cmpd-style=\bf\sf\textcolor{green}]{EtherBr} % ersetzt TMP2
+ \cmpdsetup{ref-style=\color{green}}
+ \cmpdref{Alc} % ersetzt TMP1
+ \cmpdref{EtherBr} % ersetzt TMP2
\includegraphics{scheme-tmp}
\caption{Schema mit automatisierten Labeln.}
\end{scheme}
@@ -462,76 +563,56 @@ Natürlich funktioniert das mit Sublabeln nach dem gewohnten Muster:
\caption{Schema mit automatisierten Labeln und Sublabeln.}
\end{scheme}
\end{beispiel}
+\secidx*{Schemata externer Programme}\cmpdreset[10]
-\cmpdreset[9]
-\section{Listen und Bereiche von Sublabeln}\label{sec:lists_ranges}
-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}.
-
-\chemnum stellt zwei Keys (siehe Abschnitt \ref{sec:cmpdsetup}) zur Verfügung, mit denen solche Label erzeugt werden können, und zwei, mit denen sie angepasst werden können.
+\section{Verwendung mit \textsf{hyperref}}\label{sec:hyperref}\secidx[Verwendung mit hyperref]{Verwendung mit \textsf{hyperref}}
+\subsection{Grundprinzip}
+Wenn Sie das Paket \paket{hyperref} eingebunden haben, können Sie die Label zu klickbaren Links im \textsc{pdf} machen.
\begin{framed}
- \noindent\lstinline+cmpd-all = true/false+ \hfill Typ: \lstinline=boolean=\\
- \noindent\lstinline+sub-list = {<list of sublabel names>}+ \hfill Typ: \lstinline=other=\\
- \noindent\lstinline+sub-range-sep = <separator>+ \hfill Typ: \lstinline=literal=\\
- \noindent\lstinline+sub-range-marker = <marker>+ \hfill Typ: \lstinline=literal=
+ \keyentry{hyper-use}{true/false}{boolean}
\end{framed}
-Der Typ des Keys \lstinline=sub-list= unterscheidet sich von dem anderer Keys. Am besten schauen Sie Sich das Beispiel unten an.
+Wenn Sie diesen Key (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}
- Liste von Labeln: \cmpd{q.one, q.two, q.three, q.four, q.five} \\
- Alle auf einmal: \cmpd[cmpd-all]{q}
+ \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}.
+
+ 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}
-Wenn Sie nicht auf alle Varianten auf einmal verweisen wollen, können Sie den Key \lstinline=sub-list=\label{key:sub-list} verwenden. Als Eingabe benötigt er eine Komma-separierte Liste der Sublabel-Namen, die zu dem Hauptlabel gehören, das Sie verwenden.
-\begin{beispiel}
- \cmpd[sub-list={one,three,four}]{q}
-\end{beispiel}
-
-Sie können mit diesem Key auch Bereiche von Sublabeln darstellen. Als Marker zwischen den Namen der beiden Sublabel werden zwei Punkte \lstinline=..= verwendet.
-\begin{beispiel}
- \cmpd[sub-list={two..four}]{q}\\
- \cmpd[sub-list={one,three..five}]{q}\\
- \cmpd[sub-list={one..three,five}]{q}
-\end{beispiel}
-
-Mit den Keys \lstinline=sub-range-sep= und \lstinline=sub-range-marker= kann man sowohl das Symbol, mit dem der Bereich angezeigt wird als auch den Marker für die Eingabe ändern.
-\begin{beispiel}
- \cmpdsetup{sub-range-sep = {---}, sub-range-marker = : }
- \cmpd[sub-list={two:four}]{q}
-\end{beispiel}
-
-Damit die Keys die richtigen Sublabel verwenden können, müssen diese deklariert worden sein. Daher werden sie aus der Datei \lstinline=<jobname>.cmpd= (angenommen Ihre Quelldatei heißt \lstinline=<jobname>.tex=) gelesen. Daher müssen Sie zweimal (oder öfter) kompilieren, 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 folgendem Key:
+\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.
\begin{framed}
- \noindent\lstinline+sub-only = true/false+\hfill Typ: \lstinline=boolean=
+ \keyentry{hyper-target}{<link name>}{literal}\\
+ \keyentry{hyper-link}{<link name>}{literal}
\end{framed}
-\begin{beispiel}
- % use packages `chemfig', `mhchem' and `booktabs'
- \cmpd*{benzol.H,benzol.Me,benzol.OH,benzol.NH2}
- \chemname{\chemfig{*6(=-=-(-R)=-)}}{\cmpd[cmpd-all]{benzol}}
- \begin{tabular}{lll}
- & \ce{{}-R} & Name \\\midrule
- \cmpd[sub-only]{benzol.H} & \ce{{}-H} & Benzol \\
- \cmpd[sub-only]{benzol.Me} & \ce{{}-CH3} & Toluol \\
- \cmpd[sub-only]{benzol.OH} & \ce{{}-OH} & Phenol \\
- \cmpd[sub-only]{benzol.NH2} & \ce{{}-NH2} & Anilin
- \end{tabular}
-\end{beispiel}
+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{framed}\ttfamily
+destination with the same identifier (name{<link name>}) has been already used, duplicate ignored
+\end{framed}
+\noindent ausgeben.
-In der Zwischenzeit benötigt der Key \lstinline=sub-list= etwas Aufmerksamkeit. Leider ist automatisches Sortieren nicht so trivial, wie man sich wünschte. Daher müssen Sie die Sublabel-Namen in der richtigen Reihenfolge einsetzen, um Label wie diese zu vermeiden:
+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}
- \cmpd[sub-list={five..three}]{q} or \cmpd[sub-list={three,one,four}]{q}.
+ 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
+\begin{framed}\ttfamily
+name{<link name>} has been referenced but does not exist, replaced by a fixed one
+\end{framed}
+\noindent ausgeben.
+\secidx*[Verwendung mit hyperref]{Verwendung mit \textsf{hyperref}}
+
\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
\begin{framed}
-\centering\lstinline+\cmpdsetup{key1 = value1, key2 = value2}+
+ \centering\cmd{cmpdsetup}{key1 = value1, key2 = value2}
\end{framed}
\noindent oder lokal direkt beim Befehl
\begin{framed}
-\centering\lstinline+\cmpd[key1 = value1, key2 = value2]{<label name>}+
+ \centering\cmd{cmpd}[key1 = value1, key2 = value2]{<label name>}
\end{framed}
\noindent vorgenommen werden.
@@ -542,22 +623,26 @@ Dabei gibt es verschiedene Arten von Schlüsseln. Je nach Art können sie andere
\item[\ttfamily choice] Auswahl-Schlüssel, für den es vorgegebene Optionen gibt, aus denen gewählt werden kann.
\end{description}
-Wenn Sie Schlüssel ohne Wertzuweisung verwenden \lstinline+\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. \emph{Alle} SChlüssel von \chemnum haben Defaultwerte. Sie werden in Abschnitt \ref{tab:keys} auf Seite \pageref{tab:keys} aufgelistet.
+Wenn Sie Schlüssel 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. \emph{Alle} Schlüssel von \chemnum haben Defaultwerte. Sie werden in Abschnitt \ref{tab:keys} auf Seite \pageref{tab:keys} aufgelistet.
Die Schlüssel sind in verschiedene Klassen\label{key_classes} unterteilt, die auf ihren Verwendungsbereich hindeuten. Sie folgen alle der Form \lstinline+<class>-key = <value>+:
\begin{description}
\item[\ttfamily cmpd] Schlüssel, die damit beginnen, wirken sich auch das Label insgesamt oder speziell auf das Hauptlabel aus.
- \item[\ttfamily sub] Diese Schlüssel haben mit den Sublabeln direkt zu tun.
+ \item[\texttt{sub}, \texttt{sublist}, \texttt{subrange}] Diese Schlüssel haben mit den Sublabeln direkt zu tun.
\item[\ttfamily list] Schlüssel, die die Ausgabe der Listen ändern.
- \item[\ttfamily ref] Schlüssel, die speziell mit \lstinline=\cmpdref= zu tun haben.
+ \item[\ttfamily ref] Schlüssel, die speziell mit \cmd{cmpdref} zu tun haben.
+ \item[\ttfamily hyper] Schlüssel, die mit der Verwendung von \paket{hyperref} zu tun haben.
+ \item[\ttfamily init] Schlüssel, die mit der Initialisierung von Labeln zu tun haben.
\end{description}
-\subsection{Schriftstil}\label{ssec:schriftstil}
+\subsection{Schriftstil}\label{ssec:schriftstil}\secidx{Schriftstil}
Um den Stil zu ändern, mit dem die Nummern geschrieben werden, verwenden Sie
\begin{framed}
-\noindent\lstinline+cmpd-style = <style>+ \hfill Typ: \lstinline=macro=\\
-\noindent\lstinline+cmpd-weight = bold/normal+ \hfill Typ: \lstinline=choice=
+ \keyentry{cmpd-style}{<style>}{macro}\\
+ \keyentry{cmpd-weight}{bold/normal}{choice}\\
+ \keyentry{ref-style}{<style>}{macro}
\end{framed}
+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} erzeugt Label mit \lstinline+\sffamily+ gesetzt.
\begin{beispiel}
% preamble:
% \usepackage[normalem]{ulem}
@@ -570,29 +655,32 @@ Um den Stil zu ändern, mit dem die Nummern geschrieben werden, verwenden Sie
\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.
+\secidx*{Schriftstil}
-\subsection{Eigene Labels}\label{ssec:own_labels}
+\subsection{Eigene Labels}\label{ssec:own_labels}\secidx{Eigene Labels}
Mit dem Schlüssel
\begin{framed}
-\noindent\lstinline+cmpd-label = <name>+ \hfill Typ: \lstinline=literal=
+ \keyentry{cmpd-label}{<name>}{literal}
\end{framed}
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}
\end{beispiel}
+\secidx*{Eigene Labels}
-\subsection{Eigene Marker in Bildern}
-Wenn Sie für die temporären Label, die durch \lstinline=\cmpdref= (siehe Seite \pageref{ssec:cmpdref}) nicht \lstinline=TMP= verwenden wollen, können Sie das ändern, \zB in \lstinline=tmp=: \label{key:key-tag}
+\subsection{Eigene Marker in Bildern}\secidx{Eigene Marker}
+Wenn Sie für die temporären Label, die durch \cmd{cmpdref} (siehe Seite \pageref{ssec:cmpdref}) nicht \lstinline=TMP= verwenden wollen, können Sie das ändern, \zB in \lstinline=tmp=: \label{key:key-tag}
\begin{beispiel}[code only]
\cmpdsetup{ref-marker = tmp}
\end{beispiel}
+\secidx*{Eigene Marker}
-\subsection{Zähler}\label{ssec:counter}
-Wenn Sie mögen, können Sie auch das Zählerformat \textbf{1a} ändern.
+\subsection{Zähler}\label{ssec:counter}\secidx[Zaehler]{Zähler}
+Wenn Sie mögen, können Sie auch das Zählerformat \cmpd{a.one} ändern.
\begin{framed}
-\noindent\lstinline+cmpd-counter = <counter>+ \hfill Typ: \lstinline=choice=\\
-\lstinline+sub-counter = <counter>+ \hfill Typ: \lstinline=choice=\label{key:sub-counter}
+ \keyentry{cmpd-counter}{<counter>}{choice}\\
+ \keyentry{sub-counter}{<counter>}{choice}\label{key:sub-counter}
\end{framed}
Zur Auswahl stehen \lstinline=arabic=, \lstinline=alph=, \lstinline=Alph=, \lstinline=greek=, \lstinline=Greek=, \lstinline=roman=, \lstinline=Roman= und \lstinline=Symbol=.
@@ -604,13 +692,14 @@ Bitte beachten Sie: ein Ändern des Zählerformats wirkt sich nur auf \emph{noch
\cmpd{f.three,f.four}\\ % Vorsicht: Hauptlabel wurde bereits erzeugt und wird nicht geaendert!
\cmpd[cmpd-counter,sub-counter = greek]{p.one,p.two}
\end{beispiel}
+\secidx*[Zaehler]{Zähler}
-\subsection{Begrenzer}
+\subsection{Begrenzer}\secidx{Begrenzer}
Sie können sowohl den einzelnen Nummern wie auch eine ganze Liste mit Begrenzern versehen. Dafür gibt es die Schlüssel:
\begin{framed}
-\noindent\lstinline+cmpd-delim = <odelim><cdelim>+ \hfill Typ: \lstinline=literal=\\
-\lstinline+list-delim = <odelim><cdelim>+ \hfill Typ: \lstinline=literal=\\
-Benötigen \emph{zwei} Token als Wert!
+ \keyentry{cmpd-delim}{<odelim><cdelim>}{literal}\\
+ \keyentry{list-delim}{<odelim><cdelim>}{literal}\\
+ Benötigen \emph{zwei} Token als Wert!
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
@@ -619,7 +708,7 @@ Benötigen \emph{zwei} Token als Wert!
\cmpdsetup{cmpd-delim = ()}
\cmpd{a, b, f.two, k} % eingeklammert
\end{beispiel}
-Wenn Sie \lstinline=\cmpd[cmps-delim]{<label>]= schreiben, also keinen Wert spezifizieren, werden \lstinline=()= verwendet. Dasselbe gilt für \lstinline=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 \lstinline=()= 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
@@ -635,8 +724,8 @@ Wenn Sie generell die Label eingeklammert verwenden, aber ein einzelnes einmal o
\end{beispiel}
Mit
\begin{framed}\label{cmd:ohne_begrenzer}
-\centering\lstinline=\cmpd-{<label name>}=\\
-\lstinline=\cmpdref-{<label name>}=
+ \centering\cmd[cmpdc]{cmpd-}{<label name>}\\
+ \cmd[cmpdrefc]{cmpdref-}{<label name>}
\end{framed}
\noindent kann man die Klammern eines Labels schnell entfernen (nicht jedoch die der Liste).
\begin{beispiel}
@@ -646,15 +735,16 @@ Mit
\cmpd-{a, b, f.two, k} % einfach eingeklammert
\end{beispiel}
-Durch leere Argumente, \lstinline+\cmpdsetup{cmpd-delim = }+ und \lstinline+\cmpdsetup{list-delim = }+, können Sie die Voreinstellung wiederherstellen.
+Durch leere Argumente, \cmd{cmpdsetup}{\key{cmpd-delim}{ }} und \cmd{cmpdsetup}{\key{list-delim}{ }}, können Sie die Voreinstellung wiederherstellen.
+\secidx*{Begrenzer}
-\subsection{Suffix und Präfix}
+\subsection{Suffix und Präfix}\secidx[Suffix und Praefix]{Suffix und Präfix}
Falls Sie wollen, können sie sowohl einzelnen Labeln als auch den Listen Prä- und Suffixe geben.
\begin{framed}
-\noindent\lstinline+cmpd-prefix = <prefix>+ \hfill Typ: \lstinline=literal=\\
-\lstinline+cmpd-suffix = <prefix>+ \hfill Typ: \lstinline=literal=\\
-\lstinline+list-prefix = <prefix>+ \hfill Typ: \lstinline=literal=\\
-\lstinline+list-suffix = <prefix>+ \hfill Typ: \lstinline=literal=
+ \keyentry{cmpd-prefix}{<prefix>}{literal}\\
+ \keyentry{cmpd-suffix}{<prefix>}{literal}\\
+ \keyentry{list-prefix}{<prefix>}{literal}\\
+ \keyentry{list-suffix}{<prefix>}{literal}
\end{framed}
Wie bei den Begrenzern gilt: Listen-Attribute werden erst bei einer Liste -- also zwei oder mehr Labeln -- verwendet.
@@ -681,31 +771,70 @@ Zwischen Präfix, Label und Suffix ist per Default ein Leerraum:
\end{beispiel}
Dieser kann durch
\begin{framed}
-\noindent\lstinline+cmpd-space = <space>+ \hfill Typ: \lstinline=literal=
+ \keyentry{cmpd-space}{<space>}{literal}
\end{framed}
\noindent geändert werden.
\begin{beispiel}
\cmpd[cmpd-suffix=Sx,cmpd-prefix=Px,cmpd-space={}]{k}
\end{beispiel}
+\secidx*[Suffix und Praefix]{Suffix und Präfix}
-\subsection{Trenner}\label{ssec:trenner}
-\subsubsection{Bei Labeln}
-Haben Sie Label mit Sublabeln, können Sie dort auch ein Trenn-Symbol verwenden.
+\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 \lstinline=.= 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 \lstinline=@= 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{framed}
-\noindent\lstinline+cmpd-sep = <separator>+ \hfill Typ: \lstinline=literal=
+ \keyentry{sub-input-sep}{<separator>}{literal}
+\end{framed}
+\begin{beispiel}
+ \cmpdsetup{sub-input-sep = !}%
+ \cmpd{f!one, g!two}\\
+ \cmpd[sub-input-sep= +]{f+one, g+two}\\
+ \cmpd[sub-input-sep= ~]{f~one, g~two}\\
+ \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 \lstinline=\tableofcontents= einsetzen. Am besten in der Präambel. Ansonsten kann \lstinline=\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.
+\begin{framed}
+ \keyentry{sub-output-sep}{<separator>}{literal}
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, f.three, k}\\ % default
- \cmpd[cmpd-sep = -]{a, b, f.two, f.three, k}\\
- \cmpdsetup{cmpd-sep = $\cdot$}
+ \cmpd[sub-output-sep = -]{a, b, f.two, f.three, k}\\
+ \cmpdsetup{sub-output-sep = $\cdot$}
\cmpd{a, b, f.two, f.three, k}\\
- \cmpd[cmpd-sep = :]{a, b, f.two, f.three, k}
+ \cmpd[sub-output-sep = :]{a, b, f.two, f.three, k}
\end{beispiel}
-\subsubsection{Bei Listen -- Eingabe}\label{sssec:list-input-sep}
-Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Default wird hier das Komma verwendet.
+\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 \texttt{..}. Sie können aber eine beliebige andere Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \lstinline=@= sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen Trennsymbole nicht die gleichen Zeichen zu verwenden.
\begin{framed}
-\noindent\lstinline+list-input-sep = <separator>+ \hfill Typ: \lstinline=literal=
+ \keyentry{subrange-input-sep}{<separator>}{literal}
+\end{framed}
+\begin{beispiel}
+ \cmpd[subrange-input-sep=:]{q.{one:four}}\\
+ \cmpdsetup{subrange-input-sep=--}
+ \cmpd{q.{one--four}}
+\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 diesem Key:
+\begin{framed}
+ \keyentry{subrange-output-sep}{<separator>}{literal}
+\end{framed}
+\begin{beispiel}
+ \cmpd[subrange-output-sep={ {\normalfont bis} }]{q.{one..four}}\\
+ \cmpdsetup{subrange-output-sep=-}
+ \cmpd{q.{one..four}}
+\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 \texttt{,} verwendet. Für die Eingabe eines Bereiches von Sublabeln verwendet \chemnum in der Voreinstellung zwei Punkte \texttt{..}. Sie können aber eine beliebige andere Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \lstinline=@= sollten Sie nicht verwenden. Außerdem sollten Sie darauf achten, für die anderen Trennsymbole nicht die gleichen Zeichen zu verwenden.
+\begin{framed}
+ \keyentry{list-input-sep}{<separator>}{literal}\\
+ \keyentry{sub-input-sep}{<separator>}{literal}
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
@@ -714,12 +843,17 @@ 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üdingk, 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 -- allgemein}
+\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.
\begin{framed}
-\noindent\lstinline+list-output-sep = <separator>+ \hfill Typ: \lstinline=literal=
+ \keyentry{list-output-sep}{<separator>}{literal}\\
+ \keyentry{sub-output-sep}{<separator>}{literal}
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
@@ -729,13 +863,13 @@ Auch bei Listen lässt sich ein Trennsymbol festlegen, das bestimmt, wie einzeln
\cmpd{a, b, f.two, k}
\end{beispiel}
-\subsubsection{Bei Listen -- letzter Trenner}\label{sssec:last-sep}
+\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 Schlüssel, mit dem er angepasst werden kann.
\begin{framed}
-\noindent\lstinline+list-last-sep = <separator>+ \hfill Typ: \lstinline=literal=\\
-\lstinline+list-lang = <lang>+ \hfill Typ: \lstinline=choice=
+ \keyentry{list-last-sep}{<separator>}{literal}\\
+ \keyentry{list-lang}{<lang>}{choice}
\end{framed}
-Zum einen gibt es den \lstinline=choice=-Schlüssel \lstinline=list-lang=, mit dem Sprachspezifische Einstellungen ge\-än\-dert werden können. Zur Auswahl stehen \lstinline=US= (default), \lstinline=GB=, \lstinline=DE=, \lstinline=FR=, \lstinline=ES= und \lstinline=IT=.
+Zum einen gibt es den \lstinline=choice=-Schlüssel \key{list-lang}, mit dem Sprachspezifische Einstellungen ge\-än\-dert werden können. Zur Auswahl stehen \lstinline=US= (default), \lstinline=GB=, \lstinline=DE=, \lstinline=FR=, \lstinline=ES= und \lstinline=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}\\
@@ -746,7 +880,7 @@ Zum einen gibt es den \lstinline=choice=-Schlüssel \lstinline=list-lang=, mit d
\end{beispiel}
Wie Sie sehen, verwendet die Spracheinstellung \lstinline=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 \lstinline=list-last-sep= auch individuell festlegen.
+Sie können den letzten Trenner mit \key{list-last-sep} auch individuell festlegen.
\begin{beispiel}
\cmpdsetup{list-lang = DE}%
\cmpd[list-last-sep = {und auch}]{a, b, f.two, k}\\
@@ -755,7 +889,7 @@ Sie können den letzten Trenner mit \lstinline=list-last-sep= auch individuell f
\cmpd[list-last-sep = empty]{a, b, f.two, k}
\end{beispiel}
-Ein spezieller Wert ist \lstinline=empty=. Wird er verwendet, wird überall der Trenner eingesetzt, der mit \lstinline=list-output-sep= festgelegt wurde.
+Ein spezieller Wert ist \lstinline=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}\\
@@ -763,25 +897,28 @@ Ein spezieller Wert ist \lstinline=empty=. Wird er verwendet, wird überall der
\cmpd[list-output-sep = {\ und}]{a, b, f.two, k}
\end{beispiel}
-\subsection{Sublabel-Marker}\label{ssec:sub_label_marker}
-Als Voreinstellung verwendet \chemnum den Punkt \lstinline=.= als Zeichen, um Hauptlabelnamen von Sublabelnamen zu unterscheiden. Sie können das nach Belieben ändern. Die Zeichen \verb=, % #= können Sie nicht verwenden und \lstinline=@= sollten Sie nicht verwenden.
+\subsubsection{Bei \texttt{\textbackslash\textcolor{code}{cmpdinit}} -- Eingabe}\label{sssec:init-input-sep}\index{Trennzeichen!cmpdinit@\textcolor{code}{\texttt{\textbackslash cmpdinit}}}
+Wenn Sie mögen, können Sie das Trennsymbol der Listen-Eingabe ändern. Per Default wird hier das Komma \texttt{,} verwendet. Sie können aber eine beliebige andere Eingabe wählen. Die Zeichen \verb=% #= können Sie nicht verwenden und \lstinline=@= sollten Sie nicht verwenden.
\begin{framed}
-\noindent\lstinline+sub-marker = <separator>+ \hfill Typ: \lstinline=literal=
+ \keyentry{init-input-sep}{<separator>}{literal}
\end{framed}
+
+\subsubsection{Ein Beispiel}\label{sssec:input-sep-bsp}
+Im folgenden sehen Sie ein kleines Beispiel, wie eine personalisierte Variante der Trennzeichen aussehen könnte.
\begin{beispiel}
- \cmpdsetup{sub-marker = !}%
- \cmpd{f!one, g!two}\\
- \cmpd[sub-marker= +]{f+one, g+two}\\
- \cmpd[sub-marker= ~]{f~one, g~two}\\
- \cmpd[sub-marker= &]{f&one, g&two}\\
- \cmpd[sub-marker= *]{f*one, g*two}\\
- \cmpd[sub-marker=\marker]{f\marker one,g\marker two}
+ \cmpdsetup{
+ sub-input-sep = ! ,
+ subrange-input-sep = : ,
+ sublist-input-sep = / ,
+ list-input-sep = +
+ }
+ \cmpd{a + f ! one + q ! one / three : five}
\end{beispiel}
-Sie sollten -- nicht nur aus Gründen der Konsistenz -- nur \emph{einmal} am Anfang ihres Dokuments entscheiden, welches Zeichen Sie verwenden. Und zwar \emph{bevor} Sie \lstinline=\tableofcontents= einsetzen. Am besten in der Präambel. Ansonsten kann \lstinline=\tableofcontents= nicht wissen, welchen Marker Sie verwenden und Label im Inhaltsverzeichnis können falsch dargstellt werden.
+\secidx*{Trennzeichen}
-\section{Sprachunterstützung}\label{sec:language_support}
+\section{Sprachunterstützung}\label{sec:language_support}\secidx[Sprachunterstuetzung]{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 \textsf{translator} Pakets, falls es vorhanden. Kann \textsf{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 \textsf{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}\\
@@ -794,9 +931,9 @@ Sie sollten -- nicht nur aus Gründen der Konsistenz -- nur \emph{einmal} am Anf
\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 \textsf{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}
+\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.
\begin{myquote}[\href{http://en.wikipedia.org/wiki/Serial_comma}{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).
@@ -805,61 +942,70 @@ Im US-Amerikanischen ist die Verwendung des sogenannten Harvard- oder Oxford-Kom
\end{myquote}
\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 dem Schlüssel
\begin{framed}
-\noindent\lstinline+list-serial-comma = true/false+ \hfill Typ: \lstinline=boolean=\label{key:list-serial-comma}
+ \keyentry{list-serial-comma}{true/false}{boolean}\label{key:list-serial-comma}
\end{framed}
\noindent nach Belieben zu (De-)Aktivieren.
\begin{beispiel}
\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 \lstinline=list-serial-comma= \emph{nach} \lstinline=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}
\end{beispiel}
+\secidx*{Harvard-Komma}\secidx*[Sprachunterstuetzung]{Sprachunterstützung}
-\newpage
\section{Übersicht}
\subsection{Keys}\label{ssec:keys_uebersicht}
Im folgenden sind alle verfügbaren Schlüssel aufgelistet.
\begin{center}
\label{tab:keys}
- \begin{longtabu*}{>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule
- \normalfont\bfseries key & \normalfont\bfseries default & \normalfont\bfseries type \\\midrule
- cmpd-style & & macro \\
- cmpd-weight & bold & choice \\
- cmpd-label & & literal \\
- cmpd-delim$^\mathrm{a}$ & & literal \\
- cmpd-odelim & & literal \\
- cmpd-cdelim & & literal \\
- cmpd-prefix & & literal \\
- cmpd-suffix & & literal \\
- cmpd-space & \lstinline=\penalty\@m\ = & literal \\
- cmpd-sep & & literal \\
- cmpd-counter & arabic & choice \\
- cmpd-all & true & boolean \\\midrule
- sub-marker & . & literal \\
- sub-counter & alph & choice \\
- sub-list & & other$^\mathrm{b}$ \\
- sub-range-sep & -- & literal \\
- sub-range-marker & .. & literal \\
- sub-only & & boolean \\\midrule
- list-delim$^\mathrm{a}$ & & literal \\
- list-odelim & & literal \\
- list-cdelim & & literal \\
- list-prefix & & literal \\
- list-suffix & & literal \\
- list-input-sep & , & literal \\
- list-output-sep & , & literal \\
- list-lang & US & choice \\
- list-last-sep & and$^\mathrm{c}$ & literal \\
- list-serial-comma & & boolean \\\midrule
- ref-tag & TMP & literal \\\bottomrule
+ \begin{longtabu*}{l>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule
+ \bfseries Key & \normalfont\bfseries Leerwert & \normalfont\bfseries Voreinstellung & \normalfont\bfseries Typ \\\midrule
+ \key{cmpd-style} & & & macro \\
+ \key{cmpd-weight} & bold & bold & choice \\
+ \key{cmpd-label} & & & literal \\
+ \key{cmpd-delim}$^\mathrm{a}$ & () & & literal \\
+ \key{cmpd-odelim} & & & literal \\
+ \key{cmpd-cdelim} & & & literal \\
+ \key{cmpd-prefix} & & & literal \\
+ \key{cmpd-suffix} & & & literal \\
+ \key{cmpd-space} & \lstinline=\penalty\@m\ = & \lstinline=\penalty\@m\ = & literal \\
+ \key{cmpd-counter} & arabic & arabic & choice \\
+ \key{cmpd-all} & true & false & boolean \\\midrule
+ \key{sub-only} & true & false & boolean \\
+ \key{sub-counter} & alph & alph & choice \\
+ \key{sub-output-sep} & & , & literal \\
+ \key{sub-input-sep} & . & . & literal \\
+ \key{sublist-output-sep} & , & , & literal \\
+ \key{sublist-input-sep} & , & , & literal \\
+ \key{subrange-output-sep} & -- & -- & literal \\
+ \key{subrange-input-sep} & .. & .. & literal \\\midrule
+ \key{list-delim}$^\mathrm{a}$ & () & & literal \\
+ \key{list-odelim} & & & literal \\
+ \key{list-cdelim} & & & literal \\
+ \key{list-prefix} & & & literal \\
+ \key{list-suffix} & & & literal \\
+ \key{list-input-sep} & , & , & literal \\
+ \key{list-output-sep} & , & , & literal \\
+ \key{list-lang} & US & US$^\mathrm{b}$ & choice \\
+ \key{list-last-sep} & and$^\mathrm{c}$ & & literal \\
+ \key{list-serial-comma} & true & true$^\mathrm{c}$ & boolean \\\midrule
+ \key{ref-tag} & TMP & TMP & literal \\
+ \key{ref-style} & & \lstinline=\sffamily= & macro \\\midrule
+ \key{init-strict} & true & false & boolean \\
+ \key{init-sub} & true & false & boolean \\
+ \key{init-input-sep} & , & , & literal \\\midrule
+ \key{hyper-use} & true & false & boolean \\
+ \key{hyper-target} & & & literal \\
+ \key{hyper-link} & & & literal \\\bottomrule
\end{longtabu*}
- \begin{tabular}{>{\footnotesize}r>{\footnotesize\raggedright}p{.3\linewidth}}
+ \setlength\extrarowheight{-1pt}
+ \begin{tabular}{>{\footnotesize}r>{\footnotesize\raggedright}p{.7\linewidth}}
a & Benötigt \emph{zwei} Token als Wert. \tabularnewline
- b & Eingabe ist eine Komma-separierte Liste, siehe Seite \pageref{key:sub-list}. \tabularnewline
- c & Hängt vom Wert von \lstinline=list-lang= und der Verwendung von \textsf{babel} ab.
+ b & Hängt von der Verwendung von \paket*{babel} ab. \tabularnewline
+ c & Hängt vom Wert von \key{list-lang} und der Verwendung von \paket*{babel} ab.
\end{tabular}
\end{center}
@@ -867,22 +1013,24 @@ Im folgenden sind alle verfügbaren Schlüssel aufgelistet.
Im folgenden werden alle von \chemnum definierten Befehle und deren Varianten aufgelistet.
\begin{center}
\label{tab:commands}
- \begin{tabu*}{l>{\raggedright}p{.5\linewidth}}\toprule
- \bfseries Befehl & \bfseries Beschreibung \tabularnewline\midrule
- \lstinline=\cmpd[]{}= & Hauptbefehl, erzeugt und schreibt Label oder Liste von Labeln, siehe Seite \pageref{sec:nummerieren}ff. \tabularnewline
- \lstinline=\cmpd*{}= & unsichtbar, erzeugt Label, siehe Seite \pageref{cmd:unsichtbares_label} \tabularnewline
- \lstinline=\cmpd-[]{}= & ohne Begrenzer, siehe Seite \pageref{cmd:ohne_begrenzer} \tabularnewline
- \lstinline=\cmpd+-[]{}= & Label wird aus Hilfsdatei gelesen, siehe Seite \pageref{cmd:cmpd_plus} \tabularnewline\midrule
- \lstinline=\cmpdinit{}= & Label initialisieren und erzeugen, siehe Seite \pageref{sec:cmpdinit}f. \tabularnewline
- \lstinline=\cmpdinit*{}= & Label initialisieren, siehe Seite \pageref{sec:cmpdinit}f. \tabularnewline\midrule
- \lstinline=\cmpdref[][]{}= & temporäre Label in \texttt{eps}-Dateien durch Label ersetzen, siehe Seite \pageref{ssec:cmpdref} \tabularnewline
- \lstinline=\cmpdref-[][]{}= & temporäre Label in \texttt{eps}-Dateien durch Label ohne Begrenzer ersetzen, siehe Seite \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule
- \lstinline=\cmpdreset[]= & Zähler zurücksetzen, siehe Seite \pageref{sec:cmpdreset} \tabularnewline\midrule
- \lstinline=\cmpdsetup{}= & \chemnum einstellen, siehe Seite \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule
- \end{tabu*}
+ \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
+ \end{longtabu*}%
\end{center}
\section{Dank}
Ich möchte Joseph \textsc{Wright} und Russell \textsc{Hewitt} danken, die mir wertvolle Vorschläge und Feedback gaben, um \chemnum zu verbessern.
+\printindex
+
\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.pdf b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.pdf
index 909bb378f42..4305e52756b 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.pdf
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex
index 12936db8f55..290da2d63b4 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex
@@ -3,7 +3,7 @@
% - a comprehensive approach for the numbering of chemical compounds - %
% ------------------------------------------------------------------------------------- %
% - Clemens NIEDERBERGER - %
-% - 2011/12/01 - %
+% - 2011/12/08 - %
% ------------------------------------------------------------------------------------- %
% - http://www.mychemistry.eu/ - %
% - contact@mychemistry.eu - %
@@ -29,12 +29,12 @@
% - chemnum_doc_en.tex, chemnum-codehelper.tex, scheme-tmp.eps, scheme-bla.eps, - %
% - README and the derived files chemnum_doc_de.pdf and chemnum_doc_en.pdf - %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\documentclass[DIV11]{scrartcl}
-\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,french,canadien,spanish,italian]{babel}
+\documentclass[DIV11,toc=index]{scrartcl}
+\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,frenchb,canadien,spanish,italian]{babel}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenx}
\usepackage[textgreek]{chemnum}
-\usepackage{textcomp,microtype,libertine,url,xspace,longtable,tabu,booktabs,chemscheme}
+\usepackage{textcomp,microtype,libertine,url,xspace,longtable,tabu,booktabs,chemscheme,makeidx}
\usepackage[version=3]{mhchem}
\usepackage[normalem]{ulem}
\usepackage[dvipsnames]{xcolor}
@@ -46,6 +46,19 @@
\usepackage{chemfig,chemmacros}
\input{chemnum-codehelper}
+\begin{filecontents}{index_en.ist}
+ preamble "\\begin{theindex}\n Section headings are typeset \\textbf{bold}, packages \\textsf{sans serif}, commands \\textcolor{code}{brown}, and keys \\textcolor{key}{green}.\\newline\n\n"
+ heading_prefix "{\\bfseries "
+ heading_suffix "\\hfil}\\nopagebreak\n"
+ headings_flag 1
+ delim_0 "\\dotfill "
+ delim_1 "\\dotfill "
+ delim_2 "\\dotfill "
+ delim_r "--"
+ suffix_2p "\\nohyperpage{\\,f.}"
+ suffix_3p "\\nohyperpage{\\,ff.}"
+\end{filecontents}
+
\usepackage{hyperref}
\hypersetup{colorlinks=true,
allcolors=myblue,
@@ -60,31 +73,30 @@
pdfcreator={LaTeX}
}
-\newcommand*\changefont[3]{\fontfamily{#1}\fontseries{#2}\fontshape{#3}\selectfont}
-
\ExplSyntaxOn
-\DeclareDocumentEnvironment { myquote } { m }
- {
- \quote
- \small \changefont { cmss } { m } { sl }
- }
+\NewDocumentCommand \keyentry { mmm }
{
- \par\noindent
- \parbox { \linewidth } { \raggedleft \normalfont \itshape #1 }
- \endquote
+ \noindent
+ \textcolor{key}{ \texttt { #1 } }
+ \texttt { ~=~#2 }
+ \hfill type:~
+ \texttt { #3 }
+ \index { #1 @ \textcolor{key}{ \texttt { #1 } } }
}
\ExplSyntaxOff
-\newcommand*\chemnum{{\scshape\textcolor{myblue}{chemnum}}\xspace}
-\newcommand*\CNversion{v0.3e\xspace}
-\newcommand*\CNdate{2011/12/01\xspace}
+\GetFileInfo{chemnum}
+\newcommand*\chemnum{{\scshape\textcolor{myblue}{\filename}}\xspace}
+\newcommand*\CNversion{\fileversion\xspace}
+\newcommand*\CNdate{\filedate\xspace}
+\newcommand*\CNinfo{\fileinfo\ with \LaTeXe.}
-\newcommand*\paket[1]{\textsf{#1}\footnote{\url{http://www.ctan.org/pkg/#1}}}
\newcommand*\eg{\mbox{e.\,g.}\xspace}
\newcommand*\ie{\mbox{i.\,e.}\xspace}
\newcommand*\etc{\mbox{etc.}\xspace}
-\cmpdinit*{a,aa,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,benzene,r,s,t}
+\cmpdinit*{a,aa,b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,benzene,r,s,t,{1,3-dichlorocyclohexanole}}
+\makeindex
\begin{document}
\selectlanguage{english}
\begin{titlepage}
@@ -97,8 +109,9 @@
\vskip.25cm
\normalsize\url{http://www.mychemistry.eu/}\\
\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}
- \begin{center}\Large\color{myblue}
- A comprehensive approach for the numbering of chemical compounds with \LaTeXe.
+ \begin{center}
+ \Large\color{myblue} \CNinfo \\[16pt]
+ \normalcolor English documentation
\end{center}
\vskip3cm \cmpdinit*{glucose.alpha, glucose.beta, glucose.chain}
\cmpd*[sub-counter = greek]{glucose.alpha, glucose.beta}\cmpd*{glucose.chain}
@@ -123,34 +136,72 @@
\cmpdreset
\tableofcontents
-\section{Licence, Requirements}
+\section{A very short readme}
\chemnum \CNversion underlies the \LaTeX\ Project Public License Version 1.3 or later.\newline(\url{http://www.latex-project.org/lppl.txt})
-\chemnum internally loads the packages \textsf{expl3} and \paket{xparse}. \textsf{xparse} is part of the \paket{l3packages} bundle, \textsf{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}.
-\section{Package Options}\label{sec:package_options}
+In this command you can easily distinguish between a \textcolor{code}{\ttfamily\textbackslash command}, a \textcolor{key}{\ttfamily key} belonging to a key/value pair and \texttt{other code}.
+
+\section{News and a word of apology}
+In the update to v0.4 there have been some changes made with the keys. 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 keys have new names:
+\begin{center}
+ \begin{tabular}{ll}\toprule
+ \bfseries old name & \bfseries new name \\\midrule
+ \key{cmpd-sep} & \key{sub-output-sep} \\
+ \key{sub-marker} & \key{sub-input-sep} \\
+ \key{sub-range-sep} & \key{subrange-output-sep} \\
+ \key{sub-range-marker} & \key{subrange-input-sep} \\
+ \key{strict} & \key{init-strict} \\
+ \key{sub-init} & \key{init-sub} \\\bottomrule
+ \end{tabular}
+\end{center}
+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{f.{one,two}}, see page \pageref{sssec:list-output-sep}. \\
+ \key{sublist-input-sep} & list separation in the input of labels like \cmpd{f.{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
+ \end{tabular}
+\end{center}
+
+Also new is the way how lists and ranges of sublabels are input. The key \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}.
+
+With v0.4 this documentation got an index.
+
+\section{Package options}\label{sec:package_options}\secidx{Package options}
\chemnum has one package option.
\begin{framed}
\centering\lstinline+\usepackage[textgreek = <value>]{chemnum}+
\end{framed}
-With this you can both choose between the three different styles of the \textsf{textgreek} package\footnote{See the \textsf{textgreek} documentation for details.} or load \chemnum without the \textsf{textgreek} package. Available values are \lstinline=artemisia=, \lstinline=cbgreek=, \lstinline=euler= and \lstinline=false=. Using \lstinline+\usepackage[textgreek]{chemnum}+ is the same as \lstinline+\usepackage[textgreek = cbgreek]{chemnum}+. If you use \chemnum without option \textsf{textgreek} is not used. This corresponds to \lstinline+\usepackage[textgreek = false]{chemnum}+, the default setting.
+With this you can both choose between the three different styles of the \paket{textgreek} package\footnote{See the \paket*{textgreek} documentation for details.} or load \chemnum without the \paket{textgreek} package. Available values are \lstinline=artemisia=, \lstinline=cbgreek=, \lstinline=euler= and \lstinline=false=. Using \lstinline+\usepackage[textgreek]{chemnum}+ is the same as \lstinline+\usepackage[textgreek = cbgreek]{chemnum}+. If you use \chemnum without option \textsf{textgreek} is not used. This corresponds to \lstinline+\usepackage[textgreek = false]{chemnum}+, the default setting.
This document was set with \lstinline+\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.
The first one -- \paket{chemcono} -- redefined bibliography commands for that purpose. Compounds have to be declared in what is called \lstinline=\theffbibliography=. Then one can reference them with \lstinline=\fcite=. However, it produces a list of compounds in the text. So the package author suggests:
-\begin{myquote}{Stefan Schulz}
+\begin{myquote}[Stefan Schulz]
After compilation and printout, discard the last page.
\end{myquote}
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 \textsf{chemcono} any more. When he wrote the package he basically used the same mechanism to create the labels as \textsf{chemcono} did.
-\begin{myquote}{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 \lstinline=\bibitem= and \lstinline=\cite= in pretty much the same way as \textsf{chemcono} does by extracting the corresponding code from \lstinline=article.cls= and \lstinline=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.
+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{myquote}[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 \lstinline=\bibitem= and \lstinline=\cite= in pretty much the same way as \paket{chemcono} does by extracting the corresponding code from \lstinline=article.cls= and \lstinline=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{myquote}
Some points still left me unsatisfied, though:
\begin{enumerate}
@@ -162,16 +213,15 @@ Some points still left me unsatisfied, though:
Then there is \paket{bpchem}, which provides commands similar to \lstinline=\label= \lstinline=\ref=: \lstinline=\CNlabel{}=, \lstinline=\CNlabelnoref{}= and \lstinline=\CNref{}=. It provides commands for sublabels, too: \lstinline=\CNlabelsub{}{}=, \lstinline=\CNlabelsubnoref{}{}= and \lstinline=\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 \textsf{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.
-\newpage
\section{Numbering compounds}\label{sec:nummerieren}
-\subsection{Basic command}
-The main command of this package is
+\subsection{Main command}\secidx{Main command}
+The main command of this package is this one:
\begin{framed}
-\centering\lstinline=\cmpd{<label name>}=
+ \centering\cmd{cmpd}{<label name>}
\end{framed}
\noindent When \lstinline=<label name>= is used the first time, the label is created, saved (= declared) and printed. Each further use just prints the label.
@@ -182,26 +232,28 @@ The main command of this package is
If it is necessary to declare a compound without printing the label, this is possible with
\begin{framed}\label{cmd:unsichtbares_label}
-\centering\lstinline=\cmpd*{<label name>}=
+\centering\cmd[cmpda]{cmpd*}{<label name>}
\end{framed}
-\noindent This declares the label but doesn't print anything. \textbf{This command is not needed when} \lstinline=\cmpdinit{}= \textbf{is used, see section \ref{sec:cmpdinit} (pages \pageref{sec:cmpdinit}ff).}
+\noindent This declares the label but doesn't print anything. \textbf{This command is not needed when} \cmd{cmpdinit}{} \textbf{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.
\end{beispiel}
-You can pretty much use what you like for a label name\footnote{There are restrictions, see section \ref{ssec:listen} on page \pageref{ssec:listen}, section \ref{sssec:list-input-sep} on page \pageref{sssec:list-input-sep}, section \ref{ssec:unterlabel} on page \pageref{ssec:unterlabel} and section \ref{ssec:sub_label_marker} on page \pageref{ssec:sub_label_marker}.}. 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}.
\end{beispiel}
+\lstset{showspaces=false}\secidx*{Main command}
-\subsection{Sublabels}\label{ssec:unterlabel}
+\subsection{Sublabel}\label{ssec:unterlabel}\secidx{Sublabel}
If you want a label like \cmpd{a.one}, you need to use the following syntax:
\begin{framed}
-\centering\lstinline=\cmpd{<label name>.<subname>}=
+ \centering\cmd{cmpd}{<label name>.<subname>}
\end{framed}
-\noindent \lstinline=<label name>= is the main name which stays the same, \lstinline=<subname>= varies. This syntax means that the point \lstinline=.= \emph{cannot} be a part of \lstinline=<label name>= or \lstinline=<subname>=.
+\noindent \lstinline=<label name>= is the main name which stays the same, \lstinline=<subname>= varies. This syntax means that the point \lstinline=.= \emph{cannot} be a part of \lstinline=<label name>= or \lstinline=<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}.
@@ -219,33 +271,86 @@ 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[sub-list={one,two}]{f} is explained in section \ref{ssec:lists_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}
-There is actually more to the \lstinline=\cmpd= command. It also prints lists of labels.
+\subsection{Lists}\label{ssec:listen}\secidx{Lists}
+There is actually more to the \cmd{cmpd} command. It also prints lists of labels.
The right description would be something like:
\begin{framed}
-\centering\lstinline=\cmpd{<(possibly comma separated list of) label name(s)>}=
+ \centering\cmd{cmpd}{<(possibly comma separated list of) label name(s)>}
\end{framed}
-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}.
+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 \cmd{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 \verb=, 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}.
+
+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.
+
+Using this syntax you also can create ranges of sublabels. As a marker to indicate the range \chemnum uses two points \lstinline=..=.
+\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}.
+
+\chemnum provides a key (see section \ref{sec:cmpdsetup} for more details), with which all sublabels of a main label can be printed as range.
+\begin{framed}
+ \keyentry{cmpd-all}{true/false}{boolean}
+\end{framed}
+\begin{beispiel}
+ \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 \lstinline=<jobname>.cmpd= file (supposing your source file is called \lstinline=<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 key:
+\begin{framed}
+ \keyentry{sub-only}{true/false}{boolean}
+\end{framed}
+\begin{beispiel}
+ % uses packages `chemfig', `mhchem' and `booktabs'
+ \cmpd*{benzene.H,benzene.Me,benzene.OH,benzene.NH2}
+ \chemname{\chemfig{*6(=-=-(-R)=-)}}{\cmpd[cmpd-all]{benzene}}
+ \begin{tabular}{lll}
+ & \ce{{}-R} & Name \\\midrule
+ \cmpd[sub-only]{benzene.H} & \ce{{}-H} & Benzene \\
+ \cmpd[sub-only]{benzene.Me} & \ce{{}-CH3} & Toluene \\
+ \cmpd[sub-only]{benzene.OH} & \ce{{}-OH} & Phenol \\
+ \cmpd[sub-only]{benzene.NH2} & \ce{{}-NH2} & Phenylamine (Aniline)
+ \end{tabular}
+\end{beispiel}
-\section{Initialize labels at once}\label{sec:cmpdinit}
+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.
\subsection{Usage}
\subsubsection{Main labels}
Perhaps you're missing \textsf{chemcompounds}' command \lstinline=\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{framed}
-\centering\lstinline=\cmpdinit{<comma separated list of label names>}=
-\centering\lstinline=\cmpdinit*{<comma separated list of label names>}=
+ \centering\cmd{cmpdinit}{<comma separated list of label names>}
+ \centering\cmd[cmpdinita]{cmpdinit*}{<comma separated list of label names>}
\end{framed}
-All compounds set inside \lstinline=\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}
@@ -263,7 +368,7 @@ All compounds set inside \lstinline=\cmpdinit{}= are initialized and declared \e
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.
-\lstinline=\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}
@@ -279,91 +384,96 @@ Please note that for labels with sublabels only the \emph{main name} can and sho
{}*************************************************
\end{framed}
-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 \lstinline=\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}).
\subsubsection{Sublabels}
If you'd like a warning for label-sublabel combinations as well, or want to preset their order, you can use
\begin{framed}
-\centering\lstinline+\cmpdinit[!!sub-init = true!!]{<comma separated list of label names>}+
+ \centering\cmd{cmpdinit}[\key{init-sub}{true}]{<comma separated list of label names>}
\end{framed}
\noindent This will give you a warning in these cases, too.
\cmpdreset
\begin{beispiel}
- \cmpdinit[sub-init = true]{E.e} \cmpd{E.e, E.f}
+ \cmpdinit[init-sub = true]{E.{e,f,g}}
+ \cmpd{E.e, E.h}
\end{beispiel}
\begin{framed}
\small\ttfamily\noindent
{}*************************************************\\
- {}* chemnum warning: "cmpd-sub-init"\\
+ {}* chemnum warning: "cmpd-init-sub"\\
{}* \\
- {}* You used \verb=\cmpdinit= and "{}sub-init = true"{} but didn't initiate sub-compound\\
- {}* "{}E.f"{} on line 1.\\
+ {}* You used \verb=\cmpdinit= and "{}init-sub = true"{} but didn't initiate sub-compound\\
+ {}* "{}E.h"{} on line 1.\\
{}*************************************************
\end{framed}
\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 \lstinline=\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{framed}
-\centering\lstinline+\cmpdinit[!!strict=true!!]{<comma separated list of label names>}+
+ \centering\cmd{cmpdinit}[\key{init-strict}{true}]{<comma separated list of label names>}
\end{framed}
-A usage of \lstinline+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 \lstinline+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 \lstinline=\cmpdinit= with both keys:
+Of course you can use \cmd{cmpdinit} with both keys
\begin{framed}
-\centering\lstinline+\cmpdinit[strict = true, sub-init = true]{<comma separated list of label names>}+
+ \centering\cmd{cmpdinit}[\key{init-strict}{true}, \key{init-sub}{true}]{<comma separated list of label names>}
\end{framed}
+\noindent 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.
-If you have chosen a different sublabel marker (see page \pageref{ssec:sub_label_marker}) you need to use it with \lstinline+\cmpdinit[sub-init = true]+ 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}.
\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.
\begin{enumerate}
- \item The use of \lstinline=\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 \lstinline=\cmpdinit= does the same thing as \lstinline=\cmpdinit*= \emph{and} declares all the labels in the given order. So if you use it, you won't have to use \lstinline=\cmpd*= (section \ref{cmd:unsichtbares_label}) and \lstinline=\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}
-\section{Resetting the counter}\label{sec:cmpdreset}
+\section{Resetting the counter}\label{sec:cmpdreset}\secidx{Reset the counter}
With the command
\begin{framed}
-\centering\lstinline=\cmpdreset[<number>]=
+ \centering\cmd{cmpdreset}[<number>]
\end{framed}
-\noindent it is possible to reset the counter. Without argument it is reset to \verb=1=. So \lstinline=\cmpdreset= and \lstinline=\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.
-
+\noindent 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}
\textbf{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}
\end{beispiel}
+\secidx*{Reset the counter}
\section{Special usage}
\subsection{Moving arguments -- section titles}
-Using \lstinline=\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 \lstinline=\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 \lstinline=\cmpdinit{}= (see page \pageref{sec:cmpdinit}) in the preamble or the beginning of the document.
- \item You use \lstinline=\cmpd+= to set the label. It will read the label from the file \lstinline=<jobname>.cmpd= (supposing your main file is called \lstinline=<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 \lstinline=<jobname>.cmpd= (supposing your main file is called \lstinline=<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 command\label{cmd:cmpd_plus}
\begin{framed}
-\centering\lstinline=\cmpd+{<label name>}=
+ \centering\cmd[cmpdb]{cmpd+}{<label name>}
\end{framed}
-reads the label name that is to be printed from \lstinline=<jobname>.cmpd=. In a way this is the opposite of \lstinline=\cmpd*= since it doesn't declare a label but only references and prints it. So in order to use \lstinline=\cmpd+{<label>}=, \lstinline=<label>= must have been declared, either with \lstinline=\cmpd{<label>}= or with \lstinline=\cmpd*{<label>}=. It doesn't matter, if this declaration is done before or after the usage of \lstinline=\cmpd+=. This command is useful, if the label is used inside a moving argument like in \lstinline=\section{}=. \textbf{It is not needed when} \lstinline=\cmpdinit{}= \textbf{is used, see section \ref{sec:cmpdinit} (pages \pageref{sec:cmpdinit}ff).}
+reads the label name that is to be printed from \lstinline=<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>}, \lstinline=<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 \lstinline=\section{}=. \textbf{It is not needed when} \cmd{cmpdinit}{} \textbf{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}}
@@ -372,7 +482,7 @@ reads the label name that is to be printed from \lstinline=<jobname>.cmpd=. In a
\end{beispiel}
\subsection{Floating environments}\cmpdinit*{float1,float2}
-The usage of \lstinline=\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 \lstinline=\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}
@@ -388,10 +498,10 @@ The usage of \lstinline=\cmpd= inside a float shouldn't be a problem: labels are
This also works, of the floating environment is placed before the code, for instance by using the option \lstinline=[t]=.
\cmpdinit*{Alc,EtherBr,cpd}
-\subsection{Schemes created by external programs}\label{ssec:cmpdref}
+\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 \textsc{ChemDraw} or \textsc{Marvin\-Sketch}, and want to use \chemnum with them as well, you can use this command:
\begin{framed}
-\centering\lstinline=\cmpdref[<keyval>][<tag>]{<label name>}=
+ \centering\cmd{cmpdref}[<keyval>][<tag>]{<label name>}
\end{framed}
This command is inspired by the \lstinline=\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 \lstinline=eps= file.
\begin{beispiel}[code and float]
@@ -406,10 +516,10 @@ This command is inspired by the \lstinline=\schemeref= command from the package
\cmpdref{EtherBr} % replaces TMP2
% \cmpdref{third} would replace TMP3
\includegraphics{scheme-tmp}
- \caption{Scheme with automatted labels.}
+ \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 \textsf{chemscheme} \chemnum uses the \lstinline=\psfrag= command to do that. This means you have to either compile via \textsc{latex}, \textsc{dvips}, \textsc{ps2pdf}, or for instance use the package \paket{auto-pst-pdf} to be able to use \textsc{pdflatex}.
+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 \lstinline=\psfrag= command of the \paket{psfrag} package to do that. This means you have to either compile via \textsc{latex}, \textsc{dvips}, \textsc{ps2pdf}, or for instance use the package \paket{auto-pst-pdf} to be able to use \textsc{pdflatex}.
In each case it is important that the marker is saved as \emph{text} in the \lstinline=eps= file.
@@ -420,7 +530,7 @@ You can customize the labels with the keys presented in section \ref{sec:cmpdset
\cmpdref[cmpd-style=\bf\sf\textcolor{green}]{Alc} % replaces TMP1
\cmpdref[cmpd-style=\bf\sf\textcolor{green}]{EtherBr} % replaces TMP2
\includegraphics{scheme-tmp}
- \caption{Scheme with automatted labels.}
+ \caption{Scheme with automated labels.}
\end{scheme}
\end{beispiel}
@@ -448,20 +558,57 @@ Of course sublabels work in the known way:
\cmpdref{cpd.red}
\cmpdref{cpd.ox}
\includegraphics{scheme-tmp}
- \caption{Scheme with automatted labels and sublabels.}
+ \caption{Scheme with automated labels and sublabels.}
\end{scheme}
\end{beispiel}
+\cmpdreset[10]\secidx*{Schemes by external programs}
+
+\section{Usage with \textsf{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 \textsc{pdf}.
+\begin{framed}
+ \keyentry{hyper-use}{true/false}{boolean}
+\end{framed}
+Setting this key (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.
+
+\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}.
+
+ 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 keys:
+\begin{framed}
+ \keyentry{hyper-target}{<link name>}{literal}\\
+ \keyentry{hyper-link}{<link name>}{literal}
+\end{framed}
+With \key{hyper-target} you can set the target. \textbf{Caution}: if you use this key with a list \emph{every} label of the list will get the same link name and \paket{hyperref} will warn you:
+\begin{framed}\ttfamily
+destination with the same identifier (name{<link name>}) has been already used, duplicate ignored
+\end{framed}
+
+\key{hyper-link} creates a link for the denominated target. \textbf{Caution}: if you use this key 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}.
+\end{beispiel}
+
+If you use \key{hyper-link} without the corresponding \key{hyper-target} \paket{hyperref} will issue a warning:
+\begin{framed}\ttfamily
+name{<link name>} has been referenced but does not exist, replaced by a fixed one
+\end{framed}
+\secidx*[Usage with hyperref]{Usage with \textsf{hyperref}}
-\newpage\cmpdreset[9]
\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
\begin{framed}
-\centering\lstinline+\cmpdsetup{key1 = value1, key2 = value2}+
+ \centering\cmd{cmpdsetup}{key1 = value1, key2 = value2}
\end{framed}
\noindent or only for a single command directly with
\begin{framed}
-\centering\lstinline+\cmpd[key1 = value1, key2 = value2]{<label name>}+
+ \centering\cmd{cmpd}[key1 = value1, key2 = value2]{<label name>}
\end{framed}
There are different kinds of keys. Depending on it they can have different kinds of values.
@@ -472,21 +619,23 @@ There are different kinds of keys. Depending on it they can have different kinds
\item[\ttfamily boolean] These keys can either have the value \lstinline=true= or \lstinline=false=.
\end{description}
-If you use keys without values like \lstinline+\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. \emph{All} of \chemnum's keys have default values. They are listed in section \ref{tab:keys} on page \pageref{tab:keys}.
+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. \emph{All} of \chemnum's keys have default values. They are listed in section \ref{tab:keys} on page \pageref{tab:keys}.
The keys are divided in to different classes\label{key_classes}, which indicate the scope they're used for. They all follow the form \lstinline+<class>-key = <value>+:
\begin{description}
\item[\ttfamily cmpd] These keys change the whole label or the main label.
- \item[\ttfamily sub] These keys have an impact on sublabels.
+ \item[\texttt{sub}, \texttt{sublist}, \texttt{subref}] These keys have an impact on sublabels.
\item[\ttfamily list] Keys which change the output of lists.
- \item[\ttfamily ref] Keys which have an impact on \lstinline=\cmpdref=.
+ \item[\ttfamily ref] Keys which have an impact on \cmd{cmpdref}.
+ \item[\ttfamily hyper] Keys which have an impact on the usage with \paket{hyperref}.
+ \item[\ttfamily init] Keys which have an impact in the initialization of the labels.
\end{description}
-\subsection{Font style}\label{ssec:schriftstil}
+\subsection{Font style}\label{ssec:schriftstil}\secidx{Font style}
With the keys
\begin{framed}
-\noindent\lstinline+cmpd-style = <style>+ \hfill type: \lstinline=macro=
-\noindent\lstinline+cmpd-weight = bold/normal+ \hfill type: \lstinline=choice=
+ \keyentry{cmpd-style}{<style>}{macro}\\
+ \keyentry{cmpd-weight}{bold/normal}{choice}
\end{framed}
\noindent you can change the style with which the labels are printed.
@@ -502,29 +651,32 @@ With the keys
\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.
+\secidx*{Font style}
-\subsection{Own labels}\label{ssec:own_labels}
+\subsection{Own labels}\label{ssec:own_labels}\secidx{Own labels}
With the key
\begin{framed}
-\noindent\lstinline+cmpd-label = <label>+ \hfill type: \lstinline=literal=
+ \keyentry{cmpd-label}{<label>}{literal}
\end{framed}
\noindent 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}
\end{beispiel}
+\secidx*{Own labels}
-\subsection{Own markers in images}
-If you don't want to use \lstinline=TMP= as temporary markers for \lstinline=\cmpdref= (see page \pageref{ssec:cmpdref}), you can change this. For example into \lstinline=tmp=: \label{key:key-tag}
+\subsection{Own markers in images}\secidx{Own markers in images}
+If you don't want to use \lstinline=TMP= as temporary markers for \cmd{cmpdref} (see page \pageref{ssec:cmpdref}), you can change this. For example into \lstinline=tmp=: \label{key:key-tag}
\begin{beispiel}[code only]
\cmpdsetup{ref-marker = tmp}
\end{beispiel}
+\secidx*{Own markers in images}
-\subsection{Counter}\label{ssec:counter}
+\subsection{Counter}\label{ssec:counter}\secidx{Counter}
You can change the format of the counters, too, if you like.
\begin{framed}
-\noindent\lstinline+cmpd-counter = <counter>+ \hfill type: \lstinline=choice=\\
-\lstinline+sub-counter = <counter>+ \hfill type: \lstinline=choice=\label{key:sub-counter}
+ \keyentry{cmpd-counter}{<counter>}{choice}\\
+ \keyentry{sub-counter}{<counter>}{choice}\label{key:sub-counter}
\end{framed}
You can choose between \lstinline=arabic=, \lstinline=alph=, \lstinline=Alph=, \lstinline=greek=, \lstinline=Greek=, \lstinline=roman=, \lstinline=Roman= and \lstinline=Symbol=.
@@ -536,12 +688,13 @@ Please note: a change of format only affects labels \emph{which are not yet decl
\cmpd{f.three,f.four}\\ % be careful: the main label already exists and isn't changed!
\cmpd[cmpd-counter,sub-counter = greek]{p.one,p.two}
\end{beispiel}
+\secidx*{Counter}
-\subsection{Delimiters}
+\subsection{Delimiters}\secidx{Delimiters}
Both single labels and whole lists can get delimiters. This is done with the keys
\begin{framed}
-\noindent\lstinline+cmpd-delim = <odelim><cdelim>+ \hfill type: \lstinline=literal=\\
-\lstinline+list-delim = <odelim><cdelim>+ \hfill type: \lstinline=literal=\\
+ \keyentry{cmpd-delim}{<odelim><cdelim>}{literal}\\
+ \keyentry{list-delim}{<odelim><cdelim>}{literal}\\
values need \emph{two} tokens!
\end{framed}
\begin{beispiel}
@@ -551,7 +704,7 @@ values need \emph{two} tokens!
\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 \lstinline=cmpd-delim= and \lstinline=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 \lstinline=\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
@@ -567,8 +720,8 @@ If you generally use labels in braces but want to use a single one without brace
\end{beispiel}
With
\begin{framed}\label{cmd:ohne_begrenzer}
-\centering\lstinline=\cmpd-{<label name>}=\\
-\lstinline=\cmpdref-{<label name>}=
+ \centering\cmd[cmpdc]{cmpd-}{<label name>}\\
+ \cmd[cmpdrefc]{cmpdref-}{<label name>}
\end{framed}
\noindent the braces of single labels can easily be removed (but not the ones of a list).
\begin{beispiel}
@@ -578,15 +731,16 @@ With
\cmpd-{a, b, f.two, k} % braced once
\end{beispiel}
-Using \lstinline+\cmpdsetup{cmpd-delim = }+ and \lstinline+\cmpdsetup{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}
+\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.
\begin{framed}
-\noindent\lstinline+cmpd-prefix = <prefix>+ \hfill type: \lstinline=literal=\\
-\lstinline+cmpd-suffix = <prefix>+ \hfill type: \lstinline=literal=\\
-\lstinline+list-prefix = <prefix>+ \hfill type: \lstinline=literal=\\
-\lstinline+list-suffix = <prefix>+ \hfill type: \lstinline=literal=
+ \keyentry{cmpd-prefix}{<prefix>}{literal}\\
+ \keyentry{cmpd-suffix}{<prefix>}{literal}\\
+ \keyentry{list-prefix}{<prefix>}{literal}\\
+ \keyentry{list-suffix}{<prefix>}{literal}
\end{framed}
The same rule as for the delimiters applies: list attributes are only used with lists, \ie at least with two items.
@@ -594,7 +748,7 @@ An example for the label attributes:
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
\cmpd[cmpd-prefix = Nr.]{a, b, f.two, k}\\
- \cmpdsetup{cmpd-prefix = \textnumero}
+ \cmpdsetup{cmpd-prefix = \(\rightarrow\)}
\cmpd{a, b, f.two, k}\\
\cmpd{a} % NOT a list!
\end{beispiel}
@@ -613,30 +767,69 @@ Between prefix, label and suffix there is a space inserted as default behaviour:
\end{beispiel}
It can be changed with
\begin{framed}
-\noindent\lstinline+cmpd-space = <space>+ \hfill Typ: \lstinline=literal=
+ \keyentry{cmpd-space}{<space>}{literal}
\end{framed}
\begin{beispiel}
\cmpd[cmpd-suffix=sx,cmpd-prefix=px,cmpd-space={}]{k}
\end{beispiel}
+\secidx*{Suffix and prefix}
+
+\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 \lstinline=.= 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 \lstinline=@=. Furthermore you should be careful to use different symbols for the other separators (see the next sections).
+\begin{framed}
+ \keyentry{sub-input-sep}{<separator>}{literal}
+\end{framed}
+\begin{beispiel}
+ \cmpdsetup{sub-input-sep = !}
+ \cmpd{f!one, g!two}\\
+ \cmpd[sub-input-sep= +]{f+one, g+two}\\
+ \cmpd[sub-input-sep= ~]{f~one, g~two}\\
+ \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 \lstinline=\tableofcontents= or in the preamble, which marker you use. Otherwise, the \lstinline=\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.
-\subsection{Separators}\label{ssec:trenner}
-\subsubsection{In case of labels}
-If you have labels with sublabels, you can use a separator symbol:
+\subsubsection{Labels -- output}\index{Separators!labels!output}
+You can separate the labels from the sublabels if you like to.
\begin{framed}
-\noindent\lstinline+cmpd-sep = <separator>+ \hfill type: \lstinline=literal=
+ \keyentry{sub-output-sep}{<separator>}{literal}
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, f.three, k}\\ % default
- \cmpd[cmpd-sep = -]{a, b, f.two, f.three, k}\\
- \cmpdsetup{cmpd-sep = $\cdot$}
+ \cmpd[sub-output-sep = -]{a, b, f.two, f.three, k}\\
+ \cmpdsetup{sub-output-sep = $\cdot$}
\cmpd{a, b, f.two, f.three, k}\\
- \cmpd[cmpd-sep = :]{a, b, f.two, f.three, k}
+ \cmpd[sub-output-sep = :]{a, b, f.two, f.three, k}
\end{beispiel}
-\subsubsection{In case of lists -- input}\label{sssec:list-input-sep}
-If you like you can change the list input seperator. Predefined is the comma.
+\subsubsection{Sublabels -- input}\label{sssec:range-input-sep}\index{Separators!subabels!input}
+As a default setting \chemnum use two points \lstinline=..= 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 \lstinline=@=. Furthermore you should be careful to use different symbols for the other separators.
\begin{framed}
-\noindent\lstinline+list-input-sep = <separator>+ \hfill type: \lstinline=literal=
+ \keyentry{subrange-input-sep}{<separator>}{literal}
+\end{framed}
+\begin{beispiel}
+ \cmpd[subrange-input-sep=:]{q.{one:four}}\\
+ \cmpdsetup{subrange-input-sep=--}
+ \cmpd{q.{one--four}}
+\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:
+\begin{framed}
+ \keyentry{subrange-output-sep}{<separator>}{literal}
+\end{framed}
+\begin{beispiel}
+ \cmpd[subrange-output-sep={ {\normalfont to} }]{q.{one..four}}\\
+ \cmpdsetup{subrange-output-sep=-}
+ \cmpd{q.{one..four}}
+\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 \texttt{,} as default. You can change that as you like. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \lstinline=@=. Furthermore you should be careful to use different symbols for the other separators.
+\begin{framed}
+ \keyentry{list-input-sep}{<separator>}{literal}\\
+ \keyentry{sub-input-sep}{<separator>}{literal}
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
@@ -645,12 +838,17 @@ If you like you can change the list input seperator. Predefined is the comma.
\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\"udingk 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{In case of lists -- generally}
-In case of lists you also can set a separator symbol, which determines how the labels are separated from each other. This is the comma as default.
+\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.
\begin{framed}
-\noindent\lstinline+list-output-sep = <separator>+ \hfill type: \lstinline=literal=
+ \keyentry{list-output-sep}{<separator>}{literal}\\
+ \keyentry{sub-output-sep}{<separator>}{literal}
\end{framed}
\begin{beispiel}
\cmpd{a, b, f.two, k}\\ % default
@@ -660,13 +858,13 @@ In case of lists you also can set a separator symbol, which determines how the l
\cmpd{a, b, f.two, k}
\end{beispiel}
-\subsubsection{In case of lists -- last separator}\label{sssec:last-sep}
-The last separator in a list is a special case. \chemnum provides two keys with which it can be customized.
+\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 keys with which it can be customized.
\begin{framed}
-\noindent\lstinline+list-last-sep = <separator>+ \hfill type: \lstinline=literal=\\
-\lstinline+list-lang = <lang>+ \hfill type: \lstinline=choice=
+ \keyentry{list-last-sep}{<separator>}{literal}\\
+ \keyentry{list-lang}{<lang>}{choice}
\end{framed}
-There is the \lstinline=choice= key \lstinline=list-lang=, which changes language dependent settings. You can choose between \lstinline=US= (default), \lstinline=GB=, \lstinline=DE=, \lstinline=FR=, \lstinline=ES= and \lstinline=IT=.
+There is the \lstinline=choice= key \key{list-lang}, which changes language dependent settings. You can choose between \lstinline=US= (default), \lstinline=GB=, \lstinline=DE=, \lstinline=FR=, \lstinline=ES= and \lstinline=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}\\
@@ -677,7 +875,7 @@ There is the \lstinline=choice= key \lstinline=list-lang=, which changes languag
\end{beispiel}
As you can see the language \lstinline=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 \lstinline=list-last-sep= you also can set the last separator individually.
+With the key \key{list-last-sep} you also can set the last separator individually.
\begin{beispiel}
\cmpdsetup{list-lang = GB}%
\cmpd[list-last-sep = {and also}]{a, b, f.two, k}\\
@@ -686,168 +884,119 @@ With the key \lstinline=list-last-sep= you also can set the last separator indiv
\cmpd[list-last-sep = empty]{a, b, f.two, k}
\end{beispiel}
-\lstinline=empty= is a special value. If it is used, the separator set with \lstinline=list-output-sep= is used for the whole list.
+\lstinline=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}\\
\cmpd[list-output-sep = ;]{a, b, f.two, k}\\
- \cmpd[list-output-sep = {\ and}]{a, b, f.two, k}
-\end{beispiel}
-
-\subsection{Sublabel marker}\label{ssec:sub_label_marker}
-As a default setting \chemnum uses the point \lstinline=.= as a token to divide main label names from sub label names. You can change that as you like. Tokens you \emph{can't use} are \verb=, % #= and \emph{you shouldn't} use \lstinline=@=.
-\begin{framed}
-\noindent\lstinline+sub-marker = <separator>+ \hfill type: \lstinline=literal=
-\end{framed}
-\begin{beispiel}
- \cmpdsetup{sub-marker = !}%
- \cmpd{f!one, g!two}\\
- \cmpd[sub-marker= +]{f+one, g+two}\\
- \cmpd[sub-marker= ~]{f~one, g~two}\\
- \cmpd[sub-marker= &]{f&one, g&two}\\
- \cmpd[sub-marker= *]{f*one, g*two}\\
- \cmpd[sub-marker=\marker]{f\marker one,g\marker 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 \lstinline=\tableofcontents= or in the preamble, which marker you use. Otherwise, the \lstinline=\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 \lstinline=\cmpd= or \lstinline=\cmpdinit= etc.
-
-\subsection{Lists and ranges of sublabels}\label{ssec:lists_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}.
-
-\chemnum provides two keys to create such an output and two keys to customize the range.
-\begin{framed}
- \noindent\lstinline+cmpd-all = <bool>+ \hfill type: \lstinline=boolean=\\
- \noindent\lstinline+sub-list = {<list of sublabel names>}+ \hfill type: \lstinline=other=\\
- \noindent\lstinline+sub-range-sep = <separator>+ \hfill type: \lstinline=literal=\\
- \noindent\lstinline+sub-range-marker = <marker>+ \hfill type: \lstinline=literal=
-\end{framed}
-The type of the key \lstinline=sub-list= differs from other keys. It is similar to \lstinline=literal=. Best you look at the example below.
-
-\begin{beispiel}
- List of labels: \cmpd{q.one, q.two, q.three, q.four, q.five} \\
- All at once: \cmpd[cmpd-all]{q}
-\end{beispiel}
-
-If you don't want to address all sublabels but some of them, you can use the key \lstinline=sub-list=\label{key:sub-list}. As input you write a comma separated list of sublabel names associated with the main label you use.
-\begin{beispiel}
- \cmpd[sub-list={one,three,four}]{q}
-\end{beispiel}
-
-You also can use this key to print a range of sublabels. As a marker between the names of the sublabels two points \lstinline=..= are used.
-\begin{beispiel}
- \cmpd[sub-list={two..four}]{q}\\
- \cmpd[sub-list={one,three..five}]{q}\\
- \cmpd[sub-list={one..three,five}]{q}
-\end{beispiel}
-
-With the keys \lstinline=sub-range-sep= and \lstinline=sub-range-marker= you can both change the symbol that's used to indicate the range and the marker you use to input a range.
-\begin{beispiel}
- \cmpdsetup{sub-range-sep = {--}, sub-range-marker = : }
- \cmpd[sub-list={two:four}]{q}
+ \cmpd[list-output-sep = {\ und}]{a, b, f.two, k}
\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 \lstinline=<jobname>.cmpd= file (supposing your source file is called \lstinline=<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 key:
+\subsubsection{\texttt{\textbackslash\textcolor{code}{cmpdinit}} -- input}\label{sssec:init-input-sep}\index{Separators!cmpdinit@\textcolor{code}{\texttt{\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 \lstinline=@=.
\begin{framed}
- \noindent\lstinline+sub-only = <bool>+\hfill type: \lstinline=boolean=
+ \keyentry{init-input-sep}{<separator>}{literal}
\end{framed}
-\begin{beispiel}
- % use packages `chemfig', `mhchem' and `booktabs'
- \cmpd*{benzene.H,benzene.Me,benzene.OH,benzene.NH2}
- \chemname{\chemfig{*6(=-=-(-R)=-)}}{\cmpd[cmpd-all]{benzene}}
- \begin{tabular}{lll}
- & \ce{{}-R} & Name \\\midrule
- \cmpd[sub-only]{benzene.H} & \ce{{}-H} & Benzene \\
- \cmpd[sub-only]{benzene.Me} & \ce{{}-CH3} & Toluene \\
- \cmpd[sub-only]{benzene.OH} & \ce{{}-OH} & Phenol \\
- \cmpd[sub-only]{benzene.NH2} & \ce{{}-NH2} & Phenylamine (Aniline)
- \end{tabular}
-\end{beispiel}
-For the time being the \lstinline=sub-list= key requires a little caution. Unfortunately automatic sorting isn't quite as trivial as one would wish. So you have to use the sublabel names in the right order if you want to avoid labels like these:
+\subsubsection{An example}\label{sssec:input-sep-bsp}
+A small example how a customized input could look like:
\begin{beispiel}
- \cmpd[sub-list={five..three}]{q} or \cmpd[sub-list={three,one,four}]{q}.
+ \cmpdsetup{
+ sub-input-sep = ! ,
+ subrange-input-sep = : ,
+ sublist-input-sep = / ,
+ list-input-sep = +
+ }
+ \cmpd{a + f ! one + q ! one / three : five}
\end{beispiel}
+\secidx*{Separators}
-\section{Language Support}\label{sec:language_support}
+\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 \lstinline=\translate= command of the \textsf{translator} package, if it is available. If \textsf{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 \textsf{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 \lstinline=\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{german}\cmpd{r,s,t}\\
- \selectlanguage{naustrian}AU: \cmpd{r,s,t} \selectlanguage{austrian}\cmpd{r,s,t}\\
+ \selectlanguage{ngerman}DE: \cmpd{r,s,t}\\
\selectlanguage{english}EN: \cmpd{r,s,t}\\
\selectlanguage{british}GB: \cmpd{r,s,t}\\
\selectlanguage{american}US: \cmpd{r,s,t}\\
- \selectlanguage{canadian}CDN-EN: \cmpd{r,s,t}\\
- \selectlanguage{canadien}CDN-FR: \cmpd{r,s,t}\\
\selectlanguage{french}FR: \cmpd{r,s,t}\\
\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.
-\subsection{Harvard Comma}\label{ssec:harvard-comma}
+\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.
-\begin{myquote}{\href{http://en.wikipedia.org/wiki/Serial_comma}{Wikipedia}, 2011/11/07}
+\begin{myquote}[\href{http://en.wikipedia.org/wiki/Serial_comma}{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 \textsc{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 \textsc{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{myquote}
\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{framed}
-\noindent\lstinline+list-serial-comma = <bool>+ \hfill Typ: \lstinline=boolean=\label{key:list-serial-comma}
+ \keyentry{list-serial-comma}{true/false}{boolean}\label{key:list-serial-comma}
\end{framed}
\begin{beispiel}
\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 \lstinline=list-serial-comma= \emph{after} \lstinline=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}
\end{beispiel}
+\secidx*{Harvard comma}\secidx*{Language support}
\section{Overview}
\subsection{Keys}\label{ssec:keys_uebersicht}
In this section all keys are listed.
\begin{center}
\label{tab:keys}
- \begin{longtabu*}{>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule
- \normalfont\bfseries key & \normalfont\bfseries default & \normalfont\bfseries type \\\midrule
- cmpd-style & & macro \\
- cmpd-weight & bold & choice \\
- cmpd-label & & literal \\
- cmpd-delim$^\mathrm{a}$ & () & literal \\
- cmpd-odelim & & literal \\
- cmpd-cdelim & & literal \\
- cmpd-prefix & & literal \\
- cmpd-suffix & & literal \\
- cmpd-space & \lstinline=\penalty\@m\ = & literal \\
- cmpd-sep & & literal \\
- cmpd-counter & arabic & choice \\
- cmpd-all & true & boolean \\\midrule
- sub-marker & . & literal \\
- sub-counter & alph & choice \\
- sub-list & & other$^\mathrm{b}$ \\
- sub-range-sep & - & literal \\
- sub-range-marker & .. & literal \\
- sub-only & & boolean \\\midrule
- list-delim$^\mathrm{a}$ & () & literal \\
- list-odelim & & literal \\
- list-cdelim & & literal \\
- list-prefix & & literal \\
- list-suffix & & literal \\
- list-input-sep & , & literal \\
- list-output-sep & , & literal \\
- list-lang & US & choice \\
- list-last-sep & and$^\mathrm{c}$ & literal \\
- list-serial-comma & & boolean \\\midrule
- ref-tag & TMP & literal \\\bottomrule
+ \begin{longtabu*}{l>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule
+ \bfseries key & \normalfont\bfseries default & \normalfont\bfseries predefined & \normalfont\bfseries type \\\midrule
+ \key{cmpd-style} & & & macro \\
+ \key{cmpd-weight} & bold & bold & choice \\
+ \key{cmpd-label} & & & literal \\
+ \key{cmpd-delim}$^\mathrm{a}$ & () & & literal \\
+ \key{cmpd-odelim} & & & literal \\
+ \key{cmpd-cdelim} & & & literal \\
+ \key{cmpd-prefix} & & & literal \\
+ \key{cmpd-suffix} & & & literal \\
+ \key{cmpd-space} & \lstinline=\penalty\@m\ = & \lstinline=\penalty\@m\ = & literal \\
+ \key{cmpd-counter} & arabic & arabic & choice \\
+ \key{cmpd-all} & true & false & boolean \\\midrule
+ \key{sub-only} & true & false & boolean \\
+ \key{sub-counter} & alph & alph & choice \\
+ \key{sub-output-sep} & & , & literal \\
+ \key{sub-input-sep} & . & . & literal \\
+ \key{sublist-output-sep} & , & , & literal \\
+ \key{sublist-input-sep} & , & , & literal \\
+ \key{subrange-output-sep} & -- & -- & literal \\
+ \key{subrange-input-sep} & .. & .. & literal \\\midrule
+ \key{list-delim}$^\mathrm{a}$ & () & & literal \\
+ \key{list-odelim} & & & literal \\
+ \key{list-cdelim} & & & literal \\
+ \key{list-prefix} & & & literal \\
+ \key{list-suffix} & & & literal \\
+ \key{list-input-sep} & , & , & literal \\
+ \key{list-output-sep} & , & , & literal \\
+ \key{list-lang} & US & US$^\mathrm{b}$ & choice \\
+ \key{list-last-sep} & and$^\mathrm{c}$ & & literal \\
+ \key{list-serial-comma} & true & true$^\mathrm{c}$ & boolean \\\midrule
+ \key{ref-tag} & TMP & TMP & literal \\
+ \key{ref-style} & & \lstinline=\sffamily= & macro \\\midrule
+ \key{init-strict} & true & false & boolean \\
+ \key{init-sub} & true & false & boolean \\
+ \key{init-input-sep} & , & , & literal \\\midrule
+ \key{hyper-use} & true & false & boolean \\
+ \key{hyper-target} & & & literal \\
+ \key{hyper-link} & & & literal \\\bottomrule
\end{longtabu*}
- \begin{tabular}{>{\footnotesize}r>{\footnotesize\raggedright}p{.3\linewidth}}
+ \setlength\extrarowheight{-1pt}
+ \begin{tabular}{>{\footnotesize}r>{\footnotesize\raggedright}p{.7\linewidth}}
a & value needs \emph{two} tokens. \tabularnewline
- b & input is a comma separated list, see p.\,\pageref{key:sub-list}. \tabularnewline
- c & depends on the value of \lstinline=list-lang= and the usage of \textsf{babel}.
+ b & depends in the usage of \paket*{babel}. \tabularnewline
+ c & depends on the value of \key{list-lang} and the usage of \paket*{babel}.
\end{tabular}
\end{center}
@@ -855,22 +1004,24 @@ In this section all keys are listed.
In this section all commands provided by \chemnum as well as their variants are listed.
\begin{center}
\label{tab:commands}
- \begin{tabu*}{l>{\raggedright}p{.5\linewidth}}\toprule
- \bfseries command & \bfseries description \tabularnewline\midrule
- \lstinline=\cmpd[]{}= & basic command, declares and prints labels or lists of labels, see pages \pageref{sec:nummerieren}ff. \tabularnewline
- \lstinline=\cmpd*{}= & invisible, declares label, see page \pageref{cmd:unsichtbares_label} \tabularnewline
- \lstinline=\cmpd-[]{}= & without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline
- \lstinline=\cmpd+-[]{}= & label is read from auxiliary file, see page \pageref{cmd:cmpd_plus} \tabularnewline\midrule
- \lstinline=\cmpdinit{}= & initialise and declare labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline
- \lstinline=\cmpdinit*{}= & initialise labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline\midrule
- \lstinline=\cmpdref[][]{}= & replace temporary markers in \texttt{eps} files by labels, see page \pageref{ssec:cmpdref} \tabularnewline
- \lstinline=\cmpdref-[][]{}= & replace temporary markers in \texttt{eps} files by labels without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule
- \lstinline=\cmpdreset[]= & reset counter, siehe page \pageref{sec:cmpdreset} \tabularnewline\midrule
- \lstinline=\cmpdsetup{}= & setup \chemnum, siehe pages \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule
+ \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>][<marker>]{<label>} & replace temporary markers in \texttt{eps} files by labels, see page \pageref{ssec:cmpdref} \tabularnewline
+ \cmd[cmpdrefc]{cmpdref-}[<keyval>][<marker>]{<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
\end{tabu*}
\end{center}
\section{Credits}
I would like to thank Joseph \textsc{Wright} and Russell \textsc{Hewitt} who provided me with valuable feedback and suggestions to improve \chemnum.
+\printindex
+
\end{document} \ No newline at end of file
diff --git a/Master/texmf-dist/tex/latex/chemnum/chemnum.sty b/Master/texmf-dist/tex/latex/chemnum/chemnum.sty
index e14348008b3..8578febc43c 100644
--- a/Master/texmf-dist/tex/latex/chemnum/chemnum.sty
+++ b/Master/texmf-dist/tex/latex/chemnum/chemnum.sty
@@ -3,7 +3,7 @@
% - a comprehensive approach for the numbering of chemical compounds - %
% --------------------------------------------------------------------------- %
% - Clemens NIEDERBERGER - %
-% - 2011/12/01 - %
+% - 2011/12/08 - %
% --------------------------------------------------------------------------- %
% - http://www.mychemistry.eu/ - %
% - contact@mychemistry.eu - %
@@ -32,7 +32,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\RequirePackage { expl3 , xparse , l3keys2e , etoolbox , psfrag }
-\ProvidesExplPackage {chemnum} {2011/12/01} {0.3e} {Numbering chemical compounds}
+\ProvidesExplPackage {chemnum} {2011/12/08} {0.4} {An approach for the numbering of chemical compounds}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% CHECK FOR SUPPORT
@@ -305,7 +305,11 @@
\cs_new_nopar:Npn \chemnum_cmpd_style_value:n { }
% error message
-\msg_set:nnn { chemnum } { cmpd-style } { The~value~of~"cmpd-style~=~<style>"~needs~to~be~a~(or~more)~macro~\msg_line_context: . }
+\msg_set:nnn { chemnum } { cmpd-style }
+ {
+ The~value~of~"cmpd-style~=~<style>"~needs~to~be~a~(or~more)~macro~
+ \msg_line_context: .
+ }
% set style %TODO
\cs_new_nopar:Npn \chemnum_cmpd_set_style:n #1
@@ -539,10 +543,14 @@
\tl_new:N \l_chemnum_cmpd_labelsep_tl
\tl_set:Nn \l_chemnum_cmpd_labelsep_tl { . }
+\tl_new:N \l_chemnum_sublist_input_separator_tl
+\tl_set:Nn \l_chemnum_sublist_input_separator_tl { , }
+
+\tl_new:N \l_chemnum_sublist_output_separator_tl
+\tl_set:Nn \l_chemnum_sublist_output_separator_tl { , }
+
\tl_new:N \l_chemnum_sublabel_range_marker_tl
-% \char_make_other:N \:
\tl_set:Nn \l_chemnum_sublabel_range_marker_tl { .. }
-% \catcode 58 = 11 \relax
\tl_new:N \l_chemnum_sub_range_sep_tl
\tl_set:Nn \l_chemnum_sub_range_sep_tl { -- }
@@ -551,59 +559,167 @@
\bool_set_false:N \l_chemnum_sub_label_only_bool
%-----------------------------------------------------------------------------%
+% hyperref support
+\tl_new:N \l_chemnum_cmpd_hyper_name_tl
+
+\bool_new:N \l_chemnum_use_hyperref_bool
+\bool_new:N \l_chemnum_hypertarget_bool
+\bool_new:N \l_chemnum_hyperlink_bool
+
+\cs_new_eq:NN \chemnum_make_hyper:nn \use_ii:nn
+
+% #1: main label, #2: sub labels, #3: invisible
+\cs_new_nopar:Npn \chemnum_hyperref:nnn #1#2#3
+ {
+ \bool_if:nF { #3 || !\l_chemnum_use_hyperref_bool }
+ {
+ \bool_if:NT \l_chemnum_hypertarget_bool
+ {
+ \cs_set_nopar:Npn \chemnum_make_hyper:nn ##1##2
+ {
+ \raisebox { 3ex } [ 0pt ]
+ { \hypertarget { ##1 } { } } ##2
+ }
+ }
+ \bool_if:NT \l_chemnum_hyperlink_bool
+ { \cs_set_eq:NN \chemnum_make_hyper:nn \hyperlink }
+ \bool_if:nT
+ { !\l_chemnum_hypertarget_bool && !\l_chemnum_hyperlink_bool }
+ {
+ \tl_if_blank:nTF { #2 }
+ { % no sublabel
+ \tl_set:Nn \l_chemnum_cmpd_hyper_name_tl
+ { chemnum_cmpd_#1 }
+ \cs_if_exist:cTF { chemnum_cmpd_#1_hyper: }
+ {
+ \bool_set_false:N \l_chemnum_hypertarget_bool
+ \cs_set_eq:NN \chemnum_make_hyper:nn \hyperlink
+ }
+ {
+ \bool_set_true:N \l_chemnum_hypertarget_bool
+ \cs_set_nopar:Npn \chemnum_make_hyper:nn ##1##2
+ {
+ \raisebox { 3ex } [ 0pt ]
+ { \hypertarget { ##1 } { } } ##2
+ }
+ \cs_new_nopar:cpn { chemnum_cmpd_#1_hyper: } { }
+ }
+ }
+ {
+ \chemnum_cmpd_sublist:n { #2 }
+ \int_compare:nT { \l_chemnum_cmpd_sublist_length_int < 2 }
+ { % no sublabel list
+ \chemnum_cmpd_subrange_separate:n { #2 }
+ \tl_if_blank:VT \l_tmpb_tl
+ { % no sublabel range
+ \tl_set:Nn \l_chemnum_cmpd_hyper_name_tl
+ { chemnum_cmpd_#1_\l_tmpa_tl }
+ \cs_if_exist:cTF
+ { chemnum_cmpd_#1_ \l_tmpa_tl _hyper: }
+ {
+ \bool_set_false:N \l_chemnum_hypertarget_bool
+ \cs_set_eq:NN \chemnum_make_hyper:nn \hyperlink
+ }
+ {
+ \bool_set_true:N \l_chemnum_hypertarget_bool
+ \cs_set_nopar:Npn \chemnum_make_hyper:nn ##1##2
+ {
+ \raisebox { 3ex } [ 0pt ]
+ { \hypertarget { ##1 } { } } ##2
+ }
+ \cs_new_nopar:cpn
+ { chemnum_cmpd_#1_ \l_tmpa_tl _hyper: } { }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+
+%-----------------------------------------------------------------------------%
% property keys for compounds
\keys_define:nn { chemnum } {
- cmpd-style .code:n = \chemnum_cmpd_set_style:n { #1 } ,
- cmpd-weight .choice: ,
- cmpd-weight / bold .code:n = \bool_set_true:N \l_chemnum_cmpd_bold_bool ,
- cmpd-weight / normal .code:n = \bool_set_false:N \l_chemnum_cmpd_bold_bool ,
- cmpd-label .code:n =
+ cmpd-style .code:n = \chemnum_cmpd_set_style:n { #1 } ,
+ cmpd-weight .choice: ,
+ cmpd-weight / bold .code:n = \bool_set_true:N \l_chemnum_cmpd_bold_bool ,
+ cmpd-weight / normal .code:n = \bool_set_false:N \l_chemnum_cmpd_bold_bool ,
+ cmpd-label .code:n =
{
\bool_set_true:N \l_chemnum_cmpd_name_bool
\tl_set:Nn \l_chemnum_cmpd_name_tl { #1 }
} ,
- cmpd-prefix .tl_set:N = \l_chemnum_cmpd_prefix_tl ,
- cmpd-prefix .default:n = { } ,
- cmpd-suffix .tl_set:N = \l_chemnum_cmpd_suffix_tl ,
- cmpd-suffix .default:n = { } ,
- cmpd-space .tl_set:N = \l_chemnum_cmpd_space_tl ,
- cmpd-space .default:n = { \penalty\@m\ },
- cmpd-delim .code:n = \chemnum_cmpd_delim:n { #1 },
- cmpd-delim .default:n = {(}{)} ,
- cmpd-odelim .tl_set:N = \l_chemnum_cmpd_odelim_tl ,
- cmpd-odelim .default:n = { } ,
- cmpd-cdelim .tl_set:N = \l_chemnum_cmpd_cdelim_tl ,
- cmpd-cdelim .default:n = { } ,
- cmpd-sep .tl_set:N = \l_chemnum_cmpd_separator_tl ,
- cmpd-sep .default:n = { } ,
- cmpd-all .bool_set:N = \l_chemnum_cmpd_all_bool ,
- cmpd-all .default:n = true ,
- cmpd-counter .choice: ,
- cmpd-counter .choice_code:n =
+ cmpd-prefix .tl_set:N = \l_chemnum_cmpd_prefix_tl ,
+ cmpd-prefix .default:n = { } ,
+ cmpd-suffix .tl_set:N = \l_chemnum_cmpd_suffix_tl ,
+ cmpd-suffix .default:n = { } ,
+ cmpd-space .tl_set:N = \l_chemnum_cmpd_space_tl ,
+ cmpd-space .default:n = { \penalty\@m\ },
+ cmpd-delim .code:n = \chemnum_cmpd_delim:n { #1 },
+ cmpd-delim .default:n = { ( } { ) } ,
+ cmpd-odelim .tl_set:N = \l_chemnum_cmpd_odelim_tl ,
+ cmpd-odelim .default:n = { } ,
+ cmpd-cdelim .tl_set:N = \l_chemnum_cmpd_cdelim_tl ,
+ cmpd-cdelim .default:n = { } ,
+ cmpd-all .bool_set:N = \l_chemnum_cmpd_all_bool ,
+ cmpd-all .default:n = true ,
+ cmpd-counter .choice: ,
+ cmpd-counter .choice_code:n =
\tl_set_eq:NN \l_chemnum_cmpd_kind_value_tl \l_keys_choice_tl ,
- cmpd-counter .generate_choices:n =
+ cmpd-counter .generate_choices:n =
{ arabic , alph , Alph , greek, Greek , roman , Roman , Symbol } ,
- cmpd-counter .default:n = arabic ,
- sub-counter .choice: ,
- sub-counter .choice_code:n =
+ cmpd-counter .default:n = arabic ,
+ hyper-use .choice: ,
+ hyper-use / true .code:n =
+ {
+ \bool_set_true:N \l_chemnum_use_hyperref_bool
+ \bool_set_false:N \l_chemnum_hypertarget_bool
+ \bool_set_false:N \l_chemnum_hyperlink_bool
+ } ,
+ hyper-use / false .code:n =
+ {
+ \bool_set_false:N \l_chemnum_use_hyperref_bool
+ \bool_set_false:N \l_chemnum_hypertarget_bool
+ \bool_set_false:N \l_chemnum_hyperlink_bool
+ } ,
+ hyper-use .default:n = true ,
+ hyper-target .code:n =
+ {
+ \tl_set:Nn \l_chemnum_cmpd_hyper_name_tl { #1 }
+ \bool_set_true:N \l_chemnum_use_hyperref_bool
+ \bool_set_true:N \l_chemnum_hypertarget_bool
+ \bool_set_false:N \l_chemnum_hyperlink_bool
+ } ,
+ hyper-link .code:n =
+ {
+ \tl_set:Nn \l_chemnum_cmpd_hyper_name_tl { #1 }
+ \bool_set_true:N \l_chemnum_use_hyperref_bool
+ \bool_set_false:N \l_chemnum_hypertarget_bool
+ \bool_set_true:N \l_chemnum_hyperlink_bool
+ } ,
+ sub-counter .choice: ,
+ sub-counter .choice_code:n =
\tl_set_eq:NN \l_chemnum_cmpd_sub_kind_value_tl \l_keys_choice_tl ,
- sub-counter .generate_choices:n =
+ sub-counter .generate_choices:n =
{ arabic , alph , Alph , greek , Greek , roman , Roman , Symbol } ,
- sub-counter .default:n = alph ,
- sub-marker .code:n = \chemnum_subcmpdsep:n { #1 } ,
- sub-marker .default:n = . ,
- sub-range-marker .code:n =
+ sub-counter .default:n = alph ,
+ sub-input-sep .code:n = \chemnum_subcmpdsep:n { #1 } ,
+ sub-input-sep .default:n = . ,
+ sub-output-sep .tl_set:N = \l_chemnum_cmpd_separator_tl ,
+ sub-output-sep .default:n = { } ,
+ sublist-input-sep .tl_set:N =
+ \l_chemnum_sublist_input_separator_tl ,
+ sublist-input-sep .default:n = { , } ,
+ sublist-output-sep .tl_set:N =
+ \l_chemnum_sublist_output_separator_tl ,
+ sublist-output-sep .default:n = { , } ,
+ sub-only .bool_set:N = \l_chemnum_sub_label_only_bool ,
+ sub-only .default:n = true ,
+ subrange-output-sep .tl_set:N = \l_chemnum_sub_range_sep_tl ,
+ subrange-output-sep .default:n = { -- } ,
+ subrange-input-sep .code:n =
\chemnum_sublabel_range_marker:n { #1 } ,
- sub-range-marker .default:n = { .. } ,
- sub-range-sep .tl_set:N = \l_chemnum_sub_range_sep_tl ,
- sub-range-sep .default:n = { -- } ,
- sub-list .code:n =
- {
- \tl_set:Nn \l_chemnum_cmpd_sublabel_list_tl { #1 }
- \bool_set_true:N \l_chemnum_sublabel_list_bool
- } ,
- sub-only .bool_set:N = \l_chemnum_sub_label_only_bool ,
- sub-only .default:n = true
+ subrange-input-sep .default:n = { .. }
}
%-----------------------------------------------------------------------------%
@@ -611,8 +727,8 @@
\bool_new:N \l_chemnum_no_serial_comma_bool
\bool_set_false:N \l_chemnum_no_serial_comma_bool
-\tl_new:N \l_chemnum_input_separator_tl
-\tl_set:Nn \l_chemnum_input_separator_tl { , }
+\tl_new:N \l_chemnum_list_input_separator_tl
+\tl_set:Nn \l_chemnum_list_input_separator_tl { , }
\tl_new:N \l_chemnum_list_separator_tl
\tl_set:Nn \l_chemnum_list_separator_tl { , }
@@ -656,14 +772,14 @@
list-suffix .tl_set:N = \l_chemnum_list_suffix_tl ,
list-suffix .default:n = { } ,
list-delim .code:n = \chemnum_list_delim:n { #1 } ,
- list-delim .default:n = {(}{)} ,
+ list-delim .default:n = { ( } { ) } ,
list-odelim .tl_set:N = \l_chemnum_list_odelim_tl ,
list-odelim .default:n = { } ,
list-cdelim .tl_set:N = \l_chemnum_list_cdelim_tl ,
list-cdelim .default:n = { } ,
list-space .tl_set:N = \l_chemnum_list_space_tl ,
list-space .default:n = { \penalty\@m\ } ,
- list-input-sep .tl_set:N = \l_chemnum_input_separator_tl ,
+ list-input-sep .tl_set:N = \l_chemnum_list_input_separator_tl ,
list-input-sep .default:n = { , } ,
list-output-sep .tl_set:N = \l_chemnum_list_separator_tl ,
list-output-sep .default:n = { , } ,
@@ -754,6 +870,23 @@
\cs_gset_eq:cc { chemnum_cmpd_#1_max: } { chemnum_cmpd_#1_#2: }
}
}
+\cs_generate_variant:Nn \chemnum_cmpd_sub_declare:nn { no }
+
+\cs_new_nopar:Npn \chemnum_cmpd_sub_initiate:nn #1#2
+ {
+ \cs_if_exist:cF { chemnum_cmpd_ #1 _ #2 _init: }
+ {
+ \bool_if:NTF \l_chemnum_cmpd_init_strict_bool
+ {
+ \msg_error:nnx { chemnum } { cmpd-init-sub }
+ { #1 \l_chemnum_cmpd_labelsep_tl #2 }
+ }
+ {
+ \msg_warning:nnx { chemnum } { cmpd-init-sub }
+ { #1 \l_chemnum_cmpd_labelsep_tl #2 }
+ }
+ }
+ }
%-----------------------------------------------------------------------------%
% label and sublabel initiation
@@ -765,17 +898,13 @@
{
\tl_if_blank:nF { #2 }
{
- \cs_if_exist:cF { chemnum_cmpd_ #1 _ #2 _init: }
+ \chemnum_cmpd_sublist:n { #2 }
+ \exp_args:No \tl_map_inline:nn { \l_chemnum_cmpd_sublist_tl }
{
- \bool_if:NTF \l_chemnum_cmpd_init_strict_bool
- {
- \msg_error:nnx { chemnum } { cmpd-sub-init }
- { #1 \l_chemnum_cmpd_labelsep_tl #2 }
- }
- {
- \msg_warning:nnx { chemnum } { cmpd-sub-init }
- { #1 \l_chemnum_cmpd_labelsep_tl #2 }
- }
+ \chemnum_cmpd_subrange_separate:n { ##1 }
+ \chemnum_cmpd_sub_initiate:nn { #1 } { \l_tmpa_tl }
+ \tl_if_blank:VF \l_tmpb_tl
+ { \chemnum_cmpd_sub_initiate:nn { #1 } { \l_tmpb_tl } }
}
}
}
@@ -809,13 +938,20 @@
\tl_new:N \l_chemnum_labelsep_tmp_tl
-% actual separating
+% set sublabel-separator
\cs_new_nopar:Npn \chemnum_subcmpdsep:n #1 {
\tl_if_blank:nTF { #1 }
{ \msg_error:nn { chemnum } { sub-label-separator } }
{ \tl_set:Nn \l_chemnum_cmpd_labelsep_tl { #1 } }
}
+\cs_new_nopar:Npn \chemnum_sublabel_range_marker:n #1 {
+ \tl_if_blank:nTF { #1 }
+ { \msg_error:nn { chemnum } { sub-label-range_sep } }
+ { \tl_set:Nn \l_chemnum_sublabel_range_marker_tl { #1 } }
+}
+
+% actual separating
\cs_new_nopar:Npn \chemnum_cmpd_labelsep:n #1 \q_stop {
\tl_clear:N \l_chemnum_labelsep_tmp_tl
\exp_args:Noo \tl_if_in:nnTF { #1 } { \l_chemnum_cmpd_labelsep_tl }
@@ -842,39 +978,39 @@
\tl_set:Nn \l_chemnum_cmpd_sub_label_tl { #2 }
}
-% sublabel separating to display a range
-\cs_new_nopar:Npn \chemnum_sublabel_range_marker:n #1 {
- \tl_if_blank:nTF { #1 }
- { \msg_error:nn { chemnum } { sub-label-range_sep } }
- { \tl_set:Nn \l_chemnum_sublabel_range_marker_tl { #1 } }
-}
+% sublabel separating to display a list and/or range
+\tl_new:N \l_chemnum_cmpd_sublist_tl
+\int_new:N \l_chemnum_cmpd_sublist_length_int
-\cs_new_nopar:Npn \chemnum_cmpd_sublabelsep:n #1 \q_stop {
- \tl_clear:N \l_chemnum_sublabelsep_tmp_tl
- \exp_args:Noo \tl_if_in:nnTF { #1 } { \l_chemnum_sublabel_range_marker_tl }
- {
- \tl_set:Nn \l_chemnum_sublabelsep_tmp_tl { #1 }
- \exp_args:NNo \tl_replace_once:Nnn \l_chemnum_sublabelsep_tmp_tl
- { \l_chemnum_sublabel_range_marker_tl }
- { \q_nil }
- \exp_after:wN \chemnum_cmpd_sublabelsep_aux_ii:n
- \l_chemnum_sublabelsep_tmp_tl \q_stop
- }
- { \chemnum_cmpd_sublabelsep_aux_i:n { #1 } }
-}
-
-\cs_new_nopar:Npn \chemnum_cmpd_sublabelsep_aux_i:n #1 {
- \tl_set:Nn \l_chemnum_cmpd_sub_one_label_tl { #1 }
- \tl_clear:N \l_chemnum_cmpd_sub_two_label_tl
-}
+\NewDocumentCommand \chemnum_cmpd_sublist:n
+ { > { \exp_args:No \SplitList { \l_chemnum_sublist_input_separator_tl } } m }
+ {
+ \tl_set:Nn \l_chemnum_cmpd_sublist_tl { #1 }
+ \int_zero:N \l_chemnum_cmpd_sublist_length_int
+ \exp_args:No \tl_map_inline:nn { \l_chemnum_cmpd_sublist_tl }
+ { \int_incr:N \l_chemnum_cmpd_sublist_length_int }
+ }
-\cs_new_nopar:Npn \chemnum_cmpd_sublabelsep_aux_ii:n #1 \q_nil #2 \q_stop {
- \tl_set:Nn \l_chemnum_cmpd_sub_one_label_tl { #1 }
- \tl_set:Nn \l_chemnum_cmpd_sub_two_label_tl { #2 }
-}
+\cs_new_nopar:Npn \chemnum_cmpd_subrange_separate:n #1
+ {
+ \tl_clear:N \l_tmpa_tl
+ \tl_clear:N \l_tmpb_tl
+ \tl_if_in:noTF { #1 } { \l_chemnum_sublabel_range_marker_tl }
+ {
+ \tl_set:Nn \l_tmpa_tl { #1 }
+ \exp_args:NNo \tl_replace_once:Nnn \l_tmpa_tl
+ { \l_chemnum_sublabel_range_marker_tl } { \q_nil }
+ \exp_after:wN \chemnum_cmpd_subrange_separate_aux:n \l_tmpa_tl \q_stop
+ }
+ { \tl_set:Nn \l_tmpa_tl { #1 } }
+ }
-\cs_if_exist:NF \cs_if_eq:ccF
- { \cs_generate_variant:Nn \cs_if_eq:NNF { ccF } }
+\cs_new_nopar:Npn \chemnum_cmpd_subrange_separate_aux:n
+ #1 \q_nil #2 \q_stop
+ {
+ \tl_set:Nn \l_tmpa_tl { #1 }
+ \tl_set:Nn \l_tmpb_tl { #2 }
+ }
%-----------------------------------------------------------------------------%
% print compound label
@@ -896,20 +1032,31 @@
}
%-----------------------------------------------------------------------------%
-% main internal compound label command
+% main internal compound label command
% #1: <main label> #2: <sub label> #3: <invisible> #4: <no delim>
+% #2 may be a list of sublabels
\cs_new_nopar:Npn \chemnum_cmpd_aux_i:nnnn #1#2#3#4
{
\bool_if:NT \l_chemnum_cmpd_initiated_bool
{ \chemnum_cmpd_initiate:nn { #1 } { #2 } }
\bool_if:NF \l_chemnum_cmpd_ref_bool
{ \chemnum_cmpd_declare:n { #1 } }
+ \chemnum_hyperref:nnn { #1 } { #2 } { #3 }
\tl_if_blank:nF { #2 }
{
\cs_if_exist:cF { g_chemnum_cmpd_#1_int }
{ \int_new:c { g_chemnum_cmpd_#1_int } }
+ \chemnum_cmpd_sublist:n { #2 }
\bool_if:NF \l_chemnum_cmpd_ref_bool
- { \chemnum_cmpd_sub_declare:nn { #1 } { #2 } }
+ {
+ \exp_args:No \tl_map_inline:nn { \l_chemnum_cmpd_sublist_tl }
+ {
+ \chemnum_cmpd_subrange_separate:n { ##1 }
+ \chemnum_cmpd_sub_declare:no { #1 } { \l_tmpa_tl }
+ \tl_if_blank:VF \l_tmpb_tl
+ { \chemnum_cmpd_sub_declare:no { #1 } { \l_tmpb_tl } }
+ }
+ }
}
\bool_if:NTF #3
{ \mode_if_horizontal:T { \tex_unskip:D } }
@@ -919,6 +1066,8 @@
\tl_clear:N \l_chemnum_cmpd_odelim_tl
\tl_clear:N \l_chemnum_cmpd_cdelim_tl
}
+ \chemnum_make_hyper:nn { \l_chemnum_cmpd_hyper_name_tl }
+ {
\chemnum_cmpd_print:n
{
\bool_if:NF \l_chemnum_sub_label_only_bool
@@ -949,13 +1098,30 @@
\tl_if_blank:nF { #2 }
{
\tl_use:N \l_chemnum_cmpd_separator_tl
- \bool_if:NTF \l_chemnum_cmpd_ref_bool
- { \use:c { chemnum_cmpd_ #1 _ #2 _ref: } }
- { \use:c { chemnum_cmpd_ #1 _ #2 : } }
+ \int_zero:N \l_tmpa_int
+ \exp_args:No \tl_map_inline:nn
+ { \l_chemnum_cmpd_sublist_tl }
+ {
+ \int_incr:N \l_tmpa_int
+ \chemnum_cmpd_subrange_separate:n { ##1 }
+ \bool_if:NTF \l_chemnum_cmpd_ref_bool
+ { \use:c { chemnum_cmpd_ #1 _ \l_tmpa_tl _ref: } }
+ { \use:c { chemnum_cmpd_ #1 _ \l_tmpa_tl : } }
+ \tl_if_blank:VF \l_tmpb_tl
+ {
+ \tl_use:N \l_chemnum_sub_range_sep_tl
+ \bool_if:NTF \l_chemnum_cmpd_ref_bool
+ { \use:c { chemnum_cmpd_ #1 _ \l_tmpb_tl _ref: } }
+ { \use:c { chemnum_cmpd_ #1 _ \l_tmpb_tl : } }
+ }
+ \int_compare:nF
+ { \l_tmpa_int = \l_chemnum_cmpd_sublist_length_int }
+ { \l_chemnum_sublist_output_separator_tl }
+ }
}
}
}
- }
+ } }
}
}
@@ -969,6 +1135,7 @@
\tl_clear:N \l_chemnum_cmpd_main_label_tl
\tl_clear:N \l_chemnum_cmpd_sub_label_tl
\chemnum_cmpd_labelsep:n #1 \q_stop
+ \tl_remove_all:Nn \l_chemnum_cmpd_sub_label_tl { ~ }
\chemnum_cmpd_aux_i:oonn
{ \l_chemnum_cmpd_main_label_tl }
{ \l_chemnum_cmpd_sub_label_tl }
@@ -1006,10 +1173,10 @@
% \cmpd*+-[<key-value-list>]{<(possibly comma separated list of) compound
% label(s)>}
\NewDocumentCommand \chemnum_input_separator:n
- { > { \exp_args:No \SplitList { \l_chemnum_input_separator_tl } } m }
+ { > { \exp_args:No \SplitList { \l_chemnum_list_input_separator_tl } } m }
{ \tl_set:Nn \l_tmpa_tl { #1 } }
-\NewDocumentCommand \cmpd { s t+ t- o m }
+\NewDocumentCommand \cmpd_main_command:w { s t+ t- o m }
{
\IfBooleanT #2
{
@@ -1120,21 +1287,27 @@
\bool_set_false:N \l_chemnum_cmpd_ref_bool
}
+\cs_set_eq:NN \cmpd \cmpd_main_command:w
+
%-----------------------------------------------------------------------------%
% INITIALISING LABELS
\bool_new:N \l_chemnum_cmpd_initiated_bool
\bool_new:N \l_chemnum_cmpd_init_strict_bool
\bool_new:N \l_chemnum_cmpd_sub_init_bool
\bool_new:N \l_chemnum_cmpd_init_declare_bool
-\clist_new:N \l_chemnum_cmpd_init_clist
+
+\tl_new:N \l_chemnum_cmpd_init_separator_tl
+\tl_set:Nn \l_chemnum_cmpd_init_separator_tl { , }
% property keys for \cmpdinit command
% strict=true will produce an error instead of a warning
-\keys_define:nn { chemnum / init } {
- strict .bool_set:N = \l_chemnum_cmpd_init_strict_bool ,
- strict .default:n = true ,
- sub-init .bool_set:N = \l_chemnum_cmpd_sub_init_bool ,
- sub-init .default:n = true
+\keys_define:nn { chemnum } {
+ init-strict .bool_set:N = \l_chemnum_cmpd_init_strict_bool ,
+ init-strict .default:n = true ,
+ init-sub .bool_set:N = \l_chemnum_cmpd_sub_init_bool ,
+ init-sub .default:n = true ,
+ init-input-sep .tl_set:N = \l_chemnum_cmpd_init_separator_tl ,
+ init-input-sep .default:n = { , }
}
% warning/error messages
@@ -1144,9 +1317,9 @@
compound~"#1"~\msg_line_context: .
}
-\msg_set:nnn { chemnum } { cmpd-sub-init }
+\msg_set:nnn { chemnum } { cmpd-init-sub }
{
- You~used~\token_to_str:N \cmpdinit \c_space_tl and~"sub-init~=~true"~
+ You~used~\token_to_str:N \cmpdinit \c_space_tl and~"init-sub~=~true"~
but~didn't~initiate~sub-compound~"#1"~\msg_line_context: .
}
@@ -1169,24 +1342,28 @@
{
\tl_if_blank:VF \l_chemnum_cmpd_sub_label_tl
{
- \cs_if_exist:cF
+ \exp_args:No \chemnum_cmpd_sublist:n { \l_chemnum_cmpd_sub_label_tl }
+ \exp_args:No \tl_map_inline:nn { \l_chemnum_cmpd_sublist_tl }
{
- chemnum_cmpd_
- \l_chemnum_cmpd_main_label_tl
- _
- \l_chemnum_cmpd_sub_label_tl
- _init:
- }
- {
- \cs_new_nopar:cpn
+ \cs_if_exist:cF
{
- chemnum_cmpd_
+ chemnum_cmpd_
\l_chemnum_cmpd_main_label_tl
_
- \l_chemnum_cmpd_sub_label_tl
+ ##1
_init:
}
- { }
+ {
+ \cs_new_nopar:cpn
+ {
+ chemnum_cmpd_
+ \l_chemnum_cmpd_main_label_tl
+ _
+ ##1
+ _init:
+ }
+ { }
+ }
}
}
}
@@ -1207,7 +1384,7 @@
\IfBooleanTF #1
{ \bool_set_false:N \l_chemnum_cmpd_init_declare_bool }
{ \bool_set_true:N \l_chemnum_cmpd_init_declare_bool }
- \IfNoValueF { #2 } { \keys_set:nn { chemnum / init } { #2 } }
+ \IfNoValueF { #2 } { \keys_set:nn { chemnum } { #2 } }
\chemnum_input_separator:n { #3 }
\tl_map_function:NN \l_tmpa_tl \chemnum_cmpd_init:n
}
@@ -1233,20 +1410,27 @@
% works similar to \schemeref command of the chemscheme package
% \cmpdref-[<keyval>][<tag>]{<label name>}
\tl_new:N \l_chemnum_cmpdref_tl
-\int_new:N \l_chemnum_cmpdref_int
+
+\tl_new:N \l_chemnum_cmpdref_style_tl
+\tl_set:Nn \l_chemnum_cmpdref_style_tl { \sffamily }
+
\tl_new:N \l_chemnum_cmpdref_marker_tl
\tl_set:Nn \l_chemnum_cmpdref_marker_tl { TMP }
+\int_new:N \l_chemnum_cmpdref_int
+
\keys_define:nn { chemnum }
{
- ref-tag .tl_set:N = \l_chemnum_cmpdref_marker_tl ,
- ref-tag .default:n = { TMP }
+ ref-tag .tl_set:N = \l_chemnum_cmpdref_marker_tl ,
+ ref-tag .default:n = { TMP } ,
+ ref-style .tl_set:N = \l_chemnum_cmpdref_style_tl ,
+ ref-style .default:n = { } ,
}
\NewDocumentCommand \cmpdref { t- o o m }
{
\IfBooleanT { #1 }
- { \cmpdsetup { cmpd-delim = } }
+ { \keys_set:nn { chemnum } { cmpd-delim = } }
\IfNoValueTF { #3 }
{
\int_incr:N \l_chemnum_cmpdref_int
@@ -1261,10 +1445,24 @@
}
\IfNoValueTF { #2 }
{
- \psfrag { \l_chemnum_cmpdref_tl } [ b ] [ b ] { \cmpd { #4 } }
+ \psfrag { \l_chemnum_cmpdref_tl } [ b ] [ b ]
+ {
+ \group_begin:
+ \keys_set:nn { chemnum }
+ { cmpd-style = \l_chemnum_cmpdref_style_tl }
+ \cmpd_main_command:w { #4 }
+ \group_end:
+ }
}
{
- \psfrag { \l_chemnum_cmpdref_tl } [ b ] [ b ] { \cmpd [ #2 ] { #4 } }
+ \psfrag { \l_chemnum_cmpdref_tl } [ b ] [ b ]
+ {
+ \group_begin:
+ \keys_set:nn { chemnum }
+ { cmpd-style = \l_chemnum_cmpdref_style_tl }
+ \cmpd_main_command:w [ #2 ] { #4 }
+ \group_end:
+ }
}
}
@@ -1334,7 +1532,7 @@ HISTORY:
- choices "greek" and "Greek" for the cmpd-counter
keys, choice "symbol" changed to "Symbol"
- package option "textgreek = <value>" to control
- usage of the textgreek package
+ usage of the `textgreek' package
- former \cmpd+ is now \cmpd-
- new \cmpd+ added which reads label from
<jobname>.cmpd
@@ -1362,10 +1560,10 @@ HISTORY:
http://www.arkat-usa.org/get-file/29257/ or scheme 4
at http://www.arkat-usa.org/get-file/27301/ for
reasons, why
- 2011/11/08 version 0.3c - localization via babel is now supported with the
- help of the translator package
+ 2011/11/08 version 0.3c - localization via `babel' is now supported with the
+ help of the `translator' package
- key "list-serial-comma" added
- 2011/12/01 version 0.3d - greek letters without textgreek package
+ 2011/12/01 version 0.3d - greek letters without `textgreek' package
- new key cmpd-weight = bold/normal
- bugfix: sublabels are now possible, when main label
name contains a colon
@@ -1373,12 +1571,29 @@ HISTORY:
separator; this means the comma may be part of the
label name
2011/12/01 version 0.3e - bugfix: labels have been saved in a wrong way, when
- list-input-sep had been changed. this is fixed
+ "list-input-sep" had been changed. this is fixed
+ 2011/12/09 version 0.4 - new input of sublabel lists and ranges
+ - new key: "sublist-input-sep"
+ - new key: "sublist-output-sep"
+ - new key: "init-input-sep"
+ - "sub-marker" => "sub-input-sep"
+ - "cmpd-sep" => "sub-output-sep"
+ - "sub-range-sep" => "subrange-output-sep"
+ - "sub-range-marker" => "subrange-input-sep"
+ - "strict" => "init-strict"
+ - "sub-init" => "init-sub"
+ - key removed: "sub-list"
+ - it is now possible, to mark the labels with
+ \hypertarget and \hyperlink if `hyperref' is loaded
+ - new key: "hyper-use"
+ - new key: "hyper-target"
+ - new key: "hyper-link"
+ - new key: "ref-style"
+ - documentation got an index
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% TODO:
- - natürliche Unterstützung für hyperref
+ - (rudimentäre) Unterstützung für hyperref und pdfstrings
- polyglossia: localization of us-variant of english
- - alphabetische Sortierung für sub-list
- Bug: Key "cmpd-style" wenn zB \color{<farbe>} eingegeben: Fehler beim Test
auf Makro; Test entfernen?
- \cmpdref: Reihenfolge der optionalen Argumente vertauschen? \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 21:39:51 +0000