diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemnum')
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/README | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf | bin | 943665 -> 944070 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex | 60 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf | bin | 934183 -> 934681 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex | 73 |
5 files changed, 69 insertions, 68 deletions
diff --git a/Master/texmf-dist/doc/latex/chemnum/README b/Master/texmf-dist/doc/latex/chemnum/README index 0f2f3663520..37da01c4b15 100644 --- a/Master/texmf-dist/doc/latex/chemnum/README +++ b/Master/texmf-dist/doc/latex/chemnum/README @@ -1,4 +1,4 @@ -chemnum v0.5a +chemnum v0.5c a comprehensive approach for the numbering of chemical compounds Basically one main command is provided, \cmpd{<label name>}. With @@ -12,7 +12,7 @@ chemnum also needs the packages etoolbox, psfrag and textgreek or bm to be fully functioning. Clemens NIEDERBERGER -2012/05/03 +2012/07/24 http://www.mychemistry.eu/ contact@mychemistry.eu diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf Binary files differindex 955faa35595..8042540ea2c 100644 --- a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf +++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.pdf diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex index 708d563fa74..1b6cfa46f06 100644 --- a/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex +++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_de.tex @@ -1,9 +1,13 @@ +% arara: pdflatex: { shell: on } +% arara: makeindex: { sort: true, style: chemnum_de.ist } +% arara: pdflatex: { shell: on } +% arara: pdflatex: { shell: on } %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % - chemnum - chemnum_de.tex % - a comprehensive approach for the numbering of chemical compounds % ----------------------------------------------------------------------------- % - Clemens NIEDERBERGER -% - 2012/05/03 +% - % - contact@mychemistry.eu % ----------------------------------------------------------------------------- % - If you have any ideas, questions, suggestions or bugs to report, please @@ -36,8 +40,9 @@ \docsetup{ pkg = chemnum, language = de, - code-box = {backgroundcolor=cnpkgcodebg,skipabove=1ex,skipbelow=1ex} + code-box = {skipabove=1ex,skipbelow=1ex} } +\usepackage{fnpct} \addcmds{ @m,arrow,bf,ch,chemfig,chemname,cmpd,cmpdinit,cmpdref,cmpdreset,cmpdsetup, CNlabel,CNlabelnoref,CNref,CNlabelsub,CNlabelsubnoref,CNrefsub, @@ -47,15 +52,14 @@ setdoublesep,section,sf,subsection,subsubsection,tableofcontents, texorpdfstring,textcolor,theffbibliography,uline} -\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,frenchb,canadien,spanish,italian]{babel} +\usepackage[german,naustrian,austrian,english,british,american,canadian,frenchb,canadien,spanish,italian,ngerman]{babel} \usepackage{textcomp,longtable,tabu,booktabs,chemscheme,hologo} \usepackage[iupac=strict]{chemmacros} - \DeclareChemIUPAC\a{\textalpha} - \DeclareChemIUPAC\b{\textbeta} \usepackage{chemfig} \usepackage[runs=2]{auto-pst-pdf} -\begin{filecontents}{index_de.ist} +\usepackage{filecontents} +\begin{filecontents*}{\jobname.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" @@ -66,7 +70,7 @@ delim_r "--" suffix_2p "\\nohyperpage{\\,f.}" suffix_3p "\\nohyperpage{\\,ff.}" -\end{filecontents} +\end{filecontents*} \let\prog\textsc \let\name\textsc @@ -77,7 +81,8 @@ \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}} \TitlePicture{% -\cmpdinit*{glucose.alpha, glucose.beta, glucose.chain} + \selectlanguage{ngerman} + \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)} @@ -106,7 +111,7 @@ \chemnum ruft intern die Pakete \paket*{expl3} und \paket{xparse} auf. \paket{xparse} ist Teil des \paket{l3packages}-Bundles, \paket*{expl3} ist Teil des \paket{l3kernel}-Bundles. Das heißt, \chemnum benötigt \LaTeX3-Un\-ter\-stüt\-zung. -\chemnum benötigt außerdem die Pakete \paket{etoolbox} und \paket{psfrag} und entweder das Paket \paket{textgreek} oder das Paket \paket{bm}, abhängig von den Paketoptionen (siehe Abschnitt \ref{sec:package_options}). +\chemnum benötigt außerdem die Pakete \paket{etoolbox} und \paket{psfrag} und entweder das Paket \paket{textgreek} oder das Paket \paket{bm}, abhängig von den Paketoptionen (siehe Abschnitt~\ref{sec:package_options}). \section{Neues und ein Wort der Entschuldigung} \subsection{Version 0.4} @@ -138,9 +143,9 @@ Diese Optionen sind neu: \end{tabular} \end{center} -Ebenfalls neu ist die Art und Weise, wie Sublabel-Listen und -Bereiche eingegeben werden. Der Option \key{sub-list} entfällt deshalb. Näheres siehe Abschnitt \ref{ssec:sub_ranges}. +Ebenfalls neu ist die Art und Weise, wie Sublabel-Listen und -Bereiche eingegeben werden. Der Option \key{sub-list} entfällt deshalb. Näheres siehe Abschnitt~\ref{ssec:sub_ranges}. -Dann gibt es nun die Möglichkeit, klickbare Links zu den Labeln herzustellen, vorausgesetzt Sie haben \paket{hyperref} eingebunden, siehe Abschnitt \ref{sec:hyperref}. +Dann gibt es nun die Möglichkeit, klickbare Links zu den Labeln herzustellen, vorausgesetzt Sie haben \paket{hyperref} eingebunden, siehe Abschnitt~\ref{sec:hyperref}. \subsection{Version 0.5} Ab v0.5 gibt es die Option \key{ref-pos}, die Ihnen erlaubt, die Positionierungs-Optionen des Befehls \cmd{psfrag} zu ändern, der von \cmd{cmpdref} intern verwendet wird, siehe S.\,\pageref{ssec:marker_in_bildern}. @@ -201,13 +206,13 @@ Falls es nötig sein sollte, eine Verbindung zu deklarieren, ohne ein Label ausz \end{beschreibung} verwenden. Dadurch wird ein entsprechendes Label deklariert aber nicht ausgegeben. -\achtung{Dieser Befehl wird nicht benötigt, wenn man \cmd{cmpdinit} verwendet, siehe Abschnitt \ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).} +\achtung{Dieser Befehl wird nicht benötigt, wenn man \cmd{cmpdinit} verwendet, siehe Abschnitt~\ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).} \begin{beispiel} Die versteckte Version\cmpd*{d} erzeugt zwar das Label, schreibt es aber nicht aus. Der n\"achste \cmpd{e} f\"uhrt die Z\"ahlung einfach weiter. Mit \cmpd{d} kann nat\"urlich auf das erzeugte Label zur\"uckgegriffen werden. \end{beispiel} -Als Label-Namen können Sie im Prinzip einsetzen, was Sie wollen, außer den als Trennzeichen verwendeten Symbolen (siehe Abschnitt \ref{ssec:unterlabel}, Abschnitt \ref{ssec:listen}, Abschnitt \ref{ssec:sub_ranges} und Abschnitt \ref{ssec:trenner}). Sie sollten allerdings darauf achten, dass der Name keine Leerzeichen enthält. Das führt zwar nicht unbedingt zu einem Fehler, könnte aber verschiedenen Labeln die gleiche Nummer zuweisen. +Als Label-Namen können Sie im Prinzip einsetzen, was Sie wollen, außer den als Trennzeichen verwendeten Symbolen (siehe Abschnitt~\ref{ssec:unterlabel}, Abschnitt~\ref{ssec:listen}, Abschnitt~\ref{ssec:sub_ranges} und Abschnitt~\ref{ssec:trenner}). Sie sollten allerdings darauf achten, dass der Name keine Leerzeichen enthält. Das führt zwar nicht unbedingt zu einem Fehler, könnte aber verschiedenen Labeln die gleiche Nummer zuweisen. \lstset{showspaces=true} \begin{beispiel} @@ -220,7 +225,7 @@ Möchte man Label der Form \cmpd{a.one} erzeugen, geschieht das nach folgender S \begin{beschreibung} \Befehl{cmpd}{<label name>.<subname>} \end{beschreibung} -Dabei muss \code{<label name>} der gleiche bleiben, \code{<subname>} variiert. Diese Syntax bedeutet, dass der Punkt \code{.} weder Teil von \code{<label name>} noch von \code{<subname>} sein darf. An Stelle des Punktes können Sie auch ein anderes Zeichen verwenden, siehe Abschnitt \ref{sssec:sub-input-sep}. +Dabei muss \code{<label name>} der gleiche bleiben, \code{<subname>} variiert. Diese Syntax bedeutet, dass der Punkt \code{.} weder Teil von \code{<label name>} noch von \code{<subname>} sein darf. An Stelle des Punktes können Sie auch ein anderes Zeichen verwenden, siehe Abschnitt~\ref{sssec:sub-input-sep}. \begin{beispiel} \cmpd{f.one} und \cmpd{f.two} sind eng verwandt, genauso \cmpd{g.one} und \cmpd{g.two}. Nat\"urlich bliebt auch hier bei sp\"aterem Aufruf das Label gleich: \cmpd{g.two} und \cmpd{f.one}. \end{beispiel} @@ -235,7 +240,7 @@ Genauso kann der Hauptname von kombiniert vergebenen Labeln einzeln aufgerufen w \cmpd{f} und \cmpd{g} \end{beispiel} -Wie Sie ein Label der Art \cmpd{f.{one,two}} erzeugen können,wird in Abschnitt \ref{ssec:sub_ranges} erklärt. +Wie Sie ein Label der Art \cmpd{f.{one,two}} erzeugen können,wird in Abschnitt~\ref{ssec:sub_ranges} erklärt. \secidx*{Sublabel} \subsection{Listen}\label{ssec:listen}\secidx{Listen} @@ -245,12 +250,11 @@ Die richtige Beschreibung des Befehls lautet also eher: \begin{beschreibung} \Befehl{cmpd}{<(possibly comma separated list of) label name(s)>} \end{beschreibung} -Das bedeutet, dass in der Voreinstellung das Komma nicht Teil des Label-Namens sein kann, es sei denn versteckt in geschweiften Klammern. Sie können das ändern, siehe Abschnitt \ref{sssec:list-input-sep} (S.\,\pageref{sssec:list-input-sep}). +Das bedeutet, dass in der Voreinstellung das Komma nicht Teil des Label-Namens sein kann, es sei denn versteckt in geschweiften Klammern. Sie können das ändern, siehe Abschnitt~\ref{sssec:list-input-sep} (S.\,\pageref{sssec:list-input-sep}). \begin{beispiel} Mehrere Label k\"onnen einfach durch Kommata getrennt eingegeben werden. Dann wird eine Liste wie \cmpd{a, b, c, e, g.two} ausgegeben. \end{beispiel} -The Harvard comma (see \ref{ssec:harvard-comma}) in \code{, and} between \cmpd{e} and \cmpd{g.two} suggests that there are options to customize the list, see sections \ref{ssec:trenner} and \ref{sec:language_support}. \secidx*{Listen} \subsection{Listen und Bereiche von Sublabeln}\label{ssec:sub_ranges}\index{Sublabel!Listen}\index{Sublabel!Bereiche} @@ -270,9 +274,9 @@ Sie können auf diese Weise auch Bereiche von Sublabeln darstellen. Als Marker z \cmpd{q.{one..three,five}} \end{beispiel} -Durch die Eingabe stehen Ihnen in der Voreinstellungen für Sublabel-Namen weder das Komma noch die zwei Punkte als Teils des Namens zur Verfügung. Wie Sie andere Symbole als Marker verwenden, damit Sie sie doch verwenden können, steht in den Abschnitten \ref{sssec:range-input-sep} und \ref{sssec:list-input-sep}. In Abschnitt \ref{sssec:input-sep-bsp} wird ein Beispiel gezeigt, wie eine geänderte Eingabe aussehen könnte. +Durch die Eingabe stehen Ihnen in der Voreinstellungen für Sublabel-Namen weder das Komma noch die zwei Punkte als Teils des Namens zur Verfügung. Wie Sie andere Symbole als Marker verwenden, damit Sie sie doch verwenden können, steht in den Abschnitten~\ref{sssec:range-input-sep} und \ref{sssec:list-input-sep}. In Abschnitt~\ref{sssec:input-sep-bsp} wird ein Beispiel gezeigt, wie eine geänderte Eingabe aussehen könnte. -\chemnum stellt eine Option (siehe Abschnitt \ref{sec:cmpdsetup} zur näheren Erläuterung) zur Verfügung, mit denen alle Sublabel als Bereich ausgegeben werden können +\chemnum stellt eine Option (siehe Abschnitt~\ref{sec:cmpdsetup} zur näheren Erläuterung) zur Verfügung, mit denen alle Sublabel als Bereich ausgegeben werden können \begin{beschreibung} \Option{cmpd-all}{\default{true}/false} \end{beschreibung} @@ -350,7 +354,7 @@ Beachten Sie, dass Sie bei Labeln mit Sublabeln \emph{nur den Hauptnamen} initia Wenn Sie also eigene Label vergeben wollen oder müssen (siehe Seite \pageref{ssec:own_labels}) und die Label geschlossen initialisieren wollen, sollten Sie \cmd[cmpda]{cmpdinit*} verwenden, da dort bei der Initialisierung \emph{keine} Label vergeben werden. -Der Befehl kann mehrfach verwendet werden, mit oder ohne \verb=*=. Sinnvoll ist aber wohl eine \emph{einmalige} Verwendung, vielleicht in der Dokumentenpräambel nach dem \chemnum-Setup (siehe Abschnitt \ref{sec:cmpdsetup}). +Der Befehl kann mehrfach verwendet werden, mit oder ohne \verb=*=. Sinnvoll ist aber wohl eine \emph{einmalige} Verwendung, vielleicht in der Dokumentenpräambel nach dem \chemnum-Setup (siehe Abschnitt~\ref{sec:cmpdsetup}). \subsubsection{Sublabel} Wenn Sie zusätzlich auch für jede Label-Sublabel-Kombination gewarnt werden wollen oder die Reihenfolge im Voraus festlegen wollen, dann können Sie @@ -388,7 +392,7 @@ Natürlich können Sie \cmd{cmpdinit} auch mit beiden Optionen aufrufen \begin{beschreibung} \Befehl{cmpdinit}[\key{init-strict}{true}, \key{init-sub}{true}]{<comma separated list ...>} \end{beschreibung} -oder \cmd{cmpdsetup} verwenden, siehe Abschnitt \ref{sec:cmpdsetup}. +oder \cmd{cmpdsetup} verwenden, siehe Abschnitt~\ref{sec:cmpdsetup}. \subsection{Personalisierte Eingabe} Wenn Sie andere Eingabezeichen für \key{sub-input-sep} (siehe Seite \pageref{sssec:sub-input-sep}) oder \key{sublist-input-sep} (siehe Seite \pageref{sssec:list-input-sep}) ausgewählt haben, müssen Sie sie mit \key{sub-init}{true} ebenfalls verwenden. @@ -399,7 +403,7 @@ Die Änderung der Listen-Eingabe \key{list-input-sep} (siehe Seite \pageref{ssse Wie zu Beginn dieses Abschnitts erwähnt, ist die Initialisierung von Labeln nicht nötig. Es gibt jedoch Gründe, warum man \cmd{cmpdinit} vielleicht trotzdem verwenden möchte. \begin{enumerate} \item Der Einsatz von \cmd[cmpdinita]{cmpdinit*} ist eine Möglichkeit, den Überblick darüber zu behalten, welche Label man verwendet hat. Man bekommt eine Warnung/Fehlermeldung, wenn man ein bestehendes falsch geschrieben hat. Abhängig davon, wieviele Labels man verwendet (oder verwenden muss) kann das aber viel zusätzliche Arbeit bedeuten. - \item Der Einsatz von \cmd{cmpdinit} bewirkt erst einmal dasselbe wie \cmd[cmpdinita]{cmpdinit*}, deklariert aber \emph{zusätzlich} die Label in der vorgegebenen Reihenfolge. Damit wird die Verwendung von \cmd[cmpda]{cmpd*} (Abschnitt \ref{cmd:unsichtbares_label}) und \cmd[cmpdb]{cmpd+} (Abschnitt \ref{cmd:cmpd_plus}) überflüssig. Man hat damit direkte Kontrolle, welche Verbindung welche Nummer erhält. + \item Der Einsatz von \cmd{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} @@ -441,7 +445,7 @@ Der Befehl\label{cmd:cmpd_plus} \end{beschreibung} liest den Labelnamen, der ausgegeben werden soll, aus der Datei \verb=\jobname.cmpd=. Damit ist er sozusagen das Gegenteil von \cmd[cmpda]{cmpd*}, da das Label nicht deklariert sondern nur referenziert und ausgegeben wird. Damit man also \cmd[cmpdb]{cmpd+}{<label>} einsetzen kann, muss \verb=<label>= entweder mit \cmd{cmpd}{<label>} oder \cmd[cmpda]{cmpd*}{<label>} (davor oder danach) deklariert worden sein. \cmd[cmpdb]{cmpd+} ist nützlich, wenn ein Label in einem beweglichen Argument wie in \verb=\section{}= eingesetzt werden soll. -\achtung{Er wird nicht benötigt, wenn} \cmd{cmpdinit} \textbf{verwendet wird, siehe Abschnitt \ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).} +\achtung{Er wird nicht benötigt, wenn} \cmd{cmpdinit} \textbf{verwendet wird, siehe Abschnitt~\ref{sec:cmpdinit} (S.\,\pageref{sec:cmpdinit}ff).} \begin{beispiel} \subsubsection{Test-\"Uberschrift mit Verbindungslabel \cmpd+[cmpd-delim]{f.one}} @@ -494,7 +498,7 @@ Sie nummerieren also im Schema die Substanzen mit \textsf{TMP1}, \textsf{TMP2} \ In jedem Fall ist es wichtig, dass der Marker als \emph{Text} im \verb=eps= gespeichert ist. -Mit den Optionen, die in Abschnitt \ref{sec:cmpdsetup} vorgestellt werden, können Sie die Label hier auch personalisieren. +Mit den Optionen, die in Abschnitt~\ref{sec:cmpdsetup} vorgestellt werden, können Sie die Label hier auch personalisieren. \begin{beispiel}[code and float] \begin{scheme}[ht] \centering @@ -541,7 +545,7 @@ Wenn Sie das Paket \paket{hyperref} eingebunden haben, können Sie die Label zu \begin{beschreibung} \Option{hyper-use}{\default{true}/false} \end{beschreibung} -Wenn Sie diese Option (siehe Abschnitt \ref{sec:cmpdsetup} für nähere Informationen) auf \texttt{true} setzen, dann wird beim ersten Einsatz eines Labels danach ein Ziel festgelegt und bei jedem weiteren ein Link zu diesem Ziel erzeugt. Das funktioniert allerdings nur, solange das Label \emph{ohne} Liste oder Bereich von Sublabeln gesetzt wird. Auch ein mit \cmd[cmpda]{cmpd*} gesetztes Label kann nicht als Ziel markiert werden. +Wenn Sie diese Option (siehe Abschnitt~\ref{sec:cmpdsetup} für nähere Informationen) auf \texttt{true} setzen, dann wird beim ersten Einsatz eines Labels danach ein Ziel festgelegt und bei jedem weiteren ein Link zu diesem Ziel erzeugt. Das funktioniert allerdings nur, solange das Label \emph{ohne} Liste oder Bereich von Sublabeln gesetzt wird. Auch ein mit \cmd[cmpda]{cmpd*} gesetztes Label kann nicht als Ziel markiert werden. \begin{beispiel} \cmpdsetup{hyper-use} @@ -616,7 +620,7 @@ Da es nicht unüblich ist, Schemata serifenlos zu setzen, während der Text mit \cmpd{a, b, f.two, k}\\ % kursiv und unterstrichen \cmpd[cmpd-weight=normal]{a, b, f.two, k} \end{beispiel} -Dass die Schriftstärke separat eingestellt wird, hat seine Ursache bei den griechischen Labeln (siehe Abschnitt \ref{ssec:counter}). Abhängig von der Paketoption muss die Schriftstärke dort unterschiedlich realisiert werden. +Dass die Schriftstärke separat eingestellt wird, hat seine Ursache bei den griechischen Labeln (siehe Abschnitt~\ref{ssec:counter}). Abhängig von der Paketoption muss die Schriftstärke dort unterschiedlich realisiert werden. \secidx*{Schriftstil} \subsection{Eigene Labels}\label{ssec:own_labels}\secidx{Eigene Labels} @@ -840,7 +844,7 @@ Der letzte Trenner bei Listen, derjenige zwischen dem vorletzten und letzten auf \cmpd[list-lang = ES]{a, b, f.two, k} \cmpd[list-lang = ES]{a, b}\\ \cmpd[list-lang = IT]{a, b, f.two, k} \cmpd[list-lang = IT]{a, b} \end{beispiel} -Wie Sie sehen, verwendet die Spracheinstellung \verb=US= per Default das Harvard-Komma, alle anderen Sprachen verwenden es nicht. Mehr zur Sprach-Unterstützung und zum Harvard-Komma finden Sie in Abschnitt \ref{sec:language_support}. +Wie Sie sehen, verwendet die Spracheinstellung \verb=US= per Default das Harvard-Komma, alle anderen Sprachen verwenden es nicht. Mehr zur Sprach-Unterstützung und zum Harvard-Komma finden Sie in Abschnitt~\ref{sec:language_support}. Sie können den letzten Trenner mit \key{list-last-sep} auch individuell festlegen. \begin{beispiel} @@ -880,7 +884,7 @@ Im folgenden sehen Sie ein kleines Beispiel, wie eine personalisierte Variante d \section{Sprachunterstützung}\label{sec:language_support}\secidx{Sprachunterstützung} \subsection{Zusammenarbeit mit \textsf{babel}} -\chemnum unterstützt die Sprachauswahl durch das \paket{babel}-Paket für eine Reihe von Sprachen. Dies geschieht mit Hilfe des \paket*{translator} Pakets, falls es vorhanden ist. Kann \paket*{translator} nicht geladen werden, muss die Sprachunterstützung von Hand vorgenommen werden, siehe Abschnitt \ref{sssec:last-sep}. Die Einstellung von Hand funktioniert natürlich auch, wenn \paket*{translator} geladen wurde. +\chemnum unterstützt die Sprachauswahl durch das \paket{babel}-Paket für eine Reihe von Sprachen. Dies geschieht mit Hilfe des \paket*{translator} Pakets, falls es vorhanden ist. Kann \paket*{translator} nicht geladen werden, muss die Sprachunterstützung von Hand vorgenommen werden, siehe Abschnitt~\ref{sssec:last-sep}. Die Einstellung von Hand funktioniert natürlich auch, wenn \paket*{translator} geladen wurde. \begin{beispiel} \selectlanguage{ngerman}DE: \cmpd{r,s,t} \selectlanguage{german}\cmpd{r,s,t}\\ \selectlanguage{naustrian}AU: \cmpd{r,s,t} \selectlanguage{austrian}\cmpd{r,s,t}\\ diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf Binary files differindex aa2c3b2df1a..be5e71667ce 100644 --- a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf +++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.pdf diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex index 6e7c84e3105..fc6c9ff3f04 100644 --- a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex +++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex @@ -1,9 +1,13 @@ +% arara: pdflatex: { shell: on } +% arara: makeindex: { sort: true, style: chemnum_en.ist } +% arara: pdflatex: { shell: on } +% arara: pdflatex: { shell: on } %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % - chemnum - chemnum_en.tex % - a comprehensive approach for the numbering of chemical compounds % ----------------------------------------------------------------------------- % - Clemens NIEDERBERGER -% - 2012/05/03 +% - % - contact@mychemistry.eu % ----------------------------------------------------------------------------- % - If you have any ideas, questions, suggestions or bugs to report, please @@ -35,8 +39,9 @@ \documentclass[DIV11,toc=index]{cnpkgdoc} \docsetup{ pkg = chemnum, - code-box = {backgroundcolor=cnpkgcodebg,skipabove=1ex,skipbelow=1ex} + code-box = {skipabove=1ex,skipbelow=1ex} } +\usepackage{fnpct} \addcmds{ @m,arrow,bf,ch,chemfig,chemname,cmpd,cmpdinit,cmpdref,cmpdreset,cmpdsetup, CNlabel,CNlabelnoref,CNref,CNlabelsub,CNlabelsubnoref,CNrefsub, @@ -46,15 +51,14 @@ setdoublesep,section,sf,subsection,subsubsection,tableofcontents, texorpdfstring,textcolor,theffbibliography,uline} -\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,frenchb,canadien,spanish,italian]{babel} +\usepackage[ngerman,german,naustrian,austrian,british,american,canadian,frenchb,canadien,spanish,italian,english]{babel} \usepackage{textcomp,longtable,tabu,booktabs,chemscheme,hologo} \usepackage[iupac=strict]{chemmacros} - \DeclareChemIUPAC\a{\textalpha} - \DeclareChemIUPAC\b{\textbeta} \usepackage{chemfig} \usepackage[runs=2]{auto-pst-pdf} -\begin{filecontents}{index_en.ist} +\usepackage{filecontents} +\begin{filecontents*}{\jobname.ist} preamble "\\begin{theindex}\n Section headings are typeset \\textbf{bold}, packages \\textsf{sans serif}, commands \\textcolor{code}{brown}, and options \\textcolor{key}{green}.\\newline\n\n" heading_prefix "{\\bfseries " heading_suffix "\\hfil}\\nopagebreak\n" @@ -65,7 +69,7 @@ delim_r "--" suffix_2p "\\nohyperpage{\\,f.}" suffix_3p "\\nohyperpage{\\,ff.}" -\end{filecontents} +\end{filecontents*} \let\prog\textsc \let\name\textsc @@ -76,7 +80,8 @@ \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}} \TitlePicture{% -\cmpdinit*{glucose.alpha, glucose.beta, glucose.chain} + \selectlanguage{english} + \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)} @@ -105,7 +110,7 @@ \chemnum internally loads the packages \paket*{expl3} and \paket{xparse}. \paket{xparse} is part of the \paket{l3packages} bundle, \paket*{expl3} is part of the \paket{l3kernel} bundle. This means, \chemnum needs \LaTeX3 Support. -\chemnum also needs the packages \paket{etoolbox}, \paket{psfrag} and either \paket{textgreek} or \paket{bm}, see section \ref{sec:package_options}. +\chemnum also needs the packages \paket{etoolbox}, \paket{psfrag} and either \paket{textgreek} or \paket{bm}, see section~\ref{sec:package_options}. \section{News and a word of apology} \subsection{Version 0.4} @@ -137,9 +142,9 @@ These ones are new: \end{tabular} \end{center} -Also new is the way how lists and ranges of sublabels are input. The option \key{sub-list} no longer exists. More on this in section \ref{ssec:sub_ranges}. +Also new is the way how lists and ranges of sublabels are input. The option \key{sub-list} no longer exists. More on this in section~\ref{ssec:sub_ranges}. -Then there is the possibility of creating hyperlinked labels together with the package \paket{hyperref}, see section \ref{sec:hyperref}. +Then there is the possibility of creating hyperlinked labels together with the package \paket{hyperref}, see section~\ref{sec:hyperref}. \subsection{Version 0.5} With v0.5 there is a new option \key{ref-pos} which allows to change the positioning options of the \cmd{psfrag} command that is used by the \cmd{cmpdref} command internally, see p.\,\pageref{ssec:marker_in_bildern}. @@ -199,13 +204,13 @@ If it is necessary to declare a compound without printing the label, this is pos \Befehl[cmpda]{cmpd*}\ma{<label name>}\label{cmd:unsichtbares_label} \end{beschreibung} This declares the label but doesn't print anything. -\achtung{This command is not needed when \cmd{cmpdinit} is used, see section \ref{sec:cmpdinit} (pages \pageref{sec:cmpdinit}ff).} +\achtung{This command is not needed when \cmd{cmpdinit} is used, see section~\ref{sec:cmpdinit} (pages~\pageref{sec:cmpdinit}ff).} \begin{beispiel} The hidden version\cmpd*{d} declares the label but doesn't print anything. The next \cmpd{e} continues to count with the next number. With \cmpd{d} the label can be used, of course. \end{beispiel} -You can pretty much use what you like for a label name except for the separator symbols (see sections \ref{ssec:unterlabel}, \ref{ssec:listen}, \ref{ssec:sub_ranges} and \ref{ssec:trenner}). You shouldn't leave blanks in the name, though. This may not cause an error at all, but \emph{could} declare different compounds with the same name. +You can pretty much use what you like for a label name except for the separator symbols (see sections~\ref{ssec:unterlabel}, \ref{ssec:listen}, \ref{ssec:sub_ranges} and \ref{ssec:trenner}). You shouldn't leave blanks in the name, though. This may not cause an error at all, but \emph{could} declare different compounds with the same name. \lstset{showspaces=true} \begin{beispiel} @@ -218,7 +223,7 @@ If you want a label like \cmpd{a.one}, you need to use the following syntax: \begin{beschreibung} \Befehl{cmpd}{<label name>.<subname>} \end{beschreibung} -\code{<label name>} is the main name which stays the same, \code{<subname>} varies. This syntax means that the point \code{.} \emph{cannot} be a part of \code{<label name>} or \code{<subname>}. Instead of the point you also can use another symbol, see section \ref{sssec:sub-input-sep}. +\code{<label name>} is the main name which stays the same, \code{<subname>} varies. This syntax means that the point \code{.} \emph{cannot} be a part of \code{<label name>} or \code{<subname>}. Instead of the point you also can use another symbol, see section~\ref{sssec:sub-input-sep}. \begin{beispiel} \cmpd{f.one} and \cmpd{f.two} are related, as are \cmpd{g.one} and \cmpd{g.two}. Of course, these labels can be used again: \cmpd{g.two} and \cmpd{f.one}. \end{beispiel} @@ -233,7 +238,7 @@ The same way the main name of combined labels can be used solely. \cmpd{f} and \cmpd{g} \end{beispiel} -How you can create a label like \cmpd{f.{one,two}} is explained in section \ref{ssec:sub_ranges}. +How you can create a label like \cmpd{f.{one,two}} is explained in section~\ref{ssec:sub_ranges}. \secidx*{Sublabel} \subsection{Lists}\label{ssec:listen}\secidx{Lists} @@ -243,12 +248,12 @@ The right description would be something like: \begin{beschreibung} \Befehl{cmpd}{<(possibly comma separated list of) label name(s)>} \end{beschreibung} -This means that with default settings the comma can't be part of the label name unless hidden in braces. You can change that, see section \ref{sssec:list-input-sep} on page \pageref{sssec:list-input-sep}. Section \ref{sssec:input-sep-bsp} shows an example how a changed input could look like. +This means that with default settings the comma can't be part of the label name unless hidden in braces. You can change that, see section~\ref{sssec:list-input-sep} on page~\pageref{sssec:list-input-sep}. Section~\ref{sssec:input-sep-bsp} shows an example how a changed input could look like. \begin{beispiel} More than one label can be put inside \verb=\cmpd=, separated by commas. Then a list like \cmpd{a, b, c, e, g.two} is printed. \end{beispiel} -The Harvard comma (see \ref{ssec:harvard-comma}) in \code{, and} between \cmpd{e} and \cmpd{g.two} suggests that there are options to customize the list, see sections \ref{ssec:trenner} and \ref{sec:language_support}. +The Harvard comma (see~\ref{ssec:harvard-comma}) in \code{, and} between \cmpd{e} and \cmpd{g.two} suggests that there are options to customize the list, see sections~\ref{ssec:trenner} and \ref{sec:language_support}. \secidx*{Lists} \subsection{Lists and ranges of sublabels}\label{ssec:sub_ranges}\index{Sublabel!lists}\index{Sublabel!ranges} @@ -268,9 +273,9 @@ Using this syntax you also can create ranges of sublabels. As a marker to indica \cmpd{q.{one..three,five}} \end{beispiel} -This means you can neither use the comma nor the two points as part of a sublabel name. How you can use other markers for the input you can read in sections \ref{sssec:range-input-sep} and \ref{sssec:list-input-sep}. +This means you can neither use the comma nor the two points as part of a sublabel name. How you can use other markers for the input you can read in sections~\ref{sssec:range-input-sep} and \ref{sssec:list-input-sep}. -\chemnum provides an option (see section \ref{sec:cmpdsetup} for more details), with which all sublabels of a main label can be printed as range. +\chemnum provides an option (see section~\ref{sec:cmpdsetup} for more details), with which all sublabels of a main label can be printed as range. \begin{beschreibung} \Option{cmpd-all}{\default{true}/false} \end{beschreibung} @@ -348,7 +353,7 @@ Please note that for labels with sublabels only the \emph{main name} can and sho If you need to use own labels (see page \pageref{ssec:own_labels}) but still want to initialize all labels at once, you should use \cmd[cmpdinita]{cmpdinit*}{}, because then no labels are declared when they're initialized. -This command can be used several times, with or without \verb=*=. A useful way would be a single usage, though, proposedly in the preamble of your document after the \chemnum setup (see section \ref{sec:cmpdsetup}). +This command can be used several times, with or without \verb=*=. A useful way would be a single usage, though, proposedly in the preamble of your document after the \chemnum setup (see section~\ref{sec:cmpdsetup}). \subsubsection{Sublabels} If you'd like a warning for label-sublabel combinations as well, or want to preset their order, you can use @@ -386,18 +391,18 @@ Of course you can use \cmd{cmpdinit} with both options \begin{beschreibung} \Befehl{cmpdinit}[\key{init-strict}{true}, \key{init-sub}{true}]{<comma separated list ...>} \end{beschreibung} -or use \cmd{cmpdsetup}, see section \ref{sec:cmpdsetup}. +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. -A change of \key{list-input-sep} (page \pageref{sssec:list-input-sep}) doesn't affect \cmd{cmpdinit}. If you want to change the input of \cmd{cmpdinit} you need to use \key{init-input-sep}, see section \ref{sssec:init-input-sep} on page \pageref{sssec:init-input-sep}. +A change of \key{list-input-sep} (page \pageref{sssec:list-input-sep}) doesn't affect \cmd{cmpdinit}. If you want to change the input of \cmd{cmpdinit} you need to use \key{init-input-sep}, see section~\ref{sssec:init-input-sep} on page~\pageref{sssec:init-input-sep}. \subsection{Why initiate labels?} As mentioned in the beginning of this section the initiation of labels is not required. There are two possible reasons, why one would like to use them, anyway. \begin{enumerate} \item The use of \cmd[cmpdinita]{cmpdinit*} is a way to keep track of which labels you have used and gives you a warning/error message if you use a new one or just have mispelled an existing one. Depending on the number of labels you (have to) use, this can be lots of additional work, though. - \item The use of \cmd{cmpdinit} does the same thing as \cmd[cmpdinita]{cmpdinit*} \emph{and} declares all the labels in the given order. So if you use it, you won't have to use \cmd[cmpda]{cmpd*} (section \ref{cmd:unsichtbares_label}) and \cmd[cmpdb]{cmpd+} (section \ref{cmd:cmpd_plus}). This gives you direct control, which number is given to which compound. + \item The use of \cmd{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} @@ -438,7 +443,7 @@ The command\label{cmd:cmpd_plus} \end{beschreibung} reads the label name that is to be printed from \verb=\jobname.cmpd=. In a way this is the opposite of \cmd[cmpda]{cmpd*} since it doesn't declare a label but only references and prints it. So in order to use \cmd[cmpdb]{cmpd+}{<label>}, \verb=<label>= must have been declared, either with \cmd{cmpd}{<label>} or with \cmd[cmpda]{cmpd*}{<label>}. It doesn't matter, if this declaration is done before or after the usage of \cmd[cmpdb]{cmpd+}. This command is useful, if the label is used inside a moving argument like in \verb=\section{}=. -\achtung{It is not needed when \cmd{cmpdinit} is used, see section \ref{sec:cmpdinit} (pages \pageref{sec:cmpdinit}\,ff).} +\achtung{It is not needed when \cmd{cmpdinit} is used, see section~\ref{sec:cmpdinit} (pages~\pageref{sec:cmpdinit}\,ff).} \begin{beispiel} \subsubsection{Test section title with compound label \cmpd+[cmpd-delim]{f.one}} @@ -490,7 +495,7 @@ So you nummerate the compounds with \textsf{TMP1}, \textsf{TMP2} \etc These mark In each case it is important that the marker is saved as \emph{text} in the \verb=eps= file. -You can customize the labels with the options presented in section \ref{sec:cmpdsetup}. +You can customize the labels with the options presented in section~\ref{sec:cmpdsetup}. \begin{beispiel}[code and float] \begin{scheme}[ht] \centering @@ -538,7 +543,7 @@ If you are using the package \paket{hyperref} you can make hyperlinked labels in \begin{beschreibung} \Option{hyper-use}{\default{true}/false} \end{beschreibung} -Setting this option (see section \ref{sec:cmpdsetup} for more information) to \texttt{true}, the next usage of a label will create a link target and the ones after that will create links to this target. This only works if the label does \emph{not} contain a list or range of sublabels. Also a label set with \cmd[cmpda]{cmpd*} can't be marked as target. +Setting this option (see section~\ref{sec:cmpdsetup} for more information) to \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} @@ -580,15 +585,7 @@ or only for a single command directly with \Befehl{cmpd}[key1 = value1, key2 = value2]{<label name>} \end{beschreibung} -% There are different kinds of keys. Depending on it they can have different kinds of values. -% \begin{description} -% \item[\ttfamily macro] This kind of keys expects one or more macros as value. The last of them may have a mandatory argument, \eg \verb=\bfseries= or \verb=\textbf=. \chemnum has only one such key, see section \ref{ssec:schriftstil}. -% \item[\ttfamily literal] These keys use the given value "as it is", \ie literally. Most of \chemnum's keys are \verb=literal= keys. -% \item[\ttfamily choice] For these keys there is a list of options from which one must be chosen as a value. -% \item[\ttfamily boolean] These keys can either have the value \verb=true= or \verb=false=. -% \end{description} - -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}. +If you use keys without values like \cmd{cmpdsetup}{key1,key2}, default values\label{opt:default} are used. These are \emph{not} necessarily empty are \emph{not} necessarily the default setting of \chemnum. The options are divided in to different classes\label{key_classes}, which indicate the scope they're used for. They all follow the form \verb+<class>-option = <value>+: \begin{itemize} @@ -619,7 +616,7 @@ you can change the style with which the labels are printed. \cmpd{a, b, f.two, k}\\ % underlined and in italics \cmpd[cmpd-weight=normal]{a, b, f.two, k} \end{beispiel} -The separate handling of the bold face is because of the greek labels (see section \ref{ssec:counter}). Depending on the package option \texttt{textgreek}, the bold face must realized differently. +The separate handling of the bold face is because of the greek labels (see section~\ref{ssec:counter}). Depending on the package option \texttt{textgreek}, the bold face must realized differently. \secidx*{Font style} \subsection{Own labels}\label{ssec:own_labels}\secidx{Own labels} @@ -843,7 +840,7 @@ The last separator in the main label list is a special case. \chemnum provides t \cmpd[list-lang = ES]{a, b, f.two, k} \cmpd[list-lang = ES]{a, b}\\ \cmpd[list-lang = IT]{a, b, f.two, k} \cmpd[list-lang = IT]{a, b} \end{beispiel} -As you can see the language \key{list-lang}{US} uses the Harvard comma, all other languages don't. You'll find more on language support and the Harvard comma in section \ref{sec:language_support}. +As you can see the language \key{list-lang}{US} uses the Harvard comma, all other languages don't. You'll find more on language support and the Harvard comma in section~\ref{sec:language_support}. With the key \key{list-last-sep} you also can set the last separator individually. \begin{beispiel} @@ -883,7 +880,7 @@ A small example how a customized input could look like: \section{Language support}\label{sec:language_support}\secidx{Language support} \subsection{Cooperation with \textsf{babel}} -\chemnum supports the language choice made with the \paket{babel} package for a number of languages. This is done with the \verb=\translate= command of the \paket*{translator} package, if it is available. If \paket*{translator} cannot be loaded, language support must be done manually, see section \ref{sssec:last-sep}. Manual language settings can of course still be done if \paket*{translator} has been loaded. +\chemnum supports the language choice made with the \paket{babel} package for a number of languages. This is done with the \verb=\translate= command of the \paket*{translator} package, if it is available. If \paket*{translator} cannot be loaded, language support must be done manually, see section~\ref{sssec:last-sep}. Manual language settings can of course still be done if \paket*{translator} has been loaded. \begin{beispiel} \selectlanguage{ngerman}DE: \cmpd{r,s,t}\\ \selectlanguage{english}EN: \cmpd{r,s,t}\\ |