diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemmacros')
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/README | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex | 5 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf | bin | 711291 -> 707918 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex | 113 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf | bin | 699196 -> 696092 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex | 98 |
6 files changed, 127 insertions, 93 deletions
diff --git a/Master/texmf-dist/doc/latex/chemmacros/README b/Master/texmf-dist/doc/latex/chemmacros/README index 121b57a0559..a233426213b 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/README +++ b/Master/texmf-dist/doc/latex/chemmacros/README @@ -1,10 +1,10 @@ -------------------------------------------------------------------------- -the CHEMMACROS bundle v3.1 +the CHEMMACROS bundle v3.1a -> chemmacros package -> macros and commands for chemists -> chemformula package -> typeset chemical compounds and reactions -> ghsystem package -> typeset H & P statements and pictograms from the globally harmonised system (GHS) -2012/02/19 +2012/02/26 -------------------------------------------------------------------------- This bundle succeeds the chemmacros package which is now part of the bundle diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex index 1cc6589bef9..3840f198640 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex @@ -637,12 +637,17 @@ \NewDocumentCommand \da { m } { \texttt { ( #1 ) } } +\makeatletter \NewDocumentCommand \achtung { m } { + \par\addvspace{\baselineskip} \begin{mdframed}[linecolor=red,backgroundcolor=red!10] #1 \end{mdframed} + \par\addvspace{\baselineskip} + \@endpetrue } +\makeatother \cs_new:Nn \chemmacros_doc_todo:nn { \todo [ #1 ] { #2 } } diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf Binary files differindex 54a09c1da8e..204ed943603 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex index 2948742390e..8aa6509f6c5 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex @@ -5,7 +5,7 @@ % - macros and commands for chemists - % % --------------------------------------------------------------------------- % % - Clemens Niederberger - % -% - 2012/02/19 - % +% - 2012/02/26 - % % --------------------------------------------------------------------------- % % - https://bitbucket.org/cgnieder/chemmacros/ - % % - contact@mychemistry.eu - % @@ -27,6 +27,14 @@ % - - % % - The Current Maintainer of this work is Clemens Niederberger. - % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% if you want to compile this documentation: +% +% > xelatex chemmacros_doc_de (2 or 3 times) +% > biber chemmacros_doc_de +% > makeindex -sl index_de.ist chemmacros_doc_de.idx +% > xelatex chemmacros_doc_de +% \documentclass[DIV11,idx=totoc,toc=bib]{scrartcl} \usepackage{fontspec,xltxtra} \usepackage{polyglossia} @@ -89,17 +97,18 @@ } \usepackage{hyperref} - \hypersetup{colorlinks=true, - allcolors=myblue, - plainpages=false, - bookmarksopen=true, - bookmarksopenlevel=1, - bookmarksnumbered=true, - pdfauthor={Clemens Niederberger}, - pdftitle={chemmacros bundle - deutsche Dokumentation}, - pdfsubject={macros and commands for chemists}, - pdfkeywords={chemmacros,chemformula,ghsystem}, - pdfcreator={XeLaTeX} + \hypersetup{colorlinks = true, + allcolors = myblue, + plainpages = false, + bookmarksopen = true, + bookmarksopenlevel = 1, + bookmarksnumbered = true, + pdfauthor = {Clemens Niederberger}, + pdftitle = {chemmacros bundle - deutsche Dokumentation}, + pdfsubject = {macros and commands for chemists}, + pdfkeywords = {chemmacros,chemformula,ghsystem}, + pdfcreator = {XeLaTeX}, + pdfstartview = FitH } \newcommand*\chemmacros{{\scshape\textcolor{myblue}{chemmacros}}\xspace} @@ -152,21 +161,15 @@ \section{Lizenz, Voraussetzungen und README} Das \chemmacros-Bundle steht under der \LaTeX\ Project Public License (LPPL) Version 1.3 oder später. (\url{http://www.latex-project.org/lppl.txt}) -\chemmacros verwendet die Pakete \paket*{expl3}, \paket{xparse}, \paket{l3keys2e} und \paket{xfrac}, die Teil der \paket{l3kernel}- und \paket{l3packages}-Bundles sind. \paket*{expl3} ist Teil des \paket{l3kernel} und \paket{xparse}, \paket{l3keys2e} und \paket{xfrac} sind Teil der \paket{l3packages}. - -Offensichtlich werden \chemformula und \ghsystem als Teil dieses Bundles geladen. - -\chemmacros verwendet zudem \paket{siunitx}, \paket{mathtools}, \paket{bm} und \paket{environ} sowie \paket*{tikz}\footnote{CTAN: \href{http://www.ctan.org/pkg/pgf/}{pgf}} und die \TikZ libraries \texttt{calc} und \texttt{arrows}. +Das \chemmacros-Bundle benötgt aktuelle Versionen der \paket{l3kernel}- und \paket{l3packages}-Bundles. Außerdem werden die Pakete \paket{siunitx}, \paket{mathtools}, \paket{bm}, \paket{nicefrac} und \paket{environ} sowie \paket*{tikz}\footnote{CTAN: \href{http://www.ctan.org/pkg/pgf/}{pgf}} und die \TikZ libraries \texttt{calc} und \texttt{arrows} benötigt. Die Paketoption \key{bpchem} (Abschnitt \ref{sec:optionen}) benötigt \paket{bpchem}, die Paketoption \key{xspace} benötigt \paket{xspace} und die Paketoption \key{method}{mhchem} benötigt \paket{mhchem}. -\chemmacros wurde mit den neuen Paketen \chemformula und \ghsystem gebündelt. \chemformula ist eine Alternative zu \paket{mhchem}. Das führte zu einigen internen Änderungen bei \chemmacros. Gleichzeitig wurde die Dokumentation komplett überarbeitet. +Mit v3.0 wurde das \chemmacros-Paket mit den neuen Paketen \chemformula und \ghsystem gebündelt. \chemformula ist eine Alternative zu \paket{mhchem}. Das führte zu einigen internen Änderungen bei \chemmacros. Gleichzeitig wurde die Dokumentation komplett überarbeitet. Vielleicht erinnern Sie Sich, dass \chemmacros' Optionen alle verschiedenen Modulen angehören, siehe Abschnitt \ref{sec:setup} für weitere Informationen. Sie werden in den linken Rand geschrieben, wenn die Option das erste Mal erwähnt wird. Abschnitt \ref{sec:overview} listet alle Optionen von \chemmacros und ihre Module auf. In diesem Dokument werden Optionen \textcolor{key}{\texttt{grün}} und Module \textcolor{module}{\texttt{rot}} dargestellt. -\chemformula verwendet die Pakete \chemmacros und \paket{nicefrac}. \chemformula hat keine eigenen Paketoptionen sondern leitet alle weiter an \chemmacros. - -\ghsystem verwendet die Pakete \chemmacros, \paket{tabu}, \paket{longtable}, \paket{ifpdf} und \paket{graphicx}. \ghsystem hat keine eigenen Paketoptionen sondern leitet alle weiter an \chemmacros. +Das Paket \ghsystem benötigt die Pakete \chemmacros, \paket{tabu}, \paket{longtable}, \paket{ifpdf} und \paket{graphicx}. \achtung{Es gibt einige veraltete Befehle und Optionen, die in dieser Dokumentation nicht mehr beschrieben werden. Um Kompatibilität mit älteren Dokumenten zu gewährleisten, sind sie immer noch definiert. Diese Befehle geben eine Warnung aus. In Zukunft könnten sie nicht mehr definiert sein.} @@ -180,7 +183,7 @@ Ich nehme an, dass fast jeder Chemiker, der \LaTeX\ für seine Dokumente verwend Als Chemiker wissen Sie vermutlich, dass die \textsc{United Nations} das \enquote{\textbf{G}lobally \textbf{H}armonized \textbf{S}ystem of Classification and Labelling of Chemicals} (GHS) als weltweiten Ersatz für die zahlreichen ähnlichen aber doch verschiedenen Systeme der einzelnen Länder entwickelt haben. Obwohl es noch nicht in allen Ländern umgesetzt wurde\footnote{\url{http://www.unece.org/trans/danger/publi/ghs/implementation_e.html}}, ist das nur eine Frage der Zeit. Das Paket \ghsystem gibt Ihnen nun die Möglichkeit, alle \enquote{hazard and precautionary statements} auf einfache Weise einzugeben und aufzurufen. Die Sätze wurden der EU Reguletion 1272/2008 entnommen \cite{eu:ghsystem_regulation}. \section{Installation und Laden des Bundles}\secidx{Laden des Bundles}\secidx{Installation} -Das Bundle enthält drei Style-Dateien\footnote{Die mit der Endung \texttt{sty}.}, einem Ordner namens \texttt{language/}, der die Sprach-Definitions-Dateien für GHS enthält (Endung \texttt{def}) und einem Ordner \texttt{pictures/}, der \texttt{eps}-, \texttt{jpg}- und \texttt{png}-Dateien enthält (die GHS Piktogramme). Wenn Sie das Bundle von Hand installieren, \emph{bitte achten Sie darauf, die Ordner \texttt{language/} und \texttt{pictures/} in den \emph{gleichen} Ordner wie die Style-Dateien zu kopieren}. +Das Bundle enthält drei Style-Dateien\footnote{Die mit der Endung \texttt{sty}.}, einem Ordner namens \texttt{language/}, der die Sprach-De\-fi\-ni\-tions-Dateien für GHS enthält (Endung \texttt{def}) und einem Ordner \texttt{pictures/}, der \texttt{eps}-, \texttt{jpg}- und \texttt{png}-Dateien enthält (die GHS Piktogramme). Wenn Sie das Bundle von Hand installieren, \emph{bitte achten Sie darauf, die Ordner \texttt{language/} und \texttt{pictures/} in den \emph{gleichen} Ordner wie die Style-Dateien zu kopieren}. Das Laden von \chemmacros via \begin{beispiel}[code only] @@ -214,7 +217,8 @@ Sowohl \chemformula als auch \ghsystem haben keine eigenen Paketoptionen. Wenn S \item \key[option]{bpchem}{\uline{true}/false} Diese Option lädt \paket{bpchem} und passt das Layout von \cmd{NMR} den \paket{bpchem}-Befehlen \lstinline+\HNMR+ und \lstinline+\CNMR+ an. Default = \texttt{false} \item \key[option]{circled}{\uline{formal}/all/none} \chemmacros unterscheidet zwischen zwei Typen von Ladungen\footnote{Vielen Dank an Christoph Schäfer, der mich darauf aufmerksam machte, dass v1.1 die Ladungen zu nachlässig behandelte!}: reale ($+/-$) und formale (\fplus/\fminus) Ladungen. Die Option \texttt{formal} unterscheidet zwischen ihnen, \texttt{none} stellt alle ohne Umkreisung dar, \texttt{all} umkreist alle. Default = \texttt{formal} \item \key[option]{circletype}{\uline{chem}/math} Diese Option schaltet zwischen zwei Darstellungsmöglichkeiten für formale Ladungen hin und her: \cmd{fplus} \fplus\ und \lstinline+$\oplus$+ $\oplus$. Default = \texttt{chem} - \item \key[option]{detect-bold}{\uline{true}/false} Diese Option bestimmt, ob Makros wie \cmd{pKa} eine fette Schriftserie erkennen. \textbf{fetter \pKa Text} vs.\ {\chemsetup[option]{detect-bold}\textbf{fetter \pKa Text}}. Default = \texttt{false} + \item \key[option]{detect-bold}{\uline{true}/false} \emph{Diese Option ist veraltet und wird nicht mehr unterstützt!} + \item \key[option]{EZ}{\uline{chemmacros}/cool} \emph{Diese Option ist veraltet und wird nicht mehr unterstützt!} \item \key[option]{german}{\uline{true}/false} Diese Option ändert die Befehle \cmd{pKa}, \cmd{sld} und \cmd{lqd}. Default = \texttt{false}. Diese Option hat den Alias \key[option]{ngerman}. \item \key[option]{ghs}{\uline{true}/false} Das Paket \ghsystem abschalten. Die Einstellung \key{ghs}{false} wird das Laden von \ghsystem unterbinden. Default = \texttt{true} \item \key[option]{iupac}{auto/restricted/strict} Einstellen, wie die Nomenklatur-Befehle definiert werden. Siehe Seite \pageref{key:iupac}. Default = \texttt{auto} @@ -252,7 +256,7 @@ Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\texttt{che \part{\texorpdfstring{\Chemmacros}{chemmacros}}\secidx{CHEMMACROS} \section{Teilchen, Ionen und Symbole}\label{sec:teilchen}\secidx{Teilchen, Ionen und Symbole} \subsection{Vordefiniert}\secidx[vordefiniert]{Teilchen, Ionen und Symbole} -Einige einfache Makros, um häufig verwendete Teilchen darzustellen. Außerdem ein Symbol. Bitte beachten Sie, dass sie unterschiedlich dargestellt werden, je nach dem, welche Paketoptionen Sie verwenden. Diese Befehle können auch im Mathematikmodus eingesetzt werden. +\chemmacros definiert einige einfache Makros, um häufig verwendete Teilchen und Symbole darzustellen. Bitte beachten Sie, dass sie unterschiedlich dargestellt werden, je nach dem, welche Paketoptionen Sie verwenden. Diese Befehle können auch im Mathematikmodus eingesetzt werden. \begin{description} \item \cmd{Hpl} \Hpl (Proton) \item \cmd{Hyd} \Hyd (Hydroxid) @@ -292,7 +296,7 @@ Sie hat nur dann Auswirkungen, wenn das Paket \paket{chemfig} geladen wurde, da \end{beispiel} \subsection{Eigene Teilchen definieren}\secidx[eigene]{Teilchen, Ionen und Symbole} -Manchmal kann es sicherlich nützlich sein, andere Teilchen als Makro zur Verfügung zu haben, etwa \lstinline+\positron+ oder \lstinline+\photon+. Mit dieem Befehl kann das einfach errechit werden: +Manchmal kann es sicherlich nützlich sein, andere Teilchen als Makro zur Verfügung zu haben, etwa \lstinline+\positron+ oder \lstinline+\photon+. Mit diesem Befehl kann das einfach erreicht werden: \begin{description} \item \cmd{DeclareChemParticle}{<cmd>}\ma{<definition>} \item \cmd{RenewChemParticle}{<cmd>}\ma{definition} @@ -305,7 +309,7 @@ Abhängig von der \key{method}, die Sie als Option gewählt haben, wird die \tex \RenewChemParticle{\el}{$\upbeta$-} \positron\ \photon\ \el \end{beispiel} -\cmd{DeclareChemParticle} definiert das Teilchen nur dann, wenn \texttt{<cmd>} noch nicht existiert. Andernfalls wird \chemmacros entweder eine Warnung oder einen Fehler ausgeben, abhängig vob der Option \key{strict}. \cmd{RenewChemParticle} definiert ein Teilchen \emph{nur}, wenn \texttt{<cmd>} schon existiert und gibt andernfalls eine Warnung/einen Fehler. +\cmd{DeclareChemParticle} definiert das Teilchen nur dann, wenn \texttt{<cmd>} noch nicht existiert. Andernfalls wird \chemmacros entweder eine Warnung oder einen Fehler ausgeben, abhängig von der Option \key{strict}. \cmd{RenewChemParticle} definiert ein Teilchen \emph{nur}, wenn \texttt{<cmd>} schon existiert und gibt andernfalls eine Warnung/einen Fehler. \secidx*{Teilchen, Ionen und Symbole} \section{Nomenklatur, Stereodeskriptoren und lateinische Ausdrücke}\label{sec:stereo} @@ -467,9 +471,26 @@ Einfache Darstellung von \pH, \pKa \ldots (der Befehl \cmd{pKa} hängt von der P \begin{beispiel} \Ka \Kb \pKa \pKa[1] \pKb \pKb[1]\\ - \chemsetup[option]{german=true} + \chemsetup[option]{german=false} \Ka \Kb \pKa \pKa[1] \pKb \pKb[1] \end{beispiel} + +\achtung{Das voreingestellte Erscheinungsbild der \p{}-Befehle hat sich verändert, um der IUPAC-Empfehlung zu folgen.} +\begin{myquote}[IUPAC Green Book \cite[][p.\,103]{iupac:greenbook}] + The operator \p{} […] shall be printed in Roman type. +\end{myquote} + +Es gibt eine Option, die den Stil, in dem das \p{} dargestellt wird, ändert: +\begin{description} + \item \key[acid-base]{p-style}{italics/slanted/upright} Default = \texttt{upright} +\end{description} +\begin{beispiel} + \pH, \pKa + + \chemsetup[acid-base]{p-style=slanted} \pH, \pKa + + \chemsetup[acid-base]{p-style=italics} \pH, \pKa +\end{beispiel} \secidx*{Säure/Base}[Saeure/Base] \section{Oxidationszahlen, reale und formale Ladungen}\label{sec:ladungen} @@ -503,6 +524,7 @@ Es gibt eine Option, die das Verhalten der Ladungen beeinflusst: Das hat folgende Auswirkungen: \begin{beispiel} + % uses package `mhchem' \chemsetup{charges/append=false,phases/pos=sub} \ce{H\pch\aq} \ce{H\aq\pch} @@ -578,7 +600,7 @@ Der Bruch verwendet den \lstinline+\sfrac+-Befehl des \paket{xfrac}-Pakets. Zu d slash-symbol-font = lmr } \end{beispiel} -Natürlich können Sie sie nachj Ihren Vorstellungen umdefinieren. +Natürlich können Sie sie nach Ihren Vorstellungen umdefinieren. \secidx*{Oxidationszahlen} \subsection{Partialladungen und Ähnliches}\label{ssec:partialladungen}\secidx{Partialladungen} @@ -752,7 +774,7 @@ Die Zahl und die Einheit werden entsprechend der Regeln für \paket{siunitx} ges \subsubsection{Neue Größen definieren} Mit dem Befehl \begin{description} - \item \cmd{DeclareChemState}[<keyval>]{<name>}{<symbol>}\ma{<unit>} + \item \cmd{DeclareChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} \end{description} können neue Größen definiert werden. \begin{beispiel} @@ -774,7 +796,7 @@ Dieser Befehl hat fast die gleichen Optionen, wie die Größen selbst, mit denen \subsubsection{Größen umdefinieren} Mit \begin{description} - \item \cmd{RenewChemState}[<keyval>]{<name>}{<symbol>}\ma{<unit>} + \item \cmd{RenewChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} \end{description} kann man bestehende Größen umdefinieren: @@ -852,13 +874,13 @@ Die Optionen \item\key[nmr]{unit}{<unit>} Default = \lstinline=\mega\hertz= \item\key[nmr]{nucleus}{\ma{<num>,<elem>}} Default = \ma{1,H} \end{description} -legen die Default-Werte fest. +legen die Voreinstellungen fest. Beispiele: \begin{beispiel} {\chemsetup[nmr]{nucleus={13,C}}\NMR(100) \NMR*(100) } \\ \NMR*{19,F}[CFCl3] \NMR*{19,F}(285)[CFCl3] \\ - \NMR(400)[CDCl3] = \num{1.59} (q, 1H, \textit{J} = \SI{11.6}{\hertz}, H-4) + \NMR(400)[CDCl3] = \num{1.59} (q, 1\ch{H}, \textit{J} = \SI{11.6}{\hertz}, H-4) \end{beispiel} \secidx*{Spektroskopie} @@ -1179,22 +1201,6 @@ Zusätzlich gibt es zwei Optionen, mit denen das \TikZ-Verhalten beeinflusst wer \end{beispiel} \secidx*{Orbitale} -\section{\chemformula-Unterstützung} -\chemformula und \chemmacros arbeiten eng zusammen. Das funktioniert aber noch nicht perfekt. Es gibt sogar Einschränkungen. Wenn Sie die vermeiden wollen, verwenden Sie einfach \key[option]{method}{mhchem} und vergessen diesen Abschnitt und den nächsten Teil. -\begin{description} - \item Man benötigt kein \lstinline+\mch+ und ähnliche Befehle innerhalb von \cmd{ch}. Tatsächlich sollte man sie vermeiden, da sie die Ausrichtung der Hoch- und Tiefstellungen durcheinander bringen können. Die \chemmacros-Option \texttt{circled} wird von \cmd{ch} beachtet. -\begin{beispiel} - \chemsetup[option]{circled=all} - \ch{H+ + OH- <=> H2O} -\end{beispiel} - \item Die Befehle \cmd{sld} und \cmd{lqd} haben kein optionales Argument innerhalb von \cmd{ch}. -\begin{beispiel} - \ch{Ba^{2+}\aq{} + SO4^{2-}\aq{} -> BaSO4\sld{} v} \\ - \ch{Ba^2+ \aq{} + SO4^2- \aq{} -> BaSO4\sld{} v} -\end{beispiel} - \item Die Option \key[option]{synchronize} erkennt das Format und die Schrifteinstellungen von \chemformula und übernimmt sie für die Teilchen-Makros. -\end{description} - \section{Übersicht über die Optionen}\label{sec:overview}\secidx{Übersicht über die Optionen (chemmacros)}[Uebersicht ueber die Optionen] In der folgenden Tabelle werden alle Optionen aufgelistet, die \chemmacros bietet. Alle Optionen, die einem Modul angehören, können mit \begin{description} @@ -1217,7 +1223,7 @@ Manche Optionen können ohne Wert verwendet werden. Dann wird der \uline{unterst bpchem & option & \uline{true}/false & false & Seite \pageref{key:option_bpchem} \\ circled & option & formal/\uline{all}/none & formal & Seite \pageref{key:option_circled} \\ circletype & option & chem/math & chem & Seite \pageref{key:option_circletype} \\ - detect-bold & option & \uline{true}/false & false & Seite \pageref{key:option_detect-bold} \\ +% detect-bold & option & \uline{true}/false & false & Seite \pageref{key:option_detect-bold} \\ german & option & \uline{true}/false & false & Seite \pageref{key:option_german} \\ ghs & option & \uline{true}/false & true & Seite \pageref{key:option_ghs} \\ iupac & option & auto/restricted/strict & auto & Seite \pageref{key:option_iupac} \\ @@ -1231,6 +1237,8 @@ Manche Optionen können ohne Wert verwendet werden. Dann wird der \uline{unterst elpair & particle & \uline{dots}/dash/false & false & Seite \pageref{key:particle_elpair} \\ \multicolumn{5}{l}{\cmd{pch}, \cmd{mch}, \cmd{fpch}, \cmd{fmch}:} \\ append & charges & \uline{true}/false & false & Seite \pageref{key:charges_append} \\ + \multicolumn{5}{l}{acid/base:} \\ + p-style & acid-base & slanted/italics/upright & upright & Seite \pageref{key:acid-base_p-style} \\ \multicolumn{5}{l}{\cmd{ox}:} \\ parse & ox & \uline{true}/false & true & Seite \pageref{key:ox_parse} \\ roman & ox & \uline{true}/false & true & Seite \pageref{key:ox_roman} \\ @@ -1492,6 +1500,13 @@ Ionen und Ionenverbindungen mit mehr als einer Ladung werden genauso eingegeben: \ch{SO4^2-} \ch{Ca^2+ SO4^2-} \end{beispiel} +\paragraph{Ladungsbefehle}\secidx[Hochstellungen!Ladungsbefehle]{Summenformeln} +Man benötigt kein \cmd{mch} und ähnliche Befehle innerhalb von \cmd{ch}. Tatsächlich \emph{sollte man sie vermeiden}, da sie die Ausrichtung der Hoch- und Tiefstellungen durcheinander bringen können. Die \chemmacros-Option \texttt{circled} wird von \cmd{ch} beachtet. +\begin{beispiel} + \chemsetup[option]{circled=all} + \ch{H+ + OH- <=> H2O} +\end{beispiel} + \paragraph{Verhalten}\secidx[Hochstellungen!Verhalten]{Summenformeln} Die Hochstellungen verhalten sich unterschiedlich abhängig von ihrer Position in einer Summenformal, falls Hoch- und Tiefstellung direkt aufeinander folgen. \begin{beispiel} diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf Binary files differindex 46031085a57..984c4055979 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex index da23d9866e0..1706a1f3d0c 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex @@ -5,7 +5,7 @@ % - macros and commands for chemists - % % --------------------------------------------------------------------------- % % - Clemens Niederberger - % -% - 2012/02/10 - % +% - 2012/02/26 - % % --------------------------------------------------------------------------- % % - https://bitbucket.org/cgnieder/chemmacros/ - % % - contact@mychemistry.eu - % @@ -27,6 +27,14 @@ % - - % % - The Current Maintainer of this work is Clemens Niederberger. - % %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% if you want to compile this documentation: +% +% > xelatex chemmacros_doc_en (2 or 3 times) +% > biber chemmacros_doc_en +% > makeindex -sl index_en.ist chemmacros_doc_en.idx +% > xelatex chemmacros_doc_en +% \documentclass[DIV11,idx=totoc,toc=bib]{scrartcl} \usepackage{fontspec,xltxtra} \usepackage{polyglossia} @@ -89,17 +97,18 @@ } \usepackage{hyperref} - \hypersetup{colorlinks=true, - allcolors=myblue, - plainpages=false, - bookmarksopen=true, - bookmarksopenlevel=1, - bookmarksnumbered=true, - pdfauthor={Clemens Niederberger}, - pdftitle={chemmacros bundle - English documentation}, - pdfsubject={macros and commands for chemists}, - pdfkeywords={chemmacros,chemformula,ghsystem}, - pdfcreator={XeLaTeX} + \hypersetup{colorlinks = true, + allcolors = myblue, + plainpages = false, + bookmarksopen = true, + bookmarksopenlevel = 1, + bookmarksnumbered = true, + pdfauthor = {Clemens Niederberger}, + pdftitle = {chemmacros bundle - English documentation}, + pdfsubject = {macros and commands for chemists}, + pdfkeywords = {chemmacros,chemformula,ghsystem}, + pdfcreator = {XeLaTeX}, + pdfstartview = FitH } \newcommand*\chemmacros{{\scshape\textcolor{myblue}{chemmacros}}\xspace} @@ -149,21 +158,15 @@ \section{Licence, Requirements and README} The \chemmacros bundle underlies the \LaTeX\ project public license (lppl) version 1.3 or later. (\url{http://www.latex-project.org/lppl.txt}) -\chemmacros uses the packages \paket*{expl3}, \paket{xparse}, \paket{l3keys2e} and \paket{xfrac}, which are part of the bundles \paket{l3kernel} and \paket{l3packages}. \paket*{expl3} is part of \paket{l3kernel}, and \paket{xparse}, \paket{l3keys2e} and \paket{xfrac} are part of \paket{l3packages}. - -Obviously, the packages \chemformula and \ghsystem are loaded as they are part of this bundle. - -\chemmacros also uses the packages \paket{siunitx}, \paket{mathtools}, \paket{bm} and \paket{environ} as well as \paket*{tikz}\footnote{CTAN: \href{http://www.ctan.org/pkg/pgf/}{pgf}} and the \TikZ libraries \texttt{calc} and \texttt{arrows}. +The \chemmacros bundle needs the bundles \paket{l3kernel} and \paket{l3packages}.It also needs the packages \paket{siunitx}, \paket{mathtools}, \paket{bm}, \paket{nicefrac} and \paket{environ} as well as \paket*{tikz}\footnote{CTAN: \href{http://www.ctan.org/pkg/pgf/}{pgf}} and the \TikZ libraries \texttt{calc} and \texttt{arrows}. Package option \key{bpchem} (section \ref{sec:optionen}) needs the package \paket{bpchem}, package option \key{xspace} needs the package \paket{xspace} and package option \key{method}{mhchem} needs the package \paket{mhchem}. -\chemmacros has been bundled with the new \chemformula and \ghsystem packages. \chemformula provides an alternative to \paket{mhchem}. This leads to some internal changes in \chemmacros. On the same time the documentation has been redesigned. +With v3.0 the \chemmacros package has been bundled with the new packages \chemformula and \ghsystem. \chemformula provides an alternative to \paket{mhchem}. This leads to some internal changes in \chemmacros. On the same time the documentation has been redesigned. You might remember that \chemmacros' options all belong to different modules, see section \ref{sec:setup} for further information. These are typeset in the left margin when the option is first mentioned. In section \ref{sec:overview} all options and the module the belong to are listed. Throughout the document options are typeset \textcolor{key}{\texttt{green}} and modules \textcolor{module}{\texttt{red}}. -\chemformula uses the packages \chemmacros and \paket{nicefrac}. \chemformula has no own package options but passes all options on to \chemmacros. - -\ghsystem uses the packages \chemmacros, \paket{tabu}, \paket{longtable}, \paket{ifpdf} and \paket{graphicx}. \ghsystem has no own package options but passes all options on to \chemmacros. +The package \ghsystem needs the packages \chemmacros, \paket{tabu}, \paket{longtable}, \paket{ifpdf} and \paket{graphicx}. \ghsystem has no own package options but passes all options on to \chemmacros. \achtung{There are some deprecated commands and options which are not explained in the manual any more but still exist to ensure backwards compatibility. These commands issue a warning. They may be dropped some time in the future.} @@ -212,8 +215,8 @@ Both \chemformula and \ghsystem don't have package options of their own. If you \item \key[option]{bpchem}{\uline{true}/false} This option loads the package \paket{bpchem} and adjusts the layout of the \cmd{NMR} command to the \paket{bpchem} commands \lstinline+\HNMR+ and \lstinline+\CNMR+. (default = \texttt{false}) \item \key[option]{circled}{\uline{formal}/all/none} \chemmacros uses two different kinds of charges\footnote{Thanks to Christoph Sch\"afer, who pointed out to me, that v1.1 handled the charges too sloppy!}, which indicate the usage of real ($+/-$) and formal (\fplus/\fminus) charges. The option \texttt{formal} distinguishes between them, option \texttt{none} displays them all without circle, option \texttt{all} circles all (default = \texttt{formal}) \item \key[option]{circletype}{\uline{chem}/math} This option switches between two kinds of circled charge symbols: \cmd{fplus} \fplus\ and \lstinline+$\oplus$+ $\oplus$. (default = \texttt{chem}) - \item \key[option]{detect-bold}{\uline{true}/false} This option determines wether or not macros like \cmd{pKa} recognize a bold font series. \textbf{bold \pKa text} or {\chemsetup[option]{detect-bold}\textbf{bold \pKa text}}. (default = \texttt{false}) - \item \key[option]{EZ}{\uline{chemmacros}/cool} This option is deprecated! + \item \key[option]{detect-bold}{\uline{true}/false} \emph{This option is deprecated!} + \item \key[option]{EZ}{\uline{chemmacros}/cool} \emph{This option is deprecated!} \item \key[option]{german}{\uline{true}/false} This option changes the commands \cmd{pKa}, \cmd{sld} and \cmd{lqd} (default = \texttt{false}). This option has the alias \key[option]{ngerman}. \item \key[option]{ghs}{\uline{true}/false} Disable the use of the \ghsystem package. Setting \key{ghs}{false} will prevent \chemmacros from loading \ghsystem. (default = \texttt{true}) \item \key[option]{iupac}{auto/restricted/strict} Take care of how iupac naming commands are defined, see page \pageref{key:iupac} (default = \texttt{auto}) @@ -251,7 +254,7 @@ All options of \chemformula belong to the module \textcolor{module}{\texttt{chem \part{\texorpdfstring{\Chemmacros}{chemmacros}}\secidx{CHEMMACROS} \section{Particles, Ions and Symbols}\label{sec:teilchen}\secidx{Particles, Ions and Symbols} \subsection{Predefined}\secidx[predefined]{Particles, Ions and Symbols} -Some simple macros for displaying often needed particles and a symbol. Please note, that they're displayed differently depending on the package options used, see section \ref{sec:optionen}. These commands can be used in text as well as in math mode. +\chemmacros defines some simple macros for displaying often needed particles and symbols. Please note, that they're displayed differently depending on the package options used, see section \ref{sec:optionen}. These commands can be used in text as well as in math mode. \begin{description} \item \cmd{Hpl} \Hpl (proton) \item \cmd{Hyd} \Hyd (hydroxide) @@ -470,6 +473,23 @@ Easy representation of \pH, \pKa \ldots (the command \cmd{pKa} depends on the pa \chemsetup[option]{german=true} \Ka \Kb \pKa \pKa[1] \pKb \pKb[1] \end{beispiel} + +\achtung{The default appearance of the \p{}-commands has changed to follow IUPAC recommendations.} +\begin{myquote}[IUPAC Green Book \cite[][p.\,103]{iupac:greenbook}] + The operator \p{} […] shall be printed in Roman type. +\end{myquote} + +There is one option which changes the style the \p{} is typeset: +\begin{description} + \item \key[acid-base]{p-style}{italics/slanted/upright} Default = \texttt{upright} +\end{description} +\begin{beispiel} + \pH, \pKa + + \chemsetup[acid-base]{p-style=slanted} \pH, \pKa + + \chemsetup[acid-base]{p-style=italics} \pH, \pKa +\end{beispiel} \secidx*{Acid/Base} \section{Oxidation Numbers, Real and Formal Charges}\label{sec:ladungen} @@ -502,6 +522,7 @@ There is a key which influences the behaviour of the charges. \end{description} This is how the key influences the behaviour: \begin{beispiel} + % uses package `mhchem' \chemsetup{charges/append=false,phases/pos=sub} \ce{H\pch\aq} \ce{H\aq\pch} @@ -852,7 +873,7 @@ Examples: \begin{beispiel} {\chemsetup[nmr]{nucleus={13,C}}\NMR(100) \NMR*(100) } \\ \NMR*{19,F}[CFCl3] \NMR*{19,F}(285)[CFCl3] \\ - \NMR(400)[CDCl3] = \num{1.59} (q, 1H, \textit{J} = \SI{11.6}{\hertz}, H-4) + \NMR(400)[CDCl3] = \num{1.59} (q, 1\ch{H}, \textit{J} = \SI{11.6}{\hertz}, H-4) \end{beispiel} \secidx*{Spectroscopy} @@ -1170,22 +1191,6 @@ Additionally there are two keys, with which the \TikZ behaviour can be changed. \end{beispiel} \secidx*{Orbitals} -\section{\chemformula support} -\chemformula and \chemmacros are designed to work together closely. This is not perfect, though. There are even some restrictions. If you want to avoid them simply use \key[option]{method}{mhchem} and forget about this section and the next part. -\begin{description} - \item You don't need to use \lstinline+\mch+ and related commands inside \cmd{ch}. Indeed, you shouldn't use them as they might mess with the subscript and superscript alignment. The \chemmacros option \texttt{circled} is obeyed by \cmd{ch}. -\begin{beispiel} - \chemsetup[option]{circled=all} - \ch{H+ + OH- <=> H2O} -\end{beispiel} - \item The commands \cmd{sld} and \cmd{lqd} don't have an optional argument inside \cmd{ch}. -\begin{beispiel} - \ch{Ba^{2+}\aq{} + SO4^{2-}\aq{} -> BaSO4\sld{} v} \\ - \ch{Ba^2+ \aq{} + SO4^2- \aq{} -> BaSO4\sld{} v} -\end{beispiel} - \item The option \key[option]{synchronize} recognizes the format and font selections made for \chemformula. -\end{description} - \section{Key Overview}\label{sec:overview}\secidx{Option Overview (chemmacros)} In the table below all keys provided by \chemmacros for customization are listed. All keys that belong to a module can be set with \begin{description} @@ -1205,7 +1210,7 @@ Some keys can be set without value. Then the \uline{underlined} value is used. bpchem & option & \uline{true}/false & false & page \pageref{key:option_bpchem} \\ circled & option & formal/\uline{all}/none & formal & page \pageref{key:option_circled} \\ circletype & option & chem/math & chem & page \pageref{key:option_circletype} \\ - detect-bold & option & \uline{true}/false & false & page \pageref{key:option_detect-bold} \\ +% detect-bold & option & \uline{true}/false & false & page \pageref{key:option_detect-bold} \\ german & option & \uline{true}/false & false & page \pageref{key:option_german} \\ ghs & option & \uline{true}/false & true & page \pageref{key:option_ghs} \\ iupac & option & auto/restricted/strict & auto & page \pageref{key:option_iupac} \\ @@ -1219,6 +1224,8 @@ Some keys can be set without value. Then the \uline{underlined} value is used. elpair & particle & \uline{dots}/dash/false & false & page \pageref{key:particle_elpair} \\ \multicolumn{5}{l}{\cmd{pch}, \cmd{mch}, \cmd{fpch}, \cmd{fmch}:} \\ append & charges & \uline{true}/false & false & page \pageref{key:charges_append} \\ + \multicolumn{5}{l}{acid/base:} \\ + p-style & acid-base & slanted/italics/upright & upright & page \pageref{key:acid-base_p-style} \\ \multicolumn{5}{l}{\cmd{ox}:} \\ parse & ox & \uline{true}/false & true & page \pageref{key:ox_parse} \\ roman & ox & \uline{true}/false & true & page \pageref{key:ox_roman} \\ @@ -1474,6 +1481,13 @@ Ions and ion composites with more than one charge can be typeset quite as easy: \ch{SO4^2-} \ch{Ca^2+ SO4^2-} \end{beispiel} +\paragraph{Charge Commands}\secidx[superscripts!charge commands]{Compounds} +You don't need to use \cmd{mch} and related commands inside \cmd{ch}. Indeed, you \emph{shouldn't} use them as they might mess with the subscript and superscript alignment. The \chemmacros option \texttt{circled} is obeyed by \cmd{ch}. +\begin{beispiel} + \chemsetup[option]{circled=all} + \ch{H+ + OH- <=> H2O} +\end{beispiel} + \paragraph{Behaviour}\secidx[superscripts!behaviour]{Compounds} The supercripts behave differently depending on their position in a compound, if there are super- and subscripts following each other directly. \begin{beispiel} |