diff options
author | Karl Berry <karl@freefriends.org> | 2011-08-02 22:31:58 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-08-02 22:31:58 +0000 |
commit | 5754c136ffe6b6c941127b2e2fa15238fc3323ef (patch) | |
tree | ea7fd252ea8da153c105b83d7d71a1e07fca275a /Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex | |
parent | 385daa279ac68fc0277e25586e8745366abfb796 (diff) |
new latex package chemnum (28jun11/2aug11)
git-svn-id: svn://tug.org/texlive/trunk@23357 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex | 838 |
1 files changed, 838 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex new file mode 100644 index 00000000000..719f56f5ce2 --- /dev/null +++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_de.tex @@ -0,0 +1,838 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% - chemnum - chemnum_doc_de.tex - % +% - a comprehensive numbering method for chemical compounds - % +% ------------------------------------------------------------------------------------- % +% - Clemens NIEDERBERGER - % +% - 2011/08/02 - % +% ------------------------------------------------------------------------------------- % +% - http://www.mychemistry.eu/ - % +% - contact@mychemistry.eu - % +% ------------------------------------------------------------------------------------- % +% - If you have any ideas, questions, suggestions or bugs to report, please feel free - % +% - to contact me. - % +% ------------------------------------------------------------------------------------- % +% - Copyright 2011 Clemens Niederberger - % +% - - % +% - This work may be distributed and/or modified under the - % +% - conditions of the LaTeX Project Public License, either version 1.3 - % +% - of this license or (at your option) any later version. - % +% - The latest version of this license is in - % +% - http://www.latex-project.org/lppl.txt - % +% - and version 1.3 or later is part of all distributions of LaTeX - % +% - version 2005/12/01 or later. - % +% - - % +% - This work has the LPPL maintenance status `maintained'. - % +% - - % +% - The Current Maintainer of this work is Clemens Niederberger. - % +% - - % +% - This work consists of the files chemnum.sty, chemnum_doc_de.tex, - % +% - chemnum_doc_en.tex, bsp.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]{babel} +\usepackage[utf8]{inputenx} +\usepackage{chemnum,textcomp,url,xspace,booktabs,array,chemscheme} +\usepackage[version=3]{mhchem} + \renewcommand*\schemename{Schema} +\usepackage[normalem]{ulem} +\usepackage[dvipsnames]{xcolor} + \colorlet{code}{RawSienna} + \colorlet{shadecolor}{yellow!20} +\usepackage[runs=2]{auto-pst-pdf} +\usepackage{chemfig,chemmacros} +\input{bsp} +\lstset{ + language=[LaTeX]TeX, + basicstyle={\ttfamily}, % Grundstil + extendedchars=true, + numbers=left, % Zeilennummern + numberstyle=\tiny, % Größe des Zeilennummern + numberblanklines=true, % Leerzeilen nummerieren + gobble=0, % das erste Leerzeichen abschneiden + xleftmargin=20pt, % Einrückung links + breaklines=true, % Zeilenumbruch + 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}}, + keywordstyle=\color{code}, + texcsstyle=[30]\color{code}, + moretexcs=[30] + { + @m, + cmpd, + cmpdinit, + cmpdref, + cmpdreset, + cmpdsetup, + CNlabel, + CNlabelnoref, + CNref, + CNlabelsub, + CNlabelsubnoref, + CNrefsub, + declarecompound, + compound, + compoundprefix, + compoundsuffix, + fcite, + lstinline, + penalty, + psfrag, + schemeref, + tableofcontents, + textnumero, + theffbibliography, + uline + } + }% + +\usepackage{hyperref} + \hypersetup{colorlinks=true, + plainpages=false, + bookmarksopen=true, + bookmarksopenlevel=2, + bookmarksnumbered=true, + pdfauthor={Clemens Niederberger}, + pdftitle={chemnum - Manual}, + pdfsubject={Chemische Substanzen Nummerieren}, + pdfkeywords={chemmnum}, + pdfcreator={LaTeX} + } + +\newcommand*\changefont[3]{\fontfamily{#1}\fontseries{#2}\fontshape{#3}\selectfont} + +\newcommand*\chemnum{\textsf{chemnum}\xspace} +\newcommand*\CNversion{v0.3\xspace} +\newcommand*\CNdate{2011/08/02\xspace} + +\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} +\begin{document} + +\begin{titlepage} + \centering + \Huge chemnum \CNversion + \vskip.5cm + \Large \CNdate + \vskip.5cm + \large Clemens \textsc{Niederberger} + \vskip.25cm + \normalsize\url{http://www.mychemistry.eu/}\\ + \href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu} + \vskip2cm + \begin{abstract} + \chemnum ist ein neuer, möglichst umfassender Ansatz zum Nummerieren chemischer Verbindungen. + \end{abstract} + \vskip3cm \cmpdinit*{glucose.alpha, glucose.beta, glucose.chain} + \cmpd*[sub-counter = greek]{glucose.alpha, glucose.beta}\cmpd*{glucose.chain} + \setatomsep{2em} + \definesubmol{x}{(-[4]H)(-[0]OH)} + \definesubmol{y}{(-[0]H)(-[4]HO)} + \begin{scheme}[h] + \centering\small + \schemestart + \chemfig{?(-[:-170]HO)-[:-50](-[:170]HO)-[:10](-[:-55,0.7]OH)-[:-10](-[6,0.8]OH)-[:130]O-[:-170]?(-[:150,0.7]-[2,0.7]OH)} + \arrow(alpha--chain){<=>} + \chemfig{[2]OH-[3]-!x-!x-!y-!x-=[1]O} + \arrow(--beta){<=>} + \chemfig{?(-[:-170]HO)-[:-50](-[:170]HO)-[:10](-[:-55,0.7]OH)-[:-10](-[:10]OH)(-[6,,,,draw=none]\vphantom{OH})-[:130]O-[:-170]?(-[:150,0.7]-[2,0.7]OH)} + \arrow(@chain--chainlabel){0}[-90,.2] \normalsize\cmpd[cmpd-delim]{glucose.chain} + \arrow(@chainlabel--){0}[,2.5] \normalsize\cmpd[cmpd-delim]{glucose.beta} + \arrow(@chainlabel--){0}[180,2.3] \normalsize\cmpd[cmpd-delim]{glucose.alpha} + \schemestop + \caption{Das \textalpha- und das \textbeta-Anomer von \Dfi-Glucose \cmpd[list-delim,list-lang=DE]{glucose.alpha,glucose.beta} stehen in Lösung über die offenkettige Form \cmpd[cmpd-delim]{glucose.chain} im Gleichgewicht.} + \end{scheme} +\end{titlepage} +\cmpdreset +\tableofcontents + +\section{Lizenz, Voraussetzungen} +\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 benötigt außerdem die Pakete \paket{etoolbox} und \paket{psfrag} und (manchmal) das Paket \paket{textgreek}, siehe Abschnitt \ref{sec:package_options}. + +\section{Neu in \chemnum \CNversion} +Neu seit \CNversion ist folgendes:\cmpd*{a.one,a.two,a.three,a.four,a.five} +\begin{itemize} + \item der Key \lstinline=sub-cmpd-sep= heißt jetzt \lstinline=sub-marker=, siehe Seite \pageref{ssec:sub_label_marker} + \item der Key \lstinline=cmpd-sub-counter= heißt jetzt \lstinline=sub-counter=, siehe Seite \pageref{key:sub-counter} +\end{itemize} +Diese Umbenennung folgt dem Wunsch, die Keys ihrer Verwendung nach logisch in verschiedene Klassen zu unterteilen, siehe Seite \pageref{key_classes}. +\begin{itemize} + \item mehrere Keys zum Erstellen von Labels der Art \cmpd[sub-list={one..three,five}]{a}, siehe Abschnitt \ref{ssec:lists_ranges} ab Seite \pageref{ssec:lists_ranges}. + \item der Befehl \lstinline=\cmpdref= zum Esetzen von Text-Strings in \lstinline=eps=-Dateien, siehe Abschnitt \ref{ssec:cmpdref}. + \item der Key \lstinline=ref-tag=, siehe Seite \pageref{key:key-tag}. +\end{itemize} + +\section{Paket-Optionen}\label{sec:package_options} +\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 \chemnum ohne Option verwenden, wird \textsf{textgreek} mit dem \lstinline=cbgreek=-Stil geladen. Die Verwendung von \lstinline+\usepackage[textgreek]{chemnum}+ entspricht \lstinline+\usepackage[textgreek = cbgreek]{chemnum}+ oder \lstinline+\usepackage{chemnum}+. + +Wenn Sie das \textsf{textgreek}-Paket nicht installiert haben und keine griechischen Label be\-nö\-ti\-gen, können Sie \lstinline+\usepackage[textgreek = false]{chemnum}+ verwenden. Damit resultieren die Counter-Optionen \lstinline=greek= und \lstinline=Greek= in den Optionen \lstinline=alph= und \lstinline=Alph= (siehe Abschnitt \ref{ssec:counter}). + +\section{Motivation} +Soweit mir bekannt ist, gab es bislang drei Pakete, die das Nummerieren von Verbindungen erleichtern sollen. Sie alle haben ihre Schwächen. + +Das erste, \paket{chemcono}, hat für diesen Zweck Bibliographie-Befehle umdefiniert. Dort müs\-sen Verbindungen in einer Art Literaturliste definiert werden. Dadurch kann dann im Text auf sie referenziert werden. Da es die "`Verbindungs-Bibliothek"' immer mit ausgibt, schlägt der Paket-Autor folgendes vor: +\begin{quote}\small\changefont{cmss}{m}{sl} + After compilation and printout, discard the last page.\\ + \parbox{\linewidth}{\raggedleft\normalfont\itshape Stefan Schulz} +\end{quote} +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}. +\begin{quote}\small\changefont{cmss}{m}{sl} + 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.\\ + \parbox{\linewidth}{\raggedleft\normalfont\itshape Stephan Schenk} +\end{quote} +Manche Schwächen hat auch dieses Paket: +\begin{enumerate} + \item Verbindungen müssen in der Regel mit \lstinline=\declarecompound= deklariert werden. Sie müs\-sen es auf jeden Fall, wenn man Label der Art \cmpd{a.one} haben möchte. Dann muss man die La\-bel sogar von Hand vergeben, was den Sinn einer automatischen Nummerierung untergräbt. + \item Das Layout lässt sich nicht einzeln ändern, sondern nur für alle Label. + \item Die Nummerierung kann nicht zurückgesetzt werden. Obwohl das in der allermeisten Fällen \emph{weder nötig noch zu empfehlen ist}, kann es Einzelfälle geben, in denen solches Verhalten gewünscht ist. + \item Eine Liste mehrerer Verbindungen \lstinline=\compound{a,b,c}= kann nicht oder nur um\-ständ\-lich eigenen Vorstellungen angepasst werden. +\end{enumerate} + +Dann gibt es noch \paket{bpchem}, das Befehle ähnlich den Befehlen \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. + +Wenn Ihnen irgendwelche fehlenden Features auffallen, geben Sie mir bitte Bescheid, indem Sie mir eine E-Mail senden. + +\section{Verbindungen Nummerieren}\label{sec:nummerieren} +\subsection{Basisbefehl} +Der eigentliche Befehl des Pakets ist +\begin{framed} +\centering\lstinline=\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. + +\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 + Noch einmal: \cmpd{b}, \cmpd{a}, \cmpd{c}. +\end{beispiel} + +Falls es nötig sein sollte, eine Verbindung zu deklarieren, ohne ein Label auszugeben, kann man an entsprechender Stelle +\begin{framed}\label{cmd:unsichtbares_label} +\centering\lstinline=\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).} + +\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: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. + +\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} + +\subsection{Sublabel}\label{ssec:unterlabel} +Möchte man Label der Form \cmpd{a.one} erzeugen, geschieht das nach folgender Syntax: +\begin{framed} +\centering\lstinline=\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. + +\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}. +\end{beispiel} + +Diese Syntax funtioniert auch, wenn der Hauptname bereits vergeben wurde. + +\begin{beispiel} + \cmpd{a} und seine Varianten + \cmpd{a.one} und \cmpd{a.two} +\end{beispiel} + +Genauso kann der Hauptname von kombiniert vergebenen Labeln einzeln aufgerufen werden. + +\begin{beispiel} + \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{ssec:lists_ranges} erklärt. + +\subsection{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)>}= +\end{framed} + +\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} + +Wie das nicht-US-Amerikenern merkwürdig anmutende \verb=, and= zwischen \cmpd{e} und \cmpd{g.two} schon vermuten lässt, kann man die Ausgabe der Liste noch verändern, siehe Abschnitt \ref{ssec:trenner} (S. \pageref{ssec:trenner}). + +\section{Label zentral initialisieren}\label{sec:cmpdinit} +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. +\begin{framed} +\centering\lstinline=\cmpdinit{<comma separated list of label names>}= +\centering\lstinline=\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. + +\cmpdreset +\begin{beispiel} + \cmpdinit{A, B, C} \cmpd{B} + \cmpd{A.a} \cmpd{C} \cmpd{D} +\end{beispiel} + +\begin{framed} + \small\ttfamily\noindent + {}*************************************************\\ + {}* chemnum warning: "cmpd-init"\\ + {}* \\ + {}* You used \verb=\cmpdinit= but didn't initiate compound "D"{} on line 1.\\ + {}************************************************* +\end{framed} + +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. + +\cmpdreset +\begin{beispiel} + \cmpdinit*{X, Y, Z} \cmpd{Y} + \cmpd{X.x} \cmpd{Z} \cmpd{W} +\end{beispiel} + +\begin{framed} + \small\ttfamily\noindent + {}*************************************************\\ + {}* chemnum warning: "cmpd-init"\\ + {}* \\ + {}* You used \verb=\cmpdinit= but didn't initiate compound "W"{} on line 1.\\ + {}************************************************* +\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. + +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>}+ +\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} +\end{beispiel} + +\begin{framed} + \small\ttfamily\noindent + {}*************************************************\\ + {}* chemnum warning: "cmpd-sub-init"\\ + {}* \\ + {}* You used \verb=\cmpdinit= and "{}sub-init = true"{} but didn't initiate sub-compound\\ + {}* "{}E.f"{} 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: +\begin{framed} +\centering\lstinline+\cmpdinit[!!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. + +Durch \lstinline+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: +\begin{framed} +\centering\lstinline+\cmpdinit[strict = true, sub-init = true]{<comma separated list of label names>}+ +\end{framed} + +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. + +\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. +\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. +\end{enumerate} + +\newpage +\section{Zurücksetzen des Zählers}\label{sec:cmpdreset} +Es ist möglich, mit folgendem Befehl +\begin{framed} +\centering\lstinline=\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. + +\begin{beispiel} + \cmpdreset + Die Verbindungen werden jetzt wieder von 1 gez\"ahlt: \cmpd{h, i, j} +\end{beispiel} + +\textbf{Sie sollten mit diesem Befehl sehr vorsichtig umgehen! In der Regel ist es nicht zu empfehlen, den Zähler zurückzusetzen. Dadurch können ein und dieselbe Nummer an verschiedene Verbindungen vergeben werden!} + +\begin{beispiel} + Gleiche Nummern: \cmpd{a}, \cmpd{h} +\end{beispiel} + +\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: +\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. +\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>}= +\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).} + +\begin{beispiel} + \subsubsection{Test-\"Uberschrift mit Verbindungslabel \cmpd+[cmpd-delim]{f.one}} + % mit hyperref: + \subsubsection{Test-\"Uberschrift mit Verbindungslabel \texorpdfstring{\cmpd+[cmpd-delim]{f.two}}{(7b)}} +\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 können Sie natürlich dennoch \lstinline=\cmpd+= verwenden. +\begin{beispiel}[code and float] + % preamble: + % \usepackage{chemscheme} + % \renewcommand*\schemename{Schema} + % document: + \cmpdreset\cmpd{float1, float2}. Und jetzt ein Schema: + \begin{scheme}[ht] + \centering + \caption{Dieses Label sollte eine 2 sein: \cmpd{float2}} + Wenn 2 = \cmpd{float2} wahr ist, ist alles ok. + \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]=. + +\cmpdinit*{Alc,EtherBr,cpd} +\subsection{Schemata externer Programme}\label{ssec:cmpdref} +Wenn Sie Ihre Schemata mit externen Programmen wie \zB \textsc{ChemDraw} erstellen und dort ebenfalls \chemnum einsetzen wollen, dann können Sie das mit +\begin{framed} +\centering\lstinline=\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] + \begin{scheme}[ht] + \centering + \includegraphics{scheme-tmp} + \caption{Schema mit tempor\"aren Markern.} + \end{scheme} + \begin{scheme}[ht] + \centering + \cmpdref{Alc} % ersetzt TMP1 + \cmpdref{EtherBr} % ersetzt TMP2 + % \cmpdref{drittes} wuerde TMP3 ersetzen + \includegraphics{scheme-tmp} + \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} verwenden, um trotzdem \textsc{pdflatex} einsetzen zu können. + +In jedem Fall ist es wichtig, dass der Marker als \emph{Text} im \lstinline=eps= gespeichert ist. + +Mit den Keys, die in Abschnitt \ref{sec:cmpdsetup} vorgestellt werden, können Sie die Label hier auch personalisieren. +\begin{beispiel}[code and float] + \begin{scheme}[ht] + \centering + \cmpdref[cmpd-style=\bf\sf\textcolor{green}]{Alc} % ersetzt TMP1 + \cmpdref[cmpd-style=\bf\sf\textcolor{green}]{EtherBr} % ersetzt TMP2 + \includegraphics{scheme-tmp} + \caption{Schema mit automatisierten Labeln.} + \end{scheme} +\end{beispiel} + +Sie können auch beliebigen Text ersetzen. Dafür gibt es das zweite optionale Argument. +\begin{beispiel}[code and float] + \begin{scheme}[ht] + \centering + \includegraphics{scheme-bla} + \caption{Schema mit beliebigen Markern.} + \end{scheme} + \begin{scheme}[ht] + \centering + \cmpdref[][blah]{Alc} + \cmpdref[][blub]{EtherBr} + % \cmpdref{drittes} wuerde TMP1 ersetzen + \includegraphics{scheme-bla} + \caption{Schema mit explizit gesetzten Labeln.} + \end{scheme} +\end{beispiel} + +Natürlich funktioniert das mit Sublabeln nach dem gewohnten Muster: +\begin{beispiel}[code and float] + \begin{scheme}[ht] + \centering + \cmpdref{cpd.red} + \cmpdref{cpd.ox} + \includegraphics{scheme-tmp} + \caption{Schema mit automatisierten Labeln und Sublabeln.} + \end{scheme} +\end{beispiel} + +\cmpdreset[9] +\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}+ +\end{framed} +\noindent oder lokal direkt beim Befehl +\begin{framed} +\centering\lstinline+\cmpd[key1 = value1, key2 = value2]{<label name>}+ +\end{framed} +\noindent vorgenommen werden. + +Dabei gibt es verschiedene Arten von Schlüsseln. Je nach Art können sie andere Werte bekommen. +\begin{description} + \item[\ttfamily macro] Diese Schlüssel erwarten als Eingabe ein Makro, das auch ein obligatorisches Argument besitzen kann, \zB \lstinline=\bfseries= oder \lstinline=\textbf=. \chemnum hat nur einen einzigen Schlüssel dieser Art, siehe Abschnitt \ref{ssec:schriftstil}. + \item[\ttfamily literal] Diese Sorte Schlüssel verwendet das eingegebene direkt, also buchstäblich. Die meisten Schlüssel von \chemnum entsprechen dieser Art. + \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. + +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[\ttfamily list] Schlüssel, die die Ausgabe der Listen ändern. + \item[\ttfamily ref] Schlüssel, die speziell mit \lstinline=\cmpdref= zu tun haben. +\end{description} + +\newpage +\subsection{Schriftstil}\label{ssec: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= +\end{framed} +\begin{beispiel} + % preamble: + % \usepackage[normalem]{ulem} + % document: + \cmpd{a, b, f.two, k}\\ % default + \cmpd[cmpd-style = \uline]{a, b, f.two, k}\\ % unterstrichen + \cmpd{a, b, f.two, k}\\ % wieder default + \cmpdsetup{cmpd-style = \itshape\uline} + \cmpd{a, b, f.two, k} % kursiv und unterstrichen +\end{beispiel} + +\subsection{Eigene Labels}\label{ssec:own_labels} +Mit dem Schlüssel +\begin{framed} +\noindent\lstinline+cmpd-label = <name>+ \hfill Typ: \lstinline=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} + +\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} +\begin{beispiel}[code only] + \cmpdsetup{ref-marker = tmp} +\end{beispiel} + +\subsection{Zähler}\label{ssec:counter} +Wenn Sie mögen, können Sie auch das Zählerformat \textbf{1a} ändern. +\begin{framed} +\noindent\lstinline+cmpd-counter = <counter>+ \hfill Typ: \lstinline=choice=\\ +\lstinline+sub-counter = <counter>+ \hfill Typ: \lstinline=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=. + +Bitte beachten Sie: ein Ändern des Zählerformats wirkt sich nur auf \emph{noch nicht erzeugte} Label aus! +\begin{beispiel} + \cmpdsetup{cmpd-counter = Alph, sub-counter = arabic} + \cmpd{a, b, f.two, k}\\ % keine Wirkung bei bereits erzeugten Labeln! + \cmpd{n.one,n.two,o.one}\\ + \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} + +\subsection{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! +\end{framed} +\begin{beispiel} + \cmpd{a, b, f.two, k}\\ % default + \cmpd[cmpd-delim = ()]{a, b, f.two, k}\\ % eingeklammert + \cmpd{a, b, f.two, k}\\ % wieder default + \cmpdsetup{cmpd-delim = ()} + \cmpd{a, b, f.two, k} % eingeklammert +\end{beispiel} +Bitte Beachten Sie, dass die Default-Werte (siehe S. \pageref{opt:default} und \pageref{ssec:uebersicht}) von \lstinline=cmpd-delim= und \lstinline=list-delim= und die Voreinstellung von \chemnum \emph{nicht} übereinstimmen. Per Default verwendet \chemnum keine Begrenzer. Beachten Sie außerdem, 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 + \cmpd{a, b, f.two, k}\\ % wieder default + \cmpdsetup{list-delim = []} + \cmpd{a, b, f.two, k}\\ % eingeklammert + \cmpd{a} % KEINE Liste! +\end{beispiel} +Wenn Sie generell die Label eingeklammert verwenden, aber ein einzelnes einmal ohne Klammern verwenden wollen, haben Sie mehrere Möglichkeiten: +\begin{beispiel} + \cmpdsetup{cmpd-delim = ()} + Normal \cmpd{b}, \cmpd{c}, \cmpd{d.one}, aber manchmal so \cmpd[cmpd-delim = ]{e} oder so \cmpd-{e}. +\end{beispiel} +Mit +\begin{framed}\label{cmd:ohne_begrenzer} +\centering\lstinline=\cmpd-{<label name>}=\\ +\lstinline=\cmpdref-{<label name>}= +\end{framed} +\noindent kann man die Klammern eines Labels schnell entfernen (nicht jedoch die der Liste). +\begin{beispiel} + \cmpd{a, b, f.two, k}\\ % default + \cmpdsetup{cmpd-delim = (), list-delim = []} + \cmpd{a, b, f.two, k}\\ % doppelt eingeklammert + \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. + +\subsection{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= +\end{framed} +Wie bei den Begrenzern gilt: Listen-Attribute werden erst bei einer Liste -- also zwei oder mehr Labeln -- verwendet. + +Beispiel für die Label-Attribute: +\begin{beispiel} + \cmpd{a, b, f.two, k}\\ % default + \cmpd[cmpd-prefix = Nr.]{a, b, f.two, k}\\ + \cmpdsetup{cmpd-prefix = \textnumero} + \cmpd{a, b, f.two, k}\\ + \cmpd{a} % KEINE Liste! +\end{beispiel} +Beispiel für die Listen-Attribute: +\begin{beispiel} + \cmpd{a, b, f.two, k}\\ % default + \cmpd[list-prefix = Liste:]{a, b, f.two, k}\\ + \cmpdsetup{list-prefix = Sammlung:} + \cmpd{a, b, f.two, k}\\ + \cmpd{a} % KEINE Liste! +\end{beispiel} + +\subsection{Trenner}\label{ssec:trenner} +\subsubsection{Bei Labeln} +Haben Sie Label mit Sublabeln, können Sie dort auch ein Trenn-Symbol verwenden. +\begin{framed} +\noindent\lstinline+cmpd-sep = <separator>+ \hfill Typ: \lstinline=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{a, b, f.two, f.three, k}\\ + \cmpd[cmpd-sep = :]{a, b, f.two, f.three, k} +\end{beispiel} + +\subsubsection{Bei Listen -- allgemein} +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-sep = <separator>+ \hfill Typ: \lstinline=literal= +\end{framed} +\begin{beispiel} + \cmpd{a, b, f.two, k}\\ % default + \cmpd[list-sep = ]{a, b, f.two, k}\\ + \cmpd{a, b, f.two, k}\\ + \cmpdsetup{list-sep = ;} + \cmpd{a, b, f.two, k} +\end{beispiel} + +\subsubsection{Bei 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= +\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=\footnote{Wenn Ihnen eine Sprache fehlt oder Sie einen Fehler bei den Übersetzungen finden, senden Sie mir doch bitte eine E-Mail.}. +\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}\\ + \cmpd[list-lang = DE]{a, b, f.two, k} \cmpd[list-lang = DE]{a, b}\\ + \cmpd[list-lang = FR]{a, b, f.two, k} \cmpd[list-lang = FR]{a, b}\\ + \cmpd[list-lang = ES]{a, b, f.two, k} \cmpd[list-lang = ES]{a, b}\\ + \cmpd[list-lang = IT]{a, b, f.two, k} \cmpd[list-lang = IT]{a, b} +\end{beispiel} + +Zum anderen können Sie den letzten Trenner mit \lstinline=list-last-sep= auch individuell festlegen. +\begin{beispiel} + \cmpdsetup{list-lang = DE}% + \cmpd[list-last-sep = {und auch}]{a, b, f.two, k}\\ + \cmpd[list-last-sep = ]{a, b, f.two, k}\\ + \cmpd[list-last-sep = sowie]{a, b, f.two, k}\\ + \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-sep= festgelegt wurde. +\begin{beispiel} + \cmpdsetup{list-last-sep = empty}% + \cmpd{a, b, f.two, k}\\ + \cmpd[list-sep = ;]{a, b, f.two, k}\\ + \cmpd[list-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. +\begin{framed} +\noindent\lstinline+sub-marker = <separator>+ \hfill Typ: \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} +\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. + +\subsection{Listen und Bereiche von Sublabeln}\label{ssec:lists_ranges} +Manchmal kann es nützlich oder erwünscht sein, ein Label mit einem Bereich von Sublabeln anzuzeigen. Nehmen wir an, Sie habe 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 zur Verfügung, mit denen solche Label erzeugt werden können, und zwei, mit denen sie angepasst werden können. +\begin{framed} + \noindent\lstinline+cmpd-all = <bool>+ \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= +\end{framed} +Der Typ des Keys \lstinline=sub-list= unterscheidet sich von dem anderer Keys. Er ähnelt \lstinline=literal=. Am besten schauen Sie Sich das Beispiel unten an. + +\begin{beispiel} + Liste von Labeln: \cmpd{q.one, q.two, q.three, q.four, q.five} \\ + Alle auf einmal: \cmpd[cmpd-all]{q} +\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. + +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: +\begin{beispiel} + \cmpd[sub-list={five..three}]{q} or \cmpd[sub-list={three,one,four}]{q}. +\end{beispiel} + +\newpage +\subsection{Übersicht}\label{ssec:uebersicht} +Im folgenden sind alle verfügbaren Schlüssel aufgelistet. Bitte beachten Sie, dass die Default-Werte von \lstinline=cmpd-delim= und \lstinline=list-delim= \emph{nicht} mit der Voreinstellung von \chemnum über\-ein\-stim\-men. \chemnum setzt in der Voreinstellung \emph{keine} Begrenzer. +\begin{center} + \label{tab:keys} + \begin{tabular}{>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule + \normalfont\bfseries key & \normalfont\bfseries default & \normalfont\bfseries type \\\midrule + cmpd-style & \lstinline=\textbf= & macro \\ + cmpd-label & & literal \\ + cmpd-delim$^\mathrm{a}$ & () & literal \\ + cmpd-odelim & & literal \\ + cmpd-cdelim & & literal \\ + cmpd-prefix & & literal \\ + cmpd-suffix & & 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 \\\midrule + list-delim$^\mathrm{a}$ & () & literal \\ + list-odelim & & literal \\ + list-cdelim & & literal \\ + list-prefix & & literal \\ + list-suffix & & literal \\ + list-sep & , & literal \\ + list-lang & US & choice \\ + list-last-sep & and$^\mathrm{c}$ & literal \\\midrule + ref-tag & TMP & literal \\\bottomrule + \end{tabular} + \\%\hspace*{1em} + \begin{tabular}{>{\footnotesize}r>{\footnotesize\raggedright}p{.3\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= ab. + \end{tabular} +\end{center} + +\newpage +\section{Liste der Befehle} +Im folgenden werden alle von \chemnum definierten Befehle und deren Varianten aufgelistet. +\begin{center} + \label{tab:commands} + \begin{tabular}{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{tabular} +\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. + +\end{document}
\ No newline at end of file |