diff options
Diffstat (limited to 'Master')
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/README | 15 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex | 731 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.pdf | bin | 0 -> 790259 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.tex (renamed from Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex) | 1893 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf | bin | 736367 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf | bin | 719498 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.pdf | bin | 0 -> 774621 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex (renamed from Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex) | 1906 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/chemmacros/chemformula.sty | 95 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/chemmacros/chemmacros.sty | 632 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/chemmacros/ghsystem.sty | 28 |
11 files changed, 2804 insertions, 2496 deletions
diff --git a/Master/texmf-dist/doc/latex/chemmacros/README b/Master/texmf-dist/doc/latex/chemmacros/README index 8b008666c4f..be503578100 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.2 +the CHEMMACROS bundle v3.3 -> 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/03/20 +2012/05/07 -------------------------------------------------------------------------- This bundle succeeds the chemmacros package which is now part of the bundle @@ -40,15 +40,14 @@ The chemmacros bundle consists of the files - chemformula.sty, - ghsystem.sty, - chemmacros-version1.cfg, - - chemmacros-codehelper.tex, - - chemmacros_doc_en.tex, chemmacros_doc_en.pdf, - - chemmacros_doc_de.tex, chemmacros_doc_de.pdf, + - chemmacros_en.tex, chemmacros_en.pdf, + - chemmacros_de.tex, chemmacros_de.pdf, - README, - eps-, png- and jpg-files for the GHS pictograms (3x31 pictures), - language-definition files: - ghs_german.def, - ghs_english.def, - ghs_langtemplate.def + ghsystem_german.def, + ghsystem_english.def, + ghsystem_langtemplate.def -------------------------------------------------------------------------- If you have any ideas, questions, suggestions or bugs to report, please feel free to contact me. diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex deleted file mode 100644 index 140eaf9de27..00000000000 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros-codehelper.tex +++ /dev/null @@ -1,731 +0,0 @@ -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% --------------------------------------------------------------------------- % -% - the CHEMMACROS bundle - % -% - chemmacros-codehelper.tex - % -% - macros and commands for chemists - % -% --------------------------------------------------------------------------- % -% - Clemens Niederberger - % -% - 2012/03/19 - % -% --------------------------------------------------------------------------- % -% - https://bitbucket.org/cgnieder/chemmacros/ - % -% - contact@mychemistry.eu - % -% --------------------------------------------------------------------------- % -% - If you have any ideas, questions, suggestions or bugs to report, please - % -% - feel free to contact me. - % -% --------------------------------------------------------------------------- % -% - Copyright 2011-2012 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. - % -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% Just to shorten the preamble of the documentation -% -% The beispiel environment is just a copy from the LaTeXdemo environment in -% the siunitx documentation which has been (minimally) adapted and provides -% environment beispiel with options -% * [code and example] (default) -% * [below] (like default but forces example below code) -% * [ox] (like below but with larger skip) -% * [code only] -% * [code and float] -% -% For creating examples with nice highlighting of code, and so on; based on the -% system used in the listings source (lstsample). -\RequirePackage[final]{listings} -\RequirePackage{framed,xcolor} -\RequirePackage[framemethod=tikz]{mdframed} -\RequirePackage[colorinlistoftodos,disable]{todonotes} - \xdefinecolor{code}{rgb}{.6,.25,.15} - \xdefinecolor{key}{rgb}{0.02,0.48,0.18} - \xdefinecolor{myblue}{rgb}{0.02,0.04,0.48} - \xdefinecolor{myred}{rgb}{0.65,0.04,0.07} - \xdefinecolor{comment}{rgb}{0.4,0.4,0.4} - \colorlet{codebackground}{yellow!10} - \colorlet{module}{myred} - -\makeatletter -\newcommand*\bspmidlength[2]{% - \@namedef{beispiel@#1@midlength}{#2}} - -\lst@RequireAspects{writefile} -\newsavebox{\beispiel@box} - -\lstnewenvironment{beispiel}[1][code and example] - {% - \global\let\lst@intname\@empty - \expandafter\let\expandafter\beispiel@end - \csname beispiel@#1@end\endcsname - \@nameuse{beispiel@#1}% - } - {\beispiel@end} - -\newcommand*\beispiel@new[3]{% - \expandafter\newcommand\expandafter*\expandafter - {\csname beispiel@#1\endcsname}{#2}% - \expandafter\newcommand\expandafter*\expandafter - {\csname beispiel@#1@end\endcsname}{#3}% -} - -\newcommand*\beispiel@common{% - \setkeys{lst} - { - language=[LaTeX]TeX, - basicstyle={\ttfamily\footnotesize}, % 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, - commentstyle={\color{comment}}, - keywordstyle=\color{code}, - texcsstyle=[30]\color{code}, - moretexcs=[30] - { - a, - abinitio, - AddRxnDesc, - aq, - aqi, - b, - ba, - bottomrule, - cancel, - cd, - cdot, - ce, - cee, - celsius, - centering, - chemabove, - Chemalpha, - Chembeta, - Chemgamma, - Chemdelta, - ChemDelta, - chemfig, - chemname, - Chemomega, - chemsetup, - cip, - cis, - ch, - cnsetup, - CNMR, - color, - cstsetup, - d, - D, - DeclareChemArrow, - DeclareChemIUPAC, - DeclareChemLatin, - DeclareChemParticle, - DeclareChemPhase, - DeclareChemReaction, - DeclareChemState, - DeclareInstance, - DeclareSIUnit, - definecolor, - delm, - delp, - Delta, - Dfi, - draw, - E, - el, - ElPot, - Enthalpy, - enthalpy, - Entropy, - footnotesize, - fmch, - fpch, - fscrm, - fscrp, - g, - gas, - ghs, - ghslistall, - ghspic, - Gibbs, - glqq, - grqq, - H, - hapto, - HNMR, - Helmholtz, - hertz, - hspace, - includegraphics, - insitu, - intertext, - invacuo, - iupac, - IUPAC, - joule, - Ka, - Kb, - kilo, - Kw, - L, - latin, - lewis, - Lewis, - Lfi, - listofreactions, - lqd, - mch, - mega, - meta, - mhName, - midrule, - mmHg, - mole, - N, - nicefrac, - newman, - NMR, - Nu, - Nuc, - num, - O, - ominus, - orbital, - ortho, - oplus, - ox, - OX, - p, - P, - para, - pch, - per, - pgfarrowsdeclarealias, - pgfarrowsrenewalias, - pH, - phase, - photon, - pKa, - pKb, - pOH, - positron, - Pot, - prt, - R, - Rad, - redox, - RenewChemArrow, - RenewChemIUPAC, - RenewChemLatin, - RenewChemParticle, - RenewChemPhase, - RenewChemState, - renewtagform, - rightarrow, - S, - Sf, - sample, - scriptscriptstyle, - scrm, - scrp, - setatomsep, - setbondoffset, - sfrac, - shorthandoff, - ShowChemArrow, - si, - SI, - sisetup, - sld, - Sod, - State, - subsection, - textcolor, - textendash, - textsuperscript, - tiny, - toprule, - trans, - upbeta, - upeta, - upgamma, - volt, - vphantom, - vspave, - w, - xspace, - Z - } - }% -} - -\newcommand*\beispiel@input[1][\jobname.tmp]{% - \catcode`\^^M=5\relax - \small - \begingroup - \leavevmode - \input{#1}% - \endgroup -} - -\beispiel@new{code and example} - {% - \setbox\beispiel@box=\hbox\bgroup - \lst@BeginAlsoWriteFile{\jobname.tmp}% - \beispiel@common - } - {% - \lst@EndWriteFile - \egroup - \colorlet{shadecolor}{codebackground} - \begin{shaded} - \ifdim\wd\beispiel@box>0.48\linewidth\relax - \begin{minipage}{.9\linewidth} - \hbox to \linewidth{\box\beispiel@box\hss}% - \end{minipage} - \vskip3mm - \begin{minipage}{.9\linewidth} - \beispiel@input - \end{minipage} - \else - \begin{minipage}{0.48\linewidth} - \hbox to\linewidth{\box\beispiel@box\hss}% - \end{minipage} - \hfill - \begin{minipage}{0.48\linewidth} - \beispiel@input - \end{minipage} - \fi - \end{shaded} - } - -\bspmidlength{below}{3mm} -\beispiel@new{below} - {% - \setbox\beispiel@box=\hbox\bgroup - \lst@BeginAlsoWriteFile{\jobname.tmp}% - \beispiel@common - } - {% - \lst@EndWriteFile - \egroup - \colorlet{shadecolor}{codebackground} - \begin{shaded} - \begin{minipage}{.9\linewidth} - \hbox to \linewidth{\box\beispiel@box\hss}% - \end{minipage} - \expandafter\vskip\beispiel@below@midlength - \begin{minipage}{.9\linewidth} - \beispiel@input - \end{minipage} - \end{shaded} - } - -\bspmidlength{ox}{7mm} -\beispiel@new{ox} - {% - \setbox\beispiel@box=\hbox\bgroup - \lst@BeginAlsoWriteFile{\jobname.tmp}% - \beispiel@common - } - {% - \lst@EndWriteFile - \egroup - \colorlet{shadecolor}{codebackground} - \begin{shaded} - \begin{minipage}{.9\linewidth} - \hbox to \linewidth{\box\beispiel@box\hss}% - \end{minipage} - \expandafter\vskip\beispiel@ox@midlength - \begin{minipage}{.9\linewidth} - \beispiel@input - \end{minipage} - \vskip7mm - \end{shaded} - } - -\beispiel@new{code and float}{% - \colorlet{shadecolor}{codebackground} - \shaded - \lst@BeginAlsoWriteFile{bsp.tmp}% - \beispiel@common -}{% - \lst@EndWriteFile - \endshaded - \beispiel@input[bsp.tmp] -} - -\beispiel@new{code only} - {\colorlet{shadecolor}{codebackground}\shaded\beispiel@common}{\endshaded} -\makeatother - -\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, - commentstyle={\color{comment}}, - keywordstyle=\color{code}, - texcsstyle=[30]\color{code}, - moretexcs=[30] - { - a, - abinitio, - AddRxnDesc, - aq, - aqi, - b, - ba, - bottomrule, - cancel, - cd, - cdot, - ce, - cee, - celsius, - centering, - chemabove, - Chemalpha, - Chembeta, - Chemgamma, - Chemdelta, - ChemDelta, - chemfig, - chemname, - Chemomega, - chemsetup, - cip, - cis, - ch, - cnsetup, - CNMR, - color, - cstsetup, - d, - D, - DeclareChemArrow, - DeclareChemIUPAC, - DeclareChemLatin, - DeclareChemParticle, - DeclareChemPhase, - DeclareChemReaction, - DeclareChemState, - DeclareInstance, - DeclareSIUnit, - definecolor, - delm, - delp, - Delta, - Dfi, - draw, - E, - el, - ElPot, - Enthalpy, - enthalpy, - Entropy, - footnotesize, - fmch, - fpch, - fscrm, - fscrp, - g, - gas, - ghs, - ghslistall, - ghspic, - Gibbs, - glqq, - grqq, - H, - hapto, - HNMR, - Helmholtz, - hertz, - hspace, - includegraphics, - insitu, - intertext, - invacuo, - iupac, - IUPAC, - joule, - Ka, - Kb, - kilo, - Kw, - L, - latin, - lewis, - Lewis, - Lfi, - listofreactions, - lqd, - mch, - mega, - meta, - mhName, - midrule, - mmHg, - mole, - N, - nicefrac, - newman, - NMR, - Nu, - Nuc, - num, - O, - ominus, - orbital, - ortho, - oplus, - ox, - OX, - p, - P, - para, - pch, - per, - pgfarrowsdeclarealias, - pgfarrowsrenewalias, - pH, - phase, - photon, - pKa, - pKb, - pOH, - positron, - Pot, - prt, - R, - Rad, - redox, - RenewChemArrow, - RenewChemIUPAC, - RenewChemLatin, - RenewChemParticle, - RenewChemPhase, - RenewChemState, - renewtagform, - rightarrow, - S, - Sf, - sample, - scriptscriptstyle, - scrm, - scrp, - setatomsep, - setbondoffset, - sfrac, - shorthandoff, - ShowChemArrow, - si, - SI, - sisetup, - sld, - Sod, - State, - subsection, - textcolor, - textendash, - textsuperscript, - tiny, - toprule, - trans, - upbeta, - upeta, - upgamma, - volt, - vphantom, - vspave, - w, - xspace, - Z - } - }% - -\makeatletter -\def\GetFileInfo#1{% - \def\filename{#1}% - \def\@tempb##1 ##2 ##3\relax##4\relax{% - \def\filedate{##1}% - \def\fileversion{##2}% - \def\fileinfo{##3}}% - \edef\@tempa{\csname ver@#1.sty\endcsname}% - \expandafter\@tempb\@tempa\relax? ? \relax\relax} -\makeatother - -\ExplSyntaxOn -\DeclareDocumentEnvironment { myquote } { o } - { - \quote - \small\sffamily - } - { - \IfNoValueF { #1 } - { - \par\noindent - \parbox { \linewidth } { \raggedleft \normalfont \itshape #1 } - } - \endquote - } - -\makeatletter -\NewDocumentCommand \paket { som } - { - \textsf { #3 } - \cs_if_exist:cF { paket @ #3 } - { - \cs_new_nopar:cpn { paket @ #3 } { } - \IfBooleanF { #1 } - { - \footnote - { - CTAN: ~ - \IfNoValueTF { #2 } - { \hyper@linkurl { #3 } { http://www.ctan.org/pkg/#3/} } - { \hyper@linkurl { #3 } { http://www.ctan.org/pkg/#2/} } - } - } - } - \index { #3 @ \textsf { #3 } } - } -\makeatother - -% #1: module #2: key #3: value -\NewDocumentCommand \key { somg } - { - \textcolor { key } { \texttt { #3 } } - \IfNoValueF { #4 } { \texttt { ~=~#4 } } - \index { #3 @ \textcolor { key } { \texttt { #3 } } } - \IfBooleanT { #1 } - { - \cs_if_exist:cF { none_#3 } - { - \cs_new:cpn { none_#3 } {} - \marginline { \small \textcolor { red } { \textendash none \textendash } } - \label{key:none_#3} - } - } - \IfNoValueF { #2 } - { - \index - { - #2 @ \textcolor { module } { \texttt { #2 } } ! - #3 @ \textcolor { key } { \texttt { #3 } } - } - \cs_if_exist:cF { #2_#3 } - { - \cs_new:cpn { #2_#3 } {} - \marginline { \small \textcolor { module } { \texttt { #2 } } } - \label{key:#2_#3} - } - } - } - -\NewDocumentCommand \cmd { omd()od()og } - { - \textcolor{code} { \texttt { \textbackslash #2 } } - \IfNoValueF { #3 } { \texttt { ( #3 ) } } - \IfNoValueF { #4 } { \texttt { [ #4 ] } } - \IfNoValueF { #5 } { \texttt { ( #5 ) } } - \IfNoValueF { #6 } { \texttt { [ #6 ] } } - \IfNoValueF { #7 } { \texttt { \{ #7 \} } } - \index - { - \IfNoValueTF { #1 } { #2 } { #1 } - @ \textcolor { code } { \texttt { \textbackslash #2 } } - } - } - -\NewDocumentCommand \env { omm } - { - \texttt{\textcolor{code}{\textbackslash begin}\{#2\}} - \IfNoValueF { #1 } { \texttt { [ #2 ] } } - \tl_use:N \c_space_tl \texttt { #3 } ~ - \texttt{\textcolor{code}{\textbackslash end}\{#2\}} - \index { #2 @ \texttt { #2 } ~ ( env. ) } - } - -\NewDocumentCommand \secidx { somo } - { - \IfBooleanTF { #1 } - { - \IfNoValueT { #2 } - { \index { \IfNoValueTF { #4 } { #3 } { #4 } @ \textbf { #3 } |) } } - } - { - \IfNoValueT { #2 } - { \index { \IfNoValueTF { #4 } { #3 } { #4 } @ \textbf { #3 } |( } } - } - \IfNoValueF { #2 } - { \index { \IfNoValueTF { #4 } { #3 } { #4 } @ \textbf { #3 } ! #2 } } - } - -\NewDocumentCommand \ma { m } - { \texttt { \{ #1 \} } } - -\NewDocumentCommand \oa { m } - { \texttt { [ #1 ] } } - -\NewDocumentCommand \da { m } - { \texttt { ( #1 ) } } - -\makeatletter -\NewDocumentCommand \achtung { m } - { - \ifvmode\addvspace{\baselineskip}\fi - \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 } } -\cs_generate_variant:Nn \chemmacros_doc_todo:nn { xn } - -\tl_new:N \l_chemmacros_doc_todo_inline_tl - -\NewDocumentCommand\TODO{sm} - { - \group_begin: - \IfBooleanTF{#1} - { \tl_set:Nn \l_chemmacros_doc_todo_inline_tl {, inline } } - { \tl_set:Nn \l_chemmacros_doc_todo_inline_tl { } } - \chemmacros_doc_todo:xn - { - color = myblue, - backgroundcolor = white, - size = \exp_not:N \small - \l_chemmacros_doc_todo_inline_tl - } - { \textcolor { myblue } { \textbf { TODO: } } \\ #2 } - \group_end: - } - -\ExplSyntaxOff - -\newcommand*\IUPAC{\mbox{IUPAC}\xspace} - -\endinput
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.pdf b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.pdf Binary files differnew file mode 100644 index 00000000000..3fdf0af254d --- /dev/null +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.pdf diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.tex index 1de4ef46d72..57b9a65bd0f 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.tex +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_de.tex @@ -1,62 +1,64 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% --------------------------------------------------------------------------- % -% - the CHEMMACROS bundle - % -% - chemmacros_doc_de.tex - % -% - macros and commands for chemists - % -% --------------------------------------------------------------------------- % -% - Clemens Niederberger - % -% - 2012/03/14 - % -% --------------------------------------------------------------------------- % -% - https://bitbucket.org/cgnieder/chemmacros/ - % -% - contact@mychemistry.eu - % -% --------------------------------------------------------------------------- % -% - If you have any ideas, questions, suggestions or bugs to report, please - % -% - feel free to contact me. - % -% --------------------------------------------------------------------------- % -% - Copyright 2011-2012 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. - % +% ----------------------------------------------------------------------------- +% - the CHEMMACROS bundle +% - chemmacros_de.tex +% - macros and commands for chemists +% ----------------------------------------------------------------------------- +% - Clemens Niederberger +% - 2012/05/07 +% ----------------------------------------------------------------------------- +% - https://bitbucket.org/cgnieder/chemmacros/ +% - contact@mychemistry.eu +% ----------------------------------------------------------------------------- +% - If you have any ideas, questions, suggestions or bugs to report, please +% - feel free to contact me. +% ----------------------------------------------------------------------------- +% - Copyright 2011-2012 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. +% ----------------------------------------------------------------------------- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % -% if you want to compile this documentation: +% if you want to compile this documentation +% a) you'll need the document class `cnpkgdoc' which you can get here: +% https://bitbucket.org/cgnieder/cnpkgdoc/ +% the class is licensed LPPL 1.3 or later +% b) you need the following compilation order: +% > xelatex chemmacros_de (2 or probably 3 times) +% > biber chemmacros_de +% > makeindex -sl index_de.ist chemmacros_de.idx +% > xelatex chemmacros_de % -% > 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,toc=index,toc=bib]{scrartcl} -\usepackage{fontspec,xltxtra} +\documentclass[DIV11,toc=index,toc=bib]{cnpkgdoc} +\docsetup{ + pkg = chemmacros, + title = Das \Chemmacros-Bundle, + language = de, + subtitle = {Pakete \Chemmacros, \Chemformula\ und \Ghsystem}, + modules = true, + code-box = {skipabove=1ex,skipbelow=1ex} +} \usepackage{polyglossia} \setmainlanguage{german} -\usepackage[normalem]{ulem} -\usepackage{chemfig,chemstyle,upgreek,textgreek,multicol,makeidx,booktabs,csquotes,cancel} -\usepackage[german]{chemmacros} +\usepackage{chemfig,chemstyle,upgreek,textgreek,booktabs,cancel} \usepackage[version=3]{mhchem} -\usepackage[para]{footmisc} +\usepackage{hologo} -% Setup: -\setmainfont[SmallCapsFont=Linux Libertine Capitals O,SlantedFont=Linux Libertine Slanted O]{Linux Libertine O} -\setsansfont[Scale=MatchLowercase,SmallCapsFont=Linux Biolinum Capitals O,SlantedFont=Linux Biolinum Slanted O]{Linux Biolinum O} -\setmonofont[Scale=MatchLowercase]{Inconsolata} -\chemsetup[option]{synchronize} +\chemsetup[option]{synchronize,language=german} \colorlet{chemformula}{darkgray} -\chemsetup[chemformula]{font-spec={[Color=chemformula]Latin Modern Sans}} -\reversemarginpar -\input{chemmacros-codehelper} \begin{filecontents}{index_de.ist} - preamble "\\begin{theindex}\n Überschriften werden \\textbf{fett}, Pakete \\textsf{serifenlos}, Befehle \\textcolor{code}{\\texttt{\\textbackslash braun}}, Optionen \\textcolor{key}{\\texttt{grün}} und Module (nur \\chemmacros) \\textcolor{module}{\\texttt{rot}} gesetzt.\\newline\n\n" + preamble "\\begin{theindex}\n Überschriften werden \\textbf{fett}, Pakete \\textsf{serifenlos}, Befehle \\textcolor{code}{\\code{\\textbackslash braun}}, Optionen \\textcolor{key}{\\code{grün}} und Module (nur \\chemmacros) \\textcolor{module}{\\code{rot}} gesetzt.\\newline\n\n" heading_prefix "{\\bfseries " heading_suffix "\\hfil}\\nopagebreak\n" headings_flag 1 @@ -103,79 +105,61 @@ numerator-format = \scriptsize #1 } -\usepackage{hyperref} - \hypersetup{colorlinks = true, - allcolors = myblue, - plainpages = false, - bookmarksopen = true, - bookmarksopenlevel = 1, - bookmarksnumbered = true, - bookmarksdepth = paragraph, - 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} -\newcommand*\chemformula{{\scshape\textcolor{myblue}{chemformula}}\xspace} -\newcommand*\ghsystem{{\scshape\textcolor{myblue}{ghsystem}}\xspace} +\newcommand*\chemformula{{\scshape\textcolor{cnpkgblue}{chemformula}}\xspace} +\newcommand*\ghsystem{{\scshape\textcolor{cnpkgblue}{ghsystem}}\xspace} -\newcommand*\Chemmacros{{\fontspec[Color=myblue,Scale=1.2]{Linux Biolinum Shadow O}chemmacros}} -\newcommand*\Chemformula{{\fontspec[Color=myblue,Scale=1.2]{Linux Biolinum Shadow O}chemformula}} -\newcommand*\Ghsystem{{\fontspec[Color=myblue,Scale=1.2]{Linux Biolinum Shadow O}ghsystem}} +\newcommand*\Chemmacros{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}chemmacros}} +\newcommand*\Chemformula{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}chemformula}} +\newcommand*\Ghsystem{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}ghsystem}} -\newcommand*\zB{\mbox{z.\,B.}\xspace} -\renewcommand*\dh{\mbox{d.\,h.}\xspace} -\makeatletter -\newcommand*\usw{\mbox{usw}\@ifnextchar.{}{.\ }} -\makeatother -\newcommand*\bzw{\mbox{bzw.}\xspace} -\newcommand*\TIKZ{Ti\textbf{\textit{k}}Z} -\newcommand*\TikZ{\index{TikZ@\TIKZ}\mbox{\TIKZ}\xspace} +\newcommand*\IUPAC{\mbox{IUPAC}\xspace} +\renewcommand*\AmS{\hologo{AmS}} +\newcommand*\pdfTeX{\hologo{pdfTeX}} +\newcommand*\LuaTeX{\hologo{LuaTeX}} -\newcommand*\pdfTeX{\textsc{pdf\kern-.2ex\TeX}} -\renewcommand*\LuaTeX{{Lua\kern-.2ex\TeX}} - -\providecommand\glqq{„} -\providecommand\grqq{“} +\TitlePicture{% + \ch[font-spec={[Color=chemformula]Augie}]{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" {}+ + 2 "\OX{r2,\ox{-1,Cl}}" {}- } + \redox(o1,o2)[red,-cf]{\small\ch[font-spec={[Color=red]Augie},math-space=.3em]{$-$ 2 e-}} + \redox(r1,r2)[blue,-cf][-1]{\small\ch[font-spec={[Color=blue]Augie},math-space=.3em]{$+$ 2 e-}}} + +\addcmds{ + a,abinitio,AddRxnDesc,aq,aqi,b,ba,bottomrule,cancel,cd,cdot,ce,cee,celsius, + centering,chemabove,Chemalpha,Chembeta,Chemgamma,Chemdelta,ChemDelta,chemfig, + chemname,Chemomega,chemsetup,cip,cis,ch,cnsetup,CNMR,color,cstsetup,d,D,data, + DeclareChemArrow,DeclareChemIUPAC,DeclareChemLatin,DeclareChemNMR, + DeclareChemParticle,DeclareChemPhase,DeclareChemReaction,DeclareChemState, + DeclareInstance,DeclareSIUnit,definecolor,delm,delp,Delta,Dfi,draw,E,el, + electronvolt,ElPot,Enthalpy,enthalpy,Entropy,footnotesize,fmch,fpch,fscrm, + fscrp,g,gas,ghs,ghslistall,ghspic,Gibbs,glqq,gram,grqq,H,hapto,HNMR,Helmholtz, + hertz,hspace,includegraphics,insitu,intertext,invacuo,iupac,IUPAC,J,joule,Ka, + Kb,kilo,Kw,L,latin,lewis,Lewis,Lfi,listofreactions,lqd,mch,mega,meta,metre, + mhName,midrule,milli,mmHg,mole,N,nano,nicefrac,newman,NMR,Nu,Nuc,num,O,ominus, + orbital,ortho,oplus,ox,OX,p,P,para,pch,per,percent,pgfarrowsdeclarealias, + pgfarrowsrenewalias,pH,phase,photon,pKa,pKb,pOH,pos,positron,Pot,prt,R,Rad, + redox,RenewChemArrow,RenewChemIUPAC,RenewChemLatin,RenewChemNMR, + RenewChemParticle,RenewChemPhase,RenewChemState,renewtagform,rightarrow,S,Sf, + sample,scriptscriptstyle,scrm,scrp,setatomsep,setbondoffset,sfrac, + shorthandoff,ShowChemArrow,si,SI,sisetup,sld,Sod,State,subsection,textcolor, + textendash,textsuperscript,tiny,toprule,trans,upbeta,upeta,upgamma,val,volt, + vphantom,vspave,w,xspace,Z} \makeindex \begin{document} -\GetFileInfo{chemmacros} - -\begin{center} - % title: - \Huge Das \Chemmacros\ Bundle \\[.5cm] - \fileversion \qquad \filedate \\[.5cm] - \Large Pakete \Chemmacros, \Chemformula\ und \Ghsystem \\[.5cm] - % author and contact: - \large Clemens \textsc{Niederberger} \\[.5cm] - \normalsize\url{https://bitbucket.org/cgnieder/chemmacros/}\\ - \href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}\\[1cm] - % picture: - \large\ch[font-spec={[Color=chemformula]Augie}]{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } - \redox(o1,o2)[red,-cf]{\small\ch[font-spec={[Color=red]Augie},math-space=.3em]{$-$ 2 e-}} - \redox(r1,r2)[blue,-cf][-1]{\small\ch[font-spec={[Color=blue]Augie},math-space=.3em]{$+$ 2 e-}} -\end{center} -\vskip1cm -\begin{multicols}{2} - \tableofcontents -\end{multicols} +\chemsetup[chemformula]{font-spec={[Color=chemformula]Latin Modern Sans}} +\renewcommand*\glqq{„} +\renewcommand*\grqq{“} \part{Bevor es los geht}\secidx{BEVOR ES LOS GEHT} \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}) +Das \chemmacros-Bundle steht unter der \LaTeX\ Project Public License (LPPL) Version 1.3 oder später (\url{http://www.latex-project.org/lppl.txt}) und hat den Status „maintained“. -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. +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 \code{calc} und \code{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}. 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. +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}{\code{grün}} und Module \textcolor{module}{\code{rot}} dargestellt. Das Paket \ghsystem benötigt die Pakete \chemmacros, \paket{tabu}, \paket{longtable}, \paket{ifpdf} und \paket{graphicx}. @@ -184,7 +168,9 @@ Das Paket \ghsystem benötigt die Pakete \chemmacros, \paket{tabu}, \paket{longt \section{Motivation und Hintergrund} \chemmacros entstand vor einigen Jahren als wachsende Liste von Makros, die ich häufig verwendete. Ich kann mich nicht mehr genau erinnern, wann und warum ich entschied, sie als Paket zu veröffentlichen. Nun \textendash\ hier ist es und ich hoffe, Sie werden das eine oder andere ebenfalls nützlich finden. -Ich nehme an, dass fast jeder Chemiker, der \LaTeX\ für seine Dokumente verwendet, das großartige Paket \paket{mhchem} von Martin Hensel kennt. Es gab immer ein paar Schwierigkeiten, \paket{mhchem} und \chemmacros zur Zusammenarbeit zu bewegen. Ein paar Kleinigkeiten in \paket{mhchem} haben mich zudem immer gestört, aber sie schienen nicht genug für ein neues Paket. Noch nicht einmal genug, um ein \enquote{feature request} an den Autoren von \paket{mhchem} zu senden. Die Herausforderung und der Spaß, ein neues Paket zu erschaffen, sowie der Wunsch nach größtmöglicher Flexibilität führten so doch noch zu \chemformula. +Die Makros und ihre Funktionsweise haben sich im Laufe der Zeit leicht verändert. Es sind außerdem eine ganze Reihe hinzugekommen. Insgesamt hat sich mit der Zeit vieles vereinheitlicht und es sind viele Anpassungsmöglichkeiten hinzugekommen. + +Wohl fast jeder Chemiker, der \LaTeX\ für seine Dokumente verwendet, dürfte das großartige Paket \paket{mhchem} von Martin Hensel kennen. Es gab immer ein paar Schwierigkeiten, \paket{mhchem} und \chemmacros zur Zusammenarbeit zu bewegen. Ein paar Kleinigkeiten in \paket{mhchem} haben mich zudem immer gestört, aber sie schienen nicht genug für ein neues Paket. Noch nicht einmal genug, um ein \enquote{feature request} an den Autoren von \paket{mhchem} zu senden. Die Herausforderung und der Spaß, ein neues Paket zu erschaffen, sowie der Wunsch nach größtmöglicher Flexibilität führten so doch noch zu \chemformula. \chemformula funktioniert sehr ähnlich wie \paket{mhchem}, ist aber strenger was das Eingeben von Verbindungen, stöchiometrischen Faktoren und Pfeilen angeht. Gleichzeitig bietet \chemformula ein paar Möglichkeiten, den Output anzupassen, die \paket{mhchem} nicht bietet. Da \chemformula als Alternative zu \paket{mhchem} gedacht ist, bietet \chemmacros eine Option, mit der Sie zwischen \paket{mhchem} und \chemformula wählen können. @@ -199,8 +185,10 @@ Ich hoffe, folgende vier Punkte in diesem Bundle umgesetzt zu haben: \end{itemize} Vor allem der letzte Punkt benötigte zwar einige Schubser von Anwendern\footnote{Vielen Dank an Dr.~Paul~King!}, um die richtigen Einstellungen an vielen Stellen zu bekommen. Wenn Ihnen etwas auf\-fällt, das nicht der \IUPAC-Empfehlung entspricht\footnote{Das gilt nicht für den \cmd{ox}-Befehl. Die \IUPAC-Fassung dazu ist \cmd[oxa]{ox*}.}, würde ich mich über eine E-Mail sehr freuen! +Bei einem Paket dieser Größe mit alten und neuen Teilen (die man noch als in der Beta-Phase befindlich betrachten muss) ist es unvermeidbar, dass es Fehler und Bugs gibt. Ich bin sehr daran interessiert, dieses Paket zu korrigieren und verbessern, daher eine Bitte: wenn Ihnen etwas auf{}fällt, das Sie stört, egal wie geringfügig es erscheint, senden Sie mir bitte eine E-Mail und ich werde sehen, was ich tun kann. Besonders interessiert bin ich an Feedback zu \chemformula (siehe Teil \ref{part:chemformula}) und \ghsystem (siehe Teil \ref{part:ghsystem}), freue mich aber natürlich auch über Feedback zu jedem anderen Teil des Bundles. + \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-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 Bundle enthält drei Style-Dateien\footnote{Die mit der Endung \code{sty}.}, einem Ordner namens \code{language/}, der die Sprach-De\-fi\-ni\-tions-Dateien für GHS enthält (Endung \code{def}) und einem Ordner \code{pictures/}, der \code{eps}-, \code{jpg}- und \code{png}-Dateien enthält (die GHS Piktogramme). Wenn Sie das Bundle von Hand installieren, \emph{bitte achten Sie darauf, die Ordner \code{language/} und \code{pictures/} in den \emph{gleichen} Ordner wie die Style-Dateien zu kopieren}. Das Laden von \chemmacros via \begin{beispiel}[code only] @@ -208,15 +196,15 @@ Das Laden von \chemmacros via \end{beispiel} wird ebenso \chemformula und \ghsystem laden. Sie können jedoch \chemmacros davon abhalten, \ghsystem zu laden: \begin{beispiel}[code only] - \usepackage[ghsystem=false]{chemmacros} % `chemmacros' and `formula' are loaded + \usepackage[ghsystem=false]{chemmacros} % `chemmacros' and `chemformula' are loaded \end{beispiel} Das Laden von \chemformula kann nicht verhindert werden, da \chemmacros und \chemformula miteinander interagieren. Das explizite Laden von \chemformula \bzw\ \ghsystem ist möglich und wird \chemmacros in jedem Fall laden, falls das noch nicht geschehen ist. Dadurch laden sie sich implizit gegenseitig. \begin{beispiel}[code only] - \usepackage{chemformula} % `chemmacros', `formula' and `ghs' are loaded + \usepackage{chemformula} % `chemmacros', `chemformula' and `ghsystem' are loaded or - \usepackage[ghs=false]{chemformula} % `chemmacros' and `formula' are loaded + \usepackage[ghsystem=false]{chemformula} % `chemmacros' and `chemformula' are loaded \end{beispiel} Es wird jedoch empfohlen, lediglich \lstinline=\usepackage{chemmacros}= zu verwenden und die gewünschten Optionen mit \lstinline=\chemsetup= vorzunehmen (siehe auch Abschnitt \ref{sec:setup}). @@ -227,35 +215,45 @@ Es wird jedoch empfohlen, lediglich \lstinline=\usepackage{chemmacros}= zu verwe \begin{beispiel}[code only] \usepackage[option1 = <value1>, option2 = <value2>]{chemmacros} \end{beispiel} -Die meisten können auch ohne Wert verwendet werden (\lstinline+\usepackage[option]{chemmacros}+). Sie verwenden dann den \uline{unter\-stri\-che\-nen} Wert. +Die meisten können auch ohne Wert verwendet werden (\lstinline+\usepackage[option]{chemmacros}+). Sie verwenden dann den \default{unter\-stri\-che\-nen} Wert. Sowohl \chemformula als auch \ghsystem haben keine eigenen Paketoptionen. Wenn Sie sie explizit laden, können ihnen \chemmacros' Optionen gegeben werden. Sie werden dann an \chemmacros weitergereicht. -\begin{description} - \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]{cmversion}{1/2/bundle} Diese Option stellt die Definition einiger Befehle wieder her, so dass Dokumente, die mit v1.* gesetzt wurden, Korrekt kompilieren. Default = \texttt{bundle}. Eigentlich sind \texttt{2} und \texttt{bundle} Aliase. Diese Option kann nur in der Präambel gesetzt werden. Notiz: Das ist nur die umbenannte ehemalige Option \key{version}. - \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]{ghsystem}{\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} - \item \key[option]{method}{\uline{chemformula}/mhchem} Sie können wählen, ob \chemmacros \paket{mhchem} oder \chemformula für die Reaktionsumgebungen (siehe Abschnitt \ref{ssec:mhchem_reaktionen}) und die Teilchen (siehe Abschnitt \ref{sec:teilchen}) verwendet. Default = \texttt{chemformula}. Diese Option kann nur in der Präambel gesetzt werden. - \item \key[option]{Nu}{\uline{chemmacros}/mathspec} Das Paket \paket{mathspec} definiert ebenfalls ein Makro \cmd{Nu}. Diese Option entscheidet, welche Definition gilt, siehe Seite \pageref{Nu}. Default = \texttt{chemmacros}. Diese Option kann nur in der Präambel gesetzt werden. - \item \key[option]{strict}{\uline{true}/false} Die Einstellung \key{strict}{true} wird alle Warnungen in Fehlermeldungen ändern. Default = \texttt{false} - \item \key[option]{synchronize}{\uline{true}/false} Mit der Einstellung \texttt{true} wird \chemmacros die Schrifteinstellungen von \chemformula übernehmen, falls \chemformula als Methode gewählt wurde. Default = \texttt{false}. Um diese Option zu demonstrieren, wurde dieses Dokument mit \key{synchronize}{true} und der \chemformula Einstellung \lstinline+\chemsetup[chemformula]{font-spec={[Color=darkgray]Latin Modern Sans}}+ gesetzt. - \item \key[option]{upgreek}{none/textgreek/\uline{upgreek}} Diese Option bestimmt, wie die Buchstaben \cmd{Chemalpha} und seine Verwandten dargestellt werden. Siehe Seite \pageref{key:upgreek} für weitere Informationen. Diese Option kann nur in der Präambel gesetzt werden. Default = \texttt{upgreek} - \item \key[option]{version} \emph{Diese Option macht gar nichts und existiert nur wegen Kompatibilität für ältere Dokumente}. Die Funktionalität wird nun durch die Option \key{cmversion} bereitgestellt. Die Umbenennung war nötig damit \chemmacros auch mit \paket[koma-script]{KOMA-Script} und dessen Option \texttt{version} funktioniert. - \item \key[option]{xspace}{\uline{true}/false} Mit dieser Option werden die meisten Makros mit einem \lstinline+\xspace+ definiert. Default = \texttt{true} -\end{description} +\begin{beschreibung} + % bpchem + \option[option]{bpchem}{\default{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 = \code{false} + % circled + \option[option]{circled}{\default{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 \code{formal} unterscheidet zwischen ihnen, \code{none} stellt alle ohne Umkreisung dar, \code{all} umkreist alle. Default = \code{formal} + % circletype + \option[option]{circletype}{\default{chem}/math} Diese Option schaltet zwischen zwei Darstellungsmöglichkeiten für formale Ladungen hin und her: \cmd{fplus} \fplus\ und \lstinline+$\oplus$+ $\oplus$. Default = \code{chem} + % cmversion + \option[option]{cmversion}{1/2/bundle} Diese Option stellt die Definition einiger Befehle wieder her, so dass Dokumente, die mit v1.* gesetzt wurden, Korrekt kompilieren. Default = \code{bundle}. Eigentlich sind \code{2} und \code{bundle} Aliase. Diese Option kann nur in der Präambel gesetzt werden. + % ghsystem + \option[option]{ghsystem}{\default{true}/false} Das Paket \ghsystem abschalten. Die Einstellung \key{ghs}{false} wird das Laden von \ghsystem unterbinden. Default = \code{true} + % greek + \option[option]{greek}{math/textgreek/\default{upgreek}} Diese Option bestimmt, wie die Buchstaben \cmd{Chemalpha} und seine Verwandten dargestellt werden. Siehe Seite \pageref{desc:upgreek} für weitere Informationen. Diese Option kann nur in der Präambel gesetzt werden. Default = \code{upgreek} + % iupac + \option[option]{iupac}{auto/restricted/strict} Einstellen, wie die Nomenklatur-Befehle definiert werden. Siehe Seite \pageref{desc:iupac}. Default = \code{auto} + % language + \option[option]{language}{american/british/english/french/german/italian/ngerman} Sprachspezifische Einstellungen laden. \code{english}, \code{american} und \code{british} sind Aliase, ebenso \code{german} und \code{ngerman}. Diese Option kann nur in der Präambel gesetzt werden. Default = \code{english} + % method + \option[option]{method}{\default{chemformula}/mhchem} Sie können wählen, ob \chemmacros \paket{mhchem} oder \chemformula für die Reaktionsumgebungen (siehe Abschnitt \ref{sec:reactions}) und die Teilchen (siehe Abschnitt \ref{sec:teilchen}) verwendet. Default = \code{chemformula}. Diese Option kann nur in der Präambel gesetzt werden. + % Nu + \option[option]{Nu}{\default{chemmacros}/mathspec} Das Paket \paket{mathspec} definiert ebenfalls ein Makro \cmd{Nu}. Diese Option entscheidet, welche Definition gilt, siehe Seite \pageref{Nu}. Default = \code{chemmacros}. Diese Option kann nur in der Präambel gesetzt werden. + % strict + \option[option]{strict}{\default{true}/false} Die Einstellung \key{strict}{true} wird alle Warnungen in Fehlermeldungen ändern. Default = \code{false} + % synchronize + \option[option]{synchronize}{\default{true}/false} Mit der Einstellung \code{true} wird \chemmacros die Schrifteinstellungen von \chemformula übernehmen, falls \chemformula als Methode gewählt wurde. Default = \code{false}. Um diese Option zu demonstrieren, wurde dieses Dokument mit \key{synchronize}{true} und der \chemformula Einstellung \lstinline+\chemsetup[chemformula]{font-spec={[Color=darkgray]Latin Modern Sans}}+ gesetzt. + % xspace + \option[option]{xspace}{\default{true}/false} Mit dieser Option werden die meisten Makros mit einem \lstinline+\xspace+ definiert. Default = \code{true} +\end{beschreibung} \secidx*{Paketoptionen} \section{Setup}\label{sec:setup}\secidx{Setup} Zahlreiche der Befehle von \chemmacros, \chemformula und \ghsystem haben Schlüssel/Wert-Paare als Optionen, mit denen sie angepasst werden können. Meistens können sie als (optionales) Argument des entsprechenden Befehls verwendet werden. Meistens können Sie auch mit dem \cmd{chemsetup} Befehl verwendet werden. -\begin{description} - \item \cmd{chemsetup}[<module>]{<key> = <value>} oder - \item \cmd{chemsetup}{<module>/<key> = <value>} -\end{description} +\begin{beschreibung} + \Befehl{chemsetup}[<module>]{<key> = <value>} oder + \Befehl{chemsetup}{<module>/<key> = <value>} +\end{beschreibung} Die Optionen gehören alle zu einem Modul, das anzeigt, auf welchen Befehl sie sich auswirken. Wenn eine Option vorgestellt wird, wird das dazugehörige Modul in den linken Rand geschrieben. Sie können die Optionen mit \cmd{chemsetup} auf zwei Weisen verwenden, wie oben dargestellt. Die Paketoptionen können ebenfalls als Optionen betrachtet werden, die zum Modul \textcolor{module}{\ttfamily option} gehören. Das bedeutet, sie können auch mit \cmd{chemsetup} aufgerufen werden. @@ -268,43 +266,90 @@ Die Paketoptionen können ebenfalls als Optionen betrachtet werden, die zum Modu \end{beispiel} Optionen, die \emph{keinem} Modul angehören, können \emph{nicht} mit \cmd{chemsetup} verwendet werden! -Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\texttt{chemformula}} an und alle Optionen von \ghsystem gehören dem Modul \textcolor{module}{\texttt{ghs}} an. +Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\code{chemformula}} an und alle Optionen von \ghsystem gehören dem Modul \textcolor{module}{\code{ghs}} an. \secidx*{Setup} -\secidx*{BEVOR ES LOS GEHT} + +\section{Spracheinstellungen}\label{sec:languages}\secidx{Spracheinstellung} +\subsection{Unterstützte Sprachen} +Durch die Wahl der Option +\begin{beispiel}[code only] + \chemsetup[option]{language=<language>} +\end{beispiel} +kann eine der folgenden Sprachen gewählt werden: \code{american/british/english/french/german/italian/ngerman}. Die Sprachen \code{american/british/english} sind Aliase, ebenso die Sprachen \code{german/ngerman}. + +Übersetzt werden +\begin{itemize} + \item Die Überschrift der Liste der Reaktionen. + \item Die Einträge bei der Liste der Reaktionen. + \item Die H- und P-Sätze. +\end{itemize} + +\achtung{Bitte beachten Sie, dass die GHS-Sätze nicht in allen Sprachen angeboten werden, siehe auch Abschnitt \ref{sec:ghsystem_language}.} + +\subsection{Besonderheiten} +\subsubsection{Deutsch} +Bei der Sprachwahl \code{german/ngerman} werden zusätzlich die Phasen-Befehle \cmd{sld}, \cmd{lqd} und \cmd{pKa} übersetzt. + +\subsubsection{Italienisch} +\DeclareChemIUPAC{\ter}{\textit{ter}}\DeclareChemIUPAC{\sin}{\textit{sin}}% +Bei der Sprachwahl \code{italian} werden zusätzliche IUPAC-Befehle definiert: +\begin{beschreibung} + \befehl{ter} \iupac{\ter} + \befehl{sin} \iupac{\sin} +\end{beschreibung} +\secidx*{Spracheinstellung} + +\section{Neues}\secidx{Neues} +\subsection{Version 3.3} +\begin{itemize} + \item Ab Version 3.3 gibt es die Umgebung \env{experimental}{}, siehe Abschnitt \ref{sec:spektroskopie}, die mit einigen neuen Befehlen und Optionen verwendet werden kann, um Messdaten konsistent darzustellen. + \item Die Umgebung \env{reaction}{} und ihre Verwandten können nun mit \lstinline+\label+, \lstinline+\ref+ und \lstinline+\intertext+ umgehen, siehe Abschnitt \ref{sec:reactions}. + \item Die Paketoptionen \key{german} und \key{ngerman} entfallen, dafür gibt es die neue Option \key{language}, siehe Seite \pageref{key:option_language} und Abschnitt \ref{sec:languages} ab Seite \pageref{sec:languages}. + \item Die Paketoption \key{upgreek} wurde umbenannt in \key{greek}. + \item Die \code{\textbackslash\textcolor{code}{Chem<greekletter>}}-Befehle wurden um einige Buchstaben erweitert, siehe Abschnitt \ref{sec:teilchen}. +\end{itemize} +\secidx*{Neues}\secidx*{BEVOR ES LOS GEHT} \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} \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) - \item \cmd{HtO} \HtO (Oxoniumion) (\textbf{H} \textbf{t}hree \textbf{O}) - \item \cmd{water} \water - \item \cmd{el} \el (Elektron) - \item \cmd{prt} \prt (Proton) - \item \cmd{ntr} \ntr (Neutron) - \item \cmd{Nu} \Nu (Nukleophil). Das Paket \paket{mathspec} definiert ebenfalls ein Makro \cmd{Nu}. Wenn Sie die Paketoption \key[option]{Nu}{mathspec} wählen, definiert \chemmacros stattdessen \cmd{Nuc}\label{Nu}. - \item \cmd{El} \El (Elektrophil) - \item \cmd{ba} \ba (Base) - \item \cmd{fplus} \fplus - \item \cmd{fminus} \fminus - \item \cmd{transitionstatesymbol} \transitionstatesymbol - \item \cmd{standardstate} \standardstate. Dieses Symbol wird nur dann von \chemmacros bereitgestellt, wenn das Paket \paket{chemstyle} nicht geladen wurde. Die Idee ist von dort ausgeliehen\footnote{Vielen Dank an den Paketautoren \href{http://www.texdev.net/}{Joseph Wright}.}. - \item \cmd{Chemalpha} \Chemalpha - \item \cmd{Chembeta} \Chembeta - \item \cmd{Chemgamma} \Chemgamma - \item \cmd{Chemdelta} \Chemdelta - \item \cmd{Chemomega} \Chemomega - \item \cmd{ChemDelta} \ChemDelta -\end{description} +\begin{beschreibung} + \befehl{Hpl} \Hpl (Proton) + \befehl{Hyd} \Hyd (Hydroxid) + \befehl{HtO} \HtO (Oxoniumion) (\textbf{H} \textbf{t}hree \textbf{O}) + \befehl{water} \water + \befehl{el} \el (Elektron) + \befehl{prt} \prt (Proton) + \befehl{ntr} \ntr (Neutron) + \befehl{Nu} \Nu (Nukleophil). Das Paket \paket{mathspec} definiert ebenfalls ein Makro \cmd{Nu}. Wenn Sie die Paketoption \key[option]{Nu}{mathspec} wählen, definiert \chemmacros stattdessen \cmd{Nuc}\label{Nu}. + \befehl{El} \El (Elektrophil) + \befehl{ba} \ba (Base) + \befehl{fplus} \fplus + \befehl{fminus} \fminus + \befehl{transitionstatesymbol} \transitionstatesymbol + \befehl{standardstate} \standardstate. Dieses Symbol wird nur dann von \chemmacros bereitgestellt, wenn das Paket \paket{chemstyle} nicht geladen wurde. Die Idee ist von dort ausgeliehen\footnote{Vielen Dank an den Paketautoren \href{http://www.texdev.net/}{Joseph Wright}.}. + \befehl{Chemalpha} \Chemalpha + \befehl{Chembeta} \Chembeta + \befehl{Chemgamma} \Chemgamma + \befehl{Chemdelta} \Chemdelta + \befehl{Chemepsilon} \Chemepsilon + \befehl{Chemeta} \Chemeta + \befehl{Chemmu} \Chemmu + \befehl{Chemnu} \Chemnu + \befehl{Chemrho} \Chemrho + \befehl{Chempi} \Chempi + \befehl{Chemsigma} \Chemsigma + \befehl{Chemomega} \Chemomega + \befehl{ChemDelta} \ChemDelta +\end{beschreibung} \achtung{Der Befehl \cmd{Rad} wird nicht mehr bereitgestellt!} Die beiden Teilchen \cmd{Nu} und \cmd{ba} können angepasst werden. Dafür verwenden Sie die Option -\begin{description} - \item\key[particle]{elpair}{false/\uline{dots}/dash} -\end{description} +\begin{beschreibung} + \Option[particle]{elpair}{false/\default{dots}/dash} +\end{beschreibung} Sie hat nur dann Auswirkungen, wenn das Paket \paket{chemfig} geladen wurde, da sie dessen Befehl \lstinline+\Lewis+ verwendet. \begin{beispiel} % needs package `chemfig' @@ -314,14 +359,14 @@ Sie hat nur dann Auswirkungen, wenn das Paket \paket{chemfig} geladen wurde, da \ba \Nu \end{beispiel} -\label{key:upgreek}Die griechischen Buchstaben sind keine neu definierten Zeichen sondern werden abhängig von den Paketen, die sie geladen haben, definiert. Die Default-Version entspricht den entsprechenden kursiven „Mathematik“-Buchstaben. Wenn Sie das Paket \paket{textgreek} geladen haben, werden dessen Buchstaben verwendet. Wenn Sie das Paket \paket{upgreek} geladen haben, werden dessen Buchstaben verwendet. Diese Dokumentation verwendet \paket{upgreek}. Haben Sie sowohl \paket{textgreek} als auch \paket{upgreek} geladen haben, wird \paket{upgreek} verwendet. +\label{desc:upgreek}Die griechischen Buchstaben sind keine neu definierten Zeichen sondern werden abhängig von den Paketen, die sie geladen haben, definiert. Die Default-Version entspricht den entsprechenden kursiven „Mathematik“-Buchstaben. Wenn Sie das Paket \paket{textgreek} geladen haben, werden dessen Buchstaben verwendet. Wenn Sie das Paket \paket{upgreek} geladen haben, werden dessen Buchstaben verwendet. Diese Dokumentation verwendet \paket{upgreek}. Haben Sie sowohl \paket{textgreek} als auch \paket{upgreek} geladen haben, wird \paket{upgreek} verwendet. -Wenn Sie nicht wollen, dass \chemmacros automatisch wählt, sondern selbst entscheiden wollen, verwenden Sie die Paketoption \key[option]{upgreek}. \ref{tab:upgreek_mode} zeigt die verschiedenen Varianten einiger Buchstaben. +Wenn Sie nicht wollen, dass \chemmacros automatisch wählt, sondern selbst entscheiden wollen, verwenden Sie die Paketoption \key[option]{greek}. \ref{tab:upgreek_mode} zeigt die verschiedenen Varianten einiger Buchstaben. \begin{table}[h] \centering \begin{tabular}{lccc}\toprule - & none & upgreek & textgreek \\\midrule + & math & upgreek & textgreek \\\midrule \cmd{Chemalpha} & $\alpha$ & $\upalpha$ & \textalpha \\ \cmd{Chembeta} & $\beta$ & $\upbeta$ & \textbeta \\ \cmd{ChemDelta} & $\Delta$ & $\Updelta$ & \textDelta \\ \bottomrule @@ -331,19 +376,19 @@ Wenn Sie nicht wollen, dass \chemmacros automatisch wählt, sondern selbst entsc Der Grund dafür, dass \chemmacros diese Makros überhaupt definiert, ist \IUPAC-Konformität. \IUPAC empfiehlt, aufrechte griechische Buchstaben in der Nomenklatur verwenden. -\begin{myquote}[\IUPAC Green Book \cite[][p.\,9]{iupac:greenbook}] +\begin{zitat}[\IUPAC Green Book \cite[][p.\,9]{iupac:greenbook}] Greek letters are used in systematic organic, inorganic, macromolecular and biochemical nomenclature. These should be roman (upright), since they are not symbols for physical quantities. -\end{myquote} +\end{zitat} \chemmacros verwendet diese Befehle nun, um Nomenklatur-Befehle zu definieren, siehe Seite \pageref{par:greek_letters}. \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 diesem Befehl kann das einfach erreicht werden: -\begin{description} - \item \cmd{DeclareChemParticle}{<cmd>}\ma{<definition>} - \item \cmd{RenewChemParticle}{<cmd>}\ma{<definition>} -\end{description} -Abhängig von der \key{method}, die Sie als Option gewählt haben, wird die \texttt{<definition>} entweder mit \paket{mhchem} oder mit \chemformula erfolgen. Das Teilchen verhält sich wie die vordefinierten mit einer Ausnahme: das Teilchen, das auf diese Weise definiert wurde, gehorcht der Option \key{circled} nur, wenn Sie \key{method}{chemformula} gewählt haben. Wenn Sie mit \key{method}{mhchem} formale Ladungen wollen, müssen Sie \chemmacros' Befehle (siehe Abschnitt \ref{sec:ladungen}) explizit einsetzen. +\begin{beschreibung} + \Befehl{DeclareChemParticle}{<cmd>}\ma{<definition>} + \Befehl{RenewChemParticle}{<cmd>}\ma{<definition>} +\end{beschreibung} +Abhängig von der \key{method}, die Sie als Option gewählt haben, wird die \code{<definition>} entweder mit \paket{mhchem} oder mit \chemformula erfolgen. Das Teilchen verhält sich wie die vordefinierten mit einer Ausnahme: das Teilchen, das auf diese Weise definiert wurde, gehorcht der Option \key{circled} nur, wenn Sie \key{method}{chemformula} gewählt haben. Wenn Sie mit \key{method}{mhchem} formale Ladungen wollen, müssen Sie \chemmacros' Befehle (siehe Abschnitt \ref{sec:ladungen}) explizit einsetzen. \begin{beispiel} % uses the `upgreek' package \DeclareChemParticle{\positron}{$\upbeta$+} @@ -351,23 +396,36 @@ 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 von 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 \code{<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 \code{<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} \subsection{IUPAC-Namen}\secidx{IUPAC-Namen} Ähnlich wie das Paket \paket{bpchem} stellt \chemmacros einen Befehl\footnote{Die Idee und die Umsetzung stammt aus dem Paket \paket*{bpchem} von Bjørn Pedersen.} bereit, um \IUPAC-Namen zu setzen. Wieso ist das nützlich? \IUPAC-Namen können sehr lang werden. So lang, dass sie auch mal über mehr als zwei Zeilen gehen können, vor allem in zweispaltigen Dokumenten. Das bedeutet, sie müssen sich mehr als einmal umbrechen dürfen. Dabei hilft folgender Befehl: -\begin{description} - \item\cmd{iupac}{<IUPAC name>} Innerhalb dieses Befehls werden \cmd{\textbar} und \cmd{-} verwendet, um Umbruchstellen oder einen umbrechenden Bindestrich anzugeben. \cmd{\textasciicircum} kann als Abkürzung für\\ \lstinline=\textsuperscript=\footnote{Eigentlich verwendet \cmd{\textasciicircum} einen \chemformula-Befehl.} eingesetzt werden. -\end{description} +\begin{beschreibung} + \befehl{iupac}{<IUPAC name>} Innerhalb dieses Befehls werden \cmd{|} und \cmd{-} verwendet, um Umbruchstellen oder einen umbrechenden Bindestrich anzugeben. {\catcode`\^=11\cmd{^}} kann als Abkürzung für\\ \lstinline=\textsuperscript=\footnote{Tatsächlich wird ein anderer Mechanismus verwendet, das Ergebnis ist jedoch weitestgehend dasselbe.} eingesetzt werden. +\end{beschreibung} \begin{beispiel} \begin{minipage}{.4\linewidth} \iupac{Tetra\|cyclo[2.2.2.1\^{1,4}]\-un\|decane-2\-dodecyl\-5\-(hepta\|decyl\|iso\|dodecyl\|thio\|ester)} \end{minipage} \end{beispiel} -Der Befehl \cmd{iupac} ist dennoch mehr ein semantischer Befehl. Meistens kann man (beinahe) dasselbe erreichen, indem man \cmd{-} anstelle von \cmd{\textbar} verwendet, \texttt{-} anstelle von \cmd{-} und \lstinline=\textsuperscript= anstelle von \cmd{\textasciicircum}. +Der Befehl \cmd{iupac} ist dennoch mehr ein semantischer Befehl. Meistens kann man (beinahe) dasselbe erreichen, indem man \cmd{-} anstelle von \cmd{|} verwendet, \code{-} anstelle von \cmd{-} und \lstinline=\textsuperscript= anstelle von {\catcode`\^=11\cmd{^}}. + +Es gibt subtile Unterschiede: \cmd{-} fügt einen kleiner Leerraum vor dem Bindestrich ein und entfernt etwas Raum danach. Der Befehl \cmd{|} verhindert nicht nur Ligaturen, sondern fügt ebenfalls einen kleinen Leerraum ein. +\begin{beispiel} + \huge\iupac{2,4\-Di\|chlor\|pentan} \\ + 2,4-Dichlorpentan +\end{beispiel} + +Die eingefügten Leerräume können angepasst werden: +\begin{beschreibung} + \option[iupac]{hyphen-pre-space}{<dim>} Default = \code{.01em} + \option[iupac]{hyphen-post-space}{<dim>} Default = \code{-.03em} + \option[iupac]{break-space}{<dim>} Default = \code{.01em} +\end{beschreibung} -Der Befehl \cmd{iupac} dient noch einem anderen Zweck. Unabhängig von der Paketoption \key[option]{iupac} sind alle Befehle, die in diesem Abschnitt vorgestellt werden, \emph{innerhalb} von \cmd{iupac} immer definiert. Eine ganze Reihe der Nomenklatur-Befehle haben sehr allgemeine Namen: \cmd{meta}, \cmd{D}, \cmd{E}, \cmd{L}, \cmd{R}, \cmd{S}, \cmd{trans} und so weiter. Das bedeutet, dass sie entweder schon definiert sind (\cmd{L} \L) oder leicht von anderen Paketen oder Klassen definiert werden (das Paket \paket{cool} definiert zum Beispiel sowohl \cmd{D} als auch \cmd{E}). Um Ihnen Kontrolle darüber zu geben, welche Befehle wie definiert sind, gibt es die Paketoption \key[option]{iupac}\label{key:iupac}. Sie hat drei Modi: +Der Befehl \cmd{iupac} dient noch einem anderen Zweck. Unabhängig von der Paketoption \key[option]{iupac} sind alle Befehle, die in diesem Abschnitt vorgestellt werden, \emph{innerhalb} von \cmd{iupac} immer definiert. Eine ganze Reihe der Nomenklatur-Befehle haben sehr allgemeine Namen: \cmd{meta}, \cmd{D}, \cmd{E}, \cmd{L}, \cmd{R}, \cmd{S}, \cmd{trans} und so weiter. Das bedeutet, dass sie entweder schon definiert sind (\cmd{L} \L) oder leicht von anderen Paketen oder Klassen definiert werden (das Paket \paket{cool} definiert zum Beispiel sowohl \cmd{D} als auch \cmd{E}). Um Ihnen Kontrolle darüber zu geben, welche Befehle wie definiert sind, gibt es die Paketoption \key[option]{iupac}\label{desc:iupac}. Sie hat drei Modi: \begin{itemize} \item \key{iupac}{auto}: wenn der Befehl \emph{nicht} von einem Paket oder einer Klasse, die sie verwenden, definiert wird, ist er generell verfügbar, sonst nur \emph{innerhalb} von \cmd{iupac}. \item \key{iupac}{restricted}: alle Nomenklatur-Befehle sind \emph{nur} innerhalb von \cmd{iupac} definiert. Wenn sie von einem anderen Paket definiert sind, sind sie natürlich außerhalb verfügbar. Ansonsten sind sie außerhalb nicht definiert. @@ -390,13 +448,13 @@ Der Befehl \cmd{iupac} dient noch einem anderen Zweck. Unabhängig von der Paket \subsubsection{Vordefinierte Befehle}\secidx[vordefiniert]{IUPAC-Namen}\secidx{Stereodeskriptoren und Nomenklatur} \paragraph{Griechische Buchstaben}\label{par:greek_letters}\secidx[griechische Buchstaben]{IUPAC-Namen} Griechische Buchstaben in Verbindungsnamen werden aufrecht geschrieben. Dafür gibt es die Pakete \paket{upgreek} und \paket{textgreek}. Wenn Sie eines davon geladen haben, werden die folgenden Buchstaben aufrecht geschrieben: -\begin{description} - \item \cmd{a} \iupac{\a} - \item \cmd{b} \iupac{\b} - \item \cmd{g} \iupac{\g} - \item \cmd{d} \iupac{\d} - \item \cmd{w} \iupac{\w} -\end{description} +\begin{beschreibung} + \befehl{a} \iupac{\a} + \befehl{b} \iupac{\b} + \befehl{g} \iupac{\g} + \befehl{d} \iupac{\d} + \befehl{w} \iupac{\w} +\end{beschreibung} \begin{beispiel} \iupac{5\a\-androstan\-3\b\-ol} \\ \iupac{\a\-(tri\|chloro\|methyl)\-\w\-chloro\|poly(1,4\-phenylene\|methylene)} @@ -404,13 +462,13 @@ Griechische Buchstaben in Verbindungsnamen werden aufrecht geschrieben. Dafür g \paragraph{Heteroatome und addierter Wasserstoff}\secidx[Heteroatome]{IUPAC-Namen} Bindungen an Heteroatome und addierter Wasserstoff werden durch kursive Buchstaben dargestellt \cite{iupac:greenbook}. \chemmacros definiert ein paar Abkürzungen dafür: -\begin{description} - \item \cmd{H} \iupac{\H} - \item \cmd{O} \iupac{\O} - \item \cmd{N} \iupac{\N} - \item \cmd{Sf} \iupac{\Sf} - \item \cmd{P} \iupac{\P} -\end{description} +\begin{beschreibung} + \befehl{H} \iupac{\H} + \befehl{O} \iupac{\O} + \befehl{N} \iupac{\N} + \befehl{Sf} \iupac{\Sf} + \befehl{P} \iupac{\P} +\end{beschreibung} \begin{beispiel} \iupac{\N\-methyl\|benz\|amide} \\ \iupac{3\H\-pyrrole} \\ @@ -418,44 +476,44 @@ Bindungen an Heteroatome und addierter Wasserstoff werden durch kursive Buchstab \end{beispiel} \paragraph{Cahn-Ingold-Prelog}\index{Cahn-Ingold-Prelog}\secidx[Cahn-Ingold-Prelog]{IUPAC-Namen} -\begin{description} - \item \cmd{cip}{<conf>} \zB: \cmd{cip}{R,S} \cip{R,S} - \item \cmd{R} \iupac{\R} - \item \cmd{S} \iupac{\S} -\end{description} +\begin{beschreibung} + \befehl{cip}{<conf>} \zB: \cmd{cip}{R,S} \cip{R,S} + \befehl{R} \iupac{\R} + \befehl{S} \iupac{\S} +\end{beschreibung} Da der Befehl \cmd{S} schon eine andere Bedeutung hat (\S), ist er in der Voreinstellung nur innerhalb \cmd{iupac} verfügbar. \paragraph{Fischer}\index{Fischer}\secidx[Fischer]{IUPAC-Namen} -\begin{description} - \item \cmd{D} \iupac{\D} - \item \cmd{L} \iupac{\L} -\end{description} +\begin{beschreibung} + \befehl{D} \iupac{\D} + \befehl{L} \iupac{\L} +\end{beschreibung} Da der Befehl \cmd{L} schon eine andere Bedeutung hat (\L), ist er in der Voreinstellung nur innerhalb \cmd{iupac} verfügbar. \paragraph{cis/trans, zusammen/entgegen, syn/anti \& tert}\index{tert}\secidx[tert]{IUPAC-Namen}\index{cis/trans}\secidx[cis/trans]{IUPAC-Namen}\index{zusammen/entgegen}\secidx[zusammen/entgegen]{IUPAC-Namen}\secidx[syn/anti]{IUPAC Namen} -\begin{description} - \item \cmd{cis} \cis - \item \cmd{trans} \trans - \item \cmd{Z} \Z - \item \cmd{E} \E - \item \cmd{syn} \syn - \item \cmd{anti} \anti - \item \cmd{tert} \tert -\end{description} -Das Paket \paket{cool} definiert die Befehle \cmd{E} und \cmd{D} ebenfalls. Wenn Sie es laden, ist die \chemmacros-Version in der Voreinstellung nur innerhalb von \cmd{iupac} verfügbar. +\begin{beschreibung} + \befehl{cis} \cis + \befehl{trans} \trans + \befehl{Z} \Z + \befehl{E} \E + \befehl{syn} \syn + \befehl{anti} \anti + \befehl{tert} \tert +\end{beschreibung} +Das Paket \paket{cool} beispielsweise definiert die Befehle \cmd{E} und \cmd{D} ebenfalls. Wenn Sie es laden, ist die \chemmacros-Version in der Voreinstellung nur innerhalb von \cmd{iupac} verfügbar. \paragraph{ortho/meta/para}\index{ortho/meta/para}\secidx[ortho/meta/para]{IUPAC-Namen} -\begin{description} - \item \cmd{ortho} \ortho - \item \cmd{meta} \meta - \item \cmd{para} \para -\end{description} +\begin{beschreibung} + \befehl{ortho} \ortho + \befehl{meta} \meta + \befehl{para} \para +\end{beschreibung} \paragraph{Absolute Konfiguration}\index{Absolute Konfiguration} (verwendet \TikZ) -\begin{description} - \item \cmd{Rconf}[<letter>] \cmd{Rconf}: \Rconf \quad\cmd{Rconf}[]: \Rconf[] - \item \cmd{Sconf}[<letter>] \cmd{Sconf}: \Sconf \quad\cmd{Sconf}[]: \Sconf[] -\end{description} +\begin{beschreibung} + \befehl{Rconf}[<letter>] \cmd{Rconf}: \Rconf \quad\cmd{Rconf}[]: \Rconf[] + \befehl{Sconf}[<letter>] \cmd{Sconf}: \Sconf \quad\cmd{Sconf}[]: \Sconf[] +\end{beschreibung} Beispiele: \begin{beispiel} @@ -473,14 +531,13 @@ Beispiele: \subsubsection{Eigene Nomenklatur-Befehle}\secidx[eigene]{IUPAC-Namen} Wenn Ihnen Befehle fehlen sollten, können Sie neue definieren. -\begin{description} - \item \cmd{DeclareChemIUPAC}{<cmd>}\ma{<declaration>} - \item \cmd{RenewChemIUPAC}{<cmd>}\ma{<declaration>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemIUPAC}{<cmd>}\ma{<declaration>} + \Befehl{RenewChemIUPAC}{<cmd>}\ma{<declaration>} +\end{beschreibung} Ein Befehl, der in dieser Weise definiert wurde, gehorcht der Option \key[option]{iupac}. Das bedeutet, dass bestehende Befehle nur überschrieben werden, wenn Sie die Paketoption \key{iupac}{strict} verwenden. \cmd{DeclareChemIUPAC} wird jedoch die Definition eines bestehenden Nomenklatur-Befehls \emph{nicht} überschreiben, sondern eine Warnung/einen Fehler melden (abhängig von der Paketoption \key{strict}). \begin{beispiel} - % uses the `upgreek' package - \DeclareChemIUPAC\hapto{$\upeta$} + \DeclareChemIUPAC\hapto{\Chemeta} Ferrocen = \iupac{Bis(\hapto\^5\-cyclo\|penta\|dienyl)eisen} \end{beispiel} @@ -494,13 +551,13 @@ Ein Befehl, der in dieser Weise definiert wurde, gehorcht der Option \key[option \subsection{Lateinische Ausdrücke}\secidx{Lateinische Ausdrücke}[Lateinische Ausdruecke] Das Paket \paket{chemstyle} stellt den Befehl \cmd{latin} bereit, um gebräuchliche lateinische Ausdrücke konsistent darzustellen. \chemmacros definiert ein ähnliches \cmd{latin}, aber nur, wenn \paket{chemstyle} \emph{nicht} geladen wurde, und stellt zusätzlich diese Befehle bereit: -\begin{description} - \item \cmd{insitu} \insitu - \item \cmd{abinitio} \abinitio - \item \cmd{invacuo} \invacuo -\end{description} +\begin{beschreibung} + \befehl{insitu} \insitu + \befehl{abinitio} \abinitio + \befehl{invacuo} \invacuo +\end{beschreibung} -Falls das Paket \paket{chemstyle} geladen wurde, wurden sie mit \paket{chemstyle}s Befehl \lstinline+\latin+ definiert. Das bedeutet, dass ihr Erscheinungsbild von der \paket{chemstyle} Option \texttt{abbremph} abhängen: +Falls das Paket \paket{chemstyle} geladen wurde, wurden sie mit \paket{chemstyle}s Befehl \lstinline+\latin+ definiert. Das bedeutet, dass ihr Erscheinungsbild von der \paket{chemstyle} Option \code{abbremph} abhängen: \begin{beispiel} \insitu, \abinitio\\ \cstsetup{abbremph=false} @@ -508,67 +565,65 @@ Falls das Paket \paket{chemstyle} geladen wurde, wurden sie mit \paket{chemstyle \end{beispiel} Die Makros wurden mit folgendem Befehl definiert: -\begin{description} - \item \cmd{DeclareChemLatin}{<cmd>}\ma{<phrase>} - \item \cmd{RenewChemLatin}{<cmd>}\ma{<phrase>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemLatin}{<cmd>}\ma{<phrase>} + \Befehl{RenewChemLatin}{<cmd>}\ma{<phrase>} +\end{beschreibung} \begin{beispiel} \DeclareChemLatin\ltn{latin text} \ltn \cstsetup{abbremph=false} \ltn \end{beispiel} Wenn Sie \paket{chemstyle} \emph{nicht} geladen haben, können Sie das Erscheinungsbild mit dieser Option anpassen: -\begin{description} - \item \key[latin]{format}{<definition>} Default = \lstinline+\itshape+ -\end{description} +\begin{beschreibung} + \option[latin]{format}{<definition>} Default = \lstinline+\itshape+ +\end{beschreibung} \secidx*{Lateinische Ausdrücke}[Lateinische Ausdruecke] \section{Einheiten für die Verwendung mit \textsf{siunitx}}\label{sec:einheiten}\secidx{Einheiten} In der Chemie sind einige nicht-SI-Einheiten sehr verbreitet. Das Paket \paket{siunitx} stellt den Befehl \lstinline+\DeclareSIUnit{<command>}{<unit>}+ zur Verfügung, um beliebige Einheiten zu definieren. \chemmacros verwendet diesen Befehl um die unten gelisteten Einheiten zu definieren. Wie alle \paket{siunitx}-Einheiten sind sie nur innerhalb von \lstinline+\SI{<num>}{<unit>}+ und \lstinline+\si{<unit>}+ gültig. -\begin{description} - \item \cmd{atmosphere} \si{\atmosphere} - \item \cmd{atm} \si{\atm} - \item \cmd{calory} \si{\calory} - \item \cmd{cal} \si{\cal} - \item \cmd{cmc} \si{\cmc} Die Einheiten \cmd{cmc}, \cmd{molar} und \cmd{Molar} werden durch das Paket \paket{chemstyle} ebenfalls definiert. \chemmacros definiert sie nur, wenn \paket{chemstyle} nicht geladen wurde. - \item \cmd{molar} \si{\molar} - \item \cmd{moLar} \si{\moLar} - \item \cmd{Molar} \si{\Molar} - \item \cmd{MolMass} \si{\MolMass} - \item \cmd{normal} \si{\normal} - \item \cmd{torr} \si{\torr} -\end{description} +\begin{beschreibung} + \befehl{atmosphere} \si{\atmosphere} + \befehl{atm} \si{\atm} + \befehl{calory} \si{\calory} + \befehl{cal} \si{\cal} + \befehl{cmc} \si{\cmc} Die Einheiten \cmd{cmc}, \cmd{molar} und \cmd{Molar} werden durch das Paket \paket{chemstyle} ebenfalls definiert. \chemmacros definiert sie nur, wenn \paket{chemstyle} nicht geladen wurde. + \befehl{molar} \si{\molar} + \befehl{moLar} \si{\moLar} + \befehl{Molar} \si{\Molar} + \befehl{MolMass} \si{\MolMass} + \befehl{normal} \si{\normal} + \befehl{torr} \si{\torr} +\end{beschreibung} Übrigens: \lstinline+\mmHg+ \si{\mmHg} wird durch \paket{siunitx} und \paket{chemstyle} bereitgestellt. \secidx*{Einheiten} \section{Säure/Base}\label{sec:saeure_base}\secidx{Säure/Base}[Saeure/Base] -Einfache Darstellung von \pH, \pKa \ldots (der Befehl \cmd{pKa} hängt von der Paketoption \key[option]{german} ab, siehe Abschnitt \ref{sec:optionen}.) -\begin{description} - \item \cmd{pH} \pH - \item \cmd{pOH} \pOH - \item \cmd{Ka} \Ka - \item \cmd{Kb} \Kb - \item \cmd{Kw} \Kw - \item \cmd{pKa}[<num>] \cmd{pKa}: \pKa, \cmd{pKa}[1]: \pKa[1] - \item \cmd{pKb}[<num>] \cmd{pKb}: \pKb, \cmd{pKb}[1]: \pKb[1] - \item \cmd{p}{<anything>} \zB: \cmd{p}{\cmd{Kw}} \p{\Kw} -\end{description} +Einfache Darstellung von \pH, \pKa \ldots (der Befehl \cmd{pKa} hängt von der Paketoption \key{language} ab). +\begin{beschreibung} + \befehl{pH} \pH + \befehl{pOH} \pOH + \befehl{Ka} \Ka + \befehl{Kb} \Kb + \befehl{Kw} \Kw + \befehl{pKa}[<num>] \cmd{pKa}: \pKa, \cmd{pKa}[1]: \pKa[1] + \befehl{pKb}[<num>] \cmd{pKb}: \pKb, \cmd{pKb}[1]: \pKb[1] + \befehl{p}{<anything>} \zB: \cmd{p}{\cmd{Kw}} \p{\Kw} +\end{beschreibung} \begin{beispiel} - \Ka \Kb \pKa \pKa[1] \pKb \pKb[1]\\ - \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}] +\begin{zitat}[\IUPAC Green Book \cite[][p.\,103]{iupac:greenbook}] The operator \p{} […] shall be printed in Roman type. -\end{myquote} +\end{zitat} 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{beschreibung} + \option[acid-base]{p-style}{italics/slanted/upright} Default = \code{upright} +\end{beschreibung} \begin{beispiel} \pH, \pKa @@ -579,13 +634,14 @@ Es gibt eine Option, die den Stil, in dem das \p{} dargestellt wird, ändert: \secidx*{Säure/Base}[Saeure/Base] \section{Oxidationszahlen, reale und formale Ladungen}\label{sec:ladungen} -\chemmacros unterscheidet zwischen realen ($+$/$-$) und formalen (\fplus/\fminus) Ladungssymbolen, siehe auch Abschnitt \ref{sec:optionen}. Alle Befehle, die formale Ladungen ausgeben, startem mit einem \texttt{f}. +\chemmacros unterscheidet zwischen realen ($+$/$-$) und formalen (\fplus/\fminus) Ladungssymbolen, siehe auch Abschnitt \ref{sec:optionen}. Alle Befehle, die formale Ladungen ausgeben, startem mit einem \code{f}. + \subsection{Ionenladungen}\label{ssec:ionen}\secidx{Ionenladungen} Einfache Verwendung von (realen) Ladungen: -\begin{description} - \item \cmd{pch}[<number>] positive Ladung (\textbf{p}lus + \textbf{ch}arge) - \item \cmd{mch}[<number>] negative Ladung (\textbf{m}inus + \textbf{ch}arge) -\end{description} +\begin{beschreibung} + \befehl{pch}[<number>] positive Ladung (\textbf{p}lus + \textbf{ch}arge) + \befehl{mch}[<number>] negative Ladung (\textbf{m}inus + \textbf{ch}arge) +\end{beschreibung} \begin{beispiel} \pch, Na\pch, Ca\pch[2]\\ @@ -593,19 +649,19 @@ Einfache Verwendung von (realen) Ladungen: \end{beispiel} Das gleiche für formale Ladungen: -\begin{description} - \item \cmd{fpch}[<number>] positive Ladung - \item \cmd{fmch}[<number>] negative Ladung -\end{description} +\begin{beschreibung} + \befehl{fpch}[<number>] positive Ladung + \befehl{fmch}[<number>] negative Ladung +\end{beschreibung} \begin{beispiel} \fpch\ \fmch\ \fpch[3] \fmch[3] \end{beispiel} Es gibt eine Option, die das Verhalten der Ladungen beeinflusst: -\begin{description} - \item \key[charges]{append}{\uline{true}/false} Wenn auf \texttt{true} gesetzt, wird die Ladung mit einer leeren Gruppe angehängt. Default = \texttt{false} -\end{description} +\begin{beschreibung} + \option[charges]{append}{\default{true}/false} Wenn auf \code{true} gesetzt, wird die Ladung mit einer leeren Gruppe angehängt. Default = \code{false} +\end{beschreibung} Das hat folgende Auswirkungen: \begin{beispiel} @@ -629,22 +685,22 @@ In den meisten Fällen wird das Verhalten unerwünscht sein, es kann jedoch Gele \subsection{Oxidationszahlen}\label{ssec:oxidationszahlen}\secidx{Oxidationszahlen} Eingabe von Oxidationszahlen: -\begin{description} - \item \cmd{ox}[<keyval>]{<number>,<atom>} setzt \texttt{<number>} über \texttt{<atom>}; \texttt{<number>} muss eine (rationale) Zahl sein! -\end{description} +\begin{beschreibung} + \befehl{ox}[<options>]{<number>,<atom>} setzt \code{<number>} über \code{<atom>}; \code{<number>} muss eine (rationale) Zahl sein! +\end{beschreibung} \begin{beispiel} \ox{+1,Na}, \ox{2,Ca}, \ox{-2,S}, \ox{-1,F} \end{beispiel} Es gibt eine Reihe von Optionen, mit denen \cmd{ox} angepasst werden kann. -\begin{description} - \item \key[ox]{parse}{\uline{true}/false} Wenn \texttt{false}, dann kann ein beliebiger Eintrag für \texttt{<number>} gemacht werden. Default = \texttt{true} - \item \key[ox]{roman}{\uline{true}/false} schaltet von römischen auf arabische Ziffern um. Default = \texttt{true} - \item \key[ox]{pos}{top/super/side}; \texttt{top} setzt \texttt{<number>} über \texttt{<atom>}, \texttt{super} rechts oben als Hochstellung und \texttt{side} rechts daneben in Klammern. Default = \texttt{top} - \item \key[ox]{explicit-sign}{\uline{true}/false} gibt $+$ für positive Zahlen und $\pm$ für die $0$ aus. Default = \texttt{false} - \item \key[ox]{decimal-marker}{comma/point} Wahl des Dezimalzeichens für Oxidationszahlen wie \ox{1.2,X}. Default = \texttt{point} -\end{description} +\begin{beschreibung} + \option[ox]{parse}{\default{true}/false} Wenn \code{false}, dann kann ein beliebiger Eintrag für \code{<number>} gemacht werden. Default = \code{true} + \option[ox]{roman}{\default{true}/false} schaltet von römischen auf arabische Ziffern um. Default = \code{true} + \option[ox]{pos}{top/super/side}; \code{top} setzt \code{<number>} über \code{<atom>}, \code{super} rechts oben als Hochstellung und \code{side} rechts daneben in Klammern. Default = \code{top} + \option[ox]{explicit-sign}{\default{true}/false} gibt $+$ für positive Zahlen und $\pm$ für die $0$ aus. Default = \code{false} + \option[ox]{decimal-marker}{comma/point} Wahl des Dezimalzeichens für Oxidationszahlen wie \ox{1.2,X}. Default = \code{point} +\end{beschreibung} \begin{beispiel} \ox[roman=false]{2,Ca} \ox{2,Ca} \\ @@ -690,12 +746,12 @@ Natürlich können Sie sie nach Ihren Vorstellungen umdefinieren. \subsection{Partialladungen und Ähnliches}\label{ssec:partialladungen}\secidx{Partialladungen} Vielleicht selten genutzt, manchmal aber praktisch: -\begin{description} - \item \cmd{delp} \delp\ (\textbf{del}ta + \textbf{p}lus) - \item \cmd{delm} \delm\ (\textbf{del}ta + \textbf{m}inus) - \item \cmd{fdelp} \fdelp - \item \cmd{fdelm} \fdelm -\end{description} +\begin{beschreibung} + \befehl{delp} \delp\ (\textbf{del}ta + \textbf{p}lus) + \befehl{delm} \delm\ (\textbf{del}ta + \textbf{m}inus) + \befehl{fdelp} \fdelp + \befehl{fdelm} \fdelm +\end{beschreibung} Ein Beispiel mit dem Befehl \cmd{ox} oder mit dem Paket \paket{chemfig}: \begin{beispiel} @@ -708,14 +764,14 @@ Ein Beispiel mit dem Befehl \cmd{ox} oder mit dem Paket \paket{chemfig}: \end{beispiel} Auch diese Makros lassen sich gut mit \paket{chemfig} einsetzen. -\begin{description} - \item \cmd{scrp} \scrp (\textbf{scr}iptstyle + \textbf{p}lus) - \item \cmd{scrm} \scrm (\textbf{scr}iptstyle + \textbf{m}inus) - \item \cmd{fscrp} \fscrp - \item \cmd{fscrm} \fscrm - \item \cmd{fsscrp} \fsscrp (verwendet \lstinline+\scriptscriptstyle+) - \item \cmd{fsscrm} \fsscrm -\end{description} +\begin{beschreibung} + \befehl{scrp} \scrp\ (\textbf{scr}iptstyle + \textbf{p}lus) + \befehl{scrm} \scrm\ (\textbf{scr}iptstyle + \textbf{m}inus) + \befehl{fscrp} \fscrp + \befehl{fscrm} \fscrm + \befehl{fsscrp} \fsscrp\ (verwendet \lstinline+\scriptscriptstyle+) + \befehl{fsscrm} \fsscrm +\end{beschreibung} \begin{beispiel} \setatomsep{1.8em}\chemfig{CH_3-\chemabove{C}{\scrp}(-[6]C|H_3)-\vphantom{H_3}CH_3} @@ -726,105 +782,112 @@ Auch diese Makros lassen sich gut mit \paket{chemfig} einsetzen. \section{Reaktionsmechanismen}\label{sec:mechanismen}\secidx{Reaktionsmechanismen} Mit dem Befehl -\begin{description} - \item\cmd{mech}[<type>] -\end{description} -kann man die verbreitetsten Reaktionsmechanismen spezifizieren. \texttt{<type>} kann einen der folgenden Werte annehmen: -\begin{itemize} - \item\cmd{mech} (leer, kein opt.\@ Argument) nukleophile Substitution \mech - \item\cmd{mech}[1] unimolekulare nukleophile Substitution \mech[1] - \item\cmd{mech}[2] bimolekulare nukleophile Substitution \mech[2] - \item\cmd{mech}[se] elektrophile Substitution \mech[se] - \item\cmd{mech}[1e] unimolekulare elektrophile Substitution \mech[1e] - \item\cmd{mech}[2e] bimolekulare elektrophile Substitution \mech[2e] - \item\cmd{mech}[ar] elektrophile aromatische Substitution \mech[ar] - \item\cmd{mech}[e] Eliminierung \mech[e] - \item\cmd{mech}[e1] unimolekulare Eliminierung \mech[e1] - \item\cmd{mech}[e2] bimolekulare Eliminierung \mech[e2] - \item\cmd{mech}[cb] unimolekulare Eliminierung \enquote{conjugated base}, \dh via Carbanion \mech[cb] -\end{itemize} +\begin{beschreibung} + \Befehl{mech}[<type>] +\end{beschreibung} +kann man die verbreitetsten Reaktionsmechanismen spezifizieren. \code{<type>} kann einen der folgenden Werte annehmen: +\begin{beschreibung} + \befehl{mech} (leer, kein opt.\@ Argument) nukleophile Substitution \mech + \befehl{mech}[1] unimolekulare nukleophile Substitution \mech[1] + \befehl{mech}[2] bimolekulare nukleophile Substitution \mech[2] + \befehl{mech}[se] elektrophile Substitution \mech[se] + \befehl{mech}[1e] unimolekulare elektrophile Substitution \mech[1e] + \befehl{mech}[2e] bimolekulare elektrophile Substitution \mech[2e] + \befehl{mech}[ar] elektrophile aromatische Substitution \mech[ar] + \befehl{mech}[e] Eliminierung \mech[e] + \befehl{mech}[e1] unimolekulare Eliminierung \mech[e1] + \befehl{mech}[e2] bimolekulare Eliminierung \mech[e2] + \befehl{mech}[cb] unimolekulare Eliminierung \enquote{conjugated base}, \dh via Carbanion \mech[cb] +\end{beschreibung} \secidx*{Reaktionsmechanismen} -\section{Redoxreaktionen}\label{sec:redoxreaktionen}\secidx{Redoxreaktionen} +\section{Redoxreaktionen}\label{sec:redoxreaktionen}\secidx{Redoxreaktionen}% TODO: watch pagebreaks! \chemmacros stellt zwei Befehle zur Verfügung, mit denen die Übertragung von Elektronen in Redoxreaktionen angezeigt werden kann\footnote{Dank an \href{http://www.mathannotated.com/}{Peter Cao}, der dieses Feature vorgeschlagen hat.}. Beide Befehle verwenden \TikZ. -\begin{description} - \item \cmd{OX}{<name>,<atom>} - \item \cmd{redox}(<name1>,<name2>)[<tikz>][<num>]{<text>} Lediglich das erste Argument \da{<name1>,<name2>} wird benötigt, die anderen sind optional. -\end{description} +\begin{beschreibung} + \Befehl{OX}{<name>,<atom>} + \Befehl{redox}(<name1>,<name2>)[<tikz>]\oa{<num>}\ma{<text>} \cnpkgdocarrow\ Lediglich das erste Argument\\\da{<name1>,<name2>} wird benötigt, die anderen sind optional. +\end{beschreibung} -\cmd{OX} setzt \texttt{<atom>} in einen Knoten (eine \enquote{Node}) mit dem Namen \texttt{<name>}. Wenn Sie zwei \cmd{OX} verwendet haben, dann können sie mit \cmd{redox} verbunden werden. Die Namen der zu verbindenden Knoten werden in runde Klammern geschrieben. Da \cmd{redox} ein Tikzpicture mit den Optionen \texttt{remember picture,overlay} erstellt, muss das Dokument \emph{wenigstens zwei mal} kompiliert werden. -\begin{beispiel}[ox] +\cmd{OX} setzt \code{<atom>} in einen Knoten (eine \enquote{Node}) mit dem Namen \code{<name>}. Wenn Sie zwei \cmd{OX} verwendet haben, dann können sie mit \cmd{redox} verbunden werden. Die Namen der zu verbindenden Knoten werden in runde Klammern geschrieben. Da \cmd{redox} ein Tikzpicture mit den Optionen \code{remember picture,overlay} erstellt, muss das Dokument \emph{wenigstens zwei mal} kompiliert werden. +\begin{beispiel}[dist] \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b){oxidation} \end{beispiel} Diese Linie kann mit \TikZ-Keys in \oa{<tikz>} angepasst werden: -\begin{beispiel}[ox] +\begin{beispiel}[dist] \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b)[->,red]{ox} \end{beispiel} -Mit dem Argument \oa{<num>} kann die Länge der vertikalen Linien angepasst werden. Die Voreinstellung beträgt \texttt{.6em}. Diese Länge wird mit \texttt{<num>} multipliziert. Ein negativer Wert wird die Linie \emph{unter} den Text setzen. -\begin{beispiel}[ox] +Mit dem Argument \oa{<num>} kann die Länge der vertikalen Linien angepasst werden. Die Voreinstellung beträgt \code{.6em}. Diese Länge wird mit \code{<num>} multipliziert. Ein negativer Wert wird die Linie \emph{unter} den Text setzen. +\begin{beispiel}[dist] \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch \redox(a,b)[->,red]{ox} \redox(a,b)[<-,blue][-1]{red} + \vspace{7mm} \end{beispiel} +\newpage Die Voreinstellung der vertikalen Linien kann mit -\begin{description} - \item \key[redox]{dist}{<dim>} Default = \texttt{.6em} -\end{description} +\begin{beschreibung} + \option[redox]{dist}{<dim>} Default = \code{.6em} +\end{beschreibung} angepasst werden: -\begin{beispiel}[ox] +\begin{beispiel}[dist] \chemsetup{redox/dist=1em} \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b)[->,red]{ox} \end{beispiel} Zusätzlich erlaubt die Option -\begin{description} - \item\key[redox]{sep}{<dim>} Default = \texttt{.2em} -\end{description} +\begin{beschreibung} + \option[redox]{sep}{<dim>} Default = \code{.2em} +\end{beschreibung} den Abstand zwischen Atom und Anfang der Linie zu verändern. -\begin{beispiel}[ox] +\begin{beispiel}[dist] \chemsetup{redox/sep=.5em} \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b)[->,red]{ox} \end{beispiel} -Beispiele: -\begin{beispiel}[ox] +Beispiele:% TODO: watch pagebreaks! +\begin{beispiel}[dist] \ch{ 2 "\OX{o1,Na}" + "\OX{r1,Cl}" {}2 -> 2 "\OX{o2,Na}" \pch{} + 2 "\OX{r2,Cl}" \mch } \redox(o1,o2){\small OX: $- 2\el$} \redox(r1,r2)[][-1]{\small RED: $+ 2\el$} + \vspace{7mm} \end{beispiel} -\begin{beispiel}[ox] + +\begin{beispiel}[dist] \ch{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } \redox(o1,o2){\small OX: $- 2\el$} \redox(r1,r2)[][-1]{\small RED: $+ 2\el$} + \vspace{7mm} \end{beispiel} -\bspmidlength{ox}{15mm} -\begin{beispiel}[ox] +\newpage +\bspmidlength{dist}{15mm} +\begin{beispiel}[dist] \ch{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } \redox(o1,o2)[draw=red,->][3.33]{\small OX: $- 2\el$} \redox(r1,r2)[draw=blue,->]{\small RED: $+ 2\el$} - \end{beispiel} -\bspmidlength{ox}{7mm} - \begin{beispiel}[ox] +\end{beispiel} +\bspmidlength{dist}{7mm} + \begin{beispiel}[dist] \ch{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } \redox(o1,o2)[green,-stealth]{\small OX} \redox(r1,r2)[purple,-stealth][-1]{\small RED} + \vspace{7mm} \end{beispiel} \secidx*{Redoxreaktionen} \section{(Standard) Zustand, Thermodynamik}\label{sec:standardstate}\secidx{Thermodynamik} \subsection{Thermodynamische Größen}\label{ssec:siunitx} Die folgenden Befehle verwenden \paket{siunitx}: -\begin{description} - \item \cmd{Enthalpy}[<keyval>](<subscript>){<value>} - \item \cmd{Entropy}[<keyval>](<subscript>){<value>} - \item \cmd{Gibbs}[<keyval>](<subscript>){<value>} -\end{description} +\begin{beschreibung} + \Befehl{Enthalpy}[<options>]\da{<subscript>}\ma{<value>} + \Befehl{Entropy}[<options>]\da{<subscript>}\ma{<value>} + \Befehl{Gibbs}[<options>]\da{<subscript>}\ma{<value>} +\end{beschreibung} Ihre Verwendung ist ziemlich selbsterklärend: \begin{beispiel} @@ -835,12 +898,12 @@ Ihre Verwendung ist ziemlich selbsterklärend: Das Argument \da{<subscript>} Fügt eine Tiefstellung zur Spezifizierung hinzu: \cmd{Enthalpy}(r){123} \Enthalpy(r){123}. Die Befehle können mit mehreren Optionen angepasst werden: -\begin{description} - \item \key*{exponent}{<anything>} - \item \key*{delta}{<anything>/false} - \item \key*{subscript}{left/right} - \item \key*{unit}{<unit>} -\end{description} +\begin{beschreibung} + \Option*{exponent}{<anything>} + \Option*{delta}{<anything>/false} + \Option*{subscript}{left/right} + \Option*{unit}{<unit>} +\end{beschreibung} Die Voreinstellung hängt vom jeweiligen Befehl ab: \begin{beispiel} @@ -858,9 +921,9 @@ 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>}\ma{<symbol>}\ma{<unit>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemState}[<options>]{<name>}\ma{<symbol>}\ma{<unit>} +\end{beschreibung} können neue Größen definiert werden. \begin{beispiel} \DeclareChemState{Helmholtz}{A}{\kilo\joule\per\mole} @@ -871,18 +934,18 @@ können neue Größen definiert werden. \end{beispiel} Dieser Befehl hat fast die gleichen Optionen, wie die Größen selbst, mit denen die Voreinstellung für die neue Größe festgelegt werden können. -\begin{description} - \item \key*{exponent}{<anything>} - \item \key*{delta}{<anything>/false} - \item \key*{subscript-left}{true/false} - \item \key*{subscript}{<anything>} -\end{description} +\begin{beschreibung} + \Option*{exponent}{<anything>} + \Option*{delta}{<anything>/false} + \Option*{subscript-left}{true/false} + \Option*{subscript}{<anything>} +\end{beschreibung} \subsubsection{Größen umdefinieren} Mit -\begin{description} - \item \cmd{RenewChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} -\end{description} +\begin{beschreibung} + \Befehl{RenewChemState}[<options>]{<name>}\ma{<symbol>}\ma{<unit>} +\end{beschreibung} kann man bestehende Größen umdefinieren: \begin{beispiel} @@ -900,9 +963,9 @@ Man könnte also \textendash\ um thermodynamischen Konventionen zu folgen \texte \subsection{Zustandsgrößen}\label{ssec:state} Die Befehle, die in Abschnitt \ref{ssec:siunitx} vorgestellt wurden, verwenden intern den Befehl\footnote{Beachten Sie, dass \ma{<subscript>} ein \emph{optionales} Argument ist.} -\begin{description} - \item \cmd{State}[<keyval>]{<symbol>}\ma{<subscript>} -\end{description} +\begin{beschreibung} + \Befehl{State}[<options>]{<symbol>}\ma{<subscript>} +\end{beschreibung} Er kann verwendet werden, um die Größen ohne Wert und Einheit zu schreiben. Beispiele: @@ -911,19 +974,25 @@ Beispiele: \end{beispiel} Wieder hat er (fast) die gleichen Optionen: -\begin{description} +\begin{beschreibung} \item \key[state]{exponent}{<anything>} \item \key[state]{subscript-left}{true/false} \item \key[state]{delta}{<anything>/false} -\end{description} +\end{beschreibung} \secidx*{Thermodynamik} -\section{Spektroskopie}\label{sec:spektroskopie}\secidx{Spektroskopie} -Wenn Substanzen darauf untersucht werden, ob sie sind, was sie sein sollen, wird oft die NMR Spektroskopie eingesetzt. Die Messergebnisse werden dann etwa so aufgeschrieben:\\\NMR(400)[CDCl3] = \num{1.59}\ldots\\\chemmacros stellt einen Befehl zur Verfügung, der das vereinfacht (verwendet \paket{siunitx}). -\begin{description} - \item \cmd{NMR}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} - \item \cmd{NMR*}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} -\end{description} +\section{Spektroskopie und Messdaten}\label{sec:spektroskopie}\secidx{Spektroskopie} +\subsection{Der \code{\textbackslash\textcolor{code}{NMR}}-Befehl} +Wenn Substanzen darauf untersucht werden, ob sie sind, was sie sein sollen, wird oft die NMR Spektroskopie eingesetzt. Die Messergebnisse werden dann etwa so aufgeschrieben: +\begin{center} + \NMR(400)[CDCl3] = \num{1.59} +\end{center} +\chemmacros stellt einen Befehl zur Verfügung, der das vereinfacht (verwendet \paket{siunitx}). + +\begin{beschreibung} + \Befehl{NMR}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} + \Befehl{NMR*}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} +\end{beschreibung} \emph{Alle} Argumente sind optional! Ohne Argumente\footnote{Alle Argumente können beliebig kombiniert werden.Der Befehl kann auch im Mathematik-Modus eingesetzt werden.} erhalten wir: \begin{beispiel} @@ -954,28 +1023,201 @@ Mit dem dritten Befehl schließlich kann das Lösungsmittel angegeben werden: \NMR[CDCl3] \end{beispiel} -Die Optionen -\begin{description} - \item\key[nmr]{unit}{<unit>} Default = \lstinline=\mega\hertz= - \item\key[nmr]{nucleus}{\ma{<num>,<elem>}} Default = \ma{1,H} -\end{description} -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, 1\ch{H}, \textit{J} = \SI{11.6}{\hertz}, H-4) -\end{beispiel} +\subsection{Abkürzungen} +Da man verschiedene Kerne in einem Dokument eventuell häufiger benötigt, bietet \chemmacros eine Möglichkeit, Abkürzungen zu definieren. +\begin{beschreibung} + \Befehl{DeclareChemNMR}{<csname>}\ma{<num>,<atom>} + \Befehl{RenewChemNMR}{<csname>}\ma{<num>,<atom>} +\end{beschreibung} +Das definiert einen Befehl mit denselben Argumenten wie \cmd{NMR}, \emph{außer} \ma{<num>,<atom>}. +\begin{beispiel} + \DeclareChemNMR\HNMR{1,H}% + \DeclareChemNMR\CNMR{13,C}% + \CNMR*(100) \\ + \HNMR*(400) +\end{beispiel} + +\subsection{Eine Umgebung, um Messergebnisse darzustellen} +Um ein bequemes Eingeben von Messergebnissen zu ermöglichen, bietet \chemmacros eine Umgebung. +\begin{beschreibung}\catcode`\#=11 + \umg{experimental}{Daten} Umgebung für die Ausgabe von Ex\-pe\-ri\-men\-tal-Daten. Innerhalb dieser Umgebung sind die folgenden Befehle definiert. + \Befehl{data}{<Typ>}\oa{<Spezifikation>} \cnpkgdocarrow\ Typ der Daten, \zB\ IR, MS\ldots\ In das optionale Argument können weitere Spezifikationen eingegeben werden, die in runden Klammern ausgegeben werden. + \Befehl{data*}{<Typ>}\oa{<Spezifikation>} \cnpkgdocarrow\ Wie \cmd{data}, gibt aber anstelle des \code{=} ein \code{:} mit aus, wenn \key{use-equal}{true} eingestellt ist. + \befehl{J}[<unit>]{<list of nums>} Kopplungskonstante, Werte werden mit \code{;} getrennt eingegeben. Für NMR. + \befehl{#}{<num>} Anzahl der Kerne. Für NMR. + \befehl{pos}{<num>} Position/Nummer des Kerns. Für NMR. + \befehl{val}{<num>} Zahlenwert, ein Alias für \paket*{siunitx}' \lstinline+\num{<num>}+ + \befehl{val}{<num1>-{}-<num2>} Ein Alias für \paket*{siunitx}' \lstinline+\numrange{<num1>}{<num2>}+ +\end{beschreibung} + +\begin{beispiel} + \begin{experimental} + \data{Typ1} Daten. + \data{Typ2}[Spezifikationen] noch mehr Daten. + \data*{Typ3} weitere Daten. + \end{experimental} +\end{beispiel} + +\subsection{Anpassung} +Die Ausgabe der Umgebung und der NMR-Befehle kann mir einer Reihe Optionen angepasst werden. Aus historischen Gründen gehören sie dem Modul \textcolor{module}{\code{nmr}} an. +\begin{beschreibung} + \option[nmr]{unit}{<unit>} Default = \lstinline=\mega\hertz= + \option[nmr]{nucleus}{\{<num>,<atom>\}} Default = \ma{1,H} + \option[nmr]{format}{<commands>} zum Beispiel \lstinline=\bfseries= + \option[nmr]{pos-number}{side/sub} Position der Zahl neben dem Atom. Default = \code{side} + \option[nmr]{coupling-unit}{<unit>} Eine \paket{siunitx} Einheit. Default = \lstinline=\hertz= + \option[nmr]{parse}{true/false} Das Lösungsmittel als \paket{mhchem}/\chemformula-Formel behandeln oder nicht. Default = \code{true} + \option[nmr]{delta}{<tokens>} Die \code{<tokens>} werden nach $\delta$ eingefügt. + \option[nmr]{list}{true/false} Die Umgebung \env{nmr}[<optionen>]{} wird als Liste formatiert. Default = \code{false} + \option[nmr]{list-setup}{<setup>} Setup der Liste. Default = siehe unten. + \option[nmr]{use-equal}{\default{true}/false} Istgleich-Zeichen nach \cmd{NMR} und \cmd{data} einsetzen. Default = \code{false} +\end{beschreibung} + +Das Default-Setup der Liste: +\begin{beispiel}[code only] + \topsep\z@skip \partopsep\z@skip + \itemsep\z@ \parsep\z@ \itemindent\z@ + \leftmargin\z@ +\end{beispiel} + +\begin{beispiel} + \begin{experimental}[format=\bfseries] + \data{Typ1} Daten. + \data{Typ2}[Spezifikationen] noch mehr Daten. + \data*{Typ3} weitere Daten. + \end{experimental} +\end{beispiel} + +Der Befehl \cmd{NMR} und alle mit \cmd{DeclareChemNMR} definierten Befehle können anstelle von \cmd{data} für NMR-Daten eingesetzt werden. + +\begin{beispiel} + \begin{experimental}[format=\bfseries,use-equal] + \data{Typ1} Daten. + \data{Typ2}[Spezifikationen] noch mehr Daten. + \NMR weitere Daten. + \end{experimental} +\end{beispiel} + +\subsection{Anwendungsbeispiel} +Der folgende Code in verschiedenen Ausgaben abhängig von der Auswahl der \code{<optionen>}. Die Optionen können selbstverständlich auch mit \cmd{chemsetup} global gesetzt werden. + +\begin{lstlisting} +\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--} +\begin{experimental}[<optionen>] + \data*{Ausbeute} \SI{17}{\milli\gram} gelbe Nadeln (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{Smp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{Quantenausbeute} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} +\end{lstlisting} + +\subsubsection{Beinahe Standard} +Ausgabe für \lstinline+<optionen>: delta=(ppm),pos-number=sub,use-equal+: +\bigskip + +\begin{experimental}[delta=(ppm),pos-number=sub,use-equal]\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--}\chemsetup[chemformula]{format=} + \data*{Ausbeute} \SI{17}{\milli\gram} gelbe Nadeln (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{Smp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{Quantenausbeute} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} + +\subsubsection{Formatierte Liste} +Ausgabe für \lstinline+<optionen>: format=\bfseries,delta=(ppm),list=true,use-equal+: +\bigskip + +\begin{experimental}[format=\bfseries,delta=(ppm),list=true,use-equal]\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--}\chemsetup[chemformula]{format=} + \data*{Ausbeute} \SI{17}{\milli\gram} gelbe Nadeln (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{Smp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{Quantenausbeute} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} + +\subsubsection{Verrückt} +Ausgabe für \code{<optionen>}: +\begin{lstlisting} + format=\color{red}\itshape, + list=true, + delta=\textcolor{green}{\ch{M+ + H2O}}, + pos-number=side, + coupling-unit=\mega\gram\per\square\second, + list-setup=, + use-equal +\end{lstlisting} + +\begin{experimental}[ + format=\color{red}\itshape, + list=true, + delta=\textcolor{green}{\ch{M+ + H2O}}, + pos-number=side, + coupling-unit=\mega\gram\per\square\second, + list-setup=,use-equal]\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--}\chemsetup[chemformula]{format=} + \data*{Ausbeute} \SI{17}{\milli\gram} gelbe Nadeln (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{Smp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{Quantenausbeute} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} \secidx*{Spektroskopie} \section{Befehle für \textsf{mhchem}}\label{sec:mhchem}\secidx{Befehle für \textsf{mhchem}}[Befehle fur mhchem] \paket{mhchem} wird nicht mehr automatisch geladen, sondern nur noch, wenn Sie die Option \key[option]{method}{mhchem} in der Präambel verwenden. Als Voreinstellung verwendet \chemmacros stattdessen \chemformula. \chemmacros stellt nur einen Befehl speziell für \paket{mhchem}\footnote{\chemformula hat seine eigene Möglichkeit.} bereit. Er erlaubt es, Text unter eine Formel zu schreiben. -\begin{description} - \item \cmd{mhName}[<keyval>]{<formula>}\ma{<text>} -\end{description} +\begin{beschreibung} + \Befehl{mhName}[<options>]{<formula>}\ma{<text>} +\end{beschreibung} Zum Beispiel: \begin{beispiel} @@ -983,12 +1225,12 @@ Zum Beispiel: \end{beispiel} Mit den folgenden Optionen kann \cmd{mhName} angepasst werden: -\begin{description} - \item \key[mhName]{align}{<alignment command>} Die Ausrichtung des Textes innerhalb der Box, in die er geschrieben wird.Default = \lstinline+\centering+ - \item \key[mhName]{format}{<anything>} Das Format des Textes. - \item \key[mhName]{fontsize}{<font size command>} Die Schriftgröße des Textes. Default = \lstinline+\tiny+ - \item \key[mhName]{width}{<dim>/auto} Die Breite der Box, in die der Text geschrieben wird. Default = \texttt{auto} -\end{description} +\begin{beschreibung} + \option[mhName]{align}{<alignment command>} Die Ausrichtung des Textes innerhalb der Box, in die er geschrieben wird.Default = \lstinline+\centering+ + \option[mhName]{format}{<anything>} Das Format des Textes. + \option[mhName]{fontsize}{<font size command>} Die Schriftgröße des Textes. Default = \lstinline+\tiny+ + \option[mhName]{width}{<dim>/auto} Die Breite der Box, in die der Text geschrieben wird. Default = \code{auto} +\end{beschreibung} \begin{beispiel} \ce{4 C2H5Cl + Pb / Na -> \mhName[fontsize=\footnotesize]{Pb(C2H5)4}{former antiknock additive} + NaCl}\\ \chemsetup[mhName]{align=\raggedright,fontsize=\small,format=\bfseries\color{red},width=3cm} @@ -996,22 +1238,22 @@ Mit den folgenden Optionen kann \cmd{mhName} angepasst werden: \end{beispiel} \secidx*{Befehle für \textsf{mhchem}}[Befehle fur mhchem] -\section{Reaktionsumgebungen}\label{ssec:mhchem_reaktionen}\secidx{Reaktionsumgebungen} +\section{Reaktionsumgebungen}\label{sec:reactions}\secidx{Reaktionsumgebungen} \subsection{Durch \chemmacros definiert} Es stehen folgende Umgebungen für nummerierte\ldots -\begin{description} - \item \env{reaction}{<formula or mhchem code>} - \item \env{reactions}{<formula or mhchem code>} -\end{description} +\begin{beschreibung} + \Umg{reaction}{<formula or mhchem code>} + \Umg{reactions}{<formula or mhchem code>} +\end{beschreibung} \ldots und ihre gesternten Versionen für unnummerierte Reaktionen zur Verfügung. -\begin{description} - \item \env{reaction*}{<formula or mhchem code>} - \item \env{reactions*}{<formula or mhchem code>} -\end{description} +\begin{beschreibung} + \Umg{reaction*}{<formula or mhchem code>} + \Umg{reactions*}{<formula or mhchem code>} +\end{beschreibung} Damit können Sie (un-) nummerierte Reaktionsgleichungen erstellen ähnlich den mathematischen Gleichungen. -Die Umgebungen \texttt{reaction}/\texttt{reaction*} verwenden intern \texttt{equation}/\texttt{equation*} Umgebungen und die Umgebungen \texttt{reactions}/\texttt{reactions*} verwenden die \texttt{align}/\texttt{align*} Umgebungen, um die Reaktionen darzustellen. +Die Umgebungen \code{reaction}/\code{reaction*} verwenden intern \code{equation}/\code{equation*} Umgebungen und die Umgebungen \code{reactions}/\code{reactions*} verwenden die \code{align}/\code{align*} Umgebungen, um die Reaktionen darzustellen. \begin{beispiel} Reaktion mit Z\"ahler: @@ -1044,9 +1286,9 @@ Die Umgebungen \texttt{reaction}/\texttt{reaction*} verwenden intern \texttt{equ \end{beispiel} Wenn Sie das Layout der Zähler-Tags ändern wollen, verwenden Sie -\begin{description} - \item \cmd{renewtagform}{<tagname>}\oa{<format>}\ma{<right delim>}\ma{<left delim>}\footnote{Durch das \paket*{mathtools} Paket zur Verfügung gestellt.}. -\end{description} +\begin{beschreibung} + \Befehl{renewtagform}{<tagname>}\oa{<format>}\ma{<right delim>}\ma{<left delim>}\footnote{Durch das \paket*{mathtools} Paket zur Verfügung gestellt.}. +\end{beschreibung} \begin{beispiel} \renewtagform{reaction}[R \textbf]{[}{]} @@ -1055,37 +1297,49 @@ Wenn Sie das Layout der Zähler-Tags ändern wollen, verwenden Sie \end{reaction} \end{beispiel} +Seit Version 3.3 funktionieren Querverweise und \AmS maths \cmd{intertext} wie erwartet: +\begin{beispiel} + \begin{reactions} + A + 2 B &-> 3 C + D \label{rxn:test} + \intertext{Etwas Text zwischen ausgerichteten Reaktionen.} + 3 E + F &<=> G + 1/2 H + \end{reactions} + Siehe Reaktion \ref{rxn:test}. +\end{beispiel} + +\achtung{In der Standardeinstellung, \dh mit \key{method}{chemformula}, sollten Sie \cmd{mch} und die verwandten Befehle innerhalb der \code{reaction} Umgebungen nicht verwenden. Sie bringen in den meisten Fällen die korrekte Ausrichtung durcheinander. In der Standardeinstellung erkennen Ladungen in den Umgebungen die EInstellung der Option \key{circled} automatisch, so dass die Befehle auch nicht benötigt werden.} + \subsection{Eigene Reaktionen} Sie können mit dem Befehl -\begin{description} - \item \cmd{DeclareChemReaction}[<keyval>]{<name>}\ma{<math name>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemReaction}[<options>]{<name>}\ma{<math name>} +\end{beschreibung} weitere Reaktionsumgebungen erstellen. -\texttt{<name>} wird der Name der neuen Umgebung sein. \texttt{<math name>} ist die verwendete Mathematikumgebung. +\code{<name>} wird der Name der neuen Umgebung sein. \code{<math name>} ist die verwendete Mathematikumgebung. Der Befehl hat zwei Optionen. -\begin{description} - \item\key*{star}{\uline{true}/false} - \item\key*{arg}{\uline{true}/false} -\end{description} +\begin{beschreibung} + \Option*{star}{\default{true}/false} + \Option*{arg}{\default{true}/false} +\end{beschreibung} Zum einen \key*{star}, die auch die gesternte Variante definiert, vorausgesetzt, die entsprechende Mathematikumgebung existiert. Falls nicht, wird es einen Fehler geben. Dann gibt es \key*{arg}, die verwendet wird, um eine Umgebung mit einem obligatorischen Argument zu erstellen. Auch das funktioniert natürlich nur, wenn die entsprechende Mathematikumgebung ebenfalls ein obligatorisches Argument besitzt. Die vordefinierten Umgebungen wurden durch -\begin{description} - \item \cmd{DeclareChemReaction}[star]{reaction}\ma{equation} und - \item \cmd{DeclareChemReaction}[star]{reactions}\ma{align}. -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemReaction}[star]{reaction}\ma{equation} und + \Befehl{DeclareChemReaction}[star]{reactions}\ma{align}. +\end{beschreibung} definiert. -Nehmen wir an, Sie wollen eine Umgebung mit dem Verhalten der \texttt{alignat} Umgebung für \chemformula-/\paket{mhchem}-Reaktionen. Sie könnten folgendes tun: +Nehmen wir an, Sie wollen eine Umgebung mit dem Verhalten der \code{alignat} Umgebung für \chemformula-/\paket{mhchem}-Reaktionen. Sie könnten folgendes tun: \begin{beispiel}[code only] \DeclareChemReaction[star,arg]{reactionsat}{alignat} \end{beispiel} -Damit ist die \texttt{reactionsat}-Umgebung definiert. +Damit ist die \code{reactionsat}-Umgebung definiert. \begin{beispiel} \DeclareChemReaction[star,arg]{reactionsat}{alignat} \begin{reactionsat}{3} @@ -1100,18 +1354,18 @@ Damit ist die \texttt{reactionsat}-Umgebung definiert. \subsection{Liste der Reaktionen} \chemmacros stellt ebenso einen Befehl zur Verfügung, mit dem man eine Liste der Reaktionen ausgeben kann, die mit den Reaktionsumgebungen eingegeben wurden. -\begin{description} - \item\cmd{listofreactions} -\end{description} +\begin{beschreibung} + \Befehl{listofreactions} +\end{beschreibung} \begin{beispiel}[below] \listofreactions \end{beispiel} Der Output kann mit den folgenden Optionen angepasst werden: -\begin{description} - \item\key[reaction]{list-name}{<name of the list>} Setzen der Listenüberschrift. Default = \texttt{Reaktionsverzeichnis} - \item\key[reaction]{list-entry}{<prefix to each entry>} Präfix zu jedem Eintrag. Default = \texttt{Reaktion} -\end{description} +\begin{beschreibung} + \option[reaction]{list-name}{<name of the list>} Setzen der Listenüberschrift. Default = \code{Reaktionsverzeichnis} + \option[reaction]{list-entry}{<prefix to each entry>} Präfix zu jedem Eintrag. Default = \code{Reaktion} +\end{beschreibung} Beide Default-Werte reagieren auf die Option \key[option]{german}. Statt die Option \key{list-name} zu verwenden, könnten Sie auch \cmd{reactionlistname} umdefinieren. @@ -1122,10 +1376,10 @@ Im Verzeichnis werden alle Reaktionen mit Zählen gelistet und alle anderen nich 2 H2O <<=> H3O+ + OH- \end{reaction} \end{beispiel} -Wenn Sie die \texttt{reactions} Umgebung verwenden, wird das allerdings nicht funktionieren. In diesem Fall können Sie -\begin{description} - \item\cmd{AddRxnDesc}{<description>} -\end{description} +Wenn Sie die \code{reactions} Umgebung verwenden, wird das allerdings nicht funktionieren. In diesem Fall können Sie +\begin{beschreibung} + \Befehl{AddRxnDesc}{<description>} +\end{beschreibung} verwenden. \begin{beispiel} \begin{reactions} @@ -1139,12 +1393,12 @@ Nebenbei: Sie müssen die Phantom-Befehle nicht verwenden, wenn Sie das Format d \section{Phasen}\label{sec:phasen}\secidx{Phasen} \subsection{Grundlagen}\secidx[Grundlagen]{Phasen} Diese Befehle sollen helfen, die Phase einer Substanz anzuzeigen. -\begin{description} - \item \cmd{sld} \sld - \item \cmd{lqd} \lqd - \item \cmd{gas} \gas - \item \cmd{aq} \aq -\end{description} +\begin{beschreibung} + \befehl{sld} \sld + \befehl{lqd} \lqd + \befehl{gas} \gas + \befehl{aq} \aq +\end{beschreibung} \achtung{Das Default-Verhalten der Phasen-Befehle hat sich geändert, um der \IUPAC-Empfehlung zu folgen. Sowohl \cmd{sld} als auch \cmd{lqd} haben kein optionales Argument mehr.} @@ -1153,23 +1407,19 @@ Diese Befehle sollen helfen, die Phase einer Substanz anzuzeigen. der Vollst\"andigkeit halber: NaCl\aq. \end{beispiel} -Mit der Paketoption \key{german}{false} (siehe Abschnitt \ref{sec:optionen}) erhalten Sie die englischen Versionen: -\begin{beispiel} - \chemsetup[option]{german=false} - \ch{C\sld{} + 2 H2O\lqd{} -> CO2\gas{} + 2 H2\gas} -\end{beispiel} +Mit der Paketoption \key{language}{english} (siehe Abschnitt \ref{sec:optionen}) erhalten Sie die englischen Versionen. Die \IUPAC-Empfehlung\footnote{Vielen Dank an Paul King für den Hinweis.} um einen Aggregatszustand anzuzeigen ist es, sie in Klammern nach der Formel zu schreiben \cite{iupac:greenbook}. Es ist jedoch ebenfalls verbreitet, sie als Tiefstellung zu setzen. -\begin{myquote}[{\IUPAC Green Book \cite[][p.\,54]{iupac:greenbook}}] +\begin{zitat}[{\IUPAC Green Book \cite[][p.\,54]{iupac:greenbook}}] The [\ldots] symbols are used to represent the states of aggregation of chemical species. The letters are appended to the formula in parentheses and should be printed in Roman (upright) type without a full stop (period). -\end{myquote} +\end{zitat} Es gibt zwei Optionen, um den Output anzupassen: -\begin{description} - \item \key[phases]{pos}{side/sub} Umschalten der Position des Phasen-Anzeigers. Default = \texttt{side} - \item \key[phases]{space}{<dim>} Ändern des Zwischenraums zwischen Formel und dem Phasen-Anzeiger bei \key{pos}{side}. Eine \TeX-Dimension. Default = \texttt{.1333em} -\end{description} +\begin{beschreibung} + \option[phases]{pos}{side/sub} Umschalten der Position des Phasen-Anzeigers. Default = \code{side} + \option[phases]{space}{<dim>} Ändern des Zwischenraums zwischen Formel und dem Phasen-Anzeiger bei \key{pos}{side}. Eine \TeX-Dimension. Default = \code{.1333em} +\end{beschreibung} \begin{beispiel} \chemsetup[phases]{pos=sub} \ch{C\sld{} + 2 H2O\lqd{} -> CO2\gas{} + 2 H2\gas}\\ @@ -1178,12 +1428,12 @@ Es gibt zwei Optionen, um den Output anzupassen: \subsection{Eigene Phasen definieren}\secidx[eigene]{Phasen} Abhängig vom Thema ihres Dokuments müssen Sie unter Umständen andere Aggregatszustände anzeigen. Sie können Sie einfach definieren. -\begin{description} - \item \cmd{DeclareChemPhase}{<cmd>}\oa{<german>}\ma{<english>} - \item \cmd{RenewChemPhase}{<cmd>}\oa{<german>}\ma{<english>} - \item \cmd{phase}{<phase>} Wenn Sie die Phase nur ein- oder zweimal verwenden müssen. -\end{description} -\cmd{DeclareChemPhase} definiert die Phase 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 eine Phase \emph{nur}, wenn \texttt{<cmd>} schon existiert und gibt andernfalls eine Warnung/einen Fehler. +\begin{beschreibung} + \Befehl{DeclareChemPhase}{<cmd>}\oa{<german>}\ma{<english>} + \Befehl{RenewChemPhase}{<cmd>}\oa{<german>}\ma{<english>} + \befehl{phase}{<phase>} Wenn Sie die Phase nur ein- oder zweimal verwenden müssen. +\end{beschreibung} +\cmd{DeclareChemPhase} definiert die Phase nur dann, wenn \code{<cmd>} noch nicht existiert. Andernfalls wird \chemmacros entweder eine Warnung oder einen Fehler ausgeben, abhängig vob der Option \key{strict}. \cmd{RenewChemParticle} definiert eine Phase \emph{nur}, wenn \code{<cmd>} schon existiert und gibt andernfalls eine Warnung/einen Fehler. \begin{beispiel} \DeclareChemPhase{\aqi}{aq,$\infty$}% aqueous solution at infinite dilution \DeclareChemPhase{\cd}{cd}% condensed phase @@ -1196,9 +1446,9 @@ Abhängig vom Thema ihres Dokuments müssen Sie unter Umständen andere Aggregat \section{Newman-Projektionen}\label{sec:newman}\secidx{Newman-Projektionen} \chemmacros stellt den Befehl -\begin{description} - \item \cmd{newman}[<keyval>]\da{<angle>}\ma{<1>,<2>,<3>,<4>,<5>,<6>} -\end{description} +\begin{beschreibung} + \Befehl{newman}[<options>]\da{<angle>}\ma{<1>,<2>,<3>,<4>,<5>,<6>} +\end{beschreibung} zur Verfügung, der Ihnen erlaubt, Newman-Projektionen zu erstellen (verwendet \TikZ). Das Argument \da{<angle>} dreht die hinteren Atome gegen den Uhrzeigersinn bezüglich der vorderen Atome. \begin{beispiel} \newman{} \newman(170){} @@ -1206,13 +1456,13 @@ zur Verfügung, der Ihnen erlaubt, Newman-Projektionen zu erstellen (verwendet \ \end{beispiel} Es gibt einige Optionen, um den Befehl anzupassen: -\begin{description} - \item \key[newman]{angle}{<angle>} Voreingestellter Winkel. Default = \texttt{0} - \item \key[newman]{scale}{<factor>} Skaliert die ganze Projektion. Default = \texttt{1} - \item \key[newman]{ring}{<tikz>} Aussehen des Rings mit \TikZ-Keys anpassen. - \item \key[newman]{atoms}{<tikz>} Aussehen der Knoten, in die die Atome geschrieben werden, mit \TikZ-Keys anpassen. - \item \key[newman]{back-atoms}{<tikz>} Nur die hinteren Atome anpassen. -\end{description} +\begin{beschreibung} + \option[newman]{angle}{<angle>} Voreingestellter Winkel. Default = \code{0} + \option[newman]{scale}{<factor>} Skaliert die ganze Projektion. Default = \code{1} + \option[newman]{ring}{<tikz>} Aussehen des Rings mit \TikZ-Keys anpassen. + \option[newman]{atoms}{<tikz>} Aussehen der Knoten, in die die Atome geschrieben werden, mit \TikZ-Keys anpassen. + \option[newman]{back-atoms}{<tikz>} Nur die hinteren Atome anpassen. +\end{beschreibung} \begin{beispiel} \chemsetup[newman]{angle=45} \newman{} @@ -1231,19 +1481,20 @@ Es gibt einige Optionen, um den Befehl anzupassen: \end{beispiel} \secidx*{Newman-Projektionen} +%TODO watch pagebreaks! \section{s, p und Hybrid-Orbitale}\label{sec:orbitale}\secidx{Orbitale} \chemmacros stellt einen Befehl bereit, mit dem Orbitale visualisiert werden können: -\begin{description} - \item \cmd{orbital}[<keyval>]{<type} -\end{description} +\begin{beschreibung} + \Befehl{orbital}[<options>]{<type} +\end{beschreibung} Dabei stehen folgende Typen für \ma{<type>} zur Verfügung: \begin{description} - \item \texttt{s} - \item \texttt{p} - \item \texttt{sp} - \item \texttt{sp2} - \item \texttt{sp3} + \item \code{s} + \item \code{p} + \item \code{sp} + \item \code{sp2} + \item \code{sp3} \end{description} \begin{beispiel} @@ -1251,13 +1502,13 @@ Dabei stehen folgende Typen für \ma{<type>} zur Verfügung: \end{beispiel} Abhängig vom Typ stehen verschiedene Optionen zur Modifikation zur Auswahl: -\begin{description} - \item \key[orbital]{phase}{\uline{+}/-} Ändern der Phase des Orbitals (alle Typen). - \item \key[orbital]{scale}{<factor>} Ändern der Größe des Orbitals (alle Typen). - \item \key[orbital]{color}{<color>} Ändern der Farbe des Orbitale (alle Typen). - \item \key[orbital]{angle}{<angle>} Rotiert die Orbitale mit einem p-Anteil gegen den Uhrzeigersinn (alle Typen außer \texttt{s}). - \item \key[orbital]{half}{\uline{true}/false} stellt nur ein halbes Orbital dar (nur \texttt{p}). -\end{description} +\begin{beschreibung} + \option[orbital]{phase}{\default{+}/-} Ändern der Phase des Orbitals (alle Typen). + \option[orbital]{scale}{<factor>} Ändern der Größe des Orbitals (alle Typen). + \option[orbital]{color}{<color>} Ändern der Farbe des Orbitale (alle Typen). + \option[orbital]{angle}{<angle>} Rotiert die Orbitale mit einem p-Anteil gegen den Uhrzeigersinn (alle Typen außer \code{s}). + \option[orbital]{half}{\default{true}/false} stellt nur ein halbes Orbital dar (nur \code{p}). +\end{beschreibung} \begin{beispiel} \orbital{s} \orbital[phase=-]{s} @@ -1268,23 +1519,25 @@ Abhängig vom Typ stehen verschiedene Optionen zur Modifikation zur Auswahl: \end{beispiel} Zusätzlich gibt es zwei Optionen, mit denen das \TikZ-Verhalten beeinflusst werden kann: -\begin{description} - \item \key[orbital]{overlay}{\uline{true}/false} Das Orbital \enquote{braucht keinen Platz}; es wird mit dem \TikZ-Key \texttt{overlay} gezeichnet. - \item \key[orbital]{opacity}{<num>} Das Orbital wird durchsichtig; \texttt{<value>} kann Werte zwischen \texttt{1} (undurchsichtig) bis \texttt{0} (unsichtbar) annehmen. -\end{description} - -\begin{beispiel} - \vspace{1cm}\hspace{1cm} +\begin{beschreibung} + \option[orbital]{overlay}{\default{true}/false} Das Orbital \enquote{braucht keinen Platz}; es wird mit dem \TikZ-Key \code{overlay} gezeichnet. + \option[orbital]{opacity}{<num>} Das Orbital wird durchsichtig; \code{<value>} kann Werte zwischen \code{1} (undurchsichtig) bis \code{0} (unsichtbar) annehmen. +\end{beschreibung} + +\newpage +\begin{beispiel}[dist] + \hspace{1cm} \chemsetup[orbital]{ overlay, p/color = black!70 } \setbondoffset{0pt} \chemfig{?\orbital{p}-[,1.3]{\orbital[phase=-]{p}}-[:30,1.1]\orbital{p}-[:150,.9]{\orbital[phase=-]{p}}-[4,1.3]\orbital{p}-[:-150,1.1]{\orbital[phase=-]{p}}?} - \vspace{1cm} + \vspace{7mm} \end{beispiel} -\begin{beispiel} - \vspace{2cm}\hspace{2cm} +\bspmidlength{dist}{10mm} +\begin{beispiel}[dist] + \hspace{2cm} \setbondoffset{0pt} \chemsetup[orbital]{ overlay , @@ -1294,111 +1547,14 @@ Zusätzlich gibt es zwei Optionen, mit denen das \TikZ-Verhalten beeinflusst wer s/scale = 1.6 } \chemfig{\orbital{s}-[:-20]{\orbital[scale=2]{p}}{\orbital[half,angle=0]{p}}{\orbital[angle=170,half]{p}}{\orbital[angle=-150,half]{p}}(-[:-150]\orbital{s})-\orbital{s}} - \vspace{2cm} + \vspace{1cm} \end{beispiel} -\secidx*{Orbitale} +\bspmidlength{dist}{7mm} +\secidx*{Orbitale}\secidx*{CHEMMACROS} -\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} - \item \cmd{chemsetup}[<module>]{<keyval>} oder - \item \cmd{chemsetup}{<module>/<keyval>} gesetzt werden. -\end{description} -Manche Optionen können ohne Wert verwendet werden. Dann wird der \uline{unterstrichene} Wert verwendet. -\small -\begin{longtable}{>{\ttfamily\color{key}\hspace{5mm}}l>{\ttfamily\color{module}}l>{\ttfamily}l>{\ttfamily}ll} - \toprule - \normalfont\normalcolor\bfseries Option & - \normalfont\normalcolor\bfseries Modul & - \normalfont\bfseries Werte & - \normalfont\bfseries Default & \\ - \midrule - \endhead - \bottomrule - \endfoot - \multicolumn{5}{l}{Paketoptionen:} \\ - 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} \\ - cmversion & option & 1/2/bundle & bundle & Seite \pageref{key:option_cmversion} \\ - german & option & \uline{true}/false & false & Seite \pageref{key:option_german} \\ - ghsystem & option & \uline{true}/false & true & Seite \pageref{key:option_ghsystem} \\ - iupac & option & auto/restricted/strict & auto & Seite \pageref{key:option_iupac} \\ - method & option & chemformula/formula & formula & Seite \pageref{key:option_method} \\ - Nu & option & chemmacros/mathspec & chemmacros & Seite \pageref{key:option_Nu} \\ - strict & option & \uline{true}/false & false & Seite \pageref{key:option_strict} \\ - synchronize & option & \uline{true}/false & false & Seite \pageref{key:option_synchronize} \\ - upgreek & option & none/textgreek/\uline{upgreek} & upgreek & Seite \pageref{key:option_upgreek} \\ - version & option & & & Seite \pageref{key:option_version} \\ - xspace & option & \uline{true}/false & true & Seite \pageref{key:option_xspace} \\ - \multicolumn{5}{l}{\cmd{ba}, \cmd{Nu}:} \\ - elpair & particle & \uline{dots}/dash/false & false & Seite \pageref{key:particle_elpair} \\ - \multicolumn{5}{l}{\cmd{DeclareChemLatin}:} \\ - format & latin & <anything> & \lstinline=\itshape= & page \pageref{key:latin_format} \\ - \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} \\ - pos & ox & top/super/side & top & Seite \pageref{key:ox_pos} \\ - explicit-sign & ox & \uline{true}/false & false & Seite \pageref{key:ox_explicit-sign} \\ - decimal-marker & ox & comma/point & point & Seite \pageref{key:ox_decimal-marker} \\ - \multicolumn{5}{l}{\cmd{OX}, \cmd{redox}:} \\ - dist & redox & <dim> & .6em & Seite \pageref{key:redox_dist} \\ - sep & redox & <dim> & .2em & Seite \pageref{key:redox_sep} \\ - \multicolumn{5}{l}{\cmd{Enthalpy}, \cmd{Entropy}, \cmd{Gibbs}:} \\ - exponent & & <anything> & \cmd{standardstate} & Seite \pageref{key:none_exponent} \\ - delta & & <anything>/false & & Seite \pageref{key:none_delta} \\ - subscript & & left/right & & Seite \pageref{key:none_subscript} \\ - unit & & <unit> & & Seite \pageref{key:none_unit} \\ - \multicolumn{5}{l}{\cmd{DeclareChemState}, \cmd{RenewChemState}:} \\ - exponent & & <anything> & \cmd{standardstate} & Seite \pageref{key:none_exponent} \\ - delta & & <anything>/false & & Seite \pageref{key:none_delta} \\ - subscript & & <anything> & & Seite \pageref{key:none_subscript} \\ - subscript-left & & \uline{true}/false & & Seite \pageref{key:none_subscript-left} \\ - \multicolumn{5}{l}{\cmd{State}:} \\ - exponent & state & <anything> & \cmd{standardstate} & Seite \pageref{key:state_exponent} \\ - delta & state & <anything>/false & & Seite \pageref{key:state_delta} \\ - subscript-left & state & \uline{true}/false & & Seite \pageref{key:state_subscript-left} \\ - \multicolumn{5}{l}{\cmd{NMR}:} \\ - unit & nmr & <unit> & \cmd{mega}\cmd{hertz} & Seite \pageref{key:nmr_unit} \\ - nucleus & nmr & \{<num>,<atom symbol>\} & \{1,H\} & Seite \pageref{key:nmr_nucleus} \\ - \multicolumn{5}{l}{\cmd{DeclareChemReaction}:} \\ - star & & \uline{true}/false & false & Seite \pageref{key:none_star} \\ - arg & & \uline{true}/false & false & Seite \pageref{key:none_arg} \\ - list-name & reaction & <anything> & List of reactions & Seite \pageref{key:reaction_list-name} \\ - list-entry & reaction & <anything> & Reaction & Seite \pageref{key:reaction_list-entry} \\ - \multicolumn{5}{l}{\cmd{mhName}:} \\ - align & mhName & <alignment> & \cmd{centering} & Seite \pageref{key:mhName_align} \\ - format & mhName & <commands> & & Seite \pageref{key:mhName_format} \\ - fontsize & mhName & <fontsize> & \cmd{tiny} & Seite \pageref{key:mhName_fontsize} \\ - width & mhName & <dim> & & Seite \pageref{key:mhName_width} \\ - \multicolumn{5}{l}{phases:} \\ - pos & phases & side/sub & side & Seite \pageref{key:phases_pos} \\ - space & phases & <dim> & .1333em & Seite \pageref{key:phases_space} \\ - \multicolumn{5}{l}{\cmd{newman}:} \\ - angle & newman & <angle> & 0 & Seite \pageref{key:newman_angle} \\ - scale & newman & <factor> & 1 & Seite \pageref{key:newman_scale} \\ - ring & newman & <tikz> & & Seite \pageref{key:newman_ring} \\ - atoms & newman & <tikz> & & Seite \pageref{key:newman_atoms} \\ - back-atoms & newman & <tikz> & & Seite \pageref{key:newman_back-atoms} \\ - \multicolumn{5}{l}{\cmd{orbital} \ttfamily <type> = s/p/sp/sp2/sp3:} \\ - phase & orbital/<type> & +/- & + & Seite \pageref{key:orbital_phase} \\ - scale & orbital/<type> & <factor> & 1 & Seite \pageref{key:orbital_scale} \\ - color & orbital/<type> & <color> & black & Seite \pageref{key:orbital_color} \\ - angle & orbital/<type> & <angle> & 90 & Seite \pageref{key:orbital_angle} \\ - half & orbital/p & \uline{true}/false & false & Seite \pageref{key:orbital_half} \\ - overlay & orbital & \uline{true}/false & false & Seite \pageref{key:orbital_overlay} \\ - opacity & ornital & <num> & 1 & Seite \pageref{key:orbital_opacity} -\end{longtable} -\normalsize\secidx*{Übersicht über die Optionen (chemmacros)}[Uebersicht ueber die Optionen] -\secidx*{CHEMMACROS} - -\part{\texorpdfstring{\Chemformula}{chemformula}}\chemsetup[chemformula]{format=}\secidx{CHEMFORMULA} +\part{\texorpdfstring{\Chemformula}{chemformula}}\label{part:chemformula}\chemsetup[chemformula]{format=}\secidx{CHEMFORMULA} \section{Setup} -Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\texttt{chemformula}} an. Das bedeutet, sie können via +Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\code{chemformula}} an. Das bedeutet, sie können via \begin{beispiel}[code only] \chemsetup[chemformula]{<options>} oder \chemsetup{chemformula/<option1>,chemformula/<option2>} @@ -1409,9 +1565,9 @@ Sie können außerdem direkt als Option an den Befehl \cmd{ch} weitergegeben wer \section{Das Grundprinzip} \chemformula hat einen Hauptbefehl. -\begin{description} - \item\cmd{ch}[<options>]{<input>} -\end{description} +\begin{beschreibung} + \Befehl{ch}[<options>]{<input>} +\end{beschreibung} Die Verwendung wird Ihnen sehr vertraut vorkommen, wenn Ihnen \paket{mhchem} geläufig ist: \begin{beispiel} @@ -1433,9 +1589,9 @@ Die Verwendung wird Ihnen sehr vertraut vorkommen, wenn Ihnen \paket{mhchem} gel \end{beispiel} Es gibt jedoch Unterschiede. Der wichtigste: \chemformula unterscheidet zwischen verschiedenen Input-Typen. Diese verschiedenen Typen \emph{müssen} durch Leerzeichen getrennt eingegeben werden: -\begin{description} - \item\cmd{ch}{type1 type2 type3 type4} -\end{description} +\begin{beschreibung} + \Befehl{ch}{type1 type2 type3 type4} +\end{beschreibung} Ein Leerzeichen im Input ist \emph{niemals} ein Leerzeichen im Output. Die Rolle des Leerzeichens gilt strikt und kann zu Fehlern oder fehlerhaften Output führen, wenn sie nicht beachtet wird. @@ -1452,9 +1608,11 @@ Der erste Punkt bedeutet, dass \cmd{ch}{2H2O} als \emph{ein} Teil behandelt wird \end{beispiel} Das bedeutet außerdem, dass ein Teil kein Leerzeichen enthalten kann, da ein Leerzeichen ihn automatisch in zwei Teile teilen würde. Wenn Sie ein Leerzeichen im Output benötigen, müssen sie ein \lstinline+~+ eingeben. Da die meisten Makros ein folgendes Leerzeichen schlucken, wird jedoch ein Input wie \cmd{ch}{\textbackslash command ABC} als einzelner Teil behandelt. Wenn Sie einen solchen Input teilen wollen, müssen Sie eine leere Gruppe eingeben: \cmd{ch}{\textbackslash command\{\} ABC}. Die verschiedenen Input-Typen werden in den folgenden Abschnitten einzeln behandelt. -Der \cmd{ch}-Befehl hat einige Optionen, mit denen der Output verändert werden kann. Sie können entweder lokal als optionales Argument oder global mit dem Befehl\\ -\cmd{chemsetup}[chemformula]{<options>}\\ -gesetzt werden. Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\texttt{chemformula}} an. +Der \cmd{ch}-Befehl hat einige Optionen, mit denen der Output verändert werden kann. Sie können entweder lokal als optionales Argument oder global mit dem Befehl +\begin{beschreibung} + \Befehl{chemsetup}[chemformula]{<options>} +\end{beschreibung} +gesetzt werden. Alle Optionen von \chemformula gehören dem Modul \textcolor{module}{\code{chemformula}} an. \section{Stöchiometrische Faktoren}\secidx{Stöchiometrische Faktoren}[Stoechiometrische Faktoren] Ein stöchiometrischer Faktor darf nur aus Ziffern und den Zeichen \lstinline+.,_/()+ bestehen. @@ -1486,11 +1644,11 @@ Viele Beispiele wie das folgende für die Verwendung von Klammern um stöchiomet \end{reaction*} Der Output kann mit diesen Optionen angepasst werden: -\begin{description} - \item \key{decimal-marker}{<marker>} Das Symbol, das als Dezimalzeichen verwendet wird. Default = \texttt{.} - \item \key{frac-style}{math/xfrac/nicefrac} Bestimmt, wie Brüche dargestellt werden. Default = \texttt{math} - \item \key{stoich-space}{<dim>} Der Leerraum nach einem stöchiometrischen Faktor. Eine \TeX-Länge. Default = \lstinline=.1667em= -\end{description} +\begin{beschreibung} + \option{decimal-marker}{<marker>} Das Symbol, das als Dezimalzeichen verwendet wird. Default = \code{.} + \option{frac-style}{math/xfrac/nicefrac} Bestimmt, wie Brüche dargestellt werden. Default = \code{math} + \option{stoich-space}{<dim>} Der Leerraum nach einem stöchiometrischen Faktor. Eine \TeX-Länge. Default = \lstinline=.1667em= +\end{beschreibung} \begin{beispiel} \ch[decimal-marker={,}]{3.5} \ch[decimal-marker={$\cdot$}]{3,5} \end{beispiel} @@ -1541,10 +1699,10 @@ Die Option \key{stoich-space} erlaubt Ihnen, den Leerraum zwischen stöchiometri \subsection{Addukte}\secidx[Addukte]{Summenformeln} \chemformula hat zwei Identifier, die Addukte erzeugen. -\begin{description} - \item \cmd{ch}{A.B} - \item \cmd{ch}{A*B} -\end{description} +\begin{beschreibung} + \befehl{ch}{A.B} \ch{A.B} + \befehl{ch}{A*B} \ch{A*B} +\end{beschreibung} \begin{beispiel} \ch{CaSO4.H2O} \\ \ch{CaSO4*H2O} @@ -1591,7 +1749,7 @@ Wenn eine Summenformel mit einem Plus- oder Minus-Zeichen \emph{endet}, wird es \ch{A-B} \ch{AB-} \end{beispiel} -Für längere Ladungsgruppen oder andere Hochstellungen können Sie die Mathematik-Syntax verwenden. Sie beachtet Gruppen und erlaubt Mathematik in ihnen. Innerhalb dieser Gruppen werden weder \texttt{+} noch \texttt{-} als Bindungen interpretiert. Wenn sich ein Punkt \texttt{.} in einer Hochstellung befindet, zeigt er kein Addukt an sondern ein Radikal. Ein \texttt{*} gibt den angeregten Zustand. +Für längere Ladungsgruppen oder andere Hochstellungen können Sie die Mathematik-Syntax verwenden. Sie beachtet Gruppen und erlaubt Mathematik in ihnen. Innerhalb dieser Gruppen werden weder \code{+} noch \code{-} als Bindungen interpretiert. Wenn sich ein Punkt \code{.} in einer Hochstellung befindet, zeigt er kein Addukt an sondern ein Radikal. Ein \code{*} gibt den angeregten Zustand. \begin{beispiel} \ch{A^{x-}} \\ \ch{A^x-} \\ @@ -1610,7 +1768,7 @@ Ionen und Ionenverbindungen mit mehr als einer Ladung werden genauso eingegeben: \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. +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 \code{circled} wird von \cmd{ch} beachtet. \begin{beispiel} \chemsetup[option]{circled=all} \ch{H+ + OH- <=> H2O} @@ -1625,13 +1783,13 @@ Die Hochstellungen verhalten sich unterschiedlich abhängig von ihrer Position i \end{beispiel} \begin{itemize} \item Wenn eine Formel mit einer Hochstellung \emph{startet}, werden Hoch- und Tiefstellung \emph{rechts} ausgerichtet, ansonsten \emph{links}. - \item Wenn eine Hochstellung einer Tiefstellung \emph{folgt}, wird sie zusätzlich um eine Länge verschoben, die durch die Option \key{charge-hshift}{<dim>} bestimmt wird, siehe auch Seite \pageref{key:charge-hshift}f. + \item Wenn eine Hochstellung einer Tiefstellung \emph{folgt}, wird sie zusätzlich um eine Länge verschoben, die durch die Option \key{charge-hshift}{<dim>} bestimmt wird, siehe auch Seite \pageref{desc:charge-hshift}f. \end{itemize} Der zweite Punkt folgt der \IUPAC-Empfehlung: -\begin{myquote}[{\IUPAC Green Book \cite[][p.\,51]{iupac:greenbook}}] +\begin{zitat}[{\IUPAC Green Book \cite[][p.\,51]{iupac:greenbook}}] In writing the formula for a complex ion, spacing for charge number can be added (staggered arrangement), as well as parentheses: \ch[charge-hshift=1ex]{SO4^2-}, \ch{(SO4)^2-} The staggered arrangement is now recommended. -\end{myquote} +\end{zitat} \subsection{Bindungen}\label{ssec:bonds}\secidx[Bindungen]{Summenformeln} \chemformula kennt drei Sorten Bindungen: @@ -1643,14 +1801,15 @@ Der zweite Punkt folgt der \IUPAC-Empfehlung: \subsection{Anpassung}\secidx[Anpassung]{Summenformeln} Diese Optionen ermöglichen Ihnen, den Output anzupassen: -\begin{description} - \item \key{subscript-vshift}{<dim>} Extra vertikale Verschiebung der Tiefstellungen. Default = \texttt{0pt} - \item \key{subscript-style}{text/math} Stil, der für die Tiefstellungen verwendet wird. Default = \texttt{text} - \item \key{charge-hshift}{<dim>} Verschiebung von Hochstellungen, wenn sie einer Tiefstellung folgen. Default = \texttt{.5ex}\label{key:charge-hshift} - \item \key{charge-style}{text/math} Stil, der für Hochstellungen verwendet wird. Default = \texttt{text} - \item \key{adduct-space}{<dim>} Leerraum links und rechts des Addukt-Punktes. Default = \lstinline+.1333em+ - \item \key{bond-length}{<dim>} Die Länge der Bindungen. Als Default-Länge wird die Länge eines Halbgeviertstrichs verwendet, wie sie mit \lstinline+\settowidth{<len>}{\textendash}+ bestimmt wird. -\end{description} +\begin{beschreibung} + \option{subscript-vshift}{<dim>} Extra vertikale Verschiebung der Tiefstellungen. Default = \code{0pt} + \option{subscript-style}{text/math} Stil, der für die Tiefstellungen verwendet wird. Default = \code{text} + \option{charge-hshift}{<dim>} Verschiebung von Hochstellungen, wenn sie einer Tiefstellung folgen. Default = \code{.5ex}\label{desc:charge-hshift} + \option{charge-style}{text/math} Stil, der für Hochstellungen verwendet wird. Default = \code{text} + \option{adduct-space}{<dim>} Leerraum links und rechts des Addukt-Punktes. Default = \code{.1333em} + \option{bond-length}{<dim>} Die Länge der Bindungen. Als Default-Länge wird die Länge eines Halbgeviertstrichs verwendet, wie sie mit \lstinline+\settowidth{<len>}{\textendash}+ bestimmt wird. + \option{bond-offset}{<dim>} Der Abstand zwischen Atom und Bindung. Default = \code{0pt} +\end{beschreibung} Vielleicht ist Ihnen aufgefallen, dass bei manchen Ionen die Ladungen nach rechts verschoben sind:\secidx[Ladungen!Verschiebung]{Summenformeln} \begin{beispiel} @@ -1710,6 +1869,12 @@ Die Länge der Bindungen ändern:\secidx[Bindungen!Laenge@Länge]{Summenformeln} double: \ch{CH2=CH2} \\ triple: \ch{CH+CH} \end{beispiel} + +Sie können ebenfalls den Abstand zwischen Atom und Bindung einstellen: +\begin{beispiel} + \ch{H-H + N+N + O=O} \\ + \ch[bond-offset=1pt]{H-H + N+N + O=O} +\end{beispiel} \secidx*{Summenformeln} \section{Spezielle Input-Typen}\secidx{Spezielle Input-Typen} @@ -1717,17 +1882,17 @@ Es gibt einige \enquote{spezielle Input-Typen}. \subsection{Single-Token Input}\secidx[Single-Token Input]{Spezielle Input-Typen} Die erste Sorte besteht nur aus einem Token, nämlich einem der folgenden: -\begin{description} - \item \cmd{ch}{ + } \ch{+} Erstellt ein Plus-Zeichen zwischen Formeln mit Leerraum links und rechts:\\ +\begin{beschreibung} + \befehl{ch}{ + } \ch{+} Erstellt ein Plus-Zeichen zwischen Formeln mit Leerraum links und rechts:\\ \cmd{ch}{2 Na + Cl2} \ch{2 Na + Cl2} - \item \cmd{ch}{ v } \ch{v} Zeichen für eine Fällung/Niederschlag: \cmd{ch}{BaSO4 v} \ch{BaSO4 v} - \item \cmd{ch}{ \lstinline+^+ } \ch{^} Zeichen für entweichendes Gas: \cmd{ch}{\lstinline=H2 ^=} \ch{H2 ^} -\end{description} + \befehl{ch}{ v } \ch{v} Zeichen für eine Fällung/Niederschlag: \cmd{ch}{BaSO4 v} \ch{BaSO4 v} + \befehl{ch}{ \lstinline+^+ } \ch{^} Zeichen für entweichendes Gas: \cmd{ch}{\lstinline=H2 ^=} \ch{H2 ^} +\end{beschreibung} Der Leerraum links und rechts des Plus kann mit einer Option angepasst werden: -\begin{description} - \item \key{plus-space}{<dim>} Eine \TeX-Länge. Default = \lstinline+.3em+ -\end{description} +\begin{beschreibung} + \option{plus-space}{<dim>} Eine \TeX-Länge. Default = \lstinline+.3em+ +\end{beschreibung} \begin{beispiel} \ch{A + B}\\ \ch[plus-space=4pt]{A + B} @@ -1740,9 +1905,9 @@ Manchmal möchte man eine Option nur auf einen Teil einer, sagen wir, Reaktion a \ch{H2O +}\ch[subscript-vshift=2pt]{H2SO4}\ch{-> H3O+ + HSO4-} \end{beispiel} Das unterbricht allerdings die Eingabe im Quelltext und \emph{könnte} die Abstände beeinflussen. Deshalb gibt es eine Alternative: -\begin{description} - \item \ttfamily\cmd{ch}\{\lstinline+@{<options>}+\}\normalfont\ Die angegebenen Optionen sind \emph{nur} aktiv bis nach der \emph{nächsten} Summenformel. -\end{description} +\begin{beschreibung}\makeatletter + \befehl{ch}{ @\{<options>\} } Die angegebenen Optionen sind \emph{nur} aktiv bis nach der \emph{nächsten} Summenformel. +\end{beschreibung} \begin{beispiel} \ch{H2O +}\textcolor{red}{\ch{H2SO4}}\ch{-> H3O+ + HSO4-} \\ \ch{H2O + @{format=\color{red}} H2SO4 -> H3O+ + HSO4-} \\ @@ -1759,10 +1924,10 @@ In manchen Fällen kann es wünschenswert sein, \chemformula davon abzuhalten, d \subsection{Text}\label{ssec:text}\secidx[text]{Geschützter Input}[Geschuetzter Input] Wenn Sie etwas zwischen \lstinline+" "+ oder \lstinline+' '+ setzen, dann wird der Input als normaler Text behandelt, abgesehen davon, das Leerzeichen nicht erlaubt sind und mit \lstinline+~+ eingegeben werden müssen. -\begin{description} - \item \cmd{ch}{ "<escaped text>" } - \item \cmd{ch}{ '<escaped text>' } -\end{description} +\begin{beschreibung} + \Befehl{ch}{ "<escaped text>" } + \Befehl{ch}{ '<escaped text>' } +\end{beschreibung} \begin{beispiel} \ch{"\ox{2,Ca}" O} \\ \ch{"\ldots\," Na + "\ldots\," Cl2 -> "\ldots\," NaCl} \\ @@ -1772,9 +1937,9 @@ In vielen Fällen wird das nicht nötig sein. Aber wenn Sie Schwierigkeiten habe \subsection{Mathematik}\secidx[math]{Geschützter Input}[Geschuetzter Input] Wenn Sie speziell Mathematik-Input haben, setzen Sie ihn einfach zwischen \lstinline+$ $+. Der Output unterscheidet sich vom geschützten Text (abgesehen von Mathe-Layout) darin, dass ihm ein Leerraum folgt. -\begin{description} - \item \cmd{ch}{ \lstinline"$<escaped math>$" } -\end{description} +\begin{beschreibung}\catcode`\$=11 + \Befehl{ch}{ $<escaped math>$ } +\end{beschreibung} \begin{beispiel} escaped text: \ch{"$x$" H2O} \\ escaped math: \ch{$x$ H2O} \\ @@ -1782,12 +1947,12 @@ Wenn Sie speziell Mathematik-Input haben, setzen Sie ihn einfach zwischen \lstin \end{beispiel} Der Leerraum, der nach dem geschützen Mathe-Input ausgegeben wird, kann angepasst werden. -\begin{description} - \item \key{math-space}{<dim>} Eine \TeX-Länge. Default = \lstinline=.1667em= -\end{description} +\begin{beschreibung} + \item \key{math-space}{<dim>} Eine \TeX-Länge. Default = \code{.1667em} +\end{beschreibung} \begin{beispiel} \ch{$2n$ Na + $n$ Cl2 -> $2n$ NaCl} \\ - \chemsetup[chemformula]{math-space=.2em} + \chemsetup[chemformula]{math-space=.25em} \ch{$2n$ Na + $n$ Cl2 -> $2n$ NaCl} \\ \ch{$A->B$} \end{beispiel} @@ -1796,19 +1961,19 @@ Der Leerraum, der nach dem geschützen Mathe-Input ausgegeben wird, kann angepas \section{Pfeile}\label{sec:arrows}\secidx{Pfeile} \subsection{Pfeiltypen}\secidx[Typen]{Pfeile} Pfeile werden auf die gleiche intuitive Weise eingegeben wie bei \paket{mhchem}. Es gibt eine Reihe verschiedener Typen: -\begin{description} - \item \cmd{ch}{ -> } \ch{->} Standardpfeil nach rechts - \item \cmd{ch}{ <- } \ch{<-} Standardpfeil nach links - \item \cmd{ch}{ -/> } \ch{-/>} reagiert nicht (rechts) - \item \cmd{ch}{ </- } \ch{</-} reagiert nicht (links) - \item \cmd{ch}{ <-> } \ch{<->} Mesomerie-Pfeil - \item \cmd{ch}{ <> } \ch{<>} Reaktion in beide Richtungen - \item \cmd{ch}{ == } \ch{==} stöchiometrische Gleichung - \item \cmd{ch}{ <=> } \ch{<=>} Gleichgewichts-Pfeil - \item \cmd{ch}{ \lstinline+<=>>+ } \ch{<=>>} Gleichgewicht liegt rechts - \item \cmd{ch}{ \lstinline+<<=>+ } \ch{<<=>} Gleichgewicht liegt links - \item \cmd{ch}{ <o> } \ch{<o>} Isolobal-Pfeil -\end{description} +\begin{beschreibung} + \befehl{ch}{ -> } \ch{->} Standardpfeil nach rechts + \befehl{ch}{ <- } \ch{<-} Standardpfeil nach links + \befehl{ch}{ -/> } \ch{-/>} reagiert nicht (rechts) + \befehl{ch}{ </- } \ch{</-} reagiert nicht (links) + \befehl{ch}{ <-> } \ch{<->} Mesomerie-Pfeil + \befehl{ch}{ <> } \ch{<>} Reaktion in beide Richtungen + \befehl{ch}{ == } \ch{==} stöchiometrische Gleichung + \befehl{ch}{ <=> } \ch{<=>} Gleichgewichts-Pfeil + \befehl{ch}{ \lstinline+<=>>+ } \ch{<=>>} Gleichgewicht liegt rechts + \befehl{ch}{ \lstinline+<<=>+ } \ch{<<=>} Gleichgewicht liegt links + \befehl{ch}{ <o> } \ch{<o>} Isolobal-Pfeil +\end{beschreibung} Diese Pfeile werden alle mit \TikZ gezeichnet. \begin{beispiel} \ch{H2 + Cl2 -> 2 HCl} \\ @@ -1822,9 +1987,9 @@ Diese Pfeile werden alle mit \TikZ gezeichnet. \subsection{Beschriftung}\secidx[Beschriftung]{Pfeile} Die Pfeile haben zwei optionale Argumente für Beschriftungen. -\begin{description} - \item\cmd{ch}{ ->[<above>][<below>] } -\end{description} +\begin{beschreibung} + \Befehl{ch}{ ->[<above>][<below>] } +\end{beschreibung} \begin{beispiel} \ch{A ->[a] B} \\ \ch{A ->[a][b] B} \\ @@ -1852,16 +2017,14 @@ Mit den Leerzeichen verarbeitet \chemformula den Teil zwischen den Klammern als \subsection{Anpassung}\secidx[Anpassung]{Pfeile} Mit folgenden Optionen können Sie das Erscheinungsbild der Pfeile anpassen: -\begin{description} - \item \key{arrow-offset}{<dim>} Die Länge, die ein Pfeil links und rechts über die Beschriftung hinausragt. Die Länge eines leeren Pfeils beträgt zwei mal \texttt{arrow-offset}. Eine \TeX-Länge. Default = \texttt{1.5ex} - \item \key{arrow-yshift}{<dim>} Verschiebt einen Pfeil nach oben (positiver Wert) oder nach unten (negativer Wert). Eine \TeX-Länge. Default = \texttt{0pt} - \item \key{arrow-ratio}{<factor>} Das Verhältnis der Pfeillängen der ver unbalancierten Gleichgewichtspfeile. \texttt{.4} würde bedeuten, dass der kürzere Pfeil $0.4$ mal so lang ist, wie der längere Pfeil. Default = \texttt{.6} -% \item \key{arrow-tips}{<type>} Bestimmt die Pfeilspitzen. Im Prinzip könnten alle von \TikZ' Pfeilen verwendet werden. Die Option verlangt jedoch, dass erstens \texttt{<type>} selbst eine Pfeilspitze sein muss \emph{und} dass zweitens die Spitzen \texttt{left <type>} und \texttt{right <type>} definiert sein müssen. Wenn Sie also nicht selbst Pfeilspitzen definieren, können Sie nur zwischen \texttt{cf} und \texttt{to} wählen. Default = \texttt{cf} -% \item \key{arrow-style}{<tikz>} \TikZ-Keys zur freien Gestaltung der Pfeile. - \item \key{compound-sep}{<dim>} Der Leerraum zwischen Formeln und Pfeilen. Eine \TeX-Länge. Default = \texttt{1ex} - \item \key{label-offset}{<dim>} Der Leerraum zwischen Pfeilen und ihrer Beschriftung. Eine \TeX-Länge. Default = \texttt{2pt} - \item \key{label-style}{<font command>} Die relative Schriftgröße der Beschriftung. Default = \lstinline+\footnotesize+ -\end{description} +\begin{beschreibung} + \option{arrow-offset}{<dim>} Die Länge, die ein Pfeil links und rechts über die Beschriftung hinausragt. Die Länge eines leeren Pfeils beträgt zwei mal \code{arrow-offset}. Eine \TeX-Länge. Default = \code{1.5ex} + \option{arrow-yshift}{<dim>} Verschiebt einen Pfeil nach oben (positiver Wert) oder nach unten (negativer Wert). Eine \TeX-Länge. Default = \code{0pt} + \option{arrow-ratio}{<factor>} Das Verhältnis der Pfeillängen der ver unbalancierten Gleichgewichtspfeile. \code{.4} würde bedeuten, dass der kürzere Pfeil $0.4$ mal so lang ist, wie der längere Pfeil. Default = \code{.6} + \option{compound-sep}{<dim>} Der Leerraum zwischen Formeln und Pfeilen. Eine \TeX-Länge. Default = \code{1ex} + \option{label-offset}{<dim>} Der Leerraum zwischen Pfeilen und ihrer Beschriftung. Eine \TeX-Länge. Default = \code{2pt} + \option{label-style}{<font command>} Die relative Schriftgröße der Beschriftung. Default = \lstinline+\footnotesize+ +\end{beschreibung} Der folgende Code zeigt die Effekte der verschiedenen Optionen auf den \lstinline+<=>>+ Pfeil: \begin{beispiel} @@ -1873,26 +2036,12 @@ Der folgende Code zeigt die Effekte der verschiedenen Optionen auf den \lstinlin gr\"o\ss erer Abstand zu Formeln: \ch[compound-sep=2ex]{A <=>>[x][y] B} \\ kleinere Beschriftungen: \ch[label-style=\tiny]{A <=>[x][y] B} \end{beispiel} -% -% Die Pfeilköpfe sind so gestaltet, dass sie zu \paket{chemfig}s Pfeilen passen. Wenn Sie andere Spitzen lieber mögen und sie ändern möchten, ohne alle Pfeile neu zu definieren (siehe Abschnitt \ref{sec:arrows_modify}), können Sie folgenden Befehl verwenden: -% \begin{description} -% \item \cmd{pgfarrowsrenewalias}{<new start>}\ma{<new end>}\ma{<old start>}\ma{<old end>} -% \end{description} -% Das ist derselbe Befehl wie \lstinline=\pgfarrowsdeclarealias=, mit dem Unterschied, dass nicht geprüft wird, ob die neuen Pfeilköpfe schpon existieren. Das bedeutet, dass Sie damit die alten Definitionen überschreiben können: -% \begin{beispiel} -% % overwrite the chemformula arrow heads `cf' and `left cf' -% \pgfarrowsrenewalias{left cf}{left cf}{left to}{left to} -% \pgfarrowsrenewalias{cf}{cf}{to}{to} -% -% \ch{CO + H2O <=> CO2 + H2} \\ -% \ch{C + H2O -> CO + H2} -% \end{beispiel} \subsection{Pfeiltypen bearbeiten}\label{sec:arrows_modify}\secidx[Typen!bearbeiten]{Pfeile} Die Pfeile wurden mit dem Befehl -\begin{description} - \item \cmd{DeclareChemArrow}{<tokens>}\ma{<tikz>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemArrow}{<tokens>}\ma{<tikz>} +\end{beschreibung} definiert. \ma{<tokens>} sind die Zeichen, die ersetzt werden mit dem tatsächlichen Pfeilcode. Der Hauptpfeil wurde \zB via \begin{beispiel}[code only] \DeclareChemArrow{->}{\draw[-cf] (cf_arrow_start) -- (cf_arrow_end) ;} @@ -1901,12 +2050,12 @@ definiert. Wenn Sie selbst Pfeile definieren wollen, benötigen Sie grundlegende Es gibt einige vordefinierte Koordinaten, die Sie verwenden können und sollten: \begin{description} - \item[\texttt{(cf\_arrow\_start)}] Der Pfeilanfang. - \item[\texttt{(cf\_arrow\_end)}] Das Pfeilende. - \item[\texttt{(cf\_arrow\_mid)}] Die Pfeilmitte. - \item[\texttt{(cf\_arrow\_mid\_start)}] Der Anfang des kürzeren Pfeils in Typen wie \lstinline+<=>>+. - \item[\texttt{(cf\_arrow\_mid\_end)}] Das Ende des kürzeren Pfeils in Typen wie \lstinline+<=>>+. - \item[\texttt{cf}, \texttt{left cf}, \texttt{right cf}] Für \chemformula definierte Pfeilspitzen. + \item[\code{(cf\_arrow\_start)}] Der Pfeilanfang. + \item[\code{(cf\_arrow\_end)}] Das Pfeilende. + \item[\code{(cf\_arrow\_mid)}] Die Pfeilmitte. + \item[\code{(cf\_arrow\_mid\_start)}] Der Anfang des kürzeren Pfeils in Typen wie \lstinline+<=>>+. + \item[\code{(cf\_arrow\_mid\_end)}] Das Ende des kürzeren Pfeils in Typen wie \lstinline+<=>>+. + \item[\code{cf}, \code{left cf}, \code{right cf}] Für \chemformula definierte Pfeilspitzen. \end{description} \begin{beispiel} \DeclareChemArrow{.>}{\draw[-cf,dotted,red] (cf_arrow_start) -- (cf_arrow_end);} @@ -1914,10 +2063,10 @@ Es gibt einige vordefinierte Koordinaten, die Sie verwenden können und sollten: \ch{A .> B} \ch{A .>[a][b] B} \ch{A n> B} \end{beispiel} Wenn Sie einen existierenden Pfeil umdefinieren möchten, können Sie folgende zwei Befehle verwenden: -\begin{description} - \item \cmd{RenewChemArrow}{<tokens>}\ma{<tikz>} - \item \cmd{ShowChemArrow}{<tokens>} -\end{description} +\begin{beschreibung} + \Befehl{RenewChemArrow}{<tokens>}\ma{<tikz>} + \Befehl{ShowChemArrow}{<tokens>} +\end{beschreibung} Der zweite zeigt Ihnen die bestehende Definition, der erste definiert den bestehenden Pfeil neu. \begin{beispiel} \texttt{\ShowChemArrow{->}} \\ @@ -1930,9 +2079,9 @@ Der zweite zeigt Ihnen die bestehende Definition, der erste definiert den besteh \section{Text unter Formeln}\secidx{Text unter Formeln} \subsection{Syntax}\secidx[syntax]{Text unter Formeln} \chemformula hat eine eingebaute Syntax, um Text unter Formeln zu schreiben. Sie funktioniert ähnlich wie die optionalen Argumente der Pfeile. -\begin{description} - \item\cmd{ch}{ !(<name>)( <formula> ) } -\end{description} +\begin{beschreibung} + \Befehl{ch}{ !(<name>)( <formula> ) } +\end{beschreibung} Wenn ein Ausrufezeichen von einem Paar von Klammern gefolgt wird, macht \chemformula folgendes: \begin{beispiel} \ch{!(ethanol)( CH2CH2OH )} @@ -1955,10 +2104,10 @@ Wenn Sie aus irgendeinem Grund ein Ausrufezeichen wollen, \emph{ohne} dass es ei \subsection{Anpassung}\secidx[Anpassung]{Text unter Formeln} \chemformula stellt zwei Optionen bereit, um den Text anzupassen: -\begin{description} - \item \key{name-format}{<commands>} Das Ausgabeformat des Textes. Das kann beliebiger Input sein. Default = \lstinline+\scriptsize\centering+ - \item \key{name-width}{<dim>/auto} Die Breite der Box, in die der Text geschrieben wird. \texttt{auto} erkennt die Breite der Beschriftung und setzt die Box auf diese Breite. Default = \texttt{auto} -\end{description} +\begin{beschreibung} + \option{name-format}{<commands>} Das Ausgabeformat des Textes. Das kann beliebiger Input sein. Default = \lstinline+\scriptsize\centering+ + \option{name-width}{<dim>/auto} Die Breite der Box, in die der Text geschrieben wird. \code{auto} erkennt die Breite der Beschriftung und setzt die Box auf diese Breite. Default = \code{auto} +\end{beschreibung} \begin{beispiel} \ch{!(S\"aure)( H2SO4 ) -> B} \\ \ch[name-format=\sffamily\small]{!(S\"aure)( H2SO4 ) -> B} \\ @@ -1984,9 +2133,9 @@ Nun ändern wir verschiedene Aspekte der Schrift und sehen, was passiert: Wie Sie sehen, adaptieren die meisten Features die Einstellungen des umliegenden Fonts. Wenn Sie dieses Default-Verhalten oder das Default-Format ändern wollen, können Sie diese Option verwenden: -\begin{description} - \item \key{format}{<anything>} Fügt zu Beginn des \cmd{ch}-Befehls beliebigen Code ein. -\end{description} +\begin{beschreibung} + \option{format}{<anything>} Fügt zu Beginn des \cmd{ch}-Befehls beliebigen Code ein. +\end{beschreibung} \begin{beispiel} % blau und serifenlos: \definecolor{newblue}{rgb}{.1,.1,.5}\chemsetup[chemformula]{format=\color{newblue}\sffamily} @@ -1997,11 +2146,11 @@ Wenn Sie dieses Default-Verhalten oder das Default-Format ändern wollen, könne \end{beispiel} Sie können ebenfalls speziell die Schriftfamilie, Schriftserie und Schriftform des Output setzen: -\begin{description} - \item \key{font-family}{<family>} Ändert die Schriftfamilie des Output mit: \lstinline+\fontfamily{<family>}\selectfont+. - \item \key{font-series}{<series>} Ändert die Schriftserie des Output mit: \lstinline+\fontseries{<series>}\selectfont+. - \item \key{font-shape}{<shape>} Ändert die Schriftform des Output mit: \lstinline+\fontshape{<shape>}\selectfont+. -\end{description} +\begin{beschreibung} + \option{font-family}{<family>} Ändert die Schriftfamilie des Output mit: \lstinline+\fontfamily{<family>}\selectfont+. + \option{font-series}{<series>} Ändert die Schriftserie des Output mit: \lstinline+\fontseries{<series>}\selectfont+. + \option{font-shape}{<shape>} Ändert die Schriftform des Output mit: \lstinline+\fontshape{<shape>}\selectfont+. +\end{beschreibung} \begin{beispiel} % immer fett: \chemsetup[chemformula]{font-series=bx} @@ -2012,10 +2161,10 @@ Sie können ebenfalls speziell die Schriftfamilie, Schriftserie und Schriftform \end{beispiel} Wenn Sie \XeLaTeX\ oder \LuaLaTeX\ verwenden und das Paket \paket{fontspec} geladen haben, können Sie die Schrift von \chemformula auch damit ändern: -\begin{description} - \item \key{font-spec}{\{<font>\}} oder mit Optionen - \item \key{font-spec}{\{[<options>]<font>\}} -\end{description} +\begin{beschreibung} + \Option{font-spec}{\{<font>\}} oder mit Optionen + \Option{font-spec}{\{[<options>]<font>\}} +\end{beschreibung} \begin{beispiel} \chemsetup[chemformula]{font-spec={Linux Biolinum O}} \sample \\ \chemsetup[chemformula]{font-spec={[Color=darkgray]Augie}} \sample \\ @@ -2045,7 +2194,7 @@ Der Befehl \cmd{ch} kann in Mathematikumgebungen eingesetzt werden. Er erkennt \ \secidx*{Mathematik-Umgebungen} \section{Weitere Beispiele} -Dieser Abschnitt zeigt weitere Beispiele für die Verwendung von \chemformula, auch im Zusammenspiel mit \chemmacros' \texttt{reaction}-Umgebungen. +Dieser Abschnitt zeigt weitere Beispiele für die Verwendung von \chemformula, auch im Zusammenspiel mit \chemmacros' \code{reaction}-Umgebungen. \begin{beispiel} \begin{reaction}[Synthese von Alkanen] @@ -2083,7 +2232,7 @@ Dieser Abschnitt zeigt weitere Beispiele für die Verwendung von \chemformula, a H3C-CH2 "\Lewis{0.,\vphantom{H}}" + Cl2 &-> H3CCH2Cl + "\Lewis{0.,Cl}" & &"\Enthalpy{-23.0}" \end{reactions*} \end{beispiel} -%TODO schlechter Seitenumbruch + Das folgende Beispiel zeigt, wie das kürzen von Formeln erreicht werden kann\footnote{Inspiriert durch eine Frage auf TeX.SE: \url{http://tex.stackexchange.com/q/30118/5049}}. \begin{beispiel} % needs `cancel' @@ -2097,23 +2246,23 @@ Das folgende Beispiel zeigt, wie das kürzen von Formeln erreicht werden kann\fo \end{beispiel} \secidx*{CHEMFORMULA} -\part{\texorpdfstring{\Ghsystem}{ghsystem}}\secidx{GHSYSTEM} +\part{\texorpdfstring{\Ghsystem}{ghsystem}}\label{part:ghsystem}\secidx{GHSYSTEM} \section{Setup} -Alle Optionen von \ghsystem gehören dem Modul \textcolor{module}{\texttt{ghsystem}} an. Sie können also mit -\begin{beispiel}[code only] - \chemsetup[ghsystem]{<options>} oder - \chemsetup{ghsystem/<option1>,ghsystem/<option2>} -\end{beispiel} +Alle Optionen von \ghsystem gehören dem Modul \textcolor{module}{\code{ghsystem}} an. Sie können also mit +\begin{beschreibung} + \Befehl{chemsetup}[ghsystem]{<options>} oder + \Befehl{chemsetup}{ghsystem/<option1>,ghsystem/<option2>} +\end{beschreibung} eingestellt werden. Sie können den entsprechenden Befehlen auch lokal als optionales Argument mitgegeben werden. \section{Die Gefahren- (H) und Sicherheitssätze (P) aufrufen}\secidx{Gefahren- und Sicherheitssätze}[Gefahren- und Sicherheitssaetze] \subsection{Einfacher Aufruf}\secidx[Aufruf]{GHSYSTEM} Der prinzipielle Aufruf ist einfach: -\begin{description} - \item\cmd{ghs}[<options>]{<type>}\ma{<number>} - \item\cmd[ghsa]{ghs*}[<options>]{<type>}\ma{<number>} -\end{description} -Es gibt drei Typen von Sätzen: \texttt{h}, \texttt{euh} und \texttt{p}. Das \ma{<type>} Argument ignoriert Groß- und Kleinschreibung. +\begin{beschreibung} + \Befehl{ghs}[<options>]{<type>}\ma{<number>} + \Befehl[ghsa]{ghs*}[<options>]{<type>}\ma{<number>} +\end{beschreibung} +Es gibt drei Typen von Sätzen: \code{h}, \code{euh} und \code{p}. Das \ma{<type>} Argument ignoriert Groß- und Kleinschreibung. \begin{beispiel} \ghs{h}{200} \\ \ghs{H}{224} \\ @@ -2123,14 +2272,14 @@ Es gibt drei Typen von Sätzen: \texttt{h}, \texttt{euh} und \texttt{p}. Das \ma \end{beispiel} Die gesternte Version versteckt die Nummer und liefert nur den Satz. Wenn Sie den Satz verstecken und nur die Nummer ausgeben wollen, können Sie dises Option verwenden: -\begin{description} - \item\key{hide}{\uline{true}/false} -\end{description} +\begin{beschreibung} + \Option{hide}{\default{true}/false} +\end{beschreibung} Außerdem gibt es eine Option, mit der der Output angepasst werden kann. -\begin{description} - \item\key{space}{<space command>} Leerraum zwischen \texttt{<type>} und \texttt{<number>}. -\end{description} +\begin{beschreibung} + \option{space}{<space command>} Leerraum zwischen \code{<type>} und \code{<number>}. +\end{beschreibung} \begin{beispiel} \ghs{h}{200} \\ \ghs[space=\,]{h}{200} \\ @@ -2148,9 +2297,9 @@ Einige Sätze verwenden Platzhalter. Es gibt vier Stück: \end{itemize} Außer dem letzten, der ersetzt werden muss, sind sie in der Voreinstellung versteckt. Durch die Option -\begin{description} - \item\key{fill-in}{\uline{true}/false} Default = \texttt{false} -\end{description} +\begin{beschreibung} + \option{fill-in}{\default{true}/false} Default = \code{false} +\end{beschreibung} können sie sichtbar gemacht werden. \begin{beispiel}[below] \ghs{h}{340} \\ @@ -2164,12 +2313,12 @@ können sie sichtbar gemacht werden. \end{beispiel} Mit folgenden Optionen können die Platzhalter ersetzt werden: -\begin{description} - \item\key{exposure}{<text>} Expositions-Platzhalter - \item\key{effect}{<text>} Effekt-Platzhalter - \item\key{organs}{<text>} Organ-Platzhalter - \item\key{substance}{<text>} Substanz-Platzhalter -\end{description} +\begin{beschreibung} + \option{exposure}{<text>} Expositions-Platzhalter + \option{effect}{<text>} Effekt-Platzhalter + \option{organs}{<text>} Organ-Platzhalter + \option{substance}{<text>} Substanz-Platzhalter +\end{beschreibung} \begin{beispiel} \ghs[exposure=So werden Sie der Gefahr ausgesetzt.]{h}{340} \\ \ghs[effect=Das sind die Effekte]{h}{360} \\ @@ -2187,14 +2336,14 @@ Manche Sätze haben Lücken: \end{beispiel} Mit den folgenden Optionen können diese Lücken gefüllt werden: -\begin{description} - \item\key{text}{<text>} Füllt \enquote{unsichtbare Lücke}, die einem Doppelpunkt folgt. - \item\key{dots}{<text>} Füllt Lücke, die durch \enquote{\ldots} angezeigt wird. - \item\key{C-temperature}{<num>} Füllt Celsius-Temperatur. - \item\key{F-temperature}{<num>} Füllt Fahrenheit-temperatur. - \item\key{kg-mass}{<num>} Füllt Kilogramm-Masse. - \item\key{lbs-mass}{<num>} Füllt Pfund-Masse. -\end{description} +\begin{beschreibung} + \option{text}{<text>} Füllt \enquote{unsichtbare Lücke}, die einem Doppelpunkt folgt. + \option{dots}{<text>} Füllt Lücke, die durch \enquote{\ldots} angezeigt wird. + \option{C-temperature}{<num>} Füllt Celsius-Temperatur. + \option{F-temperature}{<num>} Füllt Fahrenheit-temperatur. + \option{kg-mass}{<num>} Füllt Kilogramm-Masse. + \option{lbs-mass}{<num>} Füllt Pfund-Masse. +\end{beschreibung} \begin{beispiel} \ghs[dots=Arzt kontaktieren!]{p}{301} \\ \ghs[text=here]{p}{401} \\ @@ -2203,7 +2352,7 @@ Mit den folgenden Optionen können diese Lücken gefüllt werden: \end{beispiel} \subsection{Kombinierte Sätze}\secidx[kombinierte Saetze@kombinierte Sätze]{GHSYSTEM} -Es existieren einige Kombinationen von Sätzen. Sie werden mit einem \texttt{+} zwischen den Nummern eingegeben: +Es existieren einige Kombinationen von Sätzen. Sie werden mit einem \code{+} zwischen den Nummern eingegeben: \begin{beispiel}[below] \ghs{p}{235+410} \\ \ghs{p}{301+330+331} @@ -2219,27 +2368,27 @@ Das GHS beinhaltet einige Piktogramme: \ghspic{explos} \ghspic{flame} \ghspic{flame-O} \ghspic{bottle} \ghspic{acid} \ghspic{skull} \ghspic{exclam} \ghspic{health} \ghspic{aqpol} Der Befehl -\begin{description} - \item\cmd{ghspic}[<options>]{<name>} -\end{description} -lädt sie. \ref{tab:ghs_pictograms} zeigt alle Piktogramme und ihre Dateinamen. Genauer: sie zeigt die Namen, die beim Befehl \cmd{ghspic} verwendet werden müssen. Tatsächlich heißen sie \lstinline=ghsystem_<name>.<filetype>=, wobei \texttt{<filetype>} entweder \texttt{eps}, \texttt{jpg} oder \texttt{png} ist, siehe auch Abschnitt \ref{ssec:picture_type}. +\begin{beschreibung} + \Befehl{ghspic}[<options>]{<name>} +\end{beschreibung} +lädt sie. \ref{tab:ghs_pictograms} zeigt alle Piktogramme und ihre Dateinamen. Genauer: sie zeigt die Namen, die beim Befehl \cmd{ghspic} verwendet werden müssen. Tatsächlich heißen sie \lstinline=ghsystem_<name>.<filetype>=, wobei \code{<filetype>} entweder \code{eps}, \code{jpg} oder \code{png} ist, siehe auch Abschnitt \ref{ssec:picture_type}. \begin{beispiel} \ghspic{skull} \end{beispiel} Wenn Ihnen die Defaultgröße nicht gefällt, können Sie die Option -\begin{description} - \item\key{scale}{<factor>} Scales the pictogram. Default = \texttt{1} -\end{description} +\begin{beschreibung} + \option{scale}{<factor>} Skaliert das Piktogramm. Default = \code{1} +\end{beschreibung} verwenden. Tatsächlich sind die Bilder recht groß. Die Voreinstellung (Faktor = $1$) skaliert die Bilder auf ein Zwanzigstel ihrer echten Größe. \begin{beispiel} \ghspic[scale=2]{skull} \end{beispiel} Wenn Sie spezielle \lstinline=\includegraphics=-Optionen verwenden wollen, \zB das Piktogramm rotieren, verwenden Sie diese Option: -\begin{description} - \item\key{includegraphics}{\{<includegraphics keyvals>\}} -\end{description} +\begin{beschreibung} + \Option{includegraphics}{\{<includegraphics keyvals>\}} +\end{beschreibung} \begin{beispiel} \ghspic[includegraphics={angle=90}]{skull} \end{beispiel} @@ -2275,24 +2424,24 @@ Wenn Sie spezielle \lstinline=\includegraphics=-Optionen verwenden wollen, \zB d \end{longtable} \subsection{Der Bildtyp hängt von der Engine ab}\label{ssec:picture_type} -Sie wissen vermutlich, dass Sie nicht jeden Bildtyp mit jeder Compiler-Engine verwenden können. \pdfTeX\ im \textsc{dvi}-Modus verlangt \texttt{eps}-Dateien, während \pdfTeX\ im \textsc{pdf}-Modus, \XeTeX\ und \LuaTeX\ \texttt{eps}-Dateien in \texttt{pdf}-Dateien konvertieren, vorausgesetzt, der Anwender hat Schreibrechte in dem Verzeichnis, in dem die Bilder gespeichert sind. +Sie wissen vermutlich, dass Sie nicht jeden Bildtyp mit jeder Compiler-Engine verwenden können. \pdfTeX\ im \textsc{dvi}-Modus verlangt \code{eps}-Dateien, während \pdfTeX\ im \textsc{pdf}-Modus, \XeTeX\ und \LuaTeX\ \code{eps}-Dateien in \code{pdf}-Dateien konvertieren, vorausgesetzt, der Anwender hat Schreibrechte in dem Verzeichnis, in dem die Bilder gespeichert sind. -Die letztgenannten können jedoch \texttt{jpg}- und \texttt{png}-Dateien ohne Schwierigkeiten einbinden, während \pdfTeX\ im \textsc{dvi}-Modus das nicht kann. +Die letztgenannten können jedoch \code{jpg}- und \code{png}-Dateien ohne Schwierigkeiten einbinden, während \pdfTeX\ im \textsc{dvi}-Modus das nicht kann. -Um das Problem zu lösen, testet \ghsystem, welche Engine verwendet wird und falls es \pdfTeX\ ist, in welchem Modus es verwendet wird. Dann wird entwder das \texttt{eps}- oder das \texttt{png}-Bild für die Piktogramme verwendet. Sie können den Bildtyp über die Option -\begin{description} - \item\key{pic-type}{eps/jpg/png} -\end{description} +Um das Problem zu lösen, testet \ghsystem, welche Engine verwendet wird und falls es \pdfTeX\ ist, in welchem Modus es verwendet wird. Dann wird entwder das \code{eps}- oder das \code{png}-Bild für die Piktogramme verwendet. Sie können den Bildtyp über die Option +\begin{beschreibung} + \Option{pic-type}{eps/jpg/png} +\end{beschreibung} jedoch frei wählen. \secidx*{Piktogramme} -\section{Verfügbare Sprachen} +\section{Verfügbare Sprachen}\label{sec:ghsystem_language} Bis jetzt sind die H- und P-Sätze nur auf deutsch und englisch verfügbar. Das Paket reagiert auf die \chemmacros Option \key[option]{german}, erkennt aber die Spracheinstellung von \paket{babel} oder \paket{polyglossia} (noch) nicht. Sie können die Sprache auch explizit wählen. -\begin{description} - \item\key{language}{english/german} -\end{description} +\begin{beschreibung} + \Option{language}{english/german} +\end{beschreibung} \begin{beispiel} \ghs{h}{201} @@ -2300,30 +2449,30 @@ Sie können die Sprache auch explizit wählen. \ghs{h}{201} \end{beispiel} -Ich werde in irgendwann in der Zukunft weitere Sprachen implementieren. Das kann aber eine Weile dauern. Wenn Sie gerne zu \ghsystem beisteuern möchten und die Sätze in einer anderen Sprache tippen wollen, kontaktieren Sie mich\footnote{\href{mailto:contac@mychemistry.eu}{contact@mychemistry.eu}} gerne. Ich stelle Ihnen dann eine Template-Datei, ein \texttt{pdf} mit den offiziellen Übersetzungen sowie jede weitere Hilfe, die sie benötigen. +Ich werde in irgendwann in der Zukunft weitere Sprachen implementieren. Das kann aber eine Weile dauern. Wenn Sie gerne zu \ghsystem beisteuern möchten und die Sätze in einer anderen Sprache tippen wollen, kontaktieren Sie mich\footnote{\href{mailto:contac@mychemistry.eu}{contact@mychemistry.eu}} gerne. Ich stelle Ihnen dann eine Template-Datei, ein \code{pdf} mit den offiziellen Übersetzungen sowie jede weitere Hilfe, die sie benötigen. \section{Liste aller Sätze}\secidx{Liste aller Sätze}[Liste aller Saetze] Wenn Sie gerne alle Sätze auf\-listen wollen, können Sie -\begin{description} - \item\cmd{ghslistall}[<options>] -\end{description} +\begin{beschreibung} + \Befehl{ghslistall}[<options>] +\end{beschreibung} verwenden. Dieser Befehl erstellt eine Tabelle aller Sätze mit der \lstinline=longtable=-Umgebung des \paket{longtable} Pakets. Ihr Erscheinungsbild kann mit den folgenden Optionen angepasst werden. -\begin{description} - \item\key{table-head-number}{<text>} Default = \texttt{Nummer} - \item\key{table-head-text}{<text>} Default = \texttt{Satz} - \item\key{table-next-page}{<text>} Default = \texttt{weiter auf der nächsten Seite} - \item\key{table-caption}{<text>} \texttt{<text>} in \lstinline=\caption{<text>}=. Default = \texttt{All H, EUH, and P Statements.} - \item\key{table-caption-short}{<text>} \texttt{<short>} in \lstinline=\caption[<short>]{<text>}=. - \item\key{table-label}{<text>} Das Label, mit dem man auf die Tabelle \lstinline=\ref= und ähnlichen Befehlen verweisen kann. Default = \texttt{tab:ghs-hp-statements} - \item\key{table-row-sep}{<dim>} Abstand zwischen den Zeilen. Eine \TeX-Länge. Default = \texttt{3pt} - \item\key{table-rules}{\uline{default}/booktabs/none} Der Stil der horizontalen Linien in der Tabelle. \texttt{default} verwendet \lstinline=\hline=, \texttt{booktabs} verwendet \lstinline=\toprule=, \lstinline=\midrule= und \lstinline=\bottomrule=. Dieser Wert benötigt das \paket{booktabs} Paket, dass Sie dann einbinden müssen. Default = \texttt{default} - \item\key{table-top-head-rule}{\uline{default}/booktabs/none} Explizites Ändern der Linie. Default = \texttt{default} - \item\key{table-head-rule}{\uline{default}/booktabs/none} Explizites Ändern der Linie. Default = \texttt{default} - \item\key{table-foot-rule}{\uline{default}/booktabs/none} Explizites Ändern der Linie. Default = \texttt{default} - \item\key{table-last-foot-rule}{\uline{default}/booktabs/none} Explizites Ändern der Linie. Default = \texttt{default} -\end{description} +\begin{beschreibung} + \option{table-head-number}{<text>} Default = \code{Nummer} + \option{table-head-text}{<text>} Default = \code{Satz} + \option{table-next-page}{<text>} Default = \code{weiter auf der nächsten Seite} + \option{table-caption}{<text>} \code{<text>} in \lstinline=\caption{<text>}=. Default = \code{All H, EUH, and P Statements.} + \option{table-caption-short}{<text>} \code{<short>} in \lstinline=\caption[<short>]{<text>}=. + \option{table-label}{<text>} Das Label, mit dem man auf die Tabelle \lstinline=\ref= und ähnlichen Befehlen verweisen kann. Default = \code{tab:ghs-hp-statements} + \option{table-row-sep}{<dim>} Abstand zwischen den Zeilen. Eine \TeX-Länge. Default = \code{3pt} + \option{table-rules}{\default{default}/booktabs/none} Der Stil der horizontalen Linien in der Tabelle. \code{default} verwendet \lstinline=\hline=, \code{booktabs} verwendet \lstinline=\toprule=, \lstinline=\midrule= und \lstinline=\bottomrule=. Dieser Wert benötigt das \paket{booktabs} Paket, dass Sie dann einbinden müssen. Default = \code{default} + \option{table-top-head-rule}{\default{default}/booktabs/none} Explizites Ändern der Linie. Default = \code{default} + \option{table-head-rule}{\default{default}/booktabs/none} Explizites Ändern der Linie. Default = \code{default} + \option{table-foot-rule}{\default{default}/booktabs/none} Explizites Ändern der Linie. Default = \code{default} + \option{table-last-foot-rule}{\default{default}/booktabs/none} Explizites Ändern der Linie. Default = \code{default} +\end{beschreibung} Der folgende Code zeigt, wie \ref{tab:ghs-hp-statements} erzeugt wurde: \begin{beispiel}[code only] @@ -2335,7 +2484,137 @@ Der folgende Code zeigt, wie \ref{tab:ghs-hp-statements} erzeugt wurde: \appendix \part{Anhang}\index{ANHANG@\textbf{ANHANG}} -\section*{Vorschläge und Bugreports}\addcontentsline{toc}{section}{Vorschläge und Bugreports} +\addsec{Übersicht über die Optionen und Anpassungsmöglichkeiten}\label{sec:overview}\secidx{Übersicht über die Optionen (chemmacros)}[Uebersicht ueber die Optionen] +\minisec{Optionen} +In der folgenden Tabelle werden alle Optionen aufgelistet, die \chemmacros bietet. Alle Optionen, die einem Modul angehören, können mit +\begin{beschreibung} + \Befehl{chemsetup}[<module>]{<options>} oder + \Befehl{chemsetup}{<module>/<options>} gesetzt werden. +\end{beschreibung} +Manche Optionen können ohne Wert verwendet werden. Dann wird der \default{unterstrichene} Wert verwendet. Die Optionen der Module \code{\textcolor{module}{chemformula}} und \code{\textcolor{module}{ghssystem}} werden hier nicht extra aufgelistet. +\small +\begin{longtable}{>{\ttfamily\color{key}\hspace{5mm}}l>{\ttfamily\color{module}}l>{\ttfamily}l>{\ttfamily}ll} + \toprule + \normalfont\normalcolor\bfseries Option & + \normalfont\normalcolor\bfseries Modul & + \normalfont\bfseries Werte & + \normalfont\bfseries Default & \\ + \midrule + \endhead + \bottomrule + \endfoot + \multicolumn{5}{l}{Paketoptionen:} \\ + bpchem & option & \default{true}/false & false & Seite \pageref{key:option_bpchem} \\ + circled & option & formal/\default{all}/none & formal & Seite \pageref{key:option_circled} \\ + circletype & option & chem/math & chem & Seite \pageref{key:option_circletype} \\ + cmversion & option & 1/2/bundle & bundle & Seite \pageref{key:option_cmversion} \\ + ghsystem & option & \default{true}/false & true & Seite \pageref{key:option_ghsystem} \\ + iupac & option & auto/restricted/strict & auto & Seite \pageref{key:option_iupac} \\ + language & option & <language> & english & Seite \pageref{key:option_language} \\ + method & option & chemformula/formula & formula & Seite \pageref{key:option_method} \\ + Nu & option & chemmacros/mathspec & chemmacros & Seite \pageref{key:option_Nu} \\ + strict & option & \default{true}/false & false & Seite \pageref{key:option_strict} \\ + synchronize & option & \default{true}/false & false & Seite \pageref{key:option_synchronize} \\ + greek & option & math/textgreek/\default{upgreek} & upgreek & Seite \pageref{key:option_greek} \\ + xspace & option & \default{true}/false & true & Seite \pageref{key:option_xspace} \\ + \multicolumn{5}{l}{\cmd{ba}, \cmd{Nu}:} \\ + elpair & particle & \default{dots}/dash/false & false & Seite \pageref{key:particle_elpair} \\ + \multicolumn{5}{l}{\cmd{|}, \cmd{-}:} \\ + hyphen-pre-space & iupac & <dim> & .01em & Seite \pageref{key:iupac_hyphen-pre-space} \\ + hyphen-post-space & iupac & <dim> & -.03em & Seite \pageref{key:iupac_hyphen-post-space} \\ + break-space & iupac & <dim> & .01em & Seite \pageref{key:iupac_break-space} \\ + \multicolumn{5}{l}{\cmd{DeclareChemLatin}:} \\ + format & latin & <anything> & \lstinline=\itshape= & Seite \pageref{key:latin_format} \\ + \multicolumn{5}{l}{\cmd{pch}, \cmd{mch}, \cmd{fpch}, \cmd{fmch}:} \\ + append & charges & \default{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 & \default{true}/false & true & Seite \pageref{key:ox_parse} \\ + roman & ox & \default{true}/false & true & Seite \pageref{key:ox_roman} \\ + pos & ox & top/super/side & top & Seite \pageref{key:ox_pos} \\ + explicit-sign & ox & \default{true}/false & false & Seite \pageref{key:ox_explicit-sign} \\ + decimal-marker & ox & comma/point & point & Seite \pageref{key:ox_decimal-marker} \\ + \multicolumn{5}{l}{\cmd{OX}, \cmd{redox}:} \\ + dist & redox & <dim> & .6em & Seite \pageref{key:redox_dist} \\ + sep & redox & <dim> & .2em & Seite \pageref{key:redox_sep} \\ + \multicolumn{5}{l}{\cmd{Enthalpy}, \cmd{Entropy}, \cmd{Gibbs}:} \\ + exponent & & <anything> & \cmd{standardstate} & Seite \pageref{key:none_exponent} \\ + delta & & <anything>/false & & Seite \pageref{key:none_delta} \\ + subscript & & left/right & & Seite \pageref{key:none_subscript} \\ + unit & & <unit> & & Seite \pageref{key:none_unit} \\ + \multicolumn{5}{l}{\cmd{DeclareChemState}, \cmd{RenewChemState}:} \\ + exponent & & <anything> & \cmd{standardstate} & Seite \pageref{key:none_exponent} \\ + delta & & <anything>/false & & Seite \pageref{key:none_delta} \\ + subscript & & <anything> & & Seite \pageref{key:none_subscript} \\ + subscript-left & & \default{true}/false & & Seite \pageref{key:none_subscript-left} \\ + \multicolumn{5}{l}{\cmd{State}:} \\ + exponent & state & <anything> & \cmd{standardstate} & Seite \pageref{key:state_exponent} \\ + delta & state & <anything>/false & & Seite \pageref{key:state_delta} \\ + subscript-left & state & \default{true}/false & & Seite \pageref{key:state_subscript-left} \\ + \multicolumn{5}{l}{\cmd{NMR}, \env{spectroscopy}{}:} \\ + unit & nmr & <unit> & \cmd{mega}\cmd{hertz} & Seite \pageref{key:nmr_unit} \\ + nucleus & nmr & \{<num>,<atom symbol>\} & \{1,H\} & Seite \pageref{key:nmr_nucleus} \\ + format & nmr & <anything> & & Seite \pageref{key:nmr_format} \\ + pos-number & nmr & side/sub & side & Seite \pageref{key:nmr_pos-number} \\ + coupling-unit & nmr & <unit> & \lstinline+\hertz+ & Seite \pageref{key:nmr_coupling-unit} \\ + parse & nmr & \default{true}/false & true & Seite \pageref{key:nmr_parse} \\ + delta & nmr & <anything> & & Seite \pageref{key:nmr_delta} \\ + list & nmr & \default{true}/false & false & Seite \pageref{key:nmr_list} \\ + list-setup & nmr & & siehe Text & Seite \pageref{key:nmr_list-setup} \\ + use-equal & nmr & \default{true}/false & false & Seite \pageref{key:nmr_use-equal} \\ + \multicolumn{5}{l}{\cmd{DeclareChemReaction}:} \\ + star & & \default{true}/false & false & Seite \pageref{key:none_star} \\ + arg & & \default{true}/false & false & Seite \pageref{key:none_arg} \\ + list-name & reaction & <anything> & List of reactions & Seite \pageref{key:reaction_list-name} \\ + list-entry & reaction & <anything> & Reaction & Seite \pageref{key:reaction_list-entry} \\ + \multicolumn{5}{l}{\cmd{mhName}:} \\ + align & mhName & <alignment> & \cmd{centering} & Seite \pageref{key:mhName_align} \\ + format & mhName & <commands> & & Seite \pageref{key:mhName_format} \\ + fontsize & mhName & <fontsize> & \cmd{tiny} & Seite \pageref{key:mhName_fontsize} \\ + width & mhName & <dim> & & Seite \pageref{key:mhName_width} \\ + \multicolumn{5}{l}{phases:} \\ + pos & phases & side/sub & side & Seite \pageref{key:phases_pos} \\ + space & phases & <dim> & .1333em & Seite \pageref{key:phases_space} \\ + \multicolumn{5}{l}{\cmd{newman}:} \\ + angle & newman & <angle> & 0 & Seite \pageref{key:newman_angle} \\ + scale & newman & <factor> & 1 & Seite \pageref{key:newman_scale} \\ + ring & newman & <tikz> & & Seite \pageref{key:newman_ring} \\ + atoms & newman & <tikz> & & Seite \pageref{key:newman_atoms} \\ + back-atoms & newman & <tikz> & & Seite \pageref{key:newman_back-atoms} \\ + \multicolumn{5}{l}{\cmd{orbital} \ttfamily <type> = s/p/sp/sp2/sp3:} \\ + phase & orbital/<type> & +/- & + & Seite \pageref{key:orbital_phase} \\ + scale & orbital/<type> & <factor> & 1 & Seite \pageref{key:orbital_scale} \\ + color & orbital/<type> & <color> & black & Seite \pageref{key:orbital_color} \\ + angle & orbital/<type> & <angle> & 90 & Seite \pageref{key:orbital_angle} \\ + half & orbital/p & \default{true}/false & false & Seite \pageref{key:orbital_half} \\ + overlay & orbital & \default{true}/false & false & Seite \pageref{key:orbital_overlay} \\ + opacity & ornital & <num> & 1 & Seite \pageref{key:orbital_opacity} +\end{longtable} +\normalsize + +\minisec{Anpassungsbefehle} +Eine ganze Reihe von Befehlen wurde vorgestellt, mit denen die Möglichkeiten von \chemmacros erweitert werden können. Sie werden hier noch einmal aufgelistet. +\begin{beschreibung} + \befehl{DeclareChemArrow} Neuen Pfeil definieren, siehe Seite \pageref{cmd:DeclareChemArrow}. + \befehl{RenewChemArrow} Bestehende Pfeile verändern. + \befehl{DeclareChemIUPAC} Neuen IUPAC-Befehl definieren, siehe Seite \pageref{cmd:DeclareChemIUPAC}. + \befehl{RenewChemIUPAC} IUPAC-Befehl umdefinieren. + \befehl{DeclareChemLatin} Neue lateinische Ausdrücke definieren, siehe Seite \pageref{cmd:DeclareChemLatin}. + \befehl{RenewChemLatin} Lateinische Ausdrücke umdefinieren. + \befehl{DeclareChemNMR} Neuen NMR-Befehl definieren, siehe Seite \pageref{cmd:DeclareChemNMR}. + \befehl{RenewChemNMR} NMR-Befehl umdefinieren. + \befehl{DeclareChemParticle} Neues Teilchen definieren, siehe Seite \pageref{cmd:DeclareChemParticle}. + \befehl{RenewChemParticle} Teilchen umdefinieren. + \befehl{DeclareChemPhase} Neuen Phasenbefehl definieren, siehe Seite \pageref{cmd:DeclareChemPhase}. + \befehl{RenewChemPhase} Phasenbefehl umdefinieren. + \befehl{DeclareChemReaction} Neue Reaktionsumgebung definieren, siehe Seite \pageref{cmd:DeclareChemReaction}. + \befehl{DeclareChemState} Neue Zustandsgröße definieren, siehe Seite \pageref{cmd:DeclareChemState}. + \befehl{RenewChemState} Zustandsgröße umdefinieren. +\end{beschreibung} +\secidx*{Übersicht über die Optionen (chemmacros)}[Uebersicht ueber die Optionen] + +\addsec{Vorschläge und Bugreports} Feedback zu \chemmacros, \chemformula und \ghsystem ist hochwillkommen! Wenn Sie Vorschläge haben, Ihnen Features fehlen oder Ihnen Bugs auf\-fallen, zögern Sie nicht, mich zu kontaktieren. Wenn Sie irgendwelche Fehler finden, seien es chemische, falsche Dokumentation \usw, wäre ich über eine kurze E-Mail\footnote{\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}} dankbar. Wenn Sie einen Bug finden, wäre es am besten, Sie schickten mir ein minimales Beispiel, mit dem ich den Bug reproduzieren kann. Sie können ihn auch als \enquote{Issue} auf \url{https://bitbucket.org/cgnieder/chemmacros/} melden. @@ -2343,13 +2622,15 @@ Wenn Sie einen Bug finden, wäre es am besten, Sie schickten mir ein minimales B Vielen Dank an alle, die mir schon Feedback zukommen ließen, vor allem (in alphabetischer Reihenfolge): \begin{itemize} \item \href{http://www.mathannotated.com/}{Peter Cao} - \item Dr.\ Paul King + \item Christina Lüdigk + \item Dr.\@ Paul King + \item Jonas Rivetti \item Christoph Schäfer \end{itemize} \printbibliography[title=Quellen] -\printindex +{\catcode`\^=11 \catcode`\#=11 +\printindex} -\listoftodos \end{document}
\ No newline at end of file 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 differdeleted file mode 100644 index 1c537486c30..00000000000 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_de.pdf +++ /dev/null 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 differdeleted file mode 100644 index dec1bf666d9..00000000000 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.pdf +++ /dev/null diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.pdf b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.pdf Binary files differnew file mode 100644 index 00000000000..48eec586121 --- /dev/null +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.pdf diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex index 1a599ca9f70..447fa1b652f 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_doc_en.tex +++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex @@ -1,62 +1,63 @@ %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% --------------------------------------------------------------------------- % -% - the CHEMMACROS bundle - % -% - chemmacros_doc_en.tex - % -% - macros and commands for chemists - % -% --------------------------------------------------------------------------- % -% - Clemens Niederberger - % -% - 2012/03/14 - % -% --------------------------------------------------------------------------- % -% - https://bitbucket.org/cgnieder/chemmacros/ - % -% - contact@mychemistry.eu - % -% --------------------------------------------------------------------------- % -% - If you have any ideas, questions, suggestions or bugs to report, please - % -% - feel free to contact me. - % -% --------------------------------------------------------------------------- % -% - Copyright 2011-2012 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. - % +% ----------------------------------------------------------------------------- +% - the CHEMMACROS bundle +% - chemmacros_en.tex +% - macros and commands for chemists +% ----------------------------------------------------------------------------- +% - Clemens Niederberger +% - 2012/05/07 +% ----------------------------------------------------------------------------- +% - https://bitbucket.org/cgnieder/chemmacros/ +% - contact@mychemistry.eu +% ----------------------------------------------------------------------------- +% - If you have any ideas, questions, suggestions or bugs to report, please +% - feel free to contact me. +% ----------------------------------------------------------------------------- +% - Copyright 2011-2012 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. +% ----------------------------------------------------------------------------- %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % -% if you want to compile this documentation: +% if you want to compile this documentation +% a) you'll need the document class `cnpkgdoc' which you can get here: +% https://bitbucket.org/cgnieder/cnpkgdoc/ +% the class is licensed LPPL 1.3 or later +% b) you need the following compilation order: +% > xelatex chemmacros_en (2 or probably 3 times) +% > biber chemmacros_en +% > makeindex -sl index_en.ist chemmacros_en.idx +% > xelatex chemmacros_en % -% > 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,toc=index,toc=bib]{scrartcl} -\usepackage{fontspec,xltxtra} +\documentclass[DIV11,toc=index,toc=bib]{cnpkgdoc} +\docsetup{ + pkg = chemmacros, + title = the \Chemmacros\ bundle, + subtitle = {packages \Chemmacros, \Chemformula\ and \Ghsystem}, + modules = true, + code-box = {skipabove=1ex,skipbelow=1ex} +} \usepackage{polyglossia} \setmainlanguage{english} -\usepackage[normalem]{ulem} -\usepackage{chemfig,chemstyle,upgreek,textgreek,multicol,makeidx,booktabs,csquotes,cancel} -\usepackage{chemmacros} +\usepackage{chemfig,chemstyle,upgreek,textgreek,booktabs,cancel} \usepackage[version=3]{mhchem} -\usepackage[para]{footmisc} +\usepackage{hologo} -% Setup: -\setmainfont[SmallCapsFont=Linux Libertine Capitals O,SlantedFont=Linux Libertine Slanted O]{Linux Libertine O} -\setsansfont[Scale=MatchLowercase,SmallCapsFont=Linux Biolinum Capitals O,SlantedFont=Linux Biolinum Slanted O]{Linux Biolinum O} -\setmonofont[Scale=MatchLowercase]{Inconsolata} \chemsetup[option]{synchronize} \colorlet{chemformula}{darkgray} -\chemsetup[chemformula]{font-spec={[Color=chemformula]Latin Modern Sans}} -\reversemarginpar -\input{chemmacros-codehelper} \begin{filecontents}{index_en.ist} - preamble "\\begin{theindex}\n Section titles are indicated \\textbf{bold}, packages \\textsf{sans serif}, commands \\textcolor{code}{\\texttt{\\textbackslash brown}}, keys \\textcolor{key}{\\texttt{green}} and modules (only \\chemmacros) \\textcolor{module}{\\texttt{red}}.\\newline\n\n" + preamble "\\begin{theindex}\n Section titles are indicated \\textbf{bold}, packages \\textsf{sans serif}, commands \\textcolor{code}{\\code{\\textbackslash brown}}, keys \\textcolor{key}{\\code{green}} and modules (only \\chemmacros) \\textcolor{module}{\\code{red}}.\\newline\n\n" heading_prefix "{\\bfseries " heading_suffix "\\hfil}\\nopagebreak\n" headings_flag 1 @@ -76,7 +77,7 @@ title = {“Quantities, Symbols and Units in Physical Chemistry”, \IUPAC Green Book}, edition = {3rd Edition. 2nd Printing}, year = {2008}, - publisher = { \IUPAC \&\ RSC Publishing, Cambridge} + publisher = {\IUPAC \&\ RSC Publishing, Cambridge} } @misc{eu:ghsystem_regulation, author = {{The European Parliament and The Council of the European Union}}, @@ -103,76 +104,61 @@ numerator-format = \scriptsize #1 } -\usepackage{hyperref} - \hypersetup{colorlinks = true, - allcolors = myblue, - plainpages = false, - bookmarksopen = true, - bookmarksopenlevel = 1, - bookmarksnumbered = true, - bookmarksdepth = paragraph, - 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} -\newcommand*\chemformula{{\scshape\textcolor{myblue}{chemformula}}\xspace} -\newcommand*\ghsystem{{\scshape\textcolor{myblue}{ghsystem}}\xspace} +\newcommand*\chemformula{{\scshape\textcolor{cnpkgblue}{chemformula}}\xspace} +\newcommand*\ghsystem{{\scshape\textcolor{cnpkgblue}{ghsystem}}\xspace} -\newcommand*\Chemmacros{{\fontspec[Color=myblue,Scale=1.2]{Linux Biolinum Shadow O}chemmacros}} -\newcommand*\Chemformula{{\fontspec[Color=myblue,Scale=1.2]{Linux Biolinum Shadow O}chemformula}} -\newcommand*\Ghsystem{{\fontspec[Color=myblue,Scale=1.2]{Linux Biolinum Shadow O}ghsystem}} +\newcommand*\Chemmacros{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}chemmacros}} +\newcommand*\Chemformula{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}chemformula}} +\newcommand*\Ghsystem{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}ghsystem}} -\newcommand*\eg{\mbox{e.\,g.}\xspace} -\newcommand*\ie{\mbox{i.\,e.}\xspace} -\newcommand*\etc{\mbox{etc.}\xspace} -\newcommand*\TIKZ{Ti\textbf{\textit{k}}Z} -\newcommand*\TikZ{\index{TikZ@\TIKZ}\mbox{\TIKZ}\xspace} +\newcommand*\IUPAC{\mbox{IUPAC}\xspace} +\renewcommand*\AmS{\hologo{AmS}} +\newcommand*\pdfTeX{\hologo{pdfTeX}} +\newcommand*\LuaTeX{\hologo{LuaTeX}} -\newcommand*\pdfTeX{\textsc{pdf\kern-.2ex\TeX}} -\renewcommand*\LuaTeX{{Lua\kern-.2ex\TeX}} - -\providecommand\glqq{„} -\providecommand\grqq{“} +\TitlePicture{% + \ch[font-spec={[Color=chemformula]Augie}]{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" {}+ + 2 "\OX{r2,\ox{-1,Cl}}" {}- } + \redox(o1,o2)[red,-cf]{\small\ch[font-spec={[Color=red]Augie},math-space=.3em]{$-$ 2 e-}} + \redox(r1,r2)[blue,-cf][-1]{\small\ch[font-spec={[Color=blue]Augie},math-space=.3em]{$+$ 2 e-}}} + +\addcmds{ + a,abinitio,AddRxnDesc,aq,aqi,b,ba,bottomrule,cancel,cd,cdot,ce,cee,celsius, + centering,chemabove,Chemalpha,Chembeta,Chemgamma,Chemdelta,ChemDelta,chemfig, + chemname,Chemomega,chemsetup,cip,cis,ch,cnsetup,CNMR,color,cstsetup,d,D,data, + DeclareChemArrow,DeclareChemIUPAC,DeclareChemLatin,DeclareChemNMR, + DeclareChemParticle,DeclareChemPhase,DeclareChemReaction,DeclareChemState, + DeclareInstance,DeclareSIUnit,definecolor,delm,delp,Delta,Dfi,draw,E,el, + electronvolt,ElPot,Enthalpy,enthalpy,Entropy,footnotesize,fmch,fpch,fscrm, + fscrp,g,gas,ghs,ghslistall,ghspic,Gibbs,glqq,gram,grqq,H,hapto,HNMR,Helmholtz, + hertz,hspace,includegraphics,insitu,intertext,invacuo,iupac,IUPAC,J,joule,Ka, + Kb,kilo,Kw,L,latin,lewis,Lewis,Lfi,listofreactions,lqd,mch,mega,meta,metre, + mhName,midrule,milli,mmHg,mole,N,nano,nicefrac,newman,NMR,Nu,Nuc,num,O,ominus, + orbital,ortho,oplus,ox,OX,p,P,para,pch,per,percent,pgfarrowsdeclarealias, + pgfarrowsrenewalias,pH,phase,photon,pKa,pKb,pOH,pos,positron,Pot,prt,R,Rad, + redox,RenewChemArrow,RenewChemIUPAC,RenewChemLatin,RenewChemNMR, + RenewChemParticle,RenewChemPhase,RenewChemState,renewtagform,rightarrow,S,Sf, + sample,scriptscriptstyle,scrm,scrp,setatomsep,setbondoffset,sfrac, + shorthandoff,ShowChemArrow,si,SI,sisetup,sld,Sod,State,subsection,textcolor, + textendash,textsuperscript,tiny,toprule,trans,upbeta,upeta,upgamma,val,volt, + vphantom,vspave,w,xspace,Z} \makeindex \begin{document} -\GetFileInfo{chemmacros} - -\begin{center} - % title: - \Huge the \Chemmacros\ bundle \\[.5cm] - \fileversion \qquad \filedate \\[.5cm] - \Large packages \Chemmacros, \Chemformula\ and \Ghsystem \\[.5cm] - % author and contact: - \large Clemens \textsc{Niederberger} \\[.5cm] - \normalsize\url{https://bitbucket.org/cgnieder/chemmacros/}\\ - \href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}\\[1cm] - % picture: - \large\ch[font-spec={[Color=chemformula]Augie}]{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } - \redox(o1,o2)[red,-cf]{\small\ch[font-spec={[Color=red]Augie},math-space=.3em]{$-$ 2 e-}} - \redox(r1,r2)[blue,-cf][-1]{\small\ch[font-spec={[Color=blue]Augie},math-space=.3em]{$+$ 2 e-}} -\end{center} -\vskip1cm -\begin{multicols}{2} - \tableofcontents -\end{multicols} +\chemsetup[chemformula]{font-spec={[Color=chemformula]Latin Modern Sans}} +\renewcommand*\glqq{„} +\renewcommand*\grqq{“} \part{Preliminaries}\secidx{PRELIMINARIES} \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}) +The \chemmacros bundle underlies the \LaTeX\ project public license (lppl) version 1.3 or later (\url{http://www.latex-project.org/lppl.txt}) and has the status “maintained”. -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}. +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 \code{calc} and \code{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}. 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}}. +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}{\code{green}} and modules \textcolor{module}{\code{red}}. 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. @@ -181,11 +167,13 @@ The package \ghsystem needs the packages \chemmacros, \paket{tabu}, \paket{longt \section{Motivation and Background} \chemmacros started some years ago as a growing list of custom macros that I frequently used. I cannot completely recall when and why I decided to release them as a package. Well \textendash\ here we go and you might find it useful, too, I hope. -I would guess that nearly every chemist using \LaTeXe\ is aware of the great \paket{mhchem} package by Martin Hensel. There have always been some difficulties intertwining it with \chemmacros, though. Also, some other minor points in \paket{mhchem} always bothered me, but they hardly seemed enough for a new package. They weren't even enough for a feature request to the \paket{mhchem} author. The challenge and the fun of creating a new package and the wish for a highly customizable alternative led to \chemformula after all. +Both the macros and their functionality have changed over time and quite a lot have been added. Many things have been unified and what's probably most important: many possibilities to customize have been added, too. + +Probably every chemist using \LaTeXe\ is aware of the great \paket{mhchem} package by Martin Hensel. There have always been some difficulties intertwining it with \chemmacros, though. Also, some other minor points in \paket{mhchem} always bothered me, but they hardly seemed enough for a new package. They weren't even enough for a feature request to the \paket{mhchem} author. The challenge and the fun of creating a new package and the wish for a highly customizable alternative led to \chemformula after all. -\chemformula works very similar to \paket{mhchem} but is more strict as to how compounds, stoichiometric factors and arrows are input. In the same time \chemformula offers possibilities to customize the output that \paket{mhchem} does not. Since \chemformula is meant as an \emph{alternative} to \paket{mhchem} \chemmacros offers a package option allowing you to choose which one of the two is used. +\chemformula works very similar to \paket{mhchem} but is more strict as to how compounds, stoichiometric factors and arrows are input. In the same time \chemformula offers possibilities to customize the output that \paket{mhchem} does not. Since \chemformula is meant as an \emph{alternative} to \paket{mhchem} \chemmacros offers a package option allowing you to choose which one of the two is used. The default however is \chemmacros own way: \chemformula. -As a chemist you are probably aware of the fact that the \textsc{United Nations} have developed the \enquote{\textbf{G}lobally \textbf{H}armonized \textbf{S}ystem of Classification and Labelling of Chemicals} (GHS) as a global replacement for the various different systems in different countries. While it has not been implemented by all countries yet\cite{unece:ghsystem_implementation}, it as only a matter of time. +As a chemist you are probably aware of the fact that the \textsc{United Nations} have developed the \enquote{\textbf{G}lobally \textbf{H}armonized \textbf{S}ystem of Classification and Labelling of Chemicals} (GHS) as a global replacement for the various different systems in different countries. While it has not been implemented by all countries yet \cite{unece:ghsystem_implementation}, it as only a matter of time. The package \ghsystem now enables you to typeset all the hazard and precautionary statements and pictograms in a very easy way. The statements are taken from EU regulation 1272/2008 \cite{eu:ghsystem_regulation}. @@ -198,8 +186,10 @@ There are four points I hope I have achieved with this bundle: \end{itemize} Especially the last point needed some pushing from users to get things right in many places. If you find anything not compliant with \IUPAC recommendations\footnote{This does not convern the \cmd{ox} command. The \IUPAC version is \cmd[oxa]{ox*}.} I would welcome an email very much! +In a package this large with older parts and rather new parts (which have to be considered being in beta state) it is unavoidable that there are flaws and bugs. I am very keen on correcting and improving this package so please: if you find anything that bothers you and may it be just so small please send me a short email and I'll see what I can do. I would especially like feedback on \chemformula (see part \ref{part:chemformula}) and \ghsystem (see part \ref{part:ghsystem}) but also welcome feedback on every other part of this bundle. + \section{Installation, Loading the Bundle}\secidx{Loading the Bundle}\secidx{Installation} -The bundle comes with three style files\footnote{Those ending \texttt{sty}.}, a directory called \texttt{language/} containing the language-definition files for GHS (ending \texttt{def}), and a directory \texttt{pictures/} containing \texttt{eps}, \texttt{jpg} and \texttt{png} files (the GHS pictogramms). If you install the bundle manually \emph{please make sure to place the directories \texttt{language/} and \texttt{pictures/} in the \emph{same} directory as the style files}. +The bundle comes with three style files\footnote{Those ending \code{sty}.}, a directory called \code{language/} containing the language-definition files for GHS (ending \code{def}), and a directory \code{pictures/} containing \code{eps}, \code{jpg} and \code{png} files (the GHS pictogramms). If you install the bundle manually \emph{please make sure to place the directories \code{language/} and \code{pictures/} in the \emph{same} directory as the style files}. Loading \chemmacros with \begin{beispiel}[code only] @@ -207,14 +197,14 @@ Loading \chemmacros with \end{beispiel} will also load \chemformula and \ghsystem. However, you can prevent \chemmacros from loading \ghsystem: \begin{beispiel}[code only] - \usepackage[ghsystem=false]{chemmacros} % `chemmacros' and `formula' are loaded + \usepackage[ghsystem=false]{chemmacros} % `chemmacros' and `chemformula' are loaded \end{beispiel} Loading \chemformula or \ghsystem explicitly is possible and will also load \chemmacros if it hasn't been loaded yet, and will therefore implicitly load the other package, too. \begin{beispiel}[code only] - \usepackage{chemformula} % `chemmacros', `formula' and `ghs' are loaded + \usepackage{chemformula} % `chemmacros', `chemformula' and `ghsystem' are loaded or - \usepackage[ghs=false]{chemformula} % `chemmacros' and `formula' are loaded + \usepackage[ghsystem=false]{chemformula} % `chemmacros' and `chemformula' are loaded \end{beispiel} However, it is recommended to simply use \lstinline=\usepackage{chemmacros}= and setup the required options with \lstinline=\chemsetup= (also see section \ref{sec:setup}). @@ -225,38 +215,48 @@ However, it is recommended to simply use \lstinline=\usepackage{chemmacros}= and \begin{beispiel}[code only] \usepackage[option1 = <value1>, option2 = <value2>]{chemmacros} \end{beispiel} -Some also can be used without value (\lstinline+\usepackage[option1]{chemmacros}+), which means that the \uline{underlined} value is used. +Some also can be used without value (\lstinline+\usepackage[option1]{chemmacros}+), which means that the \default{underlined} value is used. Both \chemformula and \ghsystem don't have package options of their own. If you load them explicitly you can give them \chemmacros' options instead and they will pass them on to \chemmacros. -\begin{description} - \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 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]{cmversion}{1/2/bundle} This option restores the old definitions of some commands, so documents set with v1.* will still compile correctly. (default = \texttt{bundle}). Actually \texttt{2} and \texttt{bundle} are only aliases. This option can only be chosen in the preamble. Note: this is a new name for the now deprecated option \key{version}. - \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]{ghsystem}{\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}) - \item \key[option]{method}{\uline{chemformula}/mhchem} You can choose the method which \chemmacros will use for the reaction environments (see section \ref{ssec:mhchem_reaktionen}) and the typesetting of the particles (see section \ref{sec:teilchen}). (default = \texttt{chemformula}). This option can only be chosen in the preamble. - \item \key[option]{Nu}{\uline{chemmacros}/mathspec} The package \paket{mathspec} also defines a macro \cmd{Nu}. This option chooses which definition holds, see page \pageref{Nu}. (default = \texttt{chemmacros}). This option can only be chosen in the preamble. - \item \key[option]{strict}{\uline{true}/false} Setting \key{strict}{true} will turn all warning messages into erros messages. (default = \texttt{false}) - \item \key[option]{synchronize}{\uline{true}/false} The setting \texttt{true} will tell \chemmacros the adapt the font settings of \chemformula if that method has been chosen (default = \texttt{false}). In order to demonstrate this feature this document is set with \key{synchronize}{true} and the \chemformula setting \lstinline+\chemsetup[chemformula]{font-spec={[Color=darkgray]Latin Modern Sans}}+. - \item \key[option]{upgreek}{none/textgreek/\uline{upgreek}} This Options determines how the letters \cmd{Chemalpha} and friends are typeset. See page \pageref{key:upgreek} for more information. This option can only be chosen in the preamble. (default = \texttt{upgreek}) - \item \key[option]{version} \emph{This option does nothing and only exists for backwards compatibility}. The functionality is now provided by the option \key{cmversion}. The option has been renamed so \chemmacros is compatible with the global option \texttt{version} of \paket[koma-script]{KOMA-script}. - \item \key[option]{xspace}{\uline{true}/false} With this option most commands are defined with a \lstinline+\xspace+. (default = \texttt{true}) -\end{description} +\begin{beschreibung} + % bpchem + \option[option]{bpchem}{\default{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 = \code{false}) + % circled + \option[option]{circled}{\default{formal}/all/none} \chemmacros uses two different kinds of charges which indicate the usage of real ($+/-$) and formal (\fplus/\fminus) charges. The option \code{formal} distinguishes between them, option \code{none} displays them all without circle, option \code{all} circles all (default = \code{formal}) + % circletype + \option[option]{circletype}{\default{chem}/math} This option switches between two kinds of circled charge symbols: \cmd{fplus} \fplus\ and \lstinline+$\oplus$+ $\oplus$. (default = \code{chem}) + % cmversion + \option[option]{cmversion}{1/2/bundle} This option restores the old definitions of some commands, so documents set with v1.* will still compile correctly. (default = \code{bundle}). Actually \code{2} and \code{bundle} are only aliases. \emph{This option can only be chosen in the preamble}. + % ghsystem + \option[option]{ghsystem}{\default{true}/false} Disable the use of the \ghsystem package. Setting \key{ghs}{false} will prevent \chemmacros from loading \ghsystem. (default = \code{true}) + % greek + \option[option]{greek}{math/textgreek/\default{upgreek}} This Options determines how the letters \cmd{Chemalpha} and friends are typeset. See page \pageref{desc:upgreek} for more information. \emph{This option can only be chosen in the preamble}. (default = \code{upgreek}) + % iupac + \option[option]{iupac}{auto/restricted/strict} Take care of how iupac naming commands are defined, see page \pageref{desc:iupac} (default = \code{auto}) + % language + \option[option]{language}{american/british/english/french/german/italian/ngerman} Load language specific options. \code{english}, \code{american} and \code{british} are aliases, as are \code{german} and \code{ngerman}. \emph{This option can only be chosen in the preamble}. (default = \code{english}). + % method + \option[option]{method}{\default{chemformula}/mhchem} You can choose the method which \chemmacros will use for the reaction environments (see section \ref{sec:reactions}) and the typesetting of the particles (see section \ref{sec:teilchen}). (default = \code{chemformula}). \emph{This option can only be chosen in the preamble}. + % Nu + \option[option]{Nu}{\default{chemmacros}/mathspec} The package \paket{mathspec} also defines a macro \cmd{Nu}. This option chooses which definition holds, see page \pageref{Nu}. (default = \code{chemmacros}). \emph{This option can only be chosen in the preamble}. + % strict + \option[option]{strict}{\default{true}/false} Setting \key{strict}{true} will turn all warning messages into erros messages. (default = \code{false}) + % synchronize + \option[option]{synchronize}{\default{true}/false} The setting \code{true} will tell \chemmacros the adapt the font settings of \chemformula if that method has been chosen (default = \code{false}). In order to demonstrate this feature this document is set with \key{synchronize}{true} and the \chemformula setting \lstinline+\chemsetup[chemformula]{font-spec={[Color=darkgray]Latin Modern Sans}}+. + % xspace + \option[option]{xspace}{\default{true}/false} With this option most commands are defined with a \lstinline+\xspace+. (default = \code{true}) +\end{beschreibung} \secidx*{Package Options} \section{Setup}\label{sec:setup}\secidx{Setup} Various of \chemmacros', \chemformula's and \ghsystem's commands have key/value pairs with which they can be customized. Most times they can be used as (optional) argument of the commands themselves. They also can most times be used with the \cmd{chemsetup} command. -\begin{description} - \item \cmd{chemsetup}[<module>]{<key> = <value>} or - \item \cmd{chemsetup}{<module>/<key> = <value>} -\end{description} +\begin{beschreibung} + \Befehl{chemsetup}[<module>]{<key> = <value>} or + \Befehl{chemsetup}{<module>/<key> = <value>} +\end{beschreibung} The keys each belong to a module, which defines for which commands they are intended for. If a key is presented, you'll see the module to which it belongs in the left margin. You have two ways to use keys with the \cmd{chemsetup}, as you can see above. -The package options can also be seen as keys belonging to the module \textcolor{module}{\ttfamily option}. This means they can also be used with the \cmd{chemsetup} command (except for the option \key[option]{version}{1/2/3}). +The package options can also be seen as keys belonging to the module \textcolor{module}{\code{option}}. This means they can also be used with the \cmd{chemsetup} command (except for the option \key[option]{version}{1/2/3}). \begin{beispiel} \chemsetup[option]{circled=none}\mch\ \pch\ \fmch\ \fpch\ \el\ \prt \\ \chemsetup[option]{circled=formal}\mch\ \pch\ \fmch\ \fpch\ \el\ \prt \\ @@ -266,43 +266,90 @@ The package options can also be seen as keys belonging to the module \textcolor{ \end{beispiel} Keys \emph{not} belonging to a module \emph{cannot} be used with \cmd{chemsetup}! -All options of \chemformula belong to the module \textcolor{module}{\texttt{chemformula}} and all of \ghsystem's options belong to the module \textcolor{module}{\texttt{ghs}}. +All options of \chemformula belong to the module \textcolor{module}{\code{chemformula}} and all of \ghsystem's options belong to the module \textcolor{module}{\code{ghs}}. \secidx*{Setup} -\secidx*{PRELIMINARIES} -\part{\texorpdfstring{\Chemmacros}{chemmacros}}\secidx{CHEMMACROS} +\section{Language Settings}\label{sec:languages}\secidx{Language Settings} +\subsection{Supported Languages} +By choosing the option +\begin{beispiel}[code only] + \chemsetup[option]{language=<language>} +\end{beispiel} +you can set one of these languages: \code{american/british/english/french/german/italian/ngerman}. The languages \code{american/british/english} are aliases, as are \code{german/ngerman}. + +These translate +\begin{itemize} + \item The header of the list of reactions. + \item The beginning of the entries in the list of reactions. + \item The H- and P-statements of the GHS. +\end{itemize} + +\achtung{Please note, that the GHS statements are not provided in all languages, see also section \ref{sec:ghsystem_language}.} + +\subsection{Specialties} +\subsubsection{German} +If you choose \code{german/ngerman} the phase commands \cmd{sld} and \cmd{lqd} and the command \cmd{pKa} are translated. + +\subsubsection{Italian} +\DeclareChemIUPAC{\ter}{\textit{ter}}\DeclareChemIUPAC{\sin}{\textit{sin}}% +Choosing the language \code{italian} defines two additional IUPAC commands: +\begin{beschreibung} + \befehl{ter} \iupac{\ter} + \befehl{sin} \iupac{\sin} +\end{beschreibung} +\secidx*{Language Settings} + +\section{News}\secidx{News} +\subsection{Version 3.3} +\begin{itemize} + \item With v3.3 there is the environment \env{experimental}{}, see section \ref{sec:spektroskopie}. It can be used together with some new options and commands for the consistent typesetting of experimental data. + \item The environment \env{reaction}{} and its kin can now cope with \lstinline+\label+, \lstinline+\ref+ and \lstinline+\intertext+, see section \ref{sec:reactions}. + \item The package options \key{german} and \key{ngerman} are deprecated, the replacement is \key{language}, see page \pageref{key:option_language} and section \ref{sec:languages} from page \pageref{sec:languages}. + \item The package option \key{upgreek} got renamed into \key{greek}. + \item Some additional \code{\textbackslash\textcolor{code}{Chem<greekletter>}}-commands are provided, see section \ref{sec:teilchen}. +\end{itemize} +\secidx*{News}\secidx*{PRELIMINARIES} + +\part{\texorpdfstring{\Chemmacros}{chemmacros}}\secidx{CHEMMACROS}\label{part:chemmacros} \section{Particles, Ions and Symbols}\label{sec:teilchen}\secidx{Particles, Ions and Symbols} \subsection{Predefined}\secidx[predefined]{Particles, Ions and Symbols} \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) - \item \cmd{HtO} \HtO (oxonium ion) (\textbf{H} \textbf{t}hree \textbf{O}) - \item \cmd{water} \water - \item \cmd{el} \el (electron) - \item \cmd{prt} \prt (proton) - \item \cmd{ntr} \ntr (neutron) - \item \cmd{Nu} \Nu (nucleophile). The package \paket{mathspec} also defines a macro \cmd{Nu}. If you chose package option \key[option]{Nu}{mathspec} \chemmacros defines \cmd{Nuc} instead\label{Nu}. - \item \cmd{El} \El (electrophile) - \item \cmd{ba} \ba (base) - \item \cmd{fplus} \fplus - \item \cmd{fminus} \fminus - \item \cmd{transitionstatesymbol} \transitionstatesymbol - \item \cmd{standardstate} \standardstate. This symbol is only provided by \chemmacros, if the package \paket{chemstyle} is not loaded; the idea is borrowed from there\footnote{many thanks to the package author \href{http://www.texdev.net/}{Joseph Wright}.}. - \item \cmd{Chemalpha} \Chemalpha - \item \cmd{Chembeta} \Chembeta - \item \cmd{Chemgamma} \Chemgamma - \item \cmd{Chemdelta} \Chemdelta - \item \cmd{Chemomega} \Chemomega - \item \cmd{ChemDelta} \ChemDelta -\end{description} +\begin{beschreibung} + \befehl{Hpl} \Hpl (proton) + \befehl{Hyd} \Hyd (hydroxide) + \befehl{HtO} \HtO (oxonium ion) (\textbf{H} \textbf{t}hree \textbf{O}) + \befehl{water} \water + \befehl{el} \el (electron) + \befehl{prt} \prt (proton) + \befehl{ntr} \ntr (neutron) + \befehl{Nu} \Nu (nucleophile). The package \paket{mathspec} also defines a macro \cmd{Nu}. If you chose package option \key[option]{Nu}{mathspec} \chemmacros defines \cmd{Nuc} instead\label{Nu}. + \befehl{El} \El (electrophile) + \befehl{ba} \ba (base) + \befehl{fplus} \fplus + \befehl{fminus} \fminus + \befehl{transitionstatesymbol} \transitionstatesymbol + \befehl{standardstate} \standardstate. This symbol is only provided by \chemmacros, if the package \paket{chemstyle} is not loaded; the idea is borrowed from there\footnote{many thanks to the package author \href{http://www.texdev.net/}{Joseph Wright}.}. + \befehl{Chemalpha} \Chemalpha + \befehl{Chembeta} \Chembeta + \befehl{Chemgamma} \Chemgamma + \befehl{Chemdelta} \Chemdelta + \befehl{Chemepsilon} \Chemepsilon + \befehl{Chemeta} \Chemeta + \befehl{Chemmu} \Chemmu + \befehl{Chemnu} \Chemnu + \befehl{Chemrho} \Chemrho + \befehl{Chempi} \Chempi + \befehl{Chemsigma} \Chemsigma + \befehl{Chemomega} \Chemomega + \befehl{ChemDelta} \ChemDelta +\end{beschreibung} \achtung{The command \cmd{Rad} has been dropped!} The two particles \cmd{Nu} and \cmd{ba} can be modified. To do that you use the option -\begin{description} - \item\key[particle]{elpair}{false/\uline{dots}/dash}. -\end{description} +\begin{beschreibung} + \Option[particle]{elpair}{false/\default{dots}/dash}. +\end{beschreibung} It only has any effect, if the package \paket{chemfig} is loaded, since it uses it's command \lstinline+\Lewis+. \begin{beispiel} % needs package `chemfig' @@ -312,14 +359,14 @@ It only has any effect, if the package \paket{chemfig} is loaded, since it uses \ba \Nu \end{beispiel} -\label{key:upgreek}The greek letters aren't newly defined symbols but are defined differently depending on the packages you've loaded. The default definition is the corresponding math letter. If you have loaded the \paket{textgreek} package the letters are taken from there, and if you have loaded the package \paket{upgreek} the macros of that package are used. This documentation uses \paket{upgreek} for instance. If you load both \paket{upgreek} and \paket{textgreek} the letters from \paket{upgreek} are used. +\label{desc:upgreek}The greek letters aren't newly defined symbols but are defined differently depending on the packages you've loaded. The default definition is the corresponding math letter. If you have loaded the \paket{textgreek} package the letters are taken from there, and if you have loaded the package \paket{upgreek} the macros of that package are used. This documentation uses \paket{upgreek} for instance. If you load both \paket{upgreek} and \paket{textgreek} the letters from \paket{upgreek} are used. -If you don't want \chemmacros to use a package automatically but want to decide for yourself, there is the option \key[option]{upgreek}. \ref{tab:upgreek_mode} shows the different styles for some of the letters. +If you don't want \chemmacros to use a package automatically but want to decide for yourself, there is the option \key[option]{greek}. \ref{tab:upgreek_mode} shows the different styles for some of the letters. \begin{table}[h] \centering \begin{tabular}{lccc}\toprule - & none & upgreek & textgreek \\\midrule + & math & upgreek & textgreek \\\midrule \cmd{Chemalpha} & $\alpha$ & $\upalpha$ & \textalpha \\ \cmd{Chembeta} & $\beta$ & $\upbeta$ & \textbeta \\ \cmd{ChemDelta} & $\Delta$ & $\Updelta$ & \textDelta \\ \bottomrule @@ -329,19 +376,19 @@ If you don't want \chemmacros to use a package automatically but want to decide The reason why \chemmacros defines these macros in the first place is \IUPAC compliance. \IUPAC recommends to use upright greek letters in nomenclature. -\begin{myquote}[\IUPAC Green Book \cite[][p.\,9]{iupac:greenbook}] +\begin{zitat}[\IUPAC Green Book \cite[][p.\,9]{iupac:greenbook}] Greek letters are used in systematic organic, inorganic, macromolecular and biochemical nomenclature. These should be roman (upright), since they are not symbols for physical quantities. -\end{myquote} +\end{zitat} \chemmacros uses these commands now to defined nomenclature commands, see page \pageref{par:greek_letters}. \subsection{Own Particles}\secidx[own]{Particles, Ions and Symbols} Surely sometimes it can be handy to have other particle macros defined such as \lstinline+\positron+ or \lstinline+\photon+. This can easily be done with this command: -\begin{description} - \item \cmd{DeclareChemParticle}{<cmd>}\ma{<definition>} - \item \cmd{RenewChemParticle}{<cmd>}\ma{<definition>} -\end{description} -Depending on the \key{method} you chose as option the \texttt{<definition>} will either be a formula defined with \paket{mhchem} or with \chemformula. The particle defined this way behaves like the predefined ones with one exception: if you chose \key{method}{mhchem} the particle \emph{will not} obey the option \key{circled}. If you want formal charges with this method you need to use \chemmacros' commands (see section \ref{sec:ladungen}) explicitly. If you chose \key{method}{chemformula} the partictle \emph{will} obey the \key{circled} option. +\begin{beschreibung} + \Befehl{DeclareChemParticle}{<cmd>}\ma{<definition>} + \Befehl{RenewChemParticle}{<cmd>}\ma{<definition>} +\end{beschreibung} +Depending on the \key{method} you chose as option the \code{<definition>} will either be a formula defined with \paket{mhchem} or with \chemformula. The particle defined this way behaves like the predefined ones with one exception: if you chose \key{method}{mhchem} the particle \emph{will not} obey the option \key{circled}. If you want formal charges with this method you need to use \chemmacros' commands (see section \ref{sec:ladungen}) explicitly. If you chose \key{method}{chemformula} the partictle \emph{will} obey the \key{circled} option. \begin{beispiel} % uses the `upgreek' package \DeclareChemParticle{\positron}{$\upbeta$+} @@ -349,23 +396,37 @@ Depending on the \key{method} you chose as option the \texttt{<definition>} will \RenewChemParticle{\el}{$\upbeta$-} \positron\ \photon\ \el \end{beispiel} -\cmd{DeclareChemParticle} only defines a particle if \texttt{<cmd>} is not already used by any other command. If it \emph{is} already used \chemmacros will either give a warning or an error, depending on the option \key{strict}. \cmd{RenewChemParticle} \emph{only} defines a particle if \texttt{<cmd>} \emph{is} already used and issues a warning/error otherwise. +\cmd{DeclareChemParticle} only defines a particle if \code{<cmd>} is not already used by any other command. If it \emph{is} already used \chemmacros will either give a warning or an error, depending on the option \key{strict}. \cmd{RenewChemParticle} \emph{only} defines a particle if \code{<cmd>} \emph{is} already used and issues a warning/error otherwise. \secidx*{Particles, Ions and Symbols} \section{Nomenclature, Stereo Descriptors, Latin Phrases}\label{sec:stereo} \subsection{\IUPAC Names}\secidx{IUPAC Names} -Similar to the \paket{bpchem} package \chemmacros provides a command\footnote{The idea and the implementation is shamelessly borrowed from \paket*{bpchem} by Bjørn Pedersen.} to typeset \IUPAC names. Why is that useful? \IUPAC names can get very long. So long indeed that they span over more than two lines, especially in two-column documents. This means they must be allowed to be broken more than one time. This is what the following command does. -\begin{description} - \item\cmd{iupac}{<IUPAC name>} Inside this command use \cmd{\textbar} and \cmd{-} to indicate a breaking point or a breaking dash. Use \cmd{\textasciicircum} as a shortcut for \lstinline=\textsuperscript=\footnote{Actually \cmd{\textasciicircum} uses a \chemformula command instead.}. -\end{description} +Similar to the \paket{bpchem} package \chemmacros provides a command\footnote{The idea and the implementation is shamelessly borrowed from \paket*{bpchem} by Bjørn Pedersen.} to typeset \IUPAC names. Why is that useful? \IUPAC names can get very long. So long indeed that they span over more than two lines, especially in two-column documents. This means they must be allowed to be broken more than one time. This is what the following command does. +\begin{beschreibung} + \item\cmd{iupac}{<IUPAC name>} Inside this command use \cmd{|} and \cmd{-} to indicate a breaking point or a breaking dash. Use {\catcode`\^=11\cmd{^}} as a shortcut for \lstinline=\textsuperscript=\footnote{Actually another mechanism is used, but the effect is essentially the same.}. +\end{beschreibung} + \begin{beispiel} \begin{minipage}{.4\linewidth} \iupac{Tetra\|cyclo[2.2.2.1\^{1,4}]\-un\|decane-2\-dodecyl\-5\-(hepta\|decyl\|iso\|dodecyl\|thio\|ester)} \end{minipage} \end{beispiel} -The \cmd{iupac} command is more of a semantic command. Most times you can achieve (nearly) the same thing by using \cmd{-} instead of \cmd{\textbar}, \texttt{-} instead of \cmd{-} and \lstinline=\textsuperscript= instead of \cmd{\textasciicircum}. +The \cmd{iupac} command is more of a semantic command. Most times you can achieve (nearly) the same thing by using \cmd{-} instead of \cmd{|}, \code{-} instead of \cmd{-} and \lstinline=\textsuperscript= instead of {\catcode`\^=11\cmd{^}}. -The command \cmd{iupac} serves another purpose, too, however. Regardless of the setting of the \key[option]{iupac} option all the commands presented in this section are always defined \emph{inside} \cmd{iupac}. Quite a number of the naming commands have very general names: \cmd{meta}, \cmd{D}, \cmd{E}, \cmd{L}, \cmd{R}, \cmd{S}, \cmd{trans} and so forth. This means they either are predefined already (\cmd{L} \L) or are easily defined by another package or class (the \paket{cool} package defines both \cmd{D} and \cmd{E}, for example). In order to give you control which commands are defined in which way, there is the package option \key[option]{iupac}\label{key:iupac}. It has three modes: +There are some subtleties: \cmd{-} inserts a small space before the hyphen a removes a small space after it. The command \cmd{|} not only prevents ligatures but also inserts a small space. +\begin{beispiel} + \huge\iupac{2,4\-Di\|chlor\|pentan} \\ + 2,4-Dichlorpentan +\end{beispiel} + +The spaces inserted by these commands can be customized. +\begin{beschreibung} + \option[iupac]{hyphen-pre-space}{<dim>} Default = \code{.01em} + \option[iupac]{hyphen-post-space}{<dim>} Default = \code{-.03em} + \option[iupac]{break-space}{<dim>} Default = \code{.01em} +\end{beschreibung} + +The command \cmd{iupac} serves another purpose, too, however. Regardless of the setting of the \key[option]{iupac} option all the commands presented in this section are always defined \emph{inside} \cmd{iupac}. Quite a number of the naming commands have very general names: \cmd{meta}, \cmd{D}, \cmd{E}, \cmd{L}, \cmd{R}, \cmd{S}, \cmd{trans} and so forth. This means they either are predefined already (\cmd{L} \L) or are easily defined by another package or class (the \paket{cool} package defines both \cmd{D} and \cmd{E}, for example). In order to give you control which commands are defined in which way, there is the package option \key[option]{iupac}\label{desc:iupac}. It has three modes: \begin{itemize} \item \key{iupac}{auto}: if the commands are \emph{not} defined by any package or class you're using they are available generally, otherwise only \emph{inside} \cmd{iupac}. \item \key{iupac}{restricted}: all naming commands are \emph{only} defined inside \cmd{iupac}. If the commands are defined by another package they of course have that meaning outside. They're not defined outside otherwise. @@ -376,7 +437,7 @@ The command \cmd{iupac} serves another purpose, too, however. Regardless of the \begin{table}[h] \centering \begin{tabular}{lccc}\toprule - & auto & restricted & strict \\\midrule + & auto & restricted & strict \\\midrule \lstinline=\L= & \L & \L & \iupac{\L} \\ \lstinline=\iupac{\L}= & \iupac{\L} & \iupac{\L} & \iupac{\L} \\ \lstinline=\D= & \D & -- & \D \\ @@ -389,13 +450,13 @@ The command \cmd{iupac} serves another purpose, too, however. Regardless of the The macros in this section are intended to make the writing of \IUPAC names more convenient. \paragraph{Greek Letters}\label{par:greek_letters}\secidx[greek letters]{IUPAC Names} Greek letters in compound names are typeset upright. For this there are the packages \paket{upgreek} and \paket{textgreek}. If you have loaded one of them \chemmacros typesets the following commands upright: -\begin{description} - \item \cmd{a} \iupac{\a} - \item \cmd{b} \iupac{\b} - \item \cmd{g} \iupac{\g} - \item \cmd{d} \iupac{\d} - \item \cmd{w} \iupac{\w} -\end{description} +\begin{beschreibung} + \befehl{a} \iupac{\a} + \befehl{b} \iupac{\b} + \befehl{g} \iupac{\g} + \befehl{d} \iupac{\d} + \befehl{w} \iupac{\w} +\end{beschreibung} \begin{beispiel} \iupac{5\a\-androstan\-3\b\-ol} \\ \iupac{\a\-(tri\|chloro\|methyl)\-\w\-chloro\|poly(1,4\-phenylene\|methylene)} @@ -403,13 +464,13 @@ Greek letters in compound names are typeset upright. For this there are the pack \paragraph{Hetero Atoms and added Hydrogen}\secidx[hetero atoms]{IUPAC Names} Attachments to hetero atoms and added hydrogen atoms are indicated by italic letters \cite{iupac:greenbook}. \chemmacros defines a few shortcuts for the most common ones. -\begin{description} - \item \cmd{H} \iupac{\H} - \item \cmd{O} \iupac{\O} - \item \cmd{N} \iupac{\N} - \item \cmd{Sf} \iupac{\Sf} - \item \cmd{P} \iupac{\P} -\end{description} +\begin{beschreibung} + \befehl{H} \iupac{\H} + \befehl{O} \iupac{\O} + \befehl{N} \iupac{\N} + \befehl{Sf} \iupac{\Sf} + \befehl{P} \iupac{\P} +\end{beschreibung} \begin{beispiel} \iupac{\N\-methyl\|benz\|amide} \\ \iupac{3\H\-pyrrole} \\ @@ -417,44 +478,44 @@ Attachments to hetero atoms and added hydrogen atoms are indicated by italic let \end{beispiel} \paragraph{Cahn-Ingold-Prelog}\index{Cahn-Ingold-Prelog}\secidx[Cahn-Ingold-Prelog]{IUPAC Names} -\begin{description} - \item \cmd{cip}{<conf>} \eg: \cmd{cip}{R,S} \cip{R,S} - \item \cmd{R} \iupac{\R} - \item \cmd{S} \iupac{\S} -\end{description} +\begin{beschreibung} + \befehl{cip}{<conf>} \eg: \cmd{cip}{R,S} \cip{R,S} + \befehl{R} \iupac{\R} + \befehl{S} \iupac{\S} +\end{beschreibung} Since the command \cmd{S} has another meaning already (\S) it is only available inside \cmd{iupac} in the default setting. \paragraph{Fischer}\index{Fischer}\secidx[Fischer]{IUPAC Names} -\begin{description} - \item \cmd{D} \iupac{\D} - \item \cmd{L} \iupac{\L} -\end{description} +\begin{beschreibung} + \befehl{D} \iupac{\D} + \befehl{L} \iupac{\L} +\end{beschreibung} Since the command \cmd{L} has another meaning already (\L) it is only available inside \cmd{iupac} in the default setting. \paragraph{cis/trans, zusammen/entgegen, syn/anti \& tert}\index{tert}\secidx[tert]{IUPAC Names}\index{cis/trans}\secidx[cis/trans]{IUPAC Names}\index{zusammen/entgegen}\secidx[zusammen/entgegen]{IUPAC Names}\secidx[syn/anti]{IUPAC Names} -\begin{description} - \item \cmd{cis} \cis - \item \cmd{trans} \trans - \item \cmd{Z} \Z - \item \cmd{E} \E - \item \cmd{syn} \syn - \item \cmd{anti} \anti - \item \cmd{tert} \tert -\end{description} +\begin{beschreibung} + \befehl{cis} \cis + \befehl{trans} \trans + \befehl{Z} \Z + \befehl{E} \E + \befehl{syn} \syn + \befehl{anti} \anti + \befehl{tert} \tert +\end{beschreibung} The package \paket{cool} defines the commands \cmd{E} and \cmd{D}, too. If you load it, the \chemmacros version will only be available inside \cmd{iupac} in the default setting. \paragraph{ortho/meta/para}\index{ortho/meta/para}\secidx[ortho/meta/para]{IUPAC Names} -\begin{description} - \item \cmd{ortho} \ortho - \item \cmd{meta} \meta - \item \cmd{para} \para -\end{description} +\begin{beschreibung} + \befehl{ortho} \ortho + \befehl{meta} \meta + \befehl{para} \para +\end{beschreibung} \paragraph{absolute configuration}\index{absolute configuration} (uses \TikZ) -\begin{description} - \item \cmd{Rconf}[<letter>] \cmd{Rconf}: \Rconf \quad\cmd{Rconf}[]: \Rconf[] - \item \cmd{Sconf}[<letter>] \cmd{Sconf}: \Sconf \quad\cmd{Sconf}[]: \Sconf[] -\end{description} +\begin{beschreibung} + \befehl{Rconf}[<letter>] \cmd{Rconf}: \Rconf \quad\cmd{Rconf}[]: \Rconf[] + \befehl{Sconf}[<letter>] \cmd{Sconf}: \Sconf \quad\cmd{Sconf}[]: \Sconf[] +\end{beschreibung} Examples: \begin{beispiel} @@ -472,14 +533,14 @@ Examples: \subsubsection{Own Naming Commands}\secidx[own]{IUPAC Names} If you find any commands missing you can define them using -\begin{description} - \item \cmd{DeclareChemIUPAC}{<cmd>}\ma{<declaration>} - \item \cmd{RenewChemIUPAC}{<cmd>}\ma{<declaration>} -\end{description} +\begin{beschreibung} + \befehl{DeclareChemIUPAC}{<cmd>}\ma{<declaration>} + \befehl{RenewChemIUPAC}{<cmd>}\ma{<declaration>} +\end{beschreibung} A command defined in this way will obey the setting of the option \key[option]{iupac}. This means any existing command is only overwritten with \key{iupac}{strict}. However, \cmd{DeclareChemIUPAC} will \emph{not} change the definition of an existing \IUPAC naming command but issue a warning/an error (depending on the package option \key{strict}) if the \IUPAC naming command already exists. \begin{beispiel} % uses the `upgreek' package - \DeclareChemIUPAC\hapto{$\upeta$} + \DeclareChemIUPAC\hapto{\Chemeta} Ferrocene = \iupac{bis(\hapto\^5\-cyclo\|penta\|dienyl)iron} \end{beispiel} @@ -494,80 +555,78 @@ A command defined in this way will obey the setting of the option \key[option]{i \subsection{Latin Phrases}\secidx{Latin Phrases} The package \paket{chemstyle} provides the command \cmd{latin} to typeset common latin phrases in a consistent way. \chemmacros defines a similar \cmd{latin} only if \paket{chemstyle} has \emph{not} been loaded and additionally provides these commands: -\begin{description} - \item \cmd{insitu} \insitu - \item \cmd{abinitio} \abinitio - \item \cmd{invacuo} \invacuo -\end{description} +\begin{beschreibung} + \befehl{insitu} \insitu + \befehl{abinitio} \abinitio + \befehl{invacuo} \invacuo +\end{beschreibung} -If the package \paket{chemstyle} has been loaded they are defined using \paket{chemstyle}'s \lstinline+\latin+ command. This means that then the appearance depends on \paket{chemstyle}'s option \texttt{abbremph}: +If the package \paket{chemstyle} has been loaded they are defined using \paket{chemstyle}'s \cmd{latin} command. This means that then the appearance depends on \paket{chemstyle}'s option \code{abbremph}: \begin{beispiel} \insitu, \abinitio\\ \cstsetup{abbremph=false} \insitu, \abinitio \end{beispiel} The commands are defined through -\begin{description} - \item \cmd{DeclareChemLatin}{<cmd>}\ma{<phrase>} - \item \cmd{RenewChemLatin}{<cmd>}\ma{<phrase>} -\end{description} +\begin{beschreibung} + \befehl{DeclareChemLatin}{<cmd>}\ma{<phrase>} + \befehl{RenewChemLatin}{<cmd>}\ma{<phrase>} +\end{beschreibung} \begin{beispiel} \DeclareChemLatin\ltn{latin text} \ltn \cstsetup{abbremph=false} \ltn \end{beispiel} If you have \emph{not} loaded \paket{chemstyle} you can change the appearance with this option: -\begin{description} - \item \key[latin]{format}{<definition>} Default = \lstinline+\itshape+ -\end{description} +\begin{beschreibung} + \option[latin]{format}{<definition>} Default = \lstinline+\itshape+ +\end{beschreibung} \secidx*{Latin Phrases} \section{Units for the Usage With \textsf{siunitx}}\label{sec:einheiten}\secidx{Units} In chemistry some non-SI units are very common. \paket{siunitx} provides the command \lstinline+\DeclareSIUnit{<command>}{<unit>}+ to add arbitrary units. \chemmacros uses that command to provide some units. Like all \paket{siunitx} units they're only valid inside \lstinline+\SI{<num>}{<unit>}+ and \lstinline+\si{<unit>}+. -\begin{description} - \item \cmd{atmosphere} \si{\atmosphere} - \item \cmd{atm} \si{\atm} - \item \cmd{calory} \si{\calory} - \item \cmd{cal} \si{\cal} - \item \cmd{cmc} \si{\cmc} The units \cmd{cmc}, \cmd{molar}, and \cmd{Molar} are defined by the package \paket{chemstyle} as well. \chemmacros only defines them, if \paket{chemstyle} is not loaded. - \item \cmd{molar} \si{\molar} - \item \cmd{moLar} \si{\moLar} - \item \cmd{Molar} \si{\Molar} - \item \cmd{MolMass} \si{\MolMass} - \item \cmd{normal} \si{\normal} - \item \cmd{torr} \si{\torr} -\end{description} +\begin{beschreibung} + \befehl{atmosphere} \si{\atmosphere} + \befehl{atm} \si{\atm} + \befehl{calory} \si{\calory} + \befehl{cal} \si{\cal} + \befehl{cmc} \si{\cmc} The units \cmd{cmc}, \cmd{molar}, and \cmd{Molar} are defined by the package \paket{chemstyle} as well. \chemmacros only defines them, if \paket{chemstyle} is not loaded. + \befehl{molar} \si{\molar} + \befehl{moLar} \si{\moLar} + \befehl{Molar} \si{\Molar} + \befehl{MolMass} \si{\MolMass} + \befehl{normal} \si{\normal} + \befehl{torr} \si{\torr} +\end{beschreibung} By the way: \lstinline+\mmHg+ \si{\mmHg} already is defined by \paket{siunitx} and \paket{chemstyle} \secidx*{Units} \section{Acid/Base}\label{sec:saeure_base}\secidx{Acid/Base} -Easy representation of \pH, \pKa \ldots (the command \cmd{pKa} depends on the package option \key[option]{german}, see section \ref{sec:optionen}.) -\begin{description} - \item \cmd{pH} \pH - \item \cmd{pOH} \pOH - \item \cmd{Ka} \Ka - \item \cmd{Kb} \Kb - \item \cmd{Kw} \Kw - \item \cmd{pKa}[<num>] \cmd{pKa}: \pKa, \cmd{pKa}[1]: \pKa[1] - \item \cmd{pKb}[<num>] \cmd{pKb}: \pKb, \cmd{pKb}[1]: \pKb[1] - \item \cmd{p}{<anything>} \eg \cmd{p}{\cmd{Kw}} \p{\Kw} -\end{description} +Easy representation of \pH, \pKa \ldots (the command \cmd{pKa} depends on the package option \key[option]{language}). +\begin{beschreibung} + \befehl{pH} \pH + \befehl{pOH} \pOH + \befehl{Ka} \Ka + \befehl{Kb} \Kb + \befehl{Kw} \Kw + \befehl{pKa}[<num>] \cmd{pKa}: \pKa, \cmd{pKa}[1]: \pKa[1] + \befehl{pKb}[<num>] \cmd{pKb}: \pKb, \cmd{pKb}[1]: \pKb[1] + \befehl{p}{<anything>} \eg \cmd{p}{\cmd{Kw}} \p{\Kw} +\end{beschreibung} \begin{beispiel} - \Ka \Kb \pKa \pKa[1] \pKb \pKb[1]\\ - \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}] +\begin{zitat}[\IUPAC Green Book \cite[][p.\,103]{iupac:greenbook}] The operator \p{} […] shall be printed in Roman type. -\end{myquote} +\end{zitat} 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{beschreibung} + \option[acid-base]{p-style}{italics/slanted/upright} Default = \code{upright} +\end{beschreibung} \begin{beispiel} \pH, \pKa @@ -578,13 +637,13 @@ There is one option which changes the style the \p{} is typeset: \secidx*{Acid/Base} \section{Oxidation Numbers, Real and Formal Charges}\label{sec:ladungen} -\chemmacros distinguishes between real ($+$/$-$) and formal (\fplus/\fminus) charge symbols, also see section \ref{sec:optionen}. All commands using formal charge symbols start with a \texttt{f}. +\chemmacros distinguishes between real ($+$/$-$) and formal (\fplus/\fminus) charge symbols, also see section \ref{sec:optionen}. All commands using formal charge symbols start with a \code{f}. \subsection{Ion Charges}\label{ssec:ionen}\secidx{Ion Charges} Simple displaying of (real) charges: -\begin{description} - \item \cmd{pch}[<number>] positive charge (\textbf{p}lus + \textbf{ch}arge) - \item \cmd{mch}[<number>] negative charge (\textbf{m}inus + \textbf{ch}arge) -\end{description} +\begin{beschreibung} + \befehl{pch}[<number>] positive charge (\textbf{p}lus + \textbf{ch}arge) + \befehl{mch}[<number>] negative charge (\textbf{m}inus + \textbf{ch}arge) +\end{beschreibung} \begin{beispiel} \pch, Na\pch, Ca\pch[2]\\ @@ -592,19 +651,19 @@ Simple displaying of (real) charges: \end{beispiel} The same for formal charges: -\begin{description} - \item \cmd{fpch}[<number>] positive charge - \item \cmd{fmch}[<number>] negative charge -\end{description} +\begin{beschreibung} + \befehl{fpch}[<number>] positive charge + \befehl{fmch}[<number>] negative charge +\end{beschreibung} \begin{beispiel} \fpch\ \fmch\ \fpch[3] \fmch[3] \end{beispiel} There is a key which influences the behaviour of the charges. -\begin{description} - \item \key[charges]{append}{\uline{true}/false} if set \texttt{true}, the charge is appended together with an empty group. -\end{description} +\begin{beschreibung} + \option[charges]{append}{\default{true}/false} if set \code{true}, the charge is appended together with an empty group. +\end{beschreibung} This is how the key influences the behaviour: \begin{beispiel} % uses package `mhchem' @@ -626,22 +685,22 @@ In most cases this behaviour will be unwanted. However, in some cases it might b \subsection{Oxidation Numbers}\label{ssec:oxidationszahlen}\secidx{Oxidation Numbers} Typesetting oxidation numbers: -\begin{description} - \item \cmd{ox}[<keyval>]{<number>,<atom>} places \texttt{<number>} above \texttt{<atom>}; \texttt{<number>} has to be a (rational) number! -\end{description} +\begin{beschreibung} + \befehl{ox}[<keyval>]{<number>,<atom>} places \code{<number>} above \code{<atom>}; \code{<number>} has to be a (rational) number! +\end{beschreibung} \begin{beispiel} \ox{+1,Na}, \ox{2,Ca}, \ox{-2,S}, \ox{-1,F} \end{beispiel} There are a number of keys, that can be used to modify the \cmd{ox} command. -\begin{description} - \item \key[ox]{parse}{\uline{true}/false} when \texttt{false} an arbitrary entry can be used for \texttt{<number>}. Default = \texttt{true} - \item \key[ox]{roman}{\uline{true}/false} switches from roman to arabic numbers. Default = \texttt{true} - \item \key[ox]{pos}{top/super/side}; \texttt{top} places \texttt{<number>} above \texttt{<atom>}, \texttt{super} to the upper right as superscript and \texttt{side} to the right and inside brackets. Default = \texttt{top} - \item \key[ox]{explicit-sign}{\uline{true}/false} shows the $+$ for positiv numbers and the $\pm$ for $0$. Default = \texttt{false} - \item \key[ox]{decimal-marker}{comma/point} choice for the decimal marker for formal oxidation numbers like \ox{1.2,X}. Default = \texttt{point} -\end{description} +\begin{beschreibung} + \option[ox]{parse}{\default{true}/false} when \code{false} an arbitrary entry can be used for \code{<number>}. Default = \code{true} + \option[ox]{roman}{\default{true}/false} switches from roman to arabic numbers. Default = \code{true} + \option[ox]{pos}{top/super/side}; \code{top} places \code{<number>} above \code{<atom>}, \code{super} to the upper right as superscript and \code{side} to the right and inside brackets. Default = \code{top} + \option[ox]{explicit-sign}{\default{true}/false} shows the $+$ for positiv numbers and the $\pm$ for $0$. Default = \code{false} + \option[ox]{decimal-marker}{comma/point} choice for the decimal marker for formal oxidation numbers like \ox{1.2,X}. Default = \code{point} +\end{beschreibung} \begin{beispiel} \ox[roman=false]{2,Ca} \ox{2,Ca} \\ @@ -687,12 +746,12 @@ Of course you can redefine it so that it suits your needs as the output often st \subsection{Partial Charges and Similar Stuff}\label{ssec:partialladungen}\secidx{Partial Charges} The next ones probably are seldomly needed but nevertheless useful: -\begin{description} - \item \cmd{delp} \delp\ (\textbf{del}ta + \textbf{p}lus) - \item \cmd{delm} \delm\ (\textbf{del}ta + \textbf{m}inus) - \item \cmd{fdelp} \fdelp - \item \cmd{fdelm} \fdelm -\end{description} +\begin{beschreibung} + \befehl{delp} \delp\ (\textbf{del}ta + \textbf{p}lus) + \befehl{delm} \delm\ (\textbf{del}ta + \textbf{m}inus) + \befehl{fdelp} \fdelp + \befehl{fdelm} \fdelm +\end{beschreibung} These macros for example can be used with the \cmd{ox} command or with the \paket{chemfig} package: \begin{beispiel} @@ -705,14 +764,14 @@ These macros for example can be used with the \cmd{ox} command or with the \pake \end{beispiel} The following macros are useful together with \paket{chemfig}, too. -\begin{description} - \item \cmd{scrp} \scrp\ (\textbf{scr}iptstyle + \textbf{p}lus) - \item \cmd{scrm} \scrm\ (\textbf{scr}iptstyle + \textbf{m}inus) - \item \cmd{fscrp} \fscrp - \item \cmd{fscrm} \fscrm - \item \cmd{fsscrp} \fsscrp\ (using \lstinline+\scriptscriptstyle+) - \item \cmd{fsscrm} \fsscrm -\end{description} +\begin{beschreibung} + \befehl{scrp} \scrp\ (\textbf{scr}iptstyle + \textbf{p}lus) + \befehl{scrm} \scrm\ (\textbf{scr}iptstyle + \textbf{m}inus) + \befehl{fscrp} \fscrp + \befehl{fscrm} \fscrm + \befehl{fsscrp} \fsscrp\ (using \lstinline+\scriptscriptstyle+) + \befehl{fsscrm} \fsscrm +\end{beschreibung} \begin{beispiel} \setatomsep{1.8em}\chemfig{CH_3-\chemabove{C}{\scrp}(-[6]C|H_3)-\vphantom{H_3}CH_3} @@ -723,34 +782,34 @@ The following macros are useful together with \paket{chemfig}, too. \section{Reaction Mechanisms}\label{sec:mechanismen}\secidx{Reaction Mechanisms} With the command -\begin{description} - \item\cmd{mech}[<type>] -\end{description} -one can specify the most common reaction mechanisms. \texttt{<type>} can have one of the following values: -\begin{itemize} - \item\cmd{mech} (empty, no opt. argument) nucleophilic substitution \mech - \item\cmd{mech}[1] unimolecular nucleophilic substitution \mech[1] - \item\cmd{mech}[2] bimolecular nucleophilic substitution \mech[2] - \item\cmd{mech}[se] electrophilic substitution \mech[se] - \item\cmd{mech}[1e] unimolecular electrophilic substitution \mech[1e] - \item\cmd{mech}[2e] bimolecular electrophilic substitution \mech[2e] - \item\cmd{mech}[ar] electrophilic aromatic substitution \mech[ar] - \item\cmd{mech}[e] elimination \mech[e] - \item\cmd{mech}[e1] unimolecular elimination \mech[e1] - \item\cmd{mech}[e2] bimolecular elimination \mech[e2] - \item\cmd{mech}[cb] unimolecular elimination \enquote{conjugated base}, \ie via carbanion \mech[cb] -\end{itemize} +\begin{beschreibung} + \Befehl{mech}[<type>] +\end{beschreibung} +one can specify the most common reaction mechanisms. \code{<type>} can have one of the following values: +\begin{beschreibung} + \befehl{mech} (empty, no opt. argument) nucleophilic substitution \mech + \befehl{mech}[1] unimolecular nucleophilic substitution \mech[1] + \befehl{mech}[2] bimolecular nucleophilic substitution \mech[2] + \befehl{mech}[se] electrophilic substitution \mech[se] + \befehl{mech}[1e] unimolecular electrophilic substitution \mech[1e] + \befehl{mech}[2e] bimolecular electrophilic substitution \mech[2e] + \befehl{mech}[ar] electrophilic aromatic substitution \mech[ar] + \befehl{mech}[e] elimination \mech[e] + \befehl{mech}[e1] unimolecular elimination \mech[e1] + \befehl{mech}[e2] bimolecular elimination \mech[e2] + \befehl{mech}[cb] unimolecular elimination \enquote{conjugated base}, \ie via carbanion \mech[cb] +\end{beschreibung} \secidx*{Reaction Mechanisms} -\section{Redox Reactions}\label{sec:redoxreaktionen}\secidx{Redox Reactions} +\section{Redox Reactions}\label{sec:redoxreaktionen}\secidx{Redox Reactions}% TODO: watch pagebreaks! \chemmacros provides two commands to visualize the transfer of electrons in redox reactions. Both commands are using \TikZ. -\begin{description} - \item \cmd{OX}{<name>,<atom>} - \item \cmd{redox}(<name1>,<name2>)[<tikz>][<num>]{<text>} Only the first argument \da{<name1>,<name2>} is required, the others are all optional. -\end{description} +\begin{beschreibung} + \Befehl{OX}{<name>,<atom>} + \Befehl{redox}(<name1>,<name2>)[<tikz>]\oa{<num>}{<text>} \cnpkgdocarrow\ Only the first argument \da{<name1>,<name2>} is required, the others are all optional. +\end{beschreibung} -\cmd{OX} places \texttt{<atom>} into a node, which is named with \texttt{<name>}. If you have set two \cmd{OX}, they can be connected with a line using \cmd{redox}. To do so the names of the two nodes that are to be connected are written in the round braces. Since \cmd{redox} draws a tikzpicture with options \texttt{remember picture,overlay}, the document needs to be \emph{compiled at least two times}. -\begin{beispiel}[ox] +\cmd{OX} places \code{<atom>} into a node, which is named with \code{<name>}. If you have set two \cmd{OX}, they can be connected with a line using \cmd{redox}. To do so the names of the two nodes that are to be connected are written in the round braces. Since \cmd{redox} draws a tikzpicture with options \code{remember picture,overlay}, the document needs to be \emph{compiled at least two times}. +\begin{beispiel}[dist] \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b){oxidation} \end{beispiel} This line can be customized using \TikZ keys in \oa{<tikz>}: @@ -758,68 +817,74 @@ This line can be customized using \TikZ keys in \oa{<tikz>}: \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b)[->,red]{ox} \end{beispiel} -With the argument \oa{<num>} the length of the vertical parts of the line can be adjusted. The default length is \texttt{.6em}. This length is multiplied with \texttt{<num>}. If you use a negative value the line is placed \emph{below} the text. -\begin{beispiel}[ox] +With the argument \oa{<num>} the length of the vertical parts of the line can be adjusted. The default length is \code{.6em}. This length is multiplied with \code{<num>}. If you use a negative value the line is placed \emph{below} the text. +\begin{beispiel}[dist] \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch \redox(a,b)[->,red]{ox} \redox(a,b)[<-,blue][-1]{red} + \vspace{7mm} \end{beispiel} The default length of the vertical lines can be customized with the option -\begin{description} - \item \key[redox]{dist}{<dim>} A \TeX\ dimension. Default = \texttt{.6em} -\end{description} -\begin{beispiel}[ox] +\begin{beschreibung} + \option[redox]{dist}{<dim>} A \TeX\ dimension. Default = \code{.6em} +\end{beschreibung} +\begin{beispiel}[dist] \chemsetup{redox/dist=1em} \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b)[->,red]{ox} \end{beispiel} Additionally the option -\begin{description} - \item\key[redox]{sep}{<dim>} Default = \texttt{.2em} -\end{description} +\begin{beschreibung} + \option[redox]{sep}{<dim>} Default = \code{.2em} +\end{beschreibung} can be used to change the distance between the atom and the beginning of the line. -\begin{beispiel}[ox] +\begin{beispiel}[dist] \chemsetup{redox/sep=.5em} \OX{a,Na} $\rightarrow$ \OX{b,Na}\pch\redox(a,b)[->,red]{ox} \end{beispiel} -Examples: -\begin{beispiel}[ox] +Examples:% TODO: watch pagebreaks! +\begin{beispiel}[dist] \ch{ 2 "\OX{o1,Na}" + "\OX{r1,Cl}" {}2 -> 2 "\OX{o2,Na}" \pch{} + 2 "\OX{r2,Cl}" \mch } \redox(o1,o2){\small OX: $- 2\el$} \redox(r1,r2)[][-1]{\small RED: $+ 2\el$} + \vspace{7mm} \end{beispiel} -\begin{beispiel}[ox] +\begin{beispiel}[dist] \ch{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } \redox(o1,o2){\small OX: $- 2\el$} \redox(r1,r2)[][-1]{\small RED: $+ 2\el$} + \vspace{7mm} \end{beispiel} -\bspmidlength{ox}{15mm} -\begin{beispiel}[ox] +\bspmidlength{dist}{15mm} +\begin{beispiel}[dist] \ch{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } \redox(o1,o2)[draw=red,->][3.33]{\small OX: $- 2\el$} \redox(r1,r2)[draw=blue,->]{\small RED: $+ 2\el$} - \end{beispiel} -\bspmidlength{ox}{7mm} - \begin{beispiel}[ox] +\end{beispiel} + +\newpage +\bspmidlength{dist}{7mm} + \begin{beispiel}[dist] \ch{ 2 "\OX{o1,\ox{0,Na}}" + "\OX{r1,\ox{0,Cl}}" {}2 -> 2 "\OX{o2,\ox{+1,Na}}" \pch{} + 2 "\OX{r2,\ox{-1,Cl}}" \mch } \redox(o1,o2)[green,-stealth]{\small OX} \redox(r1,r2)[purple,-stealth][-1]{\small RED} + \vspace{7mm} \end{beispiel} \secidx*{Redox Reactions} \section{(Standard) State, Thermodynamics}\label{sec:standardstate}\secidx{Thermodynamics} \subsection{Thermodynamic Variables}\label{ssec:siunitx} The following commands use \paket{siunitx}: -\begin{description} - \item \cmd{Enthalpy}[<keyval>](<subscript>){<value>} - \item \cmd{Entropy}[<keyval>](<subscript>){<value>} - \item \cmd{Gibbs}[<keyval>](<subscript>){<value>} -\end{description} +\begin{beschreibung} + \Befehl{Enthalpy}[<keyval>]\da{<subscript>}\ma{<value>} + \Befehl{Entropy}[<keyval>]\da{<subscript>}\ma{<value>} + \Befehl{Gibbs}[<keyval>]\da{<subscript>}\ma{<value>} +\end{beschreibung} Their usage is pretty much self-explaining: \begin{beispiel} @@ -830,12 +895,12 @@ Their usage is pretty much self-explaining: The argument \da{<subscript>} adds a subscript for specification: \cmd{Enthalpy}(r){123} \Enthalpy(r){123}. There are several keys to customize the commands. -\begin{description} - \item \key*{exponent}{<anything>} - \item \key*{delta}{<anything>/false} - \item \key*{subscript}{left/right} - \item \key*{unit}{<unit>} -\end{description} +\begin{beschreibung} + \Option*{exponent}{<anything>} + \Option*{delta}{<anything>/false} + \Option*{subscript}{left/right} + \Option*{unit}{<unit>} +\end{beschreibung} The default values depend on the command. \begin{beispiel} @@ -852,9 +917,9 @@ The unit is set corresponding to the rules of \paket{siunitx} and depends on its \subsubsection{Create New Variables} You can use the command -\begin{description} - \item \cmd{DeclareChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} +\end{beschreibung} to create new corresponding commands: \begin{beispiel} @@ -866,18 +931,18 @@ to create new corresponding commands: \end{beispiel} The command has some keys with which the default behaviour of the new command can be set. -\begin{description} - \item \key*{exponent}{<anything>} - \item \key*{delta}{<anything>/false} - \item \key*{subscript-left}{true/false} - \item \key*{subscript}{<anything>} -\end{description} +\begin{beschreibung} + \Option*{exponent}{<anything>} + \Option*{delta}{<anything>/false} + \Option*{subscript-left}{true/false} + \Option*{subscript}{<anything>} +\end{beschreibung} \subsubsection{Redefine Variables} With -\begin{description} - \item \cmd{RenewChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} -\end{description} +\begin{beschreibung} + \Befehl{RenewChemState}[<keyval>]{<name>}\ma{<symbol>}\ma{<unit>} +\end{beschreibung} you can redefine the already existing commands: \begin{beispiel} @@ -895,9 +960,9 @@ So \textendash\ for following thermodynamic conventions \textendash\ one could d \subsection{State}\label{ssec:state} The commands presented in section \ref{ssec:siunitx} internally all use the command\footnote{Please note that \ma{<subscript>} is an \emph{optional} argument.} -\begin{description} - \item \cmd{State}[<keyval>]{<symbol>}\ma{<subscript>} -\end{description} +\begin{beschreibung} + \Befehl{State}[<keyval>]{<symbol>}\ma{<subscript>} +\end{beschreibung} It can be used to write the thermodynamic variables without value and unit. @@ -907,68 +972,250 @@ Examples: \end{beispiel} Again there are some keys to customize the command: -\begin{description} - \item \key[state]{exponent}{<anything>} - \item \key[state]{subscript-left}{true/false} - \item \key[state]{delta}{<anything>/false} -\end{description} +\begin{beschreibung} + \Option[state]{exponent}{<anything>} + \Option[state]{subscript-left}{true/false} + \Option[state]{delta}{<anything>/false} +\end{beschreibung} \secidx*{Thermodynamics} -\section{Spectroscopy}\label{sec:spektroskopie}\secidx{Spectroscopy} -If substances are examined wether they are what they're supposed to, one often needs NMR spectroscopy. Measured results then are written in a way like: \NMR(400)[CDCl3] = \num{1.59}\ldots\ \chemmacros provides a command which simplifies writing this down (uses \paket{siunitx}). -\begin{description} - \item \cmd{NMR}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} - \item \cmd{NMR*}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} -\end{description} +\section{Spectroscopy and Experimental Data}\label{sec:spektroskopie}\secidx{Spectroscopy} +\subsection{The \code{\textbackslash\textcolor{code}{NMR}} Command} +When you're trying to find out if a compound is the one you think it is often NMR spectroscopy is used. The experimental data are typeset similar to this: +\begin{center} + \NMR(400)[CDCl3] = \num{1.59} +\end{center} +\chemmacros provides a command which simplifies the input (uses \paket{siunitx}). + +\begin{beschreibung} + \Befehl{NMR}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} + \Befehl{NMR*}{<num>,<elem>}\da{<num>,<unit>}\oa{<solvent>} +\end{beschreibung} -\emph{All} arguments are optional! Without arguments we get\footnote{All arguments can be combined freely, the command can also be used in math mode.}: +\emph{All} Argument are optional! Without arguments we get: \begin{beispiel} \NMR \\ \NMR* \end{beispiel} -With the first argument you can specify the kind of NMR: + +The first argument specifies the kind of NMR: \begin{beispiel} \NMR{13,C} \end{beispiel} -With the second argument the frequency (in \si{\mega\hertz}) can be specified: + +The second argument sets the frequency (in \si{\mega\hertz}): \begin{beispiel} \NMR(400) \end{beispiel} -You also can change the unit: +You can choose another unit: \begin{beispiel} \NMR(4e8,\hertz) \end{beispiel} -Please note that the setup of \paket{siunitx} also has an impact on this command: +Please note that the setup of \paket{siunitx} also affects this command: \begin{beispiel} \sisetup{exponent-product=\cdot}\NMR(4e8,\hertz) \end{beispiel} -And finally with the third argument the solvent can be specified: + +The third argument specifies the solvent: \begin{beispiel} \NMR[CDCl3] \end{beispiel} -With the keys -\begin{description} - \item\key[nmr]{unit}{<unit>} Default = \lstinline=\mega\hertz= - \item\key[nmr]{nucleus}{\ma{<num>,<elem>}} Default = \ma{1,H} -\end{description} -the default unit and the default nucleus can be changed. - -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, 1\ch{H}, \textit{J} = \SI{11.6}{\hertz}, H-4) -\end{beispiel} +\subsection{Short Cuts} +It is possible to define short cut commands for specific nuclei. +\begin{beschreibung} + \Befehl{DeclareChemNMR}{<csname>}\ma{<num>,<atom>} + \Befehl{RenewChemNMR}{<csname>}\ma{<num>,<atom>} +\end{beschreibung} +This defines a command with the same arguments as \cmd{NMR} \emph{except} for \ma{<num>,<atom>}. +\begin{beispiel} + \DeclareChemNMR\HNMR{1,H}% + \DeclareChemNMR\CNMR{13,C}% + \CNMR*(100) \\ + \HNMR*(400) +\end{beispiel} + +\subsection{An Environment to Typeset Experimental Data} +\chemmacros provides an environment to ease the input of experimental data. +\begin{beschreibung}\catcode`\#=11 + \umg{experimental}{data} Environment for the output of experimental data. Inside theis environment the following commands are defined. + \Befehl{data}{<type>}\oa{<specification>} \cnpkgdocarrow\ Type of data, \eg\ IR, MS\ldots\ The optional argument takes further specifications which are output in parentheses. + \Befehl{data*}{<type>}\oa{<specification>} \cnpkgdocarrow\ Like \cmd{data} but changes the \code{=} into a \code{:}, given that \key{use-equal}{true} is used. + \befehl{J}[<unit>]{<list of nums>} Coupling constant, values are input separated by \code{;} (NMR). + \befehl{#}{<num>} Number of nuclei (NMR). + \befehl{pos}{<num>} Position of nuclues (NMR). + \befehl{val}{<num>} A number, an alias of \paket*{siunitx}' \lstinline+\num{<num>}+ + \befehl{val}{<num1>-{}-<num2>} An alias of \paket*{siunitx}' \lstinline+\numrange{<num1>}{<num2>}+ +\end{beschreibung} + +\begin{beispiel} + \begin{experimental} + \data{type1} Data. + \data{type2}[specifications] More data. + \data*{type3} Even more data. + \end{experimental} +\end{beispiel} + +\subsection{Customization} +The output of the environment and of the NMR commands can be customized be y number of options. For historical reasons they all belong to the module \textcolor{module}{\code{nmr}}. +\begin{beschreibung} + \option[nmr]{unit}{<unit>} Default = \lstinline=\mega\hertz= + \option[nmr]{nucleus}{\{<num>,<atom>\}} Default = \ma{1,H} + \option[nmr]{format}{<commands>} for example \lstinline=\bfseries= + \option[nmr]{pos-number}{side/sub} Position of the number next to the atom. Default = \code{side} + \option[nmr]{coupling-unit}{<unit>} A \paket{siunitx} unit. Default = \lstinline=\hertz= + \option[nmr]{parse}{true/false} Treat the solvent as \paket{mhchem}/\chemformula formula or not. Default = \code{true} + \option[nmr]{delta}{<tokens>} The \code{<tokens>} are added after $\delta$. + \option[nmr]{list}{true/false} The environment \env{nmr}[<optionen>]{} is formatted as a list. Default = \code{false} + \option[nmr]{list-setup}{<setup>} Setup of the list. Default = see below. + \option[nmr]{use-equal}{\default{true}/false} Add egual sign after \cmd{NMR} and \cmd{data}. Default = \code{false} +\end{beschreibung} + +The default setup of the list: +\begin{beispiel}[code only] + \topsep\z@skip \partopsep\z@skip + \itemsep\z@ \parsep\z@ \itemindent\z@ + \leftmargin\z@ +\end{beispiel} + +\begin{beispiel} + \begin{experimental}[format=\bfseries] + \data{type1} Data. + \data{type2}[specifications] More data. + \data*{type3} Even more data. + \end{experimental} +\end{beispiel} + +The command \cmd{NMR} and all commands defined through \cmd{DeclareChemNMR} can be used like \cmd{data} for the NMR data. + +\begin{beispiel} + \begin{experimental}[format=\bfseries,use-equal] + \data{type1} Data. + \data{type2}[specifications] More data. + \NMR Even more data. + \end{experimental} +\end{beispiel} + +\subsection{An Example} +The code below is shown with different specifications for \code{<optionen>}. Of course options can also be chosen with \cmd{chemsetup}. + +\begin{lstlisting} +\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--} +\begin{experimental}[<optionen>] + \data*{yield} \SI{17}{\milli\gram} yellow needles (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{mp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{quantum yield} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} +\end{lstlisting} + +\subsubsection{Nearly Standard} +Output with these options: \lstinline+<optionen>: delta=(ppm),pos-number=sub,use-equal+ +\bigskip + +\begin{experimental}[delta=(ppm),pos-number=sub,use-equal]\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--}\chemsetup[chemformula]{format=} + \data*{yield} \SI{17}{\milli\gram} yellow needles (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{mp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{quantum yield} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} + +\subsubsection{Formatted List} +Output with these options: \lstinline+<optionen>: format=\bfseries,delta=(ppm),list=true,use-equal+ +\bigskip + +\begin{experimental}[format=\bfseries,delta=(ppm),list=true,use-equal]\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--}\chemsetup[chemformula]{format=} + \data*{yield} \SI{17}{\milli\gram} yellow needles (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{mp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{quantum yield} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} + +\subsubsection{Crazy} +Output for these options: \code{<optionen>}: +\begin{lstlisting} + format=\color{red}\itshape, + list=true, + delta=\textcolor{green}{\ch{M+ + H2O}}, + pos-number=side, + coupling-unit=\mega\gram\per\square\second, + list-setup=, + use-equal +\end{lstlisting} + +\begin{experimental}[ + format=\color{red}\itshape, + list=true, + delta=\textcolor{green}{\ch{M+ + H2O}}, + pos-number=side, + coupling-unit=\mega\gram\per\square\second, + list-setup=,use-equal]\sisetup{separate-uncertainty,per-mode=symbol,detect-all,range-phrase=--}\chemsetup[chemformula]{format=} + \data*{yield} \SI{17}{\milli\gram} yellow needles (\SI{0.04}{\milli\mole}, \SI{13}{\percent}). + % + \data{mp.} \SI{277}{\celsius} (DSC). + % + \NMR(600)[CDCl3] \val{2.01} (s, \#{24}, \pos{5}), \val{2.31} (s, \#{12}, \pos{1}), \val{6.72--6.74} (m, \#{2}, \pos{11}), \val{6.82} (s, \#{8}, \pos{3}), \val{7.05--7.07} (m, \#{2}, \pos{12}), \val{7.39--7.41} (m, \#{4}, \pos{9}), \val{7.48--7.49} (m, \#{4}, \pos{8}). + % + \NMR{13,C}(150)[CDCl3] \val{21.2} ($+$, \#{4}, \pos{1}), \val{23.4} ($+$, \#{8}, \pos{5}), \val{126.0} ($+$, \#{4}, \pos{9}), \val{128.2} ($+$, \#{8}, \pos{3}), \val{130.8} ($+$, \#{2}, \pos{12}), \val{133.6} ($+$, \#{2}, \pos{11}), \val{137.0} ($+$, \#{4}, \pos{8}), \val{138.6} (q, \#{4}, \pos{2}), \val{140.6} (q, \#{2}, \pos{10}), \val{140.8} (q, \#{8}, \pos{4}), \val{141.8} (q, \#{4}, \pos{6}), \val{145.6} (q, \#{2}, \pos{7}). + % + \data{MS}[DCP, EI, \SI{60}{\electronvolt}] \val{703} (2, \ch{M+}), \val{582} (1), \val{462} (1), \val{249} (13), \val{120} (41), \val{105} (100). + % + \data{MS}[\ch{MeOH + H2O + KI}, ESI, \SI{10}{\electronvolt}] \val{720} (100, \ch{M+ + OH-}), \val{368} (\ch{M+ + 2 OH-}). + % + \data{IR}[KBr] \val{3443} (w), \val{3061} (w), \val{2957} (m), \val{2918} (m), \val{2856} (w), \val{2729} (w), \val{1725} (w), \val{1606} (s), \val{1592} (s), \val{1545} (w), \val{1446} (m), \val{1421} (m), \val{1402} (m), \val{1357} (w), \val{1278} (w), \val{1238} (s), \val{1214} (s), \val{1172} (s), \val{1154} (m), \val{1101} (w), \val{1030} (w), \val{979} (m), \val{874} (m), \val{846} (s), \val{818} (w), \val{798} (m), \val{744} (w), \val{724} (m), \val{663} (w), \val{586} (w), \val{562} (w), \val{515} (w). + % + \data*{UV-Vis} \SI{386}{\nano\metre} ($\varepsilon = \val{65984}$), \SI{406}{\nano\metre} ($\varepsilon = \val{65378}$). + % + \data*{quantum yield} $\Phi = \val{0.74+-0.1}$\,. +\end{experimental} \secidx*{Spectroscopy} \section{Commands for \textsf{mhchem}}\label{sec:mhchem}\secidx{Commands for mhchem} \paket{mhchem} isn't loaded automatically any more but only if you've specified \key[option]{method}{mhchem} in the preamble. In the default settings \chemmacros uses \chemformula instead. \chemmacros provides only one command specifically for \paket{mhchem}\footnote{\chemformula provides its own possibility.}. It is meant to place text below of compounds. -\begin{description} - \item \cmd{mhName}[<keyval>]{<formula>}\ma{<text>} -\end{description} +\begin{beschreibung} + \Befehl{mhName}[<keyval>]{<formula>}\ma{<text>} +\end{beschreibung} For example: \begin{beispiel} @@ -976,12 +1223,12 @@ For example: \end{beispiel} There are several keys to customize \cmd{mhName}. -\begin{description} - \item \key[mhName]{align}{<alignment command>} the alignment of the text in the box it is placed in, default = \lstinline+\centering+ - \item \key[mhName]{format}{<anything>} the format of the text - \item \key[mhName]{fontsize}{<font size command>} the fontsize of the text, default = \lstinline+\tiny+ - \item \key[mhName]{width}{<dim>/auto} the width of the box the text is placed in, default = \texttt{auto} -\end{description} +\begin{beschreibung} + \option[mhName]{align}{<alignment command>} the alignment of the text in the box it is placed in, default = \lstinline+\centering+ + \option[mhName]{format}{<anything>} the format of the text + \option[mhName]{fontsize}{<font size command>} the fontsize of the text, default = \lstinline+\tiny+ + \option[mhName]{width}{<dim>/auto} the width of the box the text is placed in, default = \code{auto} +\end{beschreibung} \begin{beispiel} \ce{4 C2H5Cl + Pb / Na -> \mhName[fontsize=\footnotesize]{Pb(C2H5)4}{former antiknock additive} + NaCl}\\ \chemsetup[mhName]{align=\raggedright,fontsize=\small,format=\bfseries\color{red},width=3cm} @@ -989,23 +1236,23 @@ There are several keys to customize \cmd{mhName}. \end{beispiel} \secidx*{Commands for mhchem} -\section{Reaction Environments}\label{ssec:mhchem_reaktionen}\secidx{Reaction Environments} +\section{Reaction Environments}\label{sec:reactions}\secidx{Reaction Environments} \subsection{Defined by \chemmacros} You can use these environments for numbered\ldots -\begin{description} - \item \env{reaction}{<formula or mhchem code>} - \item \env{reactions}{<formula or mhchem code>} -\end{description} +\begin{beschreibung} + \Umg{reaction}{<formula or mhchem code>} + \Umg{reactions}{<formula or mhchem code>} +\end{beschreibung} \ldots and their starred versions for unnumbered reactions. -\begin{description} - \item \env{reaction*}{<formula or mhchem code>} - \item \env{reactions*}{<formula or mhchem code>} -\end{description} +\begin{beschreibung} + \Umg{reaction*}{<formula or mhchem code>} + \Umg{reactions*}{<formula or mhchem code>} +\end{beschreibung} With them you can create (un)numbered reaction equations similar to mathematical equations. -The environments \texttt{reaction}/\texttt{reaction*} use the \texttt{equation}/\texttt{equation*} environments and the environments \texttt{reactions}/\texttt{reactions*} use the \texttt{align}/\texttt{align*} environments to display the reactions. +Theses environments use the \code{equation}/\code{equation*} environments or the \code{align}/\code{align*} environments, respectively, to display the reactions. \begin{beispiel} Reaction with counter: @@ -1048,34 +1295,46 @@ If you want to change the layout of the counter tags, you can use \end{reaction} \end{beispiel} +With version 3.3 referencing and the use of \AmS math's \cmd{intertext} also function properly: +\begin{beispiel} + \begin{reactions} + A + 2 B &-> 3 C + D \label{rxn:test} + \intertext{Some text in between aligned reactions} + 3 E + F &<=> G + 1/2 H + \end{reactions} + See reaction \ref{rxn:test}. +\end{beispiel} + +\achtung{In the standard setting, \ie using \key{method}{chemformula} you should not use \cmd{mch} and its relatives inside the \code{reaction} environments. They will very likely mess with spacing. In the standard setting charges inside the environments automatically recognize the setting of the option \key{circled} so there's also no need for the charge commands.} + \subsection{Own Reactions} You can create new types of reactions with the command: -\begin{description} - \item \cmd{DeclareChemReaction}[<keyval>]{<name>}\ma{<math name>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemReaction}[<keyval>]{<name>}\ma{<math name>} +\end{beschreibung} -\texttt{<name>} will be the name of the new environment. \texttt{<math name>} is the used math environment. +\code{<name>} will be the name of the new environment. \code{<math name>} is the used math environment. -The command has two keys. -\begin{description} - \item\key*{star}{\uline{true}/false} - \item\key*{arg}{\uline{true}/false} -\end{description} +The command has two options. +\begin{beschreibung} + \Option*{star}{\default{true}/false} + \Option*{arg}{\default{true}/false} +\end{beschreibung} There is \key*{star}, which will also define a starred version of the new environment, if the starred math environment exists. If it doesn't exist, this will cause an error. Then there is \key*{arg}, which is used to define an environment with a mandatory argument. Of course this only works, if the used math environment has a mandatory argument. The predefined environments are defined via -\begin{description} - \item \cmd{DeclareChemReaction}[star]{reaction}\ma{equation} and - \item \cmd{DeclareChemReaction}[star]{reactions}\ma{align}. -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemReaction}[star]{reaction}\ma{equation} and + \Befehl{DeclareChemReaction}[star]{reactions}\ma{align}. +\end{beschreibung} -Let's suppose, you'd like to have the alignment behaviour of the \texttt{alignat} environment for \chemformula/\paket{mhchem} reactions. You could do the following: +Let's suppose, you'd like to have the alignment behaviour of the \code{alignat} environment for \chemformula/\paket{mhchem} reactions. You could do the following: \cmd{DeclareChemReaction}[star,arg]{reactionsat}\ma{alignat} -With this the \texttt{reactionsat} environment is defined. +With this the \code{reactionsat} environment is defined. \begin{beispiel} \DeclareChemReaction[star,arg]{reactionsat}{alignat} \begin{reactionsat}{3} @@ -1090,18 +1349,18 @@ With this the \texttt{reactionsat} environment is defined. \subsection{List of Reactions} \chemmacros also provides a command to display a list of the reactions created with the \lstinline+reaction+ environment. -\begin{description} - \item\cmd{listofreactions} -\end{description} +\begin{beschreibung} + \Befehl{listofreactions} +\end{beschreibung} \begin{beispiel}[below] \listofreactions \end{beispiel} The Output of this list can be modified by two options: -\begin{description} - \item\key[reaction]{list-name}{<name of the list>} Let's you set the name of the list manually. Default = \texttt{List of reactions} - \item\key[reaction]{list-entry}{<prefix to each entry>} Let's you set a prefix to each list entry. Default = \texttt{Reaction} -\end{description} +\begin{beschreibung} + \option[reaction]{list-name}{<name of the list>} Let's you set the name of the list manually. Default = \code{List of reactions} + \option[reaction]{list-entry}{<prefix to each entry>} Let's you set a prefix to each list entry. Default = \code{Reaction} +\end{beschreibung} Both default option values recognize the package option \key[option]{german}. Instead of using the option \key{list-name} you also could redefine \cmd{reactionlistname}. @@ -1112,10 +1371,10 @@ The list lists all reactions with a number and disregards reactions without numb 2 H2O <<=> H3O+ + OH- \end{reaction} \end{beispiel} -If you use the \texttt{reactions} environment this will not work, though. In this case you can use -\begin{description} - \item\cmd{AddRxnDesc}{<description>} -\end{description} +If you use the \code{reactions} environment this will not work, though. In this case you can use +\begin{beschreibung} + \Befehl{AddRxnDesc}{<description>} +\end{beschreibung} \begin{beispiel} \begin{reactions} Cl "\Lewis{0.,\vphantom{Cl}}" + CH4 &-> HCl + "\Lewis{4.,\vphantom{CH}}" CH3 \AddRxnDesc{first~step~of~chain} \\ @@ -1128,12 +1387,12 @@ Note: you don't have to use the phantom commands if you haven't changed the form \section{Phases}\label{sec:phasen}\secidx{Phases} \subsection{Basics}\secidx[basics]{Phases} These commands are intended to indicate the phase of a compound. -\begin{description} - \item \cmd{sld} \sld - \item \cmd{lqd} \lqd - \item \cmd{gas} \gas - \item \cmd{aq} \aq -\end{description} +\begin{beschreibung} + \befehl{sld} \sld + \befehl{lqd} \lqd + \befehl{gas} \gas + \befehl{aq} \aq +\end{beschreibung} \achtung{The default behaviour of the phases commands has changed to be consistent with \IUPAC recommendations. Both \cmd{sld} and \cmd{lqd} have lost their optional argument.} @@ -1142,23 +1401,19 @@ These commands are intended to indicate the phase of a compound. To make it complete: NaCl\aq. \end{beispiel} -With the package option \key{german} (see section \ref{sec:optionen}) you get the german versions: -\begin{beispiel} - \chemsetup[option]{german=true} - \ch{C\sld{} + 2 H2O\lqd{} -> CO2\gas{} + 2 H2\gas} -\end{beispiel} +With the package option \key{language}{german} (see section \ref{sec:optionen}) you get the german versions. The \IUPAC recommendation to indicate the state of aggregation is to put it in parentheses after the compound \cite{iupac:greenbook}. However, you might want to put it as a subscript which is also very common. -\begin{myquote}[{\IUPAC Green Book \cite[][p.\,54]{iupac:greenbook}}] +\begin{zitat}[{\IUPAC Green Book \cite[][p.\,54]{iupac:greenbook}}] The [\ldots] symbols are used to represent the states of aggregation of chemical species. The letters are appended to the formula in parentheses and should be printed in Roman (upright) type without a full stop (period). -\end{myquote} +\end{zitat} There are two options to customize the output: -\begin{description} - \item \key[phases]{pos}{side/sub} Switch the position of the phase indicator. Default = \texttt{side} - \item \key[phases]{space}{<dim>} Change the default spacing between compound a phase indicator if \key{pos}{side}. A \TeX\ dimension. Default = \texttt{.1333em} -\end{description} +\begin{beschreibung} + \option[phases]{pos}{side/sub} Switch the position of the phase indicator. Default = \code{side} + \option[phases]{space}{<dim>} Change the default spacing between compound a phase indicator if \key{pos}{side}. A \TeX\ dimension. Default = \code{.1333em} +\end{beschreibung} \begin{beispiel} \chemsetup[phases]{pos=sub} \ch{C\sld{} + 2 H2O\lqd{} -> CO2\gas{} + 2 H2\gas}\\ @@ -1167,12 +1422,12 @@ There are two options to customize the output: \subsection{Define Own Phases}\secidx[own]{Phases} Depending on the subject of your document you might need to indicate other states of aggregation. You can easily define them. -\begin{description} - \item \cmd{DeclareChemPhase}{<cmd>}\oa{<german>}\ma{<english>} - \item \cmd{RenewChemPhase}{<cmd>}\oa{<german>}\ma{<english>} - \item \cmd{phase}{<phase>} If you need a phase indicator just once or twice. -\end{description} -\cmd{DeclareChemPhase} only defines a phase if \texttt{<cmd>} is not already used by any other command. If it \emph{is} already used \chemmacros will either give a warning or an error, depending on the option \key{strict}. \cmd{RenewChemPhase} \emph{only} defines a phase if \texttt{<cmd>} \emph{is} already used and issues a warning/error otherwise. +\begin{beschreibung} + \Befehl{DeclareChemPhase}{<cmd>}\oa{<german>}\ma{<english>} + \Befehl{RenewChemPhase}{<cmd>}\oa{<german>}\ma{<english>} + \befehl{phase}{<phase>} If you need a phase indicator just once or twice. +\end{beschreibung} +\cmd{DeclareChemPhase} only defines a phase if \code{<cmd>} is not already used by any other command. If it \emph{is} already used \chemmacros will either give a warning or an error, depending on the option \key{strict}. \cmd{RenewChemPhase} \emph{only} defines a phase if \code{<cmd>} \emph{is} already used and issues a warning/error otherwise. \begin{beispiel} \DeclareChemPhase{\aqi}{aq,$\infty$}% aqueous solution at infinite dilution \DeclareChemPhase{\cd}{cd}% condensed phase @@ -1185,23 +1440,23 @@ Depending on the subject of your document you might need to indicate other state \section{Newman Projections}\label{sec:newman}\secidx{Newman Projections} \chemmacros provides the command -\begin{description} - \item \cmd{newman}[<keyval>]\da{<angle>}\ma{<1>,<2>,<3>,<4>,<5>,<6>} -\end{description} -which allows you to create newman projections (uses \TikZ). With \texttt{<angle>} the back atoms are rotated counter clockwise with respect to the front atoms. +\begin{beschreibung} + \Befehl{newman}[<keyval>]\da{<angle>}\ma{<1>,<2>,<3>,<4>,<5>,<6>} +\end{beschreibung} +which allows you to create newman projections (uses \TikZ). With \code{<angle>} the back atoms are rotated counter clockwise with respect to the front atoms. \begin{beispiel} \newman{} \newman(170){} \newman{1,2,3,4,5,6} \newman{1,2,3} \newman{,,,4,5,6} \end{beispiel} -Several keys allow customization: -\begin{description} - \item \key[newman]{angle}{<angle>} default angle - \item \key[newman]{scale}{<factor>} scale the whole projection - \item \key[newman]{ring}{<tikz>} customize the ring with \TikZ keys - \item \key[newman]{atoms}{<tikz>} customize the nodes within which the atoms are set - \item \key[newman]{back-atoms}{<tikz>} explicitly customize the back atoms -\end{description} +Several options allow customization: +\begin{beschreibung} + \option[newman]{angle}{<angle>} default angle + \option[newman]{scale}{<factor>} scale the whole projection + \option[newman]{ring}{<tikz>} customize the ring with \TikZ keys + \option[newman]{atoms}{<tikz>} customize the nodes within which the atoms are set + \option[newman]{back-atoms}{<tikz>} explicitly customize the back atoms +\end{beschreibung} \begin{beispiel} \chemsetup[newman]{angle=45} \newman{} @@ -1222,31 +1477,31 @@ Several keys allow customization: \section{s, p, and Hybrid Orbitals}\label{sec:orbitale}\secidx{Orbitals} \chemmacros provides the following command to create orbitals: -\begin{description} - \item \cmd{orbital}[<keyval>]{<type} -\end{description} +\begin{beschreibung} + \Befehl{orbital}[<keyval>]{<type} +\end{beschreibung} -There are the following types available for \texttt{<type>}: +There are the following types available for \code{<type>}: \begin{description} - \item \texttt{s} - \item \texttt{p} - \item \texttt{sp} - \item \texttt{sp2} - \item \texttt{sp3} + \item \code{s} + \item \code{p} + \item \code{sp} + \item \code{sp2} + \item \code{sp3} \end{description} \begin{beispiel} \orbital{s} \orbital{p} \orbital{sp} \orbital{sp2} \orbital{sp3} \end{beispiel} -Depending on the type you have different keys to modify the orbitals: -\begin{description} - \item \key[orbital]{phase}{\uline{+}/-} changes the phase of the orbital (all types) - \item \key[orbital]{scale}{<factor>} changes the size of the orbital (all types) - \item \key[orbital]{color}{<color>} changes the color of the orbital (all types) - \item \key[orbital]{angle}{<angle>} rotates the orbitals with a p contribution counter clockwise (all types except \texttt{s}) - \item \key[orbital]{half}{\uline{true}/false} displays only half an orbital (only \texttt{p}) -\end{description} +Depending on the type you have different options to modify the orbitals: +\begin{beschreibung} + \option[orbital]{phase}{\default{+}/-} changes the phase of the orbital (all types) + \option[orbital]{scale}{<factor>} changes the size of the orbital (all types) + \option[orbital]{color}{<color>} changes the color of the orbital (all types) + \option[orbital]{angle}{<angle>} rotates the orbitals with a p contribution counter clockwise (all types except \code{s}) + \option[orbital]{half}{\default{true}/false} displays only half an orbital (only \code{p}) +\end{beschreibung} \begin{beispiel} \orbital{s} \orbital[phase=-]{s} @@ -1256,24 +1511,24 @@ Depending on the type you have different keys to modify the orbitals: \orbital[angle=0]{p} \orbital[color=red!50]{p} \orbital[angle=135,scale=1.5]{p} \orbital[half]{p} \end{beispiel} -Additionally there are two keys, with which the \TikZ behaviour can be changed. -\begin{description} - \item \key[orbital]{overlay}{\uline{true}/false} the orbital \enquote{doesn't need space}; it is displayed with the \TikZ option \texttt{overlay}. - \item \key[orbital]{opacity}{<num>} the orbital becomes transparent; \texttt{<value>} can have values between \texttt{1} (fully opaque) to \texttt{0} (invisible). -\end{description} - -\begin{beispiel} - \vspace{1cm}\hspace{1cm} +Additionally there are two options, with which the \TikZ behaviour can be changed. +\begin{beschreibung} + \option[orbital]{overlay}{\default{true}/false} the orbital \enquote{doesn't need space}; it is displayed with the \TikZ option \code{overlay}. + \option[orbital]{opacity}{<num>} the orbital becomes transparent; \code{<value>} can have values between \code{1} (fully opaque) to \code{0} (invisible). +\end{beschreibung} +\begin{beispiel}[dist] + \hspace{1cm} \chemsetup[orbital]{ overlay, p/color = black!70 } \setbondoffset{0pt} \chemfig{?\orbital{p}-[,1.3]{\orbital[phase=-]{p}}-[:30,1.1]\orbital{p}-[:150,.9]{\orbital[phase=-]{p}}-[4,1.3]\orbital{p}-[:-150,1.1]{\orbital[phase=-]{p}}?} - \vspace{1cm} + \vspace{7mm} \end{beispiel} -\begin{beispiel} - \vspace{2cm}\hspace{2cm} +\bspmidlength{dist}{10mm} +\begin{beispiel}[dist] + \hspace{2cm} \setbondoffset{0pt} \chemsetup[orbital]{ overlay , @@ -1283,108 +1538,14 @@ Additionally there are two keys, with which the \TikZ behaviour can be changed. s/scale = 1.6 } \chemfig{\orbital{s}-[:-20]{\orbital[scale=2]{p}}{\orbital[half,angle=0]{p}}{\orbital[angle=170,half]{p}}{\orbital[angle=-150,half]{p}}(-[:-150]\orbital{s})-\orbital{s}} - \vspace{2cm} + \vspace{1cm} \end{beispiel} -\secidx*{Orbitals} +\bspmidlength{dist}{7mm} +\secidx*{Orbitals}\secidx*{CHEMMACROS} -\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} - \item \cmd{chemsetup}[<module>]{<keyval>} or - \item \cmd{chemsetup}{<module>/<keyval>}. -\end{description} -Some keys can be set without value. Then the \uline{underlined} value is used. -\small -\begin{longtable}{>{\ttfamily\color{key}\hspace{5mm}}l>{\ttfamily\color{module}}l>{\ttfamily}l>{\ttfamily}ll} - \toprule - \normalfont\normalcolor\bfseries key & \normalfont\normalcolor\bfseries module & \normalfont\bfseries values & \normalfont\bfseries default & \\ - \midrule - \endhead - \bottomrule - \endfoot - \multicolumn{5}{l}{package options:} \\ - 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} \\ - cmversion & option & 1/2/bundle & bundle & page \pageref{key:option_cmversion} \\ - german & option & \uline{true}/false & false & page \pageref{key:option_german} \\ - ghsystem & option & \uline{true}/false & true & page \pageref{key:option_ghsystem} \\ - iupac & option & auto/restricted/strict & auto & page \pageref{key:option_iupac} \\ - method & option & chemformula/formula & formula & page \pageref{key:option_method} \\ - Nu & option & chemmacros/mathspec & chemmacros & page \pageref{key:option_Nu} \\ - strict & option & \uline{true}/false & false & page \pageref{key:option_strict} \\ - synchronize & option & \uline{true}/false & false & page \pageref{key:option_synchronize} \\ - upgreek & option & none/textgreek/\uline{upgreek} & upgreek & page \pageref{key:option_upgreek} \\ - version & option & & & page \pageref{key:option_version} \\ - xspace & option & \uline{true}/false & true & page \pageref{key:option_xspace} \\ - \multicolumn{5}{l}{\cmd{ba}, \cmd{Nu}:} \\ - elpair & particle & \uline{dots}/dash/false & false & page \pageref{key:particle_elpair} \\ - \multicolumn{5}{l}{\cmd{DeclareChemLatin}:} \\ - format & latin & <anything> & \lstinline=\itshape= & page \pageref{key:latin_format} \\ - \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} \\ - pos & ox & top/super/side & top & page \pageref{key:ox_pos} \\ - explicit-sign & ox & \uline{true}/false & false & page \pageref{key:ox_explicit-sign} \\ - decimal-marker & ox & comma/point & point & page \pageref{key:ox_decimal-marker} \\ - \multicolumn{5}{l}{\cmd{OX}, \cmd{redox}:} \\ - dist & redox & <dim> & .6em & page \pageref{key:redox_dist} \\ - sep & redox & <dim> & .2em & page \pageref{key:redox_sep} \\ - \multicolumn{5}{l}{\cmd{Enthalpy}, \cmd{Entropy}, \cmd{Gibbs}:} \\ - exponent & & <anything> & \cmd{standardstate} & page \pageref{key:none_exponent} \\ - delta & & <anything>/false & & page \pageref{key:none_delta} \\ - subscript & & left/right & & page \pageref{key:none_subscript} \\ - unit & & <unit> & & page \pageref{key:none_unit} \\ - \multicolumn{5}{l}{\cmd{DeclareChemState}, \cmd{RenewChemState}:} \\ - exponent & & <anything> & \cmd{standardstate} & page \pageref{key:none_exponent} \\ - delta & & <anything>/false & & page \pageref{key:none_delta} \\ - subscript & & <anything> & & page \pageref{key:none_subscript} \\ - subscript-left & & \uline{true}/false & & page \pageref{key:none_subscript-left} \\ - \multicolumn{5}{l}{\cmd{State}:} \\ - exponent & state & <anything> & \cmd{standardstate} & page \pageref{key:state_exponent} \\ - delta & state & <anything>/false & & page \pageref{key:state_delta} \\ - subscript-left & state & \uline{true}/false & & page \pageref{key:state_subscript-left} \\ - \multicolumn{5}{l}{\cmd{NMR}:} \\ - unit & nmr & <unit> & \cmd{mega}\cmd{hertz} & page \pageref{key:nmr_unit} \\ - nucleus & nmr & \{<num>,<atom symbol>\} & \{1,H\} & page \pageref{key:nmr_nucleus} \\ - \multicolumn{5}{l}{\cmd{DeclareChemReaction}:} \\ - star & & \uline{true}/false & false & page \pageref{key:none_star} \\ - arg & & \uline{true}/false & false & page \pageref{key:none_arg} \\ - list-name & reaction & <anything> & List of reactions & page \pageref{key:reaction_list-name} \\ - list-entry & reaction & <anything> & Reaction & page \pageref{key:reaction_list-entry} \\ - \multicolumn{5}{l}{\cmd{mhName}:} \\ - align & mhName & <alignment> & \cmd{centering} & page \pageref{key:mhName_align} \\ - format & mhName & <commands> & & page \pageref{key:mhName_format} \\ - fontsize & mhName & <fontsize> & \cmd{tiny} & page \pageref{key:mhName_fontsize} \\ - width & mhName & <dim> & & page \pageref{key:mhName_width} \\ - \multicolumn{5}{l}{phases:} \\ - pos & phases & side/sub & side & page \pageref{key:phases_pos} \\ - space & phases & <dim> & .1333em & page \pageref{key:phases_space} \\ - \multicolumn{5}{l}{\cmd{newman}:} \\ - angle & newman & <angle> & 0 & page \pageref{key:newman_angle} \\ - scale & newman & <factor> & 1 & page \pageref{key:newman_scale} \\ - ring & newman & <tikz> & & page \pageref{key:newman_ring} \\ - atoms & newman & <tikz> & & page \pageref{key:newman_atoms} \\ - back-atoms & newman & <tikz> & & page \pageref{key:newman_back-atoms} \\ - \multicolumn{5}{l}{\cmd{orbital} \ttfamily <type> = s/p/sp/sp2/sp3:} \\ - phase & orbital/<type> & +/- & + & page \pageref{key:orbital_phase} \\ - scale & orbital/<type> & <factor> & 1 & page \pageref{key:orbital_scale} \\ - color & orbital/<type> & <color> & black & page \pageref{key:orbital_color} \\ - angle & orbital/<type> & <angle> & 90 & page \pageref{key:orbital_angle} \\ - half & orbital/p & \uline{true}/false & false & page \pageref{key:orbital_half} \\ - overlay & orbital & \uline{true}/false & false & page \pageref{key:orbital_overlay} \\ - opacity & ornital & <num> & 1 & page \pageref{key:orbital_opacity} -\end{longtable} -\normalsize\secidx*{Option Overview (chemmacros)} -\secidx*{CHEMMACROS} - -\part{\texorpdfstring{\Chemformula}{chemformula}}\chemsetup[chemformula]{format=}\secidx{CHEMFORMULA} +\part{\texorpdfstring{\Chemformula}{chemformula}}\chemsetup[chemformula]{format=}\secidx{CHEMFORMULA}\label{part:chemformula} \section{Setup} -All of \chemformula's options belong to the module \textcolor{module}{\texttt{chemformula}}. This means they can be setup with +All of \chemformula's options belong to the module \textcolor{module}{\code{chemformula}}. This means they can be setup with \begin{beispiel}[code only] \chemsetup[chemformula]{<options>} or \chemsetup{chemformula/<option1>,chemformula/<option2>} @@ -1392,9 +1553,9 @@ All of \chemformula's options belong to the module \textcolor{module}{\texttt{ch \section{The Basic Principle} \chemformula offers one main command. -\begin{description} - \item\cmd{ch}[<options>]{<input>} -\end{description} +\begin{beschreibung} + \Befehl{ch}[<options>]{<input>} +\end{beschreibung} The usage will seem very familiar to you if you're familiar with \paket{mhchem}: \begin{beispiel} \ch{H2O} \\ @@ -1415,9 +1576,9 @@ The usage will seem very familiar to you if you're familiar with \paket{mhchem}: \end{beispiel} However, there are differences. The most notable one: \chemformula distinguishes between different types of input. These different parts \emph{have} to be seperated with blanks: -\begin{description} - \item\cmd{ch}{part1 part2 part3 part4} -\end{description} +\begin{beschreibung} + \Befehl{ch}{part1 part2 part3 part4} +\end{beschreibung} A blank in the input \emph{never} is a blank in the output. This role of the blank strictly holds and disregarding it can have unexpected results and even lead to errors. Another notable difference: \chemformula tries to avoid math mode whenever possible: @@ -1433,10 +1594,10 @@ This means that \cmd{ch}{2H2O} is recognized as a \emph{single} part, which in t \end{beispiel} This also means, that a part cannot contain a blank since this will automatically divide it into two parts. If you need an extra blank in the output you need to use \lstinline+~+. However, since commands in most cases gobble a space after them a input like \cmd{ch}{\textbackslash command ABC} will be treated as a single part. If you want or need to divide them you need to add an empty group: \cmd{ch}{\textbackslash command\{\} ABC}. The different input types are described in the following sections. -There are some options to customize the output of the \cmd{ch} command. They can either be applied locally using the optional argument or can be set globally using the setup command. All options of \chemformula belong to the module \textcolor{module}{\texttt{chemformula}}. -\begin{description} - \item\cmd{chemsetup}[chemformula]{<options>} -\end{description} +There are some options to customize the output of the \cmd{ch} command. They can either be applied locally using the optional argument or can be set globally using the setup command. All options of \chemformula belong to the module \textcolor{module}{\code{chemformula}}. +\begin{beschreibung} + \Befehl{chemsetup}[chemformula]{<options>} +\end{beschreibung} \section{Stoichiometric Factors}\secidx{Stoichiometric Factors} A stoichiometric factor may only contain of numbers and the signs \lstinline+.,_/()+ @@ -1467,11 +1628,11 @@ You can find many examples like the following for stoichiometric factors in pare \end{reaction*} There are a few possibilities to customize the output. -\begin{description} - \item \key{decimal-marker}{<marker>} the symbol to indicate the decimal. Default = \texttt{.} - \item \key{frac-style}{math/xfrac/nicefrac} determines how fractions are displayed. Default = \texttt{math} - \item \key{stoich-space}{<dim>} The space that is placed after the stoichiometric factor. Default = \lstinline=.1667em= -\end{description} +\begin{beschreibung} + \option{decimal-marker}{<marker>} the symbol to indicate the decimal. Default = \code{.} + \option{frac-style}{math/xfrac/nicefrac} determines how fractions are displayed. Default = \code{math} + \option{stoich-space}{<dim>} The space that is placed after the stoichiometric factor. Default = \code{.1667em} +\end{beschreibung} \begin{beispiel} \ch[decimal-marker={,}]{3.5} \ch[decimal-marker={$\cdot$}]{3,5} \end{beispiel} @@ -1521,10 +1682,10 @@ The option \key{stoich-space} allows you to customize the space between stoichio \subsection{Adducts}\secidx[adducts]{Compounds} \chemformula has two identifiers which will create adducts. -\begin{description} - \item \cmd{ch}{A.B} - \item \cmd{ch}{A*B} -\end{description} +\begin{beschreibung} + \befehl{ch}{A.B} + \befehl{ch}{A*B} +\end{beschreibung} \begin{beispiel} \ch{CaSO4.H2O} \\ \ch{CaSO4*H2O} @@ -1570,7 +1731,7 @@ If a compound \emph{ends} with a plus or minus sign it will be treated as charge \ch{A-B} \ch{AB-} \end{beispiel} -For longer charge groups or other superscripts you can use the math syntax. It recognizes groups and you can use math inside them. Inside these groups neither \texttt{+} nor \texttt{-} are treated as bonds. If a dot \texttt{.} is inside a superscript it is treated as indicator for a radical. A \texttt{*} gives the excited state. +For longer charge groups or other superscripts you can use the math syntax. It recognizes groups and you can use math inside them. Inside these groups neither \code{+} nor \code{-} are treated as bonds. If a dot \code{.} is inside a superscript it is treated as indicator for a radical. A \code{*} gives the excited state. \begin{beispiel} \ch{A^{x-}} \\ \ch{A^x-} \\ @@ -1589,7 +1750,7 @@ Ions and ion composites with more than one charge can be typeset quite as easy: \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}. +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 \code{circled} is obeyed by \cmd{ch}. \begin{beispiel} \chemsetup[option]{circled=all} \ch{H+ + OH- <=> H2O} @@ -1604,12 +1765,12 @@ The supercripts behave differently depending on their position in a compound, if \end{beispiel} \begin{itemize} \item If a compound \emph{starts} with a sub- or superscript both sub- and superscript are aligned to the \emph{right} else to the \emph{left}. - \item If a \emph{does not start} with a sub- or superscript and there is both a sub- and a superscript, the superscript is shifted additionally by a length determined from the option \key{charge-hshift}{<dim>}, also see page \pageref{key:charge-hshift}f. + \item If a \emph{does not start} with a sub- or superscript and there is both a sub- and a superscript, the superscript is shifted additionally by a length determined from the option \key{charge-hshift}{<dim>}, also see page \pageref{desc:charge-hshift}f. \end{itemize} The second point follows \IUPAC's recommendations: -\begin{myquote}[{\IUPAC Green Book \cite[][p.\,51]{iupac:greenbook}}] +\begin{zitat}[{\IUPAC Green Book \cite[][p.\,51]{iupac:greenbook}}] In writing the formula for a complex ion, spacing for charge number can be added (staggered arrangement), as well as parentheses: \ch[charge-hshift=full]{SO4^2-}, \ch{(SO4)^2-} The staggered arrangement is now recommended. -\end{myquote} +\end{zitat} \subsection{Bonds}\label{ssec:bonds}\secidx[bonds]{Compounds} There are three kinds of bonds: @@ -1621,15 +1782,16 @@ There are three kinds of bonds: \subsection{Customization}\secidx[customization]{Compounds} These options allow you to customize the ouptut of the compounds: -\begin{description} - \item \key{subscript-vshift}{<dim>} Extra vertical shift of the subscripts. Default = \texttt{0pt} - \item \key{subscript-style}{text/math} Style that is used to typeset the subscripts. Default = \texttt{text} - \item \key{charge-hshift}{<dim>} Shift of superscripts when following a subscript. Default = \texttt{.5ex}\label{key:charge-hshift} - \item \key{charge-vshift}{<dim>} Extra vertical shift of the superscripts. Default = \texttt{0pt} - \item \key{charge-style}{text/math} Style that is used to typeset the superscripts. Default = \texttt{text} - \item \key{adduct-space}{<dim>} Space to the left and the right of the adduct point. Default = \lstinline+.1333em+ - \item \key{bond-length}{<dim>} The length of the bonds. Default is the length of an endash as measured by \lstinline+\settowidth{<len>}{\textendash}+. -\end{description} +\begin{beschreibung} + \option{subscript-vshift}{<dim>} Extra vertical shift of the subscripts. Default = \code{0pt} + \option{subscript-style}{text/math} Style that is used to typeset the subscripts. Default = \code{text} + \option{charge-hshift}{<dim>} Shift of superscripts when following a subscript. Default = \code{.5ex}\label{desc:charge-hshift} + \option{charge-vshift}{<dim>} Extra vertical shift of the superscripts. Default = \code{0pt} + \option{charge-style}{text/math} Style that is used to typeset the superscripts. Default = \code{text} + \option{adduct-space}{<dim>} Space to the left and the right of the adduct point. Default = \code{.1333em} + \option{bond-length}{<dim>} The length of the bonds. Default is the length of an endash as measured by \lstinline+\settowidth{<len>}{\textendash}+. + \option{bond-offset}{<dim>} Space between bond and atoms. Default = \code{0pt} +\end{beschreibung} Maybe you have noticed that charges of certain ions are shifted to the right.\secidx[charges!shift]{Compounds} They are shifted if they \emph{follow} a subscript which follows \IUPAC recommendations \cite[][p.\,51]{iupac:greenbook}. The amount of the shift can be set with the option \key{charge-hshift}. \begin{beispiel} \ch{SO4^2-} \ch{NH4+} \ch{Na+} \\ @@ -1684,6 +1846,12 @@ Changing the length of the bonds:\secidx[bonds!length]{Compounds} double: \ch{CH2=CH2} \\ triple: \ch{CH+CH} \end{beispiel} + +You can change the distance between bond and atom, too: +\begin{beispiel} + \ch{H-H + N+N + O=O} \\ + \ch[bond-offset=1pt]{H-H + N+N + O=O} +\end{beispiel} \secidx*{Compounds} \section{Special Input Types}\secidx{Special Types} @@ -1691,18 +1859,18 @@ There are some \enquote{special type} input groups. \subsection{Single Token Groups}\secidx[single token groups]{Special Types} The first kind are groups which consist of only one token, namely of the following ones: -\begin{description} - \item \cmd{ch}{ + } \ch{+} creates the plus sign between compounds with space around it:\\ +\begin{beschreibung} + \befehl{ch}{ + } \ch{+} creates the plus sign between compounds with space around it:\\ \cmd{ch}{2 Na + Cl2} \ch{2 Na + Cl2} - \item \cmd{ch}{ v } \ch{v} sign for precipitate: \cmd{ch}{BaSO4 v} \ch{BaSO4 v} - \item \cmd{ch}{ \lstinline+^+ } \ch{^} sign for escaping gas\footnotemark: \cmd{ch}{\lstinline=H2 ^=} \ch{H2 ^} -\end{description} + \befehl{ch}{ v } \ch{v} sign for precipitate: \cmd{ch}{BaSO4 v} \ch{BaSO4 v} + \befehl{ch}{ \lstinline+^+ } \ch{^} sign for escaping gas\footnotemark: \cmd{ch}{\lstinline=H2 ^=} \ch{H2 ^} +\end{beschreibung} \footnotetext{Is this the correct English term? Please correct me if it isn't.} The space left and right of the plus sign can be set with this option: -\begin{description} - \item \key{plus-space}{<dim>} Default = \lstinline+.3em+ -\end{description} +\begin{beschreibung} + \option{plus-space}{<dim>} Default = \lstinline+.3em+ +\end{beschreibung} \begin{beispiel} \ch{A + B}\\ \ch[plus-space=4pt]{A + B} @@ -1716,9 +1884,9 @@ Sometimes you might want to apply an option only to a part of a, say, reaction. \ch{H2O +}\ch[subscript-vshift=2pt]{H2SO4}\ch{-> H3O+ + HSO4-} \end{beispiel} This, however, interrupts the input in your source and \emph{may} mess with the spacing. That's why there is an alternative: -\begin{description} - \item \ttfamily\cmd{ch}\{\lstinline+@{<options>}+\}\normalfont\ The options specified this way will be valid \emph{only} until the next compound is set. -\end{description} +\begin{beschreibung}\makeatletter + \befehl{ch}{ @\{<options>\} } The options specified this way will be valid \emph{only} until the next compound is set. +\end{beschreibung} \begin{beispiel} \ch{H2O +}\textcolor{red}{\ch{H2SO4}}\ch{-> H3O+ + HSO4-} \\ \ch{H2O + @{format=\color{red}} H2SO4 -> H3O+ + HSO4-} \\ @@ -1733,10 +1901,10 @@ This, however, interrupts the input in your source and \emph{may} mess with the In some cases it may be desirable to prevent \chemformula from parsing the input. This can be done in two ways. \subsection{Text}\label{ssec:text}\secidx[text]{Escaped Input} If you put something between \lstinline+" "+ or \lstinline+' '+ then the input will be treated as normal text, except that spaces are not allowed and have to be input with \lstinline+~+. -\begin{description} - \item \cmd{ch}{ "<escaped text>" } - \item \cmd{ch}{ '<escaped text>' } -\end{description} +\begin{beschreibung} + \Befehl{ch}{ "<escaped text>" } + \Befehl{ch}{ '<escaped text>' } +\end{beschreibung} \begin{beispiel} \ch{"\ox{2,Ca}" O} \\ \ch{"\ldots\," Na + "\ldots\," Cl2 -> "\ldots\," NaCl} \\ @@ -1746,9 +1914,9 @@ In many cases you won't need to escape the input. But when you get into trouble \subsection{Math}\secidx[math]{Escaped Input} If you especially want to input math you just enclose it with \lstinline+$ $+. This output is different from the escaped text as it is followed by a space. -\begin{description} - \item \cmd{ch}{ \lstinline"$<escaped math>$" } -\end{description} +\begin{beschreibung}\catcode`\$=11 + \Befehl{ch}{ $<escaped math>$ } +\end{beschreibung} \begin{beispiel} escaped text: \ch{"$x$" H2O} \\ escaped math: \ch{$x$ H2O} \\ @@ -1756,12 +1924,12 @@ If you especially want to input math you just enclose it with \lstinline+$ $+. T \end{beispiel} The space that is inserted after a math group can be edited: -\begin{description} - \item \key{math-space}{<dim>} Default = \lstinline=.1667em= -\end{description} +\begin{beschreibung} + \option{math-space}{<dim>} Default = \code{.1667em} +\end{beschreibung} \begin{beispiel} \ch{$2n$ Na + $n$ Cl2 -> $2n$ NaCl} \\ - \chemsetup[chemformula]{math-space=.2em} + \chemsetup[chemformula]{math-space=.25em} \ch{$2n$ Na + $n$ Cl2 -> $2n$ NaCl} \\ \ch{$A->B$} \end{beispiel} @@ -1770,19 +1938,19 @@ The space that is inserted after a math group can be edited: \section{Arrows}\label{sec:arrows}\secidx{Arrows} \subsection{Arrow types}\secidx[types]{Arrows} Arrows are input in the same intuitive way they are with \paket{mhchem}. There are various different types: -\begin{description} - \item \cmd{ch}{ -> } \ch{->} standard right arrow - \item \cmd{ch}{ <- } \ch{<-} standard left arrow - \item \cmd{ch}{ -/> } \ch{-/>} does not react (right) - \item \cmd{ch}{ </- } \ch{</-} does not react (left) - \item \cmd{ch}{ <-> } \ch{<->} resonance arrow - \item \cmd{ch}{ <> } \ch{<>} reaction in both directions - \item \cmd{ch}{ == } \ch{==} stoichiometric equation - \item \cmd{ch}{ <=> } \ch{<=>} equilibrium arrow - \item \cmd{ch}{ \lstinline+<=>>+ } \ch{<=>>} unbalanced equilibrium arrow to the right - \item \cmd{ch}{ \lstinline+<<=>+ } \ch{<<=>} unbalanced equilibrium arrow to the left - \item \cmd{ch}{ <o> } \ch{<o>} isolobal arrow -\end{description} +\begin{beschreibung} + \befehl{ch}{ -> } \ch{->} standard right arrow + \befehl{ch}{ <- } \ch{<-} standard left arrow + \befehl{ch}{ -/> } \ch{-/>} does not react (right) + \befehl{ch}{ </- } \ch{</-} does not react (left) + \befehl{ch}{ <-> } \ch{<->} resonance arrow + \befehl{ch}{ <> } \ch{<>} reaction in both directions + \befehl{ch}{ == } \ch{==} stoichiometric equation + \befehl{ch}{ <=> } \ch{<=>} equilibrium arrow + \befehl{ch}{ \lstinline+<=>>+ } \ch{<=>>} unbalanced equilibrium arrow to the right + \befehl{ch}{ \lstinline+<<=>+ } \ch{<<=>} unbalanced equilibrium arrow to the left + \befehl{ch}{ <o> } \ch{<o>} isolobal arrow +\end{beschreibung} All these arrows are drawn with \TikZ. \begin{beispiel} \ch{H2 + Cl2 -> 2 HCl} \\ @@ -1796,9 +1964,9 @@ All these arrows are drawn with \TikZ. \subsection{Labels}\secidx[labels]{Arrows} The arrows take two optional arguments to label them. -\begin{description} - \item\cmd{ch}{ ->[<above>][<below>] } -\end{description} +\begin{beschreibung} + \Befehl{ch}{ ->[<above>][<below>] } +\end{beschreibung} \begin{beispiel} \ch{A ->[a] B} \\ \ch{A ->[a][b] B} \\ @@ -1825,14 +1993,14 @@ If you leave the blanks \chemformula treats the groups inside the square bracket \subsection{Customization}\secidx[customization]{Arrows} These are the options which enable you to customize the arrows: -\begin{description} - \item \key{arrow-offset}{<dim>} This is the length that an arrow protrudes a label on both sides. This means an empty arrow's length is two times \texttt{arrow-offset}. Default = \texttt{1.5ex} - \item \key{arrow-yshift}{<dim>} Shifts an arrow up (positive value) or down (negative value). Default = \texttt{0pt} - \item \key{arrow-ratio}{<factor>} The ratio of the arrow lengths of the unbalanced equilibrium. \texttt{.4} would mean that the length of the shorter arrow is $0.4\times$ the length of the longer arrow. Default = \texttt{.6} - \item \key{compound-sep}{<dim>} The space between compounds and the arrows. Default = \texttt{1ex} - \item \key{label-offset}{<dim>} The space between the labels and the arrows. Default = \texttt{2pt} - \item \key{label-style}{<font command>} The relative font size of the labels. Default = \lstinline+\footnotesize+ -\end{description} +\begin{beschreibung} + \option{arrow-offset}{<dim>} This is the length that an arrow protrudes a label on both sides. This means an empty arrow's length is two times \code{arrow-offset}. Default = \code{1.5ex} + \option{arrow-yshift}{<dim>} Shifts an arrow up (positive value) or down (negative value). Default = \code{0pt} + \option{arrow-ratio}{<factor>} The ratio of the arrow lengths of the unbalanced equilibrium. \code{.4} would mean that the length of the shorter arrow is $0.4\times$ the length of the longer arrow. Default = \code{.6} + \option{compound-sep}{<dim>} The space between compounds and the arrows. Default = \code{1ex} + \option{label-offset}{<dim>} The space between the labels and the arrows. Default = \code{2pt} + \option{label-style}{<font command>} The relative font size of the labels. Default = \lstinline+\footnotesize+ +\end{beschreibung} The following code shows the effect of the different options on the \lstinline+<=>>+ arrow: \begin{beispiel} @@ -1844,38 +2012,24 @@ The following code shows the effect of the different options on the \lstinline+< larger distance to compounds: \ch[compound-sep=2ex]{A <=>>[x][y] B} \\ smaller labels: \ch[label-style=\tiny]{A <=>[x][y] B} \end{beispiel} -% -% The tips of the arrows are designed to match the appearance of \paket{chemfig}'s arrows. If you like other arrow tips better and want to change them without redefining all the arrows (see section \ref{sec:arrows_modify}) you can use the command -% \begin{description} -% \item \cmd{pgfarrowsrenewalias}{<new start>}\ma{<new end>}\ma{<old start>}\ma{<old end>} -% \end{description} -% This command is the same as \lstinline=\pgfarrowsdeclarealias= but without the check if the new tips exist. This means it lets you overwrite old definitions. -% \begin{beispiel} -% % overwrite the chemformula arrow heads `cf' and `left cf' -% \pgfarrowsrenewalias{left cf}{left cf}{left to}{left to} -% \pgfarrowsrenewalias{cf}{cf}{to}{to} -% -% \ch{CO + H2O <=> CO2 + H2} \\ -% \ch{C + H2O -> CO + H2} -% \end{beispiel} \subsection{Modify Arrow Types}\label{sec:arrows_modify}\secidx[types!modify]{Arrows} The arrows are defined with the command -\begin{description} - \item \cmd{DeclareChemArrow}{<tokens>}\ma{<tikz>} -\end{description} +\begin{beschreibung} + \Befehl{DeclareChemArrow}{<tokens>}\ma{<tikz>} +\end{beschreibung} \ma{<tokens>} is the sequence of tokens that is replaced with the actual arrow code. For example the basic arrow is defined via \begin{beispiel}[code only] \DeclareChemArrow{->}{\draw[-cf] (cf_arrow_start) -- (cf_arrow_end) ;} \end{beispiel} In order to define arrows yourself you need to know the basics of \TikZ\footnote{Please see the \textsf{pgfmanual} for details.}. There are some predefined coordinates you can and should use: \begin{description} - \item[\texttt{(cf\_arrow\_start)}] The beginning of the arrow. - \item[\texttt{(cf\_arrow\_end)}] The end of the arrow. - \item[\texttt{(cf\_arrow\_mid)}] The mid of the arrow. - \item[\texttt{(cf\_arrow\_mid\_start)}] The beginning of the shorter arrow in types like \lstinline+<=>>+. - \item[\texttt{(cf\_arrow\_mid\_end)}] The end of the shorter arrow in types like \lstinline+<=>>+. - \item[\texttt{cf}, \texttt{left cf}, \texttt{right cf}] \chemformula's own arrow heads. + \item[\code{(cf\_arrow\_start)}] The beginning of the arrow. + \item[\code{(cf\_arrow\_end)}] The end of the arrow. + \item[\code{(cf\_arrow\_mid)}] The mid of the arrow. + \item[\code{(cf\_arrow\_mid\_start)}] The beginning of the shorter arrow in types like \lstinline+<=>>+. + \item[\code{(cf\_arrow\_mid\_end)}] The end of the shorter arrow in types like \lstinline+<=>>+. + \item[\code{cf}, \code{left cf}, \code{right cf}] \chemformula's own arrow heads. \end{description} \begin{beispiel} \DeclareChemArrow{.>}{\draw[-cf,dotted,red] (cf_arrow_start) -- (cf_arrow_end);} @@ -1883,10 +2037,10 @@ In order to define arrows yourself you need to know the basics of \TikZ\footnote \ch{A .> B} \ch{A .>[a][b] B} \ch{A n> B} \end{beispiel} If you want to redefine an existing arrow there are two commands you can use: -\begin{description} - \item \cmd{RenewChemArrow}{<tokens>}\ma{<tikz>} - \item \cmd{ShowChemArrow}{<tokens>} -\end{description} +\begin{beschreibung} + \Befehl{RenewChemArrow}{<tokens>}\ma{<tikz>} + \Befehl{ShowChemArrow}{<tokens>} +\end{beschreibung} The second one gives the current definition, the first one redefines an existing arrow. \begin{beispiel} \texttt{\ShowChemArrow{->}} \\ @@ -1899,9 +2053,9 @@ The second one gives the current definition, the first one redefines an existing \section{Names}\secidx{Names} \subsection{Syntax}\secidx[syntax]{Names} \chemformula has a built-in syntax to write text under a compound. In a way it works very similar to the arrows. -\begin{description} - \item\cmd{ch}{ !(<name>)( <formula> ) } -\end{description} +\begin{beschreibung} + \Befehl{ch}{ !(<name>)( <formula> ) } +\end{beschreibung} If an exclamation mark is followed by a pair of parentheses \chemformula will parse it this way: \begin{beispiel} \ch{!(ethanol)( CH2CH2OH )} @@ -1922,10 +2076,10 @@ If for some reason you want to insert an exclamation mark \emph{without} it crea \subsection{Customization}\secidx[customization]{Names} \chemformula provides two options to customize the output of the names: -\begin{description} - \item \key{name-format}{<commands>} The format of the name. This can be arbitrary input. Default = \lstinline+\scriptsize\centering+ - \item \key{name-width}{<dim>/auto} The width of the box where the label is put into. \texttt{auto} will detect the width of the name and set the box to this width. Default = \texttt{auto} -\end{description} +\begin{beschreibung} + \option{name-format}{<commands>} The format of the name. This can be arbitrary input. Default = \lstinline+\scriptsize\centering+ + \option{name-width}{<dim>/auto} The width of the box where the label is put into. \code{auto} will detect the width of the name and set the box to this width. Default = \code{auto} +\end{beschreibung} \begin{beispiel} \ch{!(acid)( H2SO4 ) -> B} \\ \ch[name-format=\sffamily\small]{!(acid)( H2SO4 ) -> B} \\ @@ -1951,9 +2105,9 @@ Now we're going to change different aspects of the font a look what happens: As you can see most features adapt to the surrounding font. If you want to change the default format you need to use this option: -\begin{description} - \item \key{format}{<anything>} Adds arbitrary code before the output of \cmd{ch}. -\end{description} +\begin{beschreibung} + \option{format}{<anything>} Adds arbitrary code before the output of \cmd{ch}. +\end{beschreibung} \begin{beispiel} \definecolor{newblue}{rgb}{.1,.1,.5}\chemsetup[chemformula]{format=\color{newblue}\sffamily} \sffamily Hallo \sample \\ @@ -1963,11 +2117,11 @@ If you want to change the default format you need to use this option: \end{beispiel} You can also specifically change the fontfamily, fontseries and fontshape of the output. -\begin{description} - \item \key{font-family}{<family>} Changes the fontfamily of the output with \lstinline+\fontfamily{<family>}\selectfont+. - \item \key{font-series}{<series>} Changes the fontseries of the output with \lstinline+\fontseries{<series>}\selectfont+. - \item \key{font-shape}{<shape>} Changes the fontshape of the output with \lstinline+\fontshape{<shape>}\selectfont+. -\end{description} +\begin{beschreibung} + \option{font-family}{<family>} Changes the fontfamily of the output with \lstinline+\fontfamily{<family>}\selectfont+. + \option{font-series}{<series>} Changes the fontseries of the output with \lstinline+\fontseries{<series>}\selectfont+. + \option{font-shape}{<shape>} Changes the fontshape of the output with \lstinline+\fontshape{<shape>}\selectfont+. +\end{beschreibung} \begin{beispiel} \chemsetup[chemformula]{font-series=bx} Hallo \sample \\ @@ -1976,11 +2130,11 @@ You can also specifically change the fontfamily, fontseries and fontshape of the \itshape Hallo \sample \end{beispiel} -If you're using \XeLaTeX\ or \LuaLaTeX\ and have loaded \paket{fontspec} you have the possibilty to set the font with it: -\begin{description} - \item \key{font-spec}{\{<font>\}} or with options - \item \key{font-spec}{\{[<options>]<font>\}} -\end{description} +If you're using \hologo{XeLaTeX} or \hologo{LuaLaTeX} and have loaded \paket{fontspec} you have the possibilty to set the font with it: +\begin{beschreibung} + \Option{font-spec}{\{<font>\}} or with options + \Option{font-spec}{\{[<options>]<font>\}} +\end{beschreibung} \begin{beispiel} \chemsetup[chemformula]{font-spec={Linux Biolinum O}} \sample \\ \chemsetup[chemformula]{font-spec={[Color=darkgray]Augie}} \sample \\ @@ -2061,9 +2215,9 @@ The following example shows how the cancelling of compounds could be done\footno \end{beispiel} \secidx*{CHEMFORMULA} -\part{\texorpdfstring{\Ghsystem}{ghsystem}}\secidx{GHSYSTEM} +\part{\texorpdfstring{\Ghsystem}{ghsystem}}\secidx{GHSYSTEM}\label{part:ghsystem} \section{Setup} -All of \ghsystem's options belong to the module \textcolor{module}{\texttt{ghsystem}}. This means they can be setup with +All of \ghsystem's options belong to the module \textcolor{module}{\code{ghsystem}}. This means they can be setup with \begin{beispiel}[code only] \chemsetup[ghsystem]{<options>} or \chemsetup{ghsystem/<option1>,ghsystem/<option2>} @@ -2072,11 +2226,11 @@ All of \ghsystem's options belong to the module \textcolor{module}{\texttt{ghsys \section{Get Hazard and Precautionary Statements}\secidx{Hazard and Precautionary Statements} \subsection{Simple Statements}\secidx[get statements]{GHSYSTEM} The general usage is simple: you use the command -\begin{description} - \item\cmd{ghs}[<options>]{<type>}\ma{<number>} - \item\cmd[ghsa]{ghs*}[<options>]{<type>}\ma{<number>} -\end{description} -There are three types available: \texttt{h}, \texttt{euh} and \texttt{p}. The \ma{<type>} argument is case insensitive, so just type them in as you like. +\begin{beschreibung} + \Befehl{ghs}[<options>]{<type>}\ma{<number>} + \Befehl[ghsa]{ghs*}[<options>]{<type>}\ma{<number>} +\end{beschreibung} +There are three types available: \code{h}, \code{euh} and \code{p}. The \ma{<type>} argument is case insensitive, so just type them in as you like. \begin{beispiel} \ghs{h}{200} \\ \ghs{H}{224} \\ @@ -2086,14 +2240,14 @@ There are three types available: \texttt{h}, \texttt{euh} and \texttt{p}. The \m \end{beispiel} The starred version hides the identifier and only gives the statement. If you want to hide the statement itself instead you can use the option: -\begin{description} - \item\key{hide}{\uline{true}/false} -\end{description} +\begin{beschreibung} + \Option{hide}{\default{true}/false} +\end{beschreibung} There is an option to customize the output, too. -\begin{description} - \item\key{space}{<space command>} Space between \texttt{<type>} and \texttt{<number>}. -\end{description} +\begin{beschreibung} + \option{space}{<space command>} Space between \code{<type>} and \code{<number>}. +\end{beschreibung} \begin{beispiel} \ghs{h}{200} \\ \ghs[space=\,]{h}{200} \\ @@ -2111,9 +2265,9 @@ Some of the statements contain placeholders. They can be one of the following: \end{itemize} Except the last one which needs to be filled in, they are hidden per default. They can be made visible with the option -\begin{description} - \item\key{fill-in}{\uline{true}/false} Show placeholders. Default = \texttt{false} -\end{description} +\begin{beschreibung} + \option{fill-in}{\default{true}/false} Show placeholders. Default = \code{false} +\end{beschreibung} \begin{beispiel}[below] \ghs{h}{340} \\ \ghs[fill-in]{h}{340} \\ @@ -2126,12 +2280,12 @@ Except the last one which needs to be filled in, they are hidden per default. Th \end{beispiel} These placeholders can be replaced with one of these options: -\begin{description} - \item\key{exposure}{<text>} exposure placeholder - \item\key{effect}{<text>} effect placeholder - \item\key{organs}{<text>} organ placeholder - \item\key{substance}{<text>} substance placeholder -\end{description} +\begin{beschreibung} + \option{exposure}{<text>} exposure placeholder + \option{effect}{<text>} effect placeholder + \option{organs}{<text>} organ placeholder + \option{substance}{<text>} substance placeholder +\end{beschreibung} \begin{beispiel} \ghs[exposure=This is how you get exposed.]{h}{340} \\ \ghs[effect=These are the effects.]{h}{360} \\ @@ -2149,14 +2303,14 @@ Some of the statements have gaps that can be filled. \end{beispiel} These gaps can be filled using these options: -\begin{description} - \item\key{text}{<text>} - \item\key{dots}{<text>} - \item\key{C-temperature}{<num>} - \item\key{F-temperature}{<num>} - \item\key{kg-mass}{<num>} - \item\key{lbs-mass}{<num>} -\end{description} +\begin{beschreibung} + \Option{text}{<text>} + \Option{dots}{<text>} + \Option{C-temperature}{<num>} + \Option{F-temperature}{<num>} + \Option{kg-mass}{<num>} + \Option{lbs-mass}{<num>} +\end{beschreibung} \begin{beispiel} \ghs[dots=contact physician!]{p}{301} \\ \ghs[text=here]{p}{401} \\ @@ -2165,7 +2319,7 @@ These gaps can be filled using these options: \end{beispiel} \subsection{Combined Statements}\secidx[combined statements]{GHSYSTEM} -There are some combinations of statements. They are input with a \texttt{+} between the numbers: +There are some combinations of statements. They are input with a \code{+} between the numbers: \begin{beispiel}[below] \ghs{p}{235+410} \\ \ghs{p}{301+330+331} @@ -2181,27 +2335,27 @@ The GHS defines a number of pictograms: \ghspic{explos} \ghspic{flame} \ghspic{flame-O} \ghspic{bottle} \ghspic{acid} \ghspic{skull} \ghspic{exclam} \ghspic{health} \ghspic{aqpol} The command -\begin{description} - \item\cmd{ghspic}[<options>]{<name>} -\end{description} -loads them. \ref{tab:ghs_pictograms} shows all available pictograms and their names. To be more precise: it shows the names to use with the \cmd{ghspic} command. The file names are \lstinline=ghsystem_<name>.<filetype>= where \texttt{<filetype>} is \texttt{eps}, \texttt{jpg} or \texttt{png}, see also section \ref{ssec:picture_type}. +\begin{beschreibung} + \Befehl{ghspic}[<options>]{<name>} +\end{beschreibung} +loads them. \ref{tab:ghs_pictograms} shows all available pictograms and their names. To be more precise: it shows the names to use with the \cmd{ghspic} command. The file names are \lstinline=ghsystem_<name>.<filetype>= where \code{<filetype>} is \code{eps}, \code{jpg} or \code{png}, see also section \ref{ssec:picture_type}. \begin{beispiel} \ghspic{skull} \end{beispiel} If you don't like the default size you can change it using this option: -\begin{description} - \item\key{scale}{<factor>} Scales the pictogram. Default = \texttt{1} -\end{description} +\begin{beschreibung} + \option{scale}{<factor>} Scales the pictogram. Default = \code{1} +\end{beschreibung} The pictures are actually quite large. The default setting scales them by a factor of $\frac{1}{20}$. \begin{beispiel} \ghspic[scale=2]{skull} \end{beispiel} If you want to use some specific \lstinline=\includegraphics= options, \eg if you want to rotate the pictogram for soma reason, use this option: -\begin{description} - \item\key{includegraphics}{\{<includegraphics keyvals>\}} -\end{description} +\begin{beschreibung} + \Option{includegraphics}{\{<includegraphics keyvals>\}} +\end{beschreibung} \begin{beispiel} \ghspic[includegraphics={angle=90}]{skull} \end{beispiel} @@ -2237,23 +2391,23 @@ If you want to use some specific \lstinline=\includegraphics= options, \eg if yo \end{longtable} \subsection{Picture Type Depending on Engine}\label{ssec:picture_type} -As you probably know you can't use every picture type with every compiler engine. \pdfTeX\ in \textsc{dvi} mode \emph{needs} \texttt{eps} pictures while \pdfTeX\ in \textsc{pdf} mode, \XeTeX\ and \LuaTeX\ convert \texttt{eps} pictures into \texttt{pdf} files, given they have the rights to write in the directory the pictures are saved in. +As you probably know you can't use every picture type with every compiler engine. \pdfTeX\ in \textsc{dvi} mode \emph{needs} \code{eps} pictures while \pdfTeX\ in \textsc{pdf} mode, \XeTeX\ and \LuaTeX\ convert \code{eps} pictures into \code{pdf} files, given they have the rights to write in the directory the pictures are saved in. -However, the latter can include \texttt{jpg} and \texttt{png} without any problems, while \pdfTeX\ in \textsc{dvi} mode can't. +However, the latter can include \code{jpg} and \code{png} without any problems, while \pdfTeX\ in \textsc{dvi} mode can't. -To resolve this \ghsystem tests which engine is used and if \pdfTeX\ which mode is used and then chooses either \texttt{eps} or \texttt{png} for the pictograms. You are free to choose the picture type yourself with the option -\begin{description} - \item\key{pic-type}{eps/jpg/png} -\end{description} +To resolve this \ghsystem tests which engine is used and if \pdfTeX\ which mode is used and then chooses either \code{eps} or \code{png} for the pictograms. You are free to choose the picture type yourself with the option +\begin{beschreibung} + \Option{pic-type}{eps/jpg/png} +\end{beschreibung} \secidx*{Pictograms} -\section{Available Languages} +\section{Available Languages}\label{sec:ghsystem_language} Right now the H and P statements are only available in English or German. The package adapts the package option \key[option]{german} but does not (yet) recognize language settings by \paket{babel} or \paket{polyglossia}. You can also choose the language explicitly. -\begin{description} - \item\key{language}{english/german} -\end{description} +\begin{beschreibung} + \Option{language}{english/german} +\end{beschreibung} \begin{beispiel} \ghs{h}{201} @@ -2261,29 +2415,29 @@ You can also choose the language explicitly. \ghs{h}{201} \end{beispiel} -I will add other languages some time in future. This may take a while, though. If you would be willing to contribute and write the statements of another language please feel free to contact me\footnote{\href{mailto:contac@mychemistry.eu}{contact@mychemistry.eu}}. I would provide you with a template file, a \texttt{pdf} containing the official translations, and help to all your questions. +I will add other languages some time in future. This may take a while, though. If you would be willing to contribute and write the statements of another language please feel free to contact me\footnote{\href{mailto:contac@mychemistry.eu}{contact@mychemistry.eu}}. I would provide you with a template file, a \code{pdf} containing the official translations, and help to all your questions. \section{List of All Statements}\secidx{List of All Statements} If for some reason you want to list all sentences you can use -\begin{description} - \item\cmd{ghslistall}[<options>] -\end{description} +\begin{beschreibung} + \Befehl{ghslistall}[<options>] +\end{beschreibung} This command has a number of options to customize the table, which is created with the \lstinline=longtable= environment of the \paket{longtable} package. -\begin{description} - \item\key{table-head-number}{<text>} Default = \texttt{Identifier} - \item\key{table-head-text}{<text>} Default = \texttt{Statement} - \item\key{table-next-page}{<text>} Default = \texttt{continues on next page} - \item\key{table-caption}{<text>} As \texttt{<text>} in \lstinline=\caption{<text>}=. Default = \texttt{All H, EUH, and P Statements.} - \item\key{table-caption-short}{<text>} As \texttt{<short>} in \lstinline=\caption[<short>]{<text>}=. - \item\key{table-label}{<text>} The label to refer to the table with \lstinline=\ref= and similar commands. Default = \texttt{tab:ghs-hp-statements} - \item\key{table-row-sep}{<dim>} The separation of the table rows. A \TeX\ dimension. Default = \texttt{3pt} - \item\key{table-rules}{\uline{default}/booktabs/none} The style of the horizontal rules in the table. \texttt{default} uses \lstinline=\hline=, \texttt{booktabs} uses \lstinline=\toprule=, \lstinline=\midrule= or \lstinline=\bottomrule=, resp. This option needs the \paket{booktabs} package which you have to load yourself then. Default = \texttt{default} - \item\key{table-top-head-rule}{\uline{default}/booktabs/none} Change top rule explicitly. Default = \texttt{default} - \item\key{table-head-rule}{\uline{default}/booktabs/none} Change rule below head explicitly. Default = \texttt{default} - \item\key{table-foot-rule}{\uline{default}/booktabs/none} Change foot rule explicitly. Default = \texttt{default} - \item\key{table-last-foot-rule}{\uline{default}/booktabs/none} Change last foot rule explicitly. Default = \texttt{default} -\end{description} +\begin{beschreibung} + \option{table-head-number}{<text>} Default = \code{Identifier} + \option{table-head-text}{<text>} Default = \code{Statement} + \option{table-next-page}{<text>} Default = \code{continues on next page} + \option{table-caption}{<text>} As \code{<text>} in \lstinline=\caption{<text>}=. Default = \code{All H, EUH, and P Statements.} + \option{table-caption-short}{<text>} As \code{<short>} in \lstinline=\caption[<short>]{<text>}=. + \option{table-label}{<text>} The label to refer to the table with \lstinline=\ref= and similar commands. Default = \code{tab:ghs-hp-statements} + \option{table-row-sep}{<dim>} The separation of the table rows. A \TeX\ dimension. Default = \code{3pt} + \option{table-rules}{\default{default}/booktabs/none} The style of the horizontal rules in the table. \code{default} uses \lstinline=\hline=, \code{booktabs} uses \lstinline=\toprule=, \lstinline=\midrule= or \lstinline=\bottomrule=, resp. This option needs the \paket{booktabs} package which you have to load yourself then. Default = \code{default} + \option{table-top-head-rule}{\default{default}/booktabs/none} Change top rule explicitly. Default = \code{default} + \option{table-head-rule}{\default{default}/booktabs/none} Change rule below head explicitly. Default = \code{default} + \option{table-foot-rule}{\default{default}/booktabs/none} Change foot rule explicitly. Default = \code{default} + \option{table-last-foot-rule}{\default{default}/booktabs/none} Change last foot rule explicitly. Default = \code{default} +\end{beschreibung} The code below shows how \ref{tab:ghs-hp-statements} was created: \begin{beispiel}[code only] @@ -2295,7 +2449,138 @@ The code below shows how \ref{tab:ghs-hp-statements} was created: \appendix \part{Appendix}\index{APPENDIX@\textbf{APPENDIX}} -\section*{Suggestions and Bug Reports}\addcontentsline{toc}{section}{Suggestions and Bug Reports} +\addsec{Overview: Options and Customization}\label{sec:overview}\secidx{Option Overview (chemmacros)} +\minisec{Options} +In the table below all options provided by \chemmacros for customization are listed. All options that belong to a module can be set with +\begin{beschreibung} + \Befehl{chemsetup}[<module>]{<keyval>} or + \Befehl{chemsetup}{<module>/<keyval>}. +\end{beschreibung} +Some options can be set without value. Then the \default{underlined} value is used. The options belonging to the modules \code{\textcolor{module}{chemformula}} and \code{\textcolor{module}{ghsystem}} are not listed here. +\small +\begin{longtable}{>{\ttfamily\color{key}\hspace{5mm}}l>{\ttfamily\color{module}}l>{\ttfamily}l>{\ttfamily}ll} + \toprule + \normalfont\normalcolor\bfseries option & + \normalfont\normalcolor\bfseries module & + \normalfont\bfseries values & + \normalfont\bfseries default & \\ + \midrule + \endhead + \bottomrule + \endfoot + \multicolumn{5}{l}{package options:} \\ + bpchem & option & \default{true}/false & false & page \pageref{key:option_bpchem} \\ + circled & option & formal/\default{all}/none & formal & page \pageref{key:option_circled} \\ + circletype & option & chem/math & chem & page \pageref{key:option_circletype} \\ + cmversion & option & 1/2/bundle & bundle & page \pageref{key:option_cmversion} \\ + ghsystem & option & \default{true}/false & true & page \pageref{key:option_ghsystem} \\ + iupac & option & auto/restricted/strict & auto & page \pageref{key:option_iupac} \\ + language & option & <language> & english & page \pageref{key:option_language} \\ + method & option & chemformula/formula & formula & page \pageref{key:option_method} \\ + Nu & option & chemmacros/mathspec & chemmacros & page \pageref{key:option_Nu} \\ + strict & option & \default{true}/false & false & page \pageref{key:option_strict} \\ + synchronize & option & \default{true}/false & false & page \pageref{key:option_synchronize} \\ + greek & option & math/textgreek/\default{upgreek} & upgreek & page \pageref{key:option_greek} \\ + version & option & & & page \pageref{key:option_version} \\ + xspace & option & \default{true}/false & true & page \pageref{key:option_xspace} \\ + \multicolumn{5}{l}{\cmd{ba}, \cmd{Nu}:} \\ + elpair & particle & \default{dots}/dash/false & false & page \pageref{key:particle_elpair} \\ + \multicolumn{5}{l}{\cmd{|}, \cmd{-}:} \\ + hyphen-pre-space & iupac & <dim> & .01em & page \pageref{key:iupac_hyphen-pre-space} \\ + hyphen-post-space & iupac & <dim> & -.03em & page \pageref{key:iupac_hyphen-post-space} \\ + break-space & iupac & <dim> & .01em & page \pageref{key:iupac_break-space} \\ + \multicolumn{5}{l}{\cmd{DeclareChemLatin}:} \\ + format & latin & <anything> & \lstinline=\itshape= & page \pageref{key:latin_format} \\ + \multicolumn{5}{l}{\cmd{pch}, \cmd{mch}, \cmd{fpch}, \cmd{fmch}:} \\ + append & charges & \default{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 & \default{true}/false & true & page \pageref{key:ox_parse} \\ + roman & ox & \default{true}/false & true & page \pageref{key:ox_roman} \\ + pos & ox & top/super/side & top & page \pageref{key:ox_pos} \\ + explicit-sign & ox & \default{true}/false & false & page \pageref{key:ox_explicit-sign} \\ + decimal-marker & ox & comma/point & point & page \pageref{key:ox_decimal-marker} \\ + \multicolumn{5}{l}{\cmd{OX}, \cmd{redox}:} \\ + dist & redox & <dim> & .6em & page \pageref{key:redox_dist} \\ + sep & redox & <dim> & .2em & page \pageref{key:redox_sep} \\ + \multicolumn{5}{l}{\cmd{Enthalpy}, \cmd{Entropy}, \cmd{Gibbs}:} \\ + exponent & & <anything> & \cmd{standardstate} & page \pageref{key:none_exponent} \\ + delta & & <anything>/false & & page \pageref{key:none_delta} \\ + subscript & & left/right & & page \pageref{key:none_subscript} \\ + unit & & <unit> & & page \pageref{key:none_unit} \\ + \multicolumn{5}{l}{\cmd{DeclareChemState}, \cmd{RenewChemState}:} \\ + exponent & & <anything> & \cmd{standardstate} & page \pageref{key:none_exponent} \\ + delta & & <anything>/false & & page \pageref{key:none_delta} \\ + subscript & & <anything> & & page \pageref{key:none_subscript} \\ + subscript-left & & \default{true}/false & & page \pageref{key:none_subscript-left} \\ + \multicolumn{5}{l}{\cmd{State}:} \\ + exponent & state & <anything> & \cmd{standardstate} & page \pageref{key:state_exponent} \\ + delta & state & <anything>/false & & page \pageref{key:state_delta} \\ + subscript-left & state & \default{true}/false & & page \pageref{key:state_subscript-left} \\ + \multicolumn{5}{l}{\cmd{NMR}:} \\ + unit & nmr & <unit> & \cmd{mega}\cmd{hertz} & page \pageref{key:nmr_unit} \\ + nucleus & nmr & \{<num>,<atom symbol>\} & \{1,H\} & page \pageref{key:nmr_nucleus} \\ + format & nmr & <anything> & & page \pageref{key:nmr_format} \\ + pos-number & nmr & side/sub & side & page \pageref{key:nmr_pos-number} \\ + coupling-unit & nmr & <unit> & \lstinline+\hertz+ & page \pageref{key:nmr_coupling-unit} \\ + parse & nmr & \default{true}/false & true & page \pageref{key:nmr_parse} \\ + delta & nmr & <anything> & & page \pageref{key:nmr_delta} \\ + list & nmr & \default{true}/false & false & page \pageref{key:nmr_list} \\ + list-setup & nmr & & see text & page \pageref{key:nmr_list-setup} \\ + use-equal & nmr & \default{true}/false & true & page \pageref{key:nmr_use-equal} \\ + \multicolumn{5}{l}{\cmd{DeclareChemReaction}:} \\ + star & & \default{true}/false & false & page \pageref{key:none_star} \\ + arg & & \default{true}/false & false & page \pageref{key:none_arg} \\ + list-name & reaction & <anything> & List of reactions & page \pageref{key:reaction_list-name} \\ + list-entry & reaction & <anything> & Reaction & page \pageref{key:reaction_list-entry} \\ + \multicolumn{5}{l}{\cmd{mhName}:} \\ + align & mhName & <alignment> & \cmd{centering} & page \pageref{key:mhName_align} \\ + format & mhName & <commands> & & page \pageref{key:mhName_format} \\ + fontsize & mhName & <fontsize> & \cmd{tiny} & page \pageref{key:mhName_fontsize} \\ + width & mhName & <dim> & & page \pageref{key:mhName_width} \\ + \multicolumn{5}{l}{phases:} \\ + pos & phases & side/sub & side & page \pageref{key:phases_pos} \\ + space & phases & <dim> & .1333em & page \pageref{key:phases_space} \\ + \multicolumn{5}{l}{\cmd{newman}:} \\ + angle & newman & <angle> & 0 & page \pageref{key:newman_angle} \\ + scale & newman & <factor> & 1 & page \pageref{key:newman_scale} \\ + ring & newman & <tikz> & & page \pageref{key:newman_ring} \\ + atoms & newman & <tikz> & & page \pageref{key:newman_atoms} \\ + back-atoms & newman & <tikz> & & page \pageref{key:newman_back-atoms} \\ + \multicolumn{5}{l}{\cmd{orbital} \ttfamily <type> = s/p/sp/sp2/sp3:} \\ + phase & orbital/<type> & +/- & + & page \pageref{key:orbital_phase} \\ + scale & orbital/<type> & <factor> & 1 & page \pageref{key:orbital_scale} \\ + color & orbital/<type> & <color> & black & page \pageref{key:orbital_color} \\ + angle & orbital/<type> & <angle> & 90 & page \pageref{key:orbital_angle} \\ + half & orbital/p & \default{true}/false & false & page \pageref{key:orbital_half} \\ + overlay & orbital & \default{true}/false & false & page \pageref{key:orbital_overlay} \\ + opacity & ornital & <num> & 1 & page \pageref{key:orbital_opacity} +\end{longtable} +\normalsize + +\minisec{Commands} +Quite a number of commands has been presented with which the possibilities of \chemmacros can be expanded. They are listed below for a quick overview. +\begin{beschreibung} + \befehl{DeclareChemArrow} Define new arrow, see page \pageref{cmd:DeclareChemArrow}. + \befehl{RenewChemArrow} Redefine existing arrow. + \befehl{DeclareChemIUPAC} Define new IUPAC command, see page \pageref{cmd:DeclareChemIUPAC}. + \befehl{RenewChemIUPAC} Redefine IUPAC command. + \befehl{DeclareChemLatin} Define new latin phrases, see page \pageref{cmd:DeclareChemLatin}. + \befehl{RenewChemLatin} Redefine latin phrases. + \befehl{DeclareChemNMR} Define new NMR command, see page \pageref{cmd:DeclareChemNMR}. + \befehl{RenewChemNMR} Redefine NMR command. + \befehl{DeclareChemParticle} Define new particle, see page \pageref{cmd:DeclareChemParticle}. + \befehl{RenewChemParticle} Redefine particle. + \befehl{DeclareChemPhase} Define new phases command, see page \pageref{cmd:DeclareChemPhase}. + \befehl{RenewChemPhase} Redefine phases command. + \befehl{DeclareChemReaction} Define new reaction environment, see page \pageref{cmd:DeclareChemReaction}. + \befehl{DeclareChemState} Define new state command, see page \pageref{cmd:DeclareChemState}. + \befehl{RenewChemState} Redefine state command. +\end{beschreibung} +\secidx*{Option Overview (chemmacros)} + +\addsec{Suggestions and Bug Reports}\addcontentsline{toc}{section}{Suggestions and Bug Reports} Feedback on \chemmacros, \chemformula and \ghsystem is highly appreciated and welcome! Especially \chemformula and \ghsystem are still in beta testing phase so even if I repeat myself: feedback is highly welcome. If you have suggestions for macros, missing features \etc, please don't hesitate to contact me. If you recognize any errors, be it chemical ones, wrong documentation and the like, I'd be grateful about a short email\footnote{\href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu}}. @@ -2305,13 +2590,16 @@ If you find any bugs, it would be best, if you'd send me a minimal example, with Many thanks to all the people who already provided me with feedback, especially (in alphabetical order): \begin{itemize} \item \href{http://www.mathannotated.com/}{Peter Cao} - \item Dr.\ Paul King + \item Christina Lüdigk + \item Dr.\@ Paul King + \item Jonas Rivetti \item Christoph Schäfer \end{itemize} \printbibliography -\printindex +{\catcode`\^=11 \catcode`\#=11 +\printindex} % \listoftodos \end{document}
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/chemmacros/chemformula.sty b/Master/texmf-dist/tex/latex/chemmacros/chemformula.sty index a509e2772a1..30f254f9039 100644 --- a/Master/texmf-dist/tex/latex/chemmacros/chemformula.sty +++ b/Master/texmf-dist/tex/latex/chemmacros/chemformula.sty @@ -5,7 +5,7 @@ % - macros and commands for chemists - % % --------------------------------------------------------------------------- % % - Clemens Niederberger - % -% - 2012/03/20 - % +% - 2012/05/07 - % % --------------------------------------------------------------------------- % % - https://bitbucket.org/cgnieder/chemmacros/ - % % - contact@mychemistry.eu - % @@ -30,8 +30,8 @@ \RequirePackage{ expl3 } \ProvidesExplPackage {chemformula} - {2012/03/20} - {3.2} + {2012/05/07} + {3.3} {typeset chemical compounds and reactions} %-----------------------------------------------------------------------------% @@ -488,7 +488,7 @@ %-----------------------------------------------------------------------------% % MAIN COMMAND -\NewDocumentCommand \chemformula_ch_aux_iii:w { > { \SplitList { ~ } } m } +\NewDocumentCommand \chemformula_ch_main:w { > { \SplitList { ~ } } m } { \group_begin: \cs_set_eq:NN \xspace \scan_stop: @@ -504,7 +504,7 @@ \chemformula_generate_arrows:V \l_chemformula_input_tl \chemformula_generate_name:V \l_chemformula_output_tl \tl_set_rescan:Nno \l_chemformula_output_tl - { \ExplSyntaxOn } + { \ExplSyntaxOn \makeatletter } { \l_chemformula_output_tl } \chemformula_write:V \l_chemformula_output_tl \group_end: @@ -523,6 +523,8 @@ \tl_gclear:N \g_chemformula_output_tl } +% Trickery to use \ch inside align environment: +% bypass \\: \cs_new:Npn \chemformula_ch_aux_i:w #1 \\ #2 \q_stop { \chemformula_ch_aux_ii:w #1 & \q_no_value \q_stop @@ -533,10 +535,10 @@ } } +% bypass &: \cs_new:Npn \chemformula_ch_aux_ii:w #1 & #2 \q_stop { - \tl_gput_right:Nn \g_chemformula_output_tl - { \chemformula_ch_aux_iii:w { #1 } } + \chemformula_ch_aux_iii:w #1 \label{} \q_no_value \q_stop \quark_if_no_value:nF { #2 } { \tl_gput_right:Nn \g_chemformula_output_tl { & } @@ -544,6 +546,40 @@ } } +% bypass \label: +\cs_new:Npn \chemformula_ch_aux_iii:w #1 \label#2 #3 \q_stop + { + \chemformula_ch_aux_iv:w #1 \tag{} \q_no_value \q_stop + \quark_if_no_value:nF { #3 } + { + \tl_gput_right:Nn \g_chemformula_output_tl { \label{#2} } + \chemformula_ch_aux_iii:w #3 \q_stop + } + } + +% bypass \tag: +\cs_new:Npn \chemformula_ch_aux_iv:w #1 \tag#2 #3 \q_stop + { + \chemformula_ch_aux_v:w #1 \intertext{} \q_no_value \q_stop + \quark_if_no_value:nF { #3 } + { + \tl_gput_right:Nn \g_chemformula_output_tl { \tag{#2} } + \chemformula_ch_aux_iv:w #3 \q_stop + } + } + +% bypass \intertext: +\cs_new:Npn \chemformula_ch_aux_v:w #1 \intertext#2 #3 \q_stop + { + \tl_gput_right:Nn \g_chemformula_output_tl + { \chemformula_ch_main:w { #1 } } + \quark_if_no_value:nF { #3 } + { + \tl_gput_right:Nn \g_chemformula_output_tl { \intertext{#2} } + \chemformula_ch_aux_v:w #3 \q_stop + } + } + % user command: \NewDocumentCommand \ch { om } { \chemformula_ch:nn { #1 } { #2 } } @@ -807,23 +843,29 @@ %-----------------------------------------------------------------------------% % bonds: +\dim_new:N \l_chemformula_bond_space_dim +\dim_zero:N \l_chemformula_bond_space_dim + \cs_new:Npn \chemformula_single_bond: { \bool_if:NTF \l_chemformula_sup_bool { \chemformula_minus: } { - \chemformula_tikz:nn { inner~sep=0, outer~sep=0 } - { - \draw node[draw=none,minimum~height=1em,minimum~width=0] - (chemformula-single-bond) at (0,0) {} ; - \draw[butt~cap-butt~cap] (chemformula-single-bond) ++ (0,-.1716em) - -- ++( \l_chemformula_bond_dim ,0) ; - } - } + \skip_horizontal:N \l_chemformula_bond_space_dim + \chemformula_tikz:nn { inner~sep=0, outer~sep=0 } + { + \draw node[draw=none,minimum~height=1em,minimum~width=0] + (chemformula-single-bond) at (0,0) {} ; + \draw[butt~cap-butt~cap] (chemformula-single-bond) ++ (0,-.1716em) + -- ++( \l_chemformula_bond_dim ,0) ; + } + \skip_horizontal:N \l_chemformula_bond_space_dim + } } \cs_new:Npn \chemformula_double_bond: { + \skip_horizontal:N \l_chemformula_bond_space_dim \chemformula_tikz:nn { inner~sep=0, outer~sep=0 } { \draw node[draw=none,minimum~height=1em,minimum~width=0] @@ -835,10 +877,12 @@ (chemformula-double-bond) ++ (0,-.2574em) -- ++ (\l_chemformula_bond_dim ,0) ; } + \skip_horizontal:N \l_chemformula_bond_space_dim } \cs_new:Npn \chemformula_triple_bond: { + \skip_horizontal:N \l_chemformula_bond_space_dim \chemformula_tikz:nn { inner~sep=0, outer~sep=0 } { \draw node[draw=none,minimum~height=1em,minimum~width=0] @@ -853,6 +897,7 @@ (chemformula-triple-bond) ++ (0,-.3003em) -- ++ (\l_chemformula_bond_dim ,0) ; } + \skip_horizontal:N \l_chemformula_bond_space_dim } %-----------------------------------------------------------------------------% @@ -1146,8 +1191,6 @@ %-----------------------------------------------------------------------------% % set options for next compound: -% TODO: this is not working: -% - applies to first instead of the next cmpd \cs_new:Npn \chemformula_input_options:n #1 { \makeatother @@ -1345,10 +1388,10 @@ \char_set_catcode_letter:N \{ \char_set_catcode_letter:N \} \char_set_catcode_letter:N \\ + \char_set_catcode_letter:N \# } { #1 } % let's see if the compound starts with a sub- or superscript: -% \exp_args:Nx \tl_show:n { \tl_head:V \l_tmpa_tl } \exp_args:Nx \tl_if_in:nnT { \tl_head:V \l_tmpa_tl } { ^ } { \bool_set_true:N \l_chemformula_is_isotope_bool } \exp_args:Nx \tl_if_in:nnT { \tl_head:V \l_tmpa_tl } { _ } @@ -1356,8 +1399,6 @@ \exp_args:NNx \prop_if_in:NnT \l_chemformula_numbers_prop { \tl_head:V \l_tmpa_tl } { \bool_set_true:N \l_chemformula_is_isotope_bool } -% \bool_if:NT \l_chemformula_is_isotope_bool -% { \exp_args:Nx \tl_show:n { \tl_head:V \l_tmpa_tl } } \tl_if_in:VnT \l_tmpa_tl { ^ } { \tl_replace_all:Nnn \l_tmpa_tl { ^ } @@ -1502,7 +1543,7 @@ { \ExplSyntaxNamesOn \char_set_catcode_other:N \: } { { #1 } } \tl_replace_all:Nnn \l_tmpa_tl { \_ } { chemformulaplaceholder } - \tl_replace_all:Nnn \l_tmpa_tl { _ } { \sb } + \tl_replace_all:Nnn \l_tmpa_tl { _ } { \sb } % TODO use \c_math_subscript_token \tl_replace_all:Nnn \l_tmpa_tl { chemformulaplaceholder } { \_ } \tl_set_rescan:Nno \l_tmpa_tl { \ExplSyntaxOff } { \l_tmpa_tl } \tl_put_right:NV \l_chemformula_input_tl \l_tmpa_tl @@ -1514,7 +1555,7 @@ { \ExplSyntaxNamesOn \char_set_catcode_other:N \: } { { #1 } } \tl_replace_all:Nnn \l_tmpa_tl { \_ } { chemformulaplaceholder } - \tl_replace_all:Nnn \l_tmpa_tl { _ } { \sb } + \tl_replace_all:Nnn \l_tmpa_tl { _ } { \sb } % TODO use \c_math_subscript_token \tl_replace_all:Nnn \l_tmpa_tl { chemformulaplaceholder } { \_ } \tl_set_rescan:Nno \l_tmpa_tl { \ExplSyntaxOff } { \l_tmpa_tl } \tl_put_right:NV \l_chemformula_input_tl \l_tmpa_tl @@ -1580,7 +1621,7 @@ } { \mbox { \( #1 \) } } \tl_replace_all:Nnn \l_tmpa_tl { \_ } { chemformulaplaceholder } - \tl_replace_all:Nnn \l_tmpa_tl { _ } { \sb } + \tl_replace_all:Nnn \l_tmpa_tl { _ } { \sb } % TODO use \c_math_subscript_token \tl_replace_all:Nnn \l_tmpa_tl { chemformulaplaceholder } { \_ } \tl_set_rescan:Nno \l_tmpa_tl { \ExplSyntaxOff } { \l_tmpa_tl } \tl_put_right:NV \l_chemformula_input_tl \l_tmpa_tl @@ -1680,6 +1721,7 @@ } } , bond-length .dim_set:N = \l_chemformula_bond_dim , + bond-offset .dim_set:N = \l_chemformula_bond_space_dim , font-family .code:n = \bool_set_true:N \l_chemformula_fss_bool \bool_set_false:N \l_chemformula_fontspec_bool @@ -1742,9 +1784,16 @@ VERSION HISTORY - improved arrow labels 2012/03/20 - version 3.2 - new: option input via @{<options>} - a few changes in chemmacros.sty +2012/05/07 - version 3.3 - \ch now bypasses \ref{}, \label{}, and \intertext{} + - new features in chemmacros.sty %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % TODO +- Bindungen nach einem Mechanismus ähnlich der Pfeile konstruieren + => Möglichkeit, eigene Bindungen hinzuzufügen, Bindungen leichter um weitere + Typen erweitern + => Problem: bislang nur ein Token pro Bindung möglich + => Makro \bond{<type>}? - Addukte: Zahlen nach * und . automatisch erkennen? - allow fractions in subscripts: _{$\frac{1}{2}$} ? - optionale argumente von \\ nach außen weiterreichen? diff --git a/Master/texmf-dist/tex/latex/chemmacros/chemmacros.sty b/Master/texmf-dist/tex/latex/chemmacros/chemmacros.sty index b06c416bc68..e925819baf0 100644 --- a/Master/texmf-dist/tex/latex/chemmacros/chemmacros.sty +++ b/Master/texmf-dist/tex/latex/chemmacros/chemmacros.sty @@ -5,7 +5,7 @@ % - macros and commands for chemists - % % --------------------------------------------------------------------------- % % - Clemens Niederberger - % -% - 2012/03/20 - % +% - 2012/05/07 - % % --------------------------------------------------------------------------- % % - https://bitbucket.org/cgnieder/chemmacros/ - % % - contact@mychemistry.eu - % @@ -33,14 +33,13 @@ \ProvidesExplPackage {chemmacros} - {2012/03/20} - {3.2} + {2012/05/07} + {3.3} {macros and commands for chemists} \@ifpackageloaded { chemformula } {} { \RequirePackage { chemformula } } \bool_new:N \l_chemmacros_version_one_bool -\bool_new:N \l_chemmacros_german_bool \bool_new:N \l_chemmacros_xspace_bool \bool_set_true:N \l_chemmacros_xspace_bool \bool_new:N \l_chemmacros_bpchem_bool @@ -102,7 +101,13 @@ \bool_set_true:N \l_chemmacros_detect_bold_bool \bool_new:N \l_chemmacros_use_upgreek_bool -\bool_new:N \l_chemmacros_use_textgreek_bool +\bool_new:N \l_chemmacros_use_textgreek_bool +\bool_new:N \l_chemmacros_option_upgreek_set_bool + +\tl_new:N \l_chemmacros_language_tl +\tl_set:Nn \l_chemmacros_language_tl { english } +\tl_new:N \l_chemmacros_current_language_tl +\tl_set:Nn \l_chemmacros_current_language_tl { english } \cs_new:Nn \chemmacros_inner_font: {} @@ -137,8 +142,12 @@ { detect-bold } {} , EZ .code:n = \chemmacros_msg:nnxx { chemmacros } { option-deprecated } { EZ } {} , - german .bool_set:N = \l_chemmacros_german_bool , - german .default:n = true , + german .code:n = + \chemmacros_msg:nnxx { chemmacros } { option-deprecated } + { german } {} , + ngerman .code:n = + \chemmacros_msg:nnxx { chemmacros } { option-deprecated } + { ngerman } {} , ghsystem .bool_set:N = \l_chemmacros_ghsystem_bool , ghsystem .default:n = true , iupac .choice: , @@ -151,13 +160,12 @@ iupac / strict .code:n = \bool_set_false:N \l_chemmacros_iupac_restricted_bool \bool_set_true:N \l_chemmacros_iupac_strict_bool , + language .tl_set:N = \l_chemmacros_language_tl , method .choice: , method / chemformula .code:n = \bool_set_false:N \l_chemmacros_use_mhchem_bool , method / mhchem .code:n = \bool_set_true:N \l_chemmacros_use_mhchem_bool , - ngerman .bool_set:N = \l_chemmacros_german_bool , - ngerman .default:n = true , Nu .choice: , Nu / mathspec .code:n = \bool_set_true:N \l_chemmacros_Nu_mathspec_bool , @@ -170,21 +178,28 @@ \cs_set_eq:NN \chemmacros_inner_font: \chemformula_font_inner: , synchronize / false .code:n = \cs_set:Nn \chemmacros_inner_font: {} , synchronize .default:n = true , - upgreek .choice: , - upgreek / upgreek .code:n = + greek .choice: , + greek / upgreek .code:n = \bool_set_true:N \l_chemmacros_use_upgreek_bool - \bool_set_false:N \l_chemmacros_use_textgreek_bool , - upgreek / textgreek .code:n = + \bool_set_false:N \l_chemmacros_use_textgreek_bool + \bool_set_true:N \l_chemmacros_option_upgreek_set_bool , + greek / textgreek .code:n = \bool_set_false:N \l_chemmacros_use_upgreek_bool - \bool_set_true:N \l_chemmacros_use_textgreek_bool , - upgreek / none .code:n = + \bool_set_true:N \l_chemmacros_use_textgreek_bool + \bool_set_true:N \l_chemmacros_option_upgreek_set_bool , + greek / math .code:n = \bool_set_false:N \l_chemmacros_use_upgreek_bool - \bool_set_false:N \l_chemmacros_use_textgreek_bool , - upgreek .default:n = upgreek , + \bool_set_false:N \l_chemmacros_use_textgreek_bool + \bool_set_true:N \l_chemmacros_option_upgreek_set_bool , + greek .default:n = upgreek , + upgreek .code:n = + \chemmacros_msg:nnxx { chemmacros } { option-deprecated } + { upgreek } {} , % dummy version for compatibility with KOMA's global option and backwards % compatibility of chemmacros - version .code:n = , - % TODO: neuen Namen finden! + version .code:n = + \chemmacros_msg:nnxx { chemmacros } { option-deprecated } + { version } {} , cmversion .choice: , cmversion / 1 .code:n = { \bool_set_true:N \l_chemmacros_version_one_bool } , @@ -198,8 +213,42 @@ \ProcessKeysOptions { chemmacros / option } +% --------------------------------------------------------------------------- % +% language settings: +\prop_new:N \l_chemmacros_language_prop +\prop_put:Nnn \l_chemmacros_language_prop { english } { english } +\prop_put:Nnn \l_chemmacros_language_prop { american } { english } +\prop_put:Nnn \l_chemmacros_language_prop { british } { english } +\prop_put:Nnn \l_chemmacros_language_prop { german } { german } +\prop_put:Nnn \l_chemmacros_language_prop { ngerman } { german } +\prop_put:Nnn \l_chemmacros_language_prop { italian } { italian } +\prop_put:Nnn \l_chemmacros_language_prop { french } { french } + +\prop_map_inline:Nn \l_chemmacros_language_prop + { + \cs_if_exist:cF { l_chemmacros_ #2 _bool } + { \bool_new:c { l_chemmacros_ #2 _bool } } + } + +\cs_new_nopar:Npn \chemmacros_set_language: + { + \prop_get:NoNTF + \l_chemmacros_language_prop + { \l_chemmacros_language_tl } + \l_chemmacros_current_language_tl + { + \bool_set_true:c + { l_chemmacros_ \l_chemmacros_current_language_tl _bool } + } + { + \chemmacros_msg:nnxx { chemmacros } { language-not-defined } + { \l_chemmacros_language_tl } { } + } + } + \AtEndPreamble { + \chemmacros_set_language: \chemmacros_make_phases: \bool_if:NT \l_chemmacros_ghsystem_bool { \RequirePackage { ghsystem } } @@ -209,21 +258,31 @@ { \RequirePackage { xspace } } \bool_if:NT \l_chemmacros_use_mhchem_bool { \RequirePackage[ version=3 ]{ mhchem } } - \@ifpackageloaded { upgreek } - { \bool_set_true:N \l_chemmacros_use_upgreek_bool } + \bool_if:NF \l_chemmacros_option_upgreek_set_bool { - \@ifpackageloaded { textgreek } - { \bool_set_true:N \l_chemmacros_use_textgreek_bool } - {} + \@ifpackageloaded { upgreek } + { \bool_set_true:N \l_chemmacros_use_upgreek_bool } + { + \@ifpackageloaded { textgreek } + { \bool_set_true:N \l_chemmacros_use_textgreek_bool } + {} + } } \bool_if:NTF \l_chemmacros_use_upgreek_bool { - \cs_set_nopar:Npn \Chemalpha { \ensuremath { \upalpha } } - \cs_set_nopar:Npn \Chembeta { \ensuremath { \upbeta } } - \cs_set_nopar:Npn \Chemgamma { \ensuremath { \upgamma } } - \cs_set_nopar:Npn \Chemdelta { \ensuremath { \updelta } } - \cs_set_nopar:Npn \Chemomega { \ensuremath { \upomega } } - \cs_set_nopar:Npn \ChemDelta { \ensuremath { \Updelta } } + \cs_set_nopar:Npn \Chemalpha { \ensuremath { \upalpha } } + \cs_set_nopar:Npn \Chembeta { \ensuremath { \upbeta } } + \cs_set_nopar:Npn \Chemgamma { \ensuremath { \upgamma } } + \cs_set_nopar:Npn \Chemdelta { \ensuremath { \updelta } } + \cs_set_nopar:Npn \Chemepsilon { \ensuremath { \upvarepsilon } } + \cs_set_nopar:Npn \Chemeta { \ensuremath { \upeta } } + \cs_set_nopar:Npn \Chemmu { \ensuremath { \upmu } } + \cs_set_nopar:Npn \Chemnu { \ensuremath { \upnu } } + \cs_set_nopar:Npn \Chemrho { \ensuremath { \uprho } } + \cs_set_nopar:Npn \Chempi { \ensuremath { \uppi } } + \cs_set_nopar:Npn \Chemsigma { \ensuremath { \upsigma } } + \cs_set_nopar:Npn \Chemomega { \ensuremath { \upomega } } + \cs_set_nopar:Npn \ChemDelta { \ensuremath { \Updelta } } } { \bool_if:NT \l_chemmacros_use_textgreek_bool @@ -236,6 +295,20 @@ { \ensuremath { \text { \textgamma } } } \cs_set_nopar:Npn \Chemdelta { \ensuremath { \text { \textdelta } } } + \cs_set_nopar:Npn \Chemepsilon + { \ensuremath { \text { \textepsilon } } } + \cs_set_nopar:Npn \Chemeta + { \ensuremath { \text { \texteta } } } + \cs_set_nopar:Npn \Chemmu + { \ensuremath { \text { \textmu } } } + \cs_set_nopar:Npn \Chemnu + { \ensuremath { \text { \textnu } } } + \cs_set_nopar:Npn \Chemrho + { \ensuremath { \text { \textrho } } } + \cs_set_nopar:Npn \Chempi + { \ensuremath { \text { \textpi } } } + \cs_set_nopar:Npn \Chemsigma + { \ensuremath { \text { \textsigma } } } \cs_set_nopar:Npn \Chemomega { \ensuremath { \text { \textomega } } } \cs_set_nopar:Npn \ChemDelta @@ -244,12 +317,19 @@ } } -\cs_new_nopar:Npn \Chemalpha { \ensuremath { \alpha } } -\cs_new_nopar:Npn \Chembeta { \ensuremath { \beta } } -\cs_new_nopar:Npn \Chemgamma { \ensuremath { \gamma } } -\cs_new_nopar:Npn \Chemdelta { \ensuremath { \delta } } -\cs_new_nopar:Npn \Chemomega { \ensuremath { \omega } } -\cs_new_nopar:Npn \ChemDelta { \ensuremath { \Delta } } +\cs_new_nopar:Npn \Chemalpha { \ensuremath { \alpha } } +\cs_new_nopar:Npn \Chembeta { \ensuremath { \beta } } +\cs_new_nopar:Npn \Chemgamma { \ensuremath { \gamma } } +\cs_new_nopar:Npn \Chemdelta { \ensuremath { \delta } } +\cs_new_nopar:Npn \Chemepsilon { \ensuremath { \varepsilon } } +\cs_new_nopar:Npn \Chemeta { \ensuremath { \eta } } +\cs_new_nopar:Npn \Chemmu { \ensuremath { \mu } } +\cs_new_nopar:Npn \Chemnu { \ensuremath { \nu } } +\cs_new_nopar:Npn \Chemrho { \ensuremath { \rho } } +\cs_new_nopar:Npn \Chempi { \ensuremath { \pi } } +\cs_new_nopar:Npn \Chemsigma { \ensuremath { \sigma } } +\cs_new_nopar:Npn \Chemomega { \ensuremath { \omega } } +\cs_new_nopar:Npn \ChemDelta { \ensuremath { \Delta } } \cs_new_nopar:Npn \chemmacros_xspace: { @@ -266,6 +346,16 @@ { \msg_warning:nnxx { #1 } { #2 } { #3 } { #4 } } } +\msg_set:nnnn { chemmacros } { language-not-defined } + { + The~language~#1~is~not~defined~by~chemmacros. + } + { + You~chose~the~language~`#1'~which~is~not~defined~by~chemmacros.~`english'~is + ~used~instead.~If~you~just~mistyped~try~again!~Otherwise~contact~the~author~ + and~he'll~probably~add~your~language. + } + \msg_set:nnnn { chemmacros } { already-defined } { The~command~#1~has~also~been~defined~by~another~package. @@ -295,7 +385,7 @@ { You've~tried~to~define~a~particle~with~\token_to_str:N \DeclareChemParticle, ~but~the~command~sequence~ \token_to_str:N #1 \c_space_tl already~exists. - ~Choose~another~name. + ~Please~choose~another~name. } \msg_set:nnnn { chemmacros } { renew-particle } @@ -312,16 +402,33 @@ { You've~tried~to~define~a~latin~phrase~with~\token_to_str:N \DeclareChemLatin,~but~the~command~sequence~ \token_to_str:N #1 \c_space_tl - already~exists.~Choose~another~name. + already~exists.~Please~choose~another~name. } -\msg_set:nnnn { chemmacros } { f } +\msg_set:nnnn { chemmacros } { renew-latin } { The~latin~phrase \token_to_str:N #1 \c_space_tl is~not~defined. } { You've~tried~to~renew~the~latin~phrase~\token_to_str:N #1 ,~but~it~doesn't~ exist. } +\msg_set:nnnn { chemmacros } { declare-nmr } + { + The~command~sequence~ \token_to_str:N #1 \c_space_tl is~already~defined. + } + { + You've~tried~to~define~a~NMR~command~with~\token_to_str:N + \DeclareChemParticle, ~but~the~command~sequence~ \token_to_str:N #1 + \c_space_tl already~exists.~Please~choose~another~name. + } + +\msg_set:nnnn { chemmacros } { renew-nmr } + { The~NMR~command~ \token_to_str:N #1 \c_space_tl is~not~defined. } + { + You've~tried~to~renew~the~NMR~command~\token_to_str:N #1 ,~but~it~doesn't~ + exist. + } + \msg_set:nnnn { chemmacros } { declare-phase } { The~command~sequence~ \token_to_str:N #1 \c_space_tl is~already~defined. @@ -329,7 +436,7 @@ { You've~tried~to~define~a~particle~with~\token_to_str:N \DeclareChemPhase , ~but~the~command~sequence~ \token_to_str:N #1 \c_space_tl already~exists. - ~Choose~another~name. + ~Please~choose~another~name. } \msg_set:nnnn { chemmacros } { renew-phase } @@ -555,6 +662,7 @@ \group_end: } } +\cs_generate_variant:Nn \chemmacros_chemformula:n { x } % --------------------------------------------------------------------------- % % particles, charges @@ -966,6 +1074,16 @@ \DeclareChemIUPAC \Sf { \textit { S } } \DeclareChemIUPAC \P { \textit { P } } +% language specific settings +\AtBeginDocument + { + \bool_if:NT \l_chemmacros_italian_bool + { + \DeclareChemIUPAC \sin { \textit { sin } } + \DeclareChemIUPAC \ter { \textit { ter } } + } + } + % greek letters \DeclareChemIUPAC\a{\Chemalpha} \DeclareChemIUPAC\b{\Chembeta} @@ -976,16 +1094,44 @@ % \iupac (basically the same as bpchem's \IUPAC) % - allows multiple breaking points as compound names can get really long and % especially in multicolumn documents can span more than two lines -% - add a (very) little space after the hyphen +% - add a (very) little space before the hyphen and a little negative space +% after it +% - add a little space at breaking points if not broken % - enables all naming commands regardless if they're definied otherwise or not \cs_new_protected:Nn \chemmacros_allow_hyphens: { \tex_penalty:D \c_ten_thousand \skip_horizontal:n { \c_zero_dim } } + +\dim_new:N \l_chemmacros_iupac_hyphen_pre_dim +\dim_set:Nn \l_chemmacros_iupac_hyphen_pre_dim { .01em } +\dim_new:N \l_chemmacros_iupac_hyphen_post_dim +\dim_set:Nn \l_chemmacros_iupac_hyphen_post_dim { -.03em } +\dim_new:N \l_chemmacros_iupac_break_dim +\dim_set:Nn \l_chemmacros_iupac_break_dim { .03em } + +\keys_define:nn { chemmacros / iupac } + { + hyphen-pre-space .dim_set:N = \l_chemmacros_iupac_hyphen_pre_dim , + hyphen-post-space .dim_set:N = \l_chemmacros_iupac_hyphen_post_dim , + break-space .dim_set:N = \l_chemmacros_iupac_break_dim + } + \cs_new_protected:Nn \chemmacros_break_point_hyphen: - { \tex_penalty:D \c_ten_thousand - \chemmacros_allow_hyphens: } + { + \tex_penalty:D \c_ten_thousand + \tex_discretionary:D { - } { } + { + \tex_kern:D \l_chemmacros_iupac_hyphen_pre_dim + - + \tex_kern:D \l_chemmacros_iupac_hyphen_post_dim + } + \chemmacros_allow_hyphens: + } + \cs_new_protected:Nn \chemmacros_break_point: { \tex_penalty:D \c_ten_thousand - \tex_discretionary:D { - } { } { \tex_kern:D .03em } + \tex_discretionary:D { - } { } + { \tex_kern:D \l_chemmacros_iupac_break_dim } \chemmacros_allow_hyphens: } @@ -1083,8 +1229,6 @@ \tl_new:N \l_chemmacros_if_bf_tl \tl_set:Nn \l_chemmacros_if_bf_tl { bx } -\char_set_catcode_math_subscript:N \@ - \cs_new_protected_nopar:Npn \Ka { \mbox @@ -1092,7 +1236,7 @@ \( \chemmacros_detect_bold:n { - K @ \mathrm + K \c_math_subscript_token \mathrm { \bool_if:NTF \l_chemmacros_german_bool { S } { A } } } \) @@ -1102,13 +1246,25 @@ \cs_new_protected_nopar:Npn \Kb { - \mbox { \( \chemmacros_detect_bold:n { K @ \mathrm { B } } \) } + \mbox + { + \( + \chemmacros_detect_bold:n + { K \c_math_subscript_token \mathrm { B } } + \) + } \chemmacros_xspace: } \cs_new_protected_nopar:Npn \Kw { - \mbox { \( \chemmacros_detect_bold:n { K @ \mathrm { W } } \) } + \mbox + { + \( + \chemmacros_detect_bold:n + { K \c_math_subscript_token \mathrm { W } } + \) + } \chemmacros_xspace: } @@ -1128,13 +1284,21 @@ \NewDocumentCommand \pKa { o } { - \p { \Ka \IfNoValueF { #1 } { @ { \chemmacros_detect_bold:n { #1 } } } } + \p + { + \Ka \IfNoValueF { #1 } + { \c_math_subscript_token { \chemmacros_detect_bold:n { #1 } } } + } \chemmacros_xspace: } \NewDocumentCommand \pKb { o } { - \p { \Kb \IfNoValueF { #1 } { @ { \chemmacros_detect_bold:n { #1 } } } } + \p + { + \Kb \IfNoValueF { #1 } + { \c_math_subscript_token { \chemmacros_detect_bold:n { #1 } } } + } \chemmacros_xspace: } @@ -1174,24 +1338,44 @@ \tl_set:Nn \l_chemmacros_mech_ar_tl { #3 } } -\char_set_catcode_math_subscript:N \@ \keys_define:nn { chemmacros / mech } { type .choice: , type / .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {N} $ } {} } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {N} $ } {} + } , type / 1 .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {N} $ 1 } {} } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {N} $ 1 } {} + } , type / 2 .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {N} $ 2 } {} } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {N} $ 2 } {} + } , type / se .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {E} $ } {} } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {E} $ } {} + } , type / 1e .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {E} $ 1 } {} } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {E} $ 1 } {} + } , type / 2e .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {E} $ 2 } {} } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {E} $ 2 } {} + } , type / ar .code:n = - { \chemmacros_set_mech:nnn { S } { $ @ \text {E} $ } { Ar - } } , + { + \chemmacros_set_mech:nnn { S } + { $ \c_math_subscript_token \text {E} $ } { Ar - } + } , type / e .code:n = { \chemmacros_set_mech:nnn { E } {} {} } , type / e1 .code:n = @@ -1199,7 +1383,10 @@ type / e2 .code:n = { \chemmacros_set_mech:nnn { E } { 2 } {} } , type / cb .code:n = - { \chemmacros_set_mech:nnn { E } { 1 $ @ \text {cb} $ } {} } , + { + \chemmacros_set_mech:nnn { E } + { 1 $ \c_math_subscript_token \text {cb} $ } {} + } , type .default:n = } @@ -1216,7 +1403,6 @@ } \chemmacros_xspace: } -\char_set_catcode_letter:N \@ % --------------------------------------------------------------------------- % % oxidation numbers @@ -1575,26 +1761,47 @@ % --------------------------------------------------------------------------- % % spectroscopy -\tl_new:N \l_chemmacros_nmr_isotope_tl +\tl_new:N \g_chemmacros_nmr_isotope_tl \tl_new:N \l_chemmacros_nmr_isotope_default_tl \tl_set:Nn \l_chemmacros_nmr_isotope_default_tl { 1 } -\tl_new:N \l_chemmacros_nmr_element_tl +\tl_new:N \g_chemmacros_nmr_element_tl \tl_new:N \l_chemmacros_nmr_element_default_tl \tl_set:Nn \l_chemmacros_nmr_element_default_tl { H } +\tl_new:N \l_chemmacros_nmr_format_tl +\tl_new:N \l_chemmacros_nmr_delta_tl +\tl_new:N \l_chemmacros_nmr_coupling_unit_tl +\tl_set:Nn \l_chemmacros_nmr_coupling_unit_tl { \hertz } +\tl_new:N \l_chemmacros_nmr_list_setup_tl +\tl_set:Nn \l_chemmacros_nmr_list_setup_tl + { + \topsep\z@skip \partopsep\z@skip + \itemsep\z@ \parsep\z@ \itemindent\z@ + \leftmargin\z@ + } \bool_new:N \l_chemmacros_nmr_frequency_bool \bool_new:N \l_chemmacros_nmr_solvent_bool \bool_new:N \l_chemmacros_nmr_delimiters_bool \bool_new:N \l_chemmacros_nmr_comma_bool +\bool_new:N \l_chemmacros_nmr_inner_bool +\bool_new:N \l_chemmacros_nmr_position_sub_bool +\bool_new:N \l_chemmacros_nmr_parse_bool +\bool_set_true:N \l_chemmacros_nmr_parse_bool +\bool_new:N \l_chemmacros_nmr_list_bool +% \bool_set_true:N \l_chemmacros_nmr_list_bool +\bool_new:N \l_chemmacros_nmr_use_equal_bool +% \bool_set_true:N \l_chemmacros_nmr_use_equal_bool +\bool_new:N \l_chemmacros_nmr_custom_command_active_bool +\bool_new:N \l_chemmacros_nmr_custom_command_used_bool \tl_new:N \l_chemmacros_nmr_unit_tl \tl_set:Nn \l_chemmacros_nmr_unit_tl { \mega\hertz } \cs_new_nopar:Npn \chemmacros_nmr_nucleus:w #1,#2 \q_stop { - \tl_set:Nn \l_chemmacros_nmr_isotope_tl { #1 } - \tl_set:Nn \l_chemmacros_nmr_element_tl { #2 } + \tl_gset:Nn \g_chemmacros_nmr_isotope_tl { #1 } + \tl_gset:Nn \g_chemmacros_nmr_element_tl { #2 } } \cs_new:Npn \chemmacros_nmr_default_nucleus:w #1,#2 \q_stop @@ -1624,10 +1831,50 @@ \keys_define:nn { chemmacros / nmr } { - unit .tl_set:N = \l_chemmacros_nmr_unit_tl , - unit .default:n = \mega\hertz , - nucleus .code:n = { \chemmacros_nmr_default_nucleus:w #1 \q_stop } , - nucleus .default:n = { 1,H } + unit .tl_set:N = \l_chemmacros_nmr_unit_tl , + unit .default:n = \mega\hertz , + nucleus .code:n = + { \chemmacros_nmr_default_nucleus:w #1 \q_stop } , + nucleus .default:n = { 1,H } , + format .tl_set:N = \l_chemmacros_nmr_format_tl , + pos-number .choice: , + pos-number / sub .code:n = + \bool_set_true:N \l_chemmacros_nmr_position_sub_bool , + pos-number / side .code:n = + \bool_set_false:N \l_chemmacros_nmr_position_sub_bool , + coupling-unit .tl_set:N = \l_chemmacros_nmr_coupling_unit_tl , + parse .bool_set:N = \l_chemmacros_nmr_parse_bool , + delta .code:n = + \tl_set:Nn \l_chemmacros_nmr_delta_tl { \, #1 } , + list .bool_set:N = \l_chemmacros_nmr_list_bool , + list .default:n = true , + list-setup .tl_set:N = \l_chemmacros_nmr_list_setup_tl , + use-equal .bool_set:N = \l_chemmacros_nmr_use_equal_bool , + use-equal .default:n = true + } + +\prop_new:N \l_chemmacros_nmr_prop + +\NewDocumentCommand \DeclareChemNMR { mm } + { + \prop_if_in:NnTF \l_chemmacros_nmr_prop { #1 } + { \chemmacros_msg:nnxx { chemmacros } { declare-nmr } { #1 } { } } + { + \prop_put:Nnn \l_chemmacros_nmr_prop { #1 } { #2 } + \NewDocumentCommand #1 { s } + { \IfBooleanTF {##1} { \NMR*{#2} } { \NMR{#2} } } + } + } + +\NewDocumentCommand \RenewChemNMR { mm } + { + \prop_if_in:NnTF \l_chemmacros_nmr_prop { #1 } + { + \prop_put:Nnn \l_chemmacros_nmr_prop { #1 } { #2 } + \NewDocumentCommand #1 { s } + { \IfBooleanTF {##1} { \NMR*{#2} } { \NMR{#2} } } + } + { \chemmacros_msg:nnxx { chemmacros } { renew-nmr } { #1 } { } } } \AtBeginDocument @@ -1636,7 +1883,9 @@ % \NMR* same but without ": $\delta$" at end \NewDocumentCommand \NMR { s g d() o } { + \bool_if:NT \l_chemmacros_nmr_list_bool { \item \scan_stop: } \group_begin: + \leavevmode \bool_set_false:N \l_chemmacros_nmr_frequency_bool \bool_set_false:N \l_chemmacros_nmr_solvent_bool \IfNoValueF { #3 } @@ -1668,39 +1917,63 @@ { \text { - \chemmacros_nmr_base:VV - \l_chemmacros_nmr_isotope_tl - \l_chemmacros_nmr_element_tl - \bool_if:NT \l_chemmacros_nmr_delimiters_bool - { ~ ( } - \bool_if:NT \l_chemmacros_nmr_frequency_bool - { \chemmacros_nmr_frequency:n { #3 } } - \bool_if:NT \l_chemmacros_nmr_comma_bool - { , ~ } - \bool_if:NT \l_chemmacros_nmr_solvent_bool - { \chemmacros_atom:n { #4 } } - \bool_if:NT \l_chemmacros_nmr_delimiters_bool - { ) } - \IfBooleanF { #1 } { : ~ } + \group_begin: + \tl_use:N \l_chemmacros_nmr_format_tl + \chemmacros_nmr_base:VV + \g_chemmacros_nmr_isotope_tl + \g_chemmacros_nmr_element_tl + \bool_if:NT \l_chemmacros_nmr_delimiters_bool + { ~ ( } + \bool_if:NT \l_chemmacros_nmr_frequency_bool + { \chemmacros_nmr_frequency:n { #3 } } + \bool_if:NT \l_chemmacros_nmr_comma_bool + { , ~ } + \bool_if:NT \l_chemmacros_nmr_solvent_bool + { \chemmacros_atom:n { #4 } } + \bool_if:NT \l_chemmacros_nmr_delimiters_bool + { ) } + \IfBooleanF { #1 } { : ~ } + \group_end: + } + \IfBooleanF { #1 } + { + \delta + \text { \l_chemmacros_nmr_delta_tl } + \bool_if:NT \l_chemmacros_nmr_use_equal_bool { = } } - \IfBooleanF { #1 } { \delta } } { - \chemmacros_nmr_base:VV - \l_chemmacros_nmr_isotope_tl - \l_chemmacros_nmr_element_tl - \bool_if:NT \l_chemmacros_nmr_delimiters_bool - { ~ ( } - \bool_if:NT \l_chemmacros_nmr_frequency_bool - { \chemmacros_nmr_frequency:n { #3 } } - \bool_if:NT \l_chemmacros_nmr_comma_bool - { , ~ } - \bool_if:NT \l_chemmacros_nmr_solvent_bool - { \chemmacros_chemformula:n { #4 } } - \bool_if:NT \l_chemmacros_nmr_delimiters_bool - { ) } + \group_begin: + \tl_use:N \l_chemmacros_nmr_format_tl + \chemmacros_nmr_base:VV + \g_chemmacros_nmr_isotope_tl + \g_chemmacros_nmr_element_tl + \bool_if:NT \l_chemmacros_nmr_delimiters_bool + { ~ ( } + \bool_if:NT \l_chemmacros_nmr_frequency_bool + { \chemmacros_nmr_frequency:n { #3 } } + \bool_if:NT \l_chemmacros_nmr_comma_bool + { , ~ } + \bool_if:NT \l_chemmacros_nmr_solvent_bool + { + \bool_if:NTF \l_chemmacros_nmr_parse_bool + { + \bool_if:NTF \l_chemmacros_use_mhchem_bool + { \ce { #4 } } + { \ch { #4 } } + } + { #4 } + } + \bool_if:NT \l_chemmacros_nmr_delimiters_bool + { ) } + \IfBooleanF { #1 } { : } + \group_end: \IfBooleanF { #1 } - { : ~ $ \delta $ } + { + \tl_use:N \c_space_tl $ \delta $ + \l_chemmacros_nmr_delta_tl + \bool_if:NT \l_chemmacros_nmr_use_equal_bool { ~ = } + } \bool_if:NF \l_chemmacros_nmr_comma_bool { \IfBooleanF { #1 } { \chemmacros_xspace: } } } @@ -1708,6 +1981,119 @@ } } +\NewDocumentCommand \chemmacros_data:w { smo } + { + \bool_if:NT \l_chemmacros_nmr_list_bool { \item } + { + \tl_use:N \l_chemmacros_nmr_format_tl #2 + \IfNoValueF { #3 } { ~ ( #3 ) } + \IfBooleanT { #1 } { \bool_if:NT \l_chemmacros_nmr_use_equal_bool { : } } + } + \IfBooleanF { #1 } { \bool_if:NT \l_chemmacros_nmr_use_equal_bool { ~ = } } + } + +\cs_new_protected_nopar:Npn \chemmacros_val:n #1 + { + \tl_if_in:nnTF { #1 } { -- } + { \chemmacros_val_aux:w #1 \q_nil } + { \num { #1 } } + } +\cs_new_protected_nopar:Npn \chemmacros_val_aux:w #1--#2 \q_nil + { \numrange { #1 } { #2 } } + +\NewDocumentEnvironment { experimental } { o } + { + \group_begin: + \IfNoValueF { #1 } { \keys_set:nn { chemmacros / nmr } { #1 } } + \bool_set_true:N \l_chemmacros_nmr_inner_bool + \cs_set_eq:NN \# \chemmacros_nmr_number:n + \cs_set_eq:NN \pos \chemmacros_nmr_position:n + \cs_set_eq:NN \J \chemmacros_nmr_coupling:w + \cs_set_eq:NN \data \chemmacros_data:w + \cs_set_eq:NN \val \chemmacros_val:n + \bool_if:NT \l_chemmacros_nmr_list_bool + { \list {} { \l_chemmacros_nmr_list_setup_tl } } + } + { + \bool_if:NT \l_chemmacros_nmr_list_bool + { \endlist } + \group_end: + \ignorespaces + } + +\cs_new:Npn \chemmacros_nmr_number:n #1 + { + #1 \, + \bool_if:NTF \l_chemmacros_bpchem_bool + { \g_chemmacros_nmr_element_tl } + { \chemmacros_atom:n { \g_chemmacros_nmr_element_tl } } + } + +\cs_new:Npn \chemmacros_nmr_position:n #1 + { + \bool_if:NTF \l_chemmacros_bpchem_bool + { + \tl_use:N \g_chemmacros_nmr_element_tl + \bool_if:NTF \l_chemmacros_nmr_position_sub_bool + { $\sb{#1}$ } + { - #1 } + } + { + \bool_if:NTF \l_chemmacros_nmr_position_sub_bool + { + \chemmacros_chemformula:x { \g_chemmacros_nmr_element_tl _ #1 } + } + { \chemmacros_atom:n { \g_chemmacros_nmr_element_tl } - #1 } + } + } + +\cs_new:Npn \chemmacros_nmr_coupling:w + { + \peek_meaning:NTF [ + { \chemmacros_nmr_coupling_auxi:w } + { \chemmacros_nmr_coupling_auxii:n } + } + +\cs_new:Npn \chemmacros_nmr_coupling_auxi:w [#1]#2 + { + \group_begin: + \sisetup + { + list-final-separator={,~}, + list-pair-separator={,~}, + list-units=single + } + \tl_if_in:nnTF { #1 } { ; } + { \( J = \SIlist{#2}{#1} \) } + { \( J = \SI{#2}{#1} \) } + \group_end: + } + +\cs_new:Npn \chemmacros_nmr_coupling_auxii:n #1 + { + \group_begin: + \sisetup + { + list-final-separator={,~}, + list-pair-separator={,~}, + list-units=single + } + \tl_if_in:nnTF { #1 } { ; } + { + \( + J = \exp_args:Nno \SIlist + { #1 } { \l_chemmacros_nmr_coupling_unit_tl } + \) + } + { + \( + J = \exp_args:Nno \SI + { #1 } { \l_chemmacros_nmr_coupling_unit_tl } + \) + } + \group_end: + } + % --------------------------------------------------------------------------- % % placing text below atom/molecule \cs_new_nopar:Npn \dim_to_width:nn #1#2 @@ -1783,7 +2169,6 @@ space .dim_set:N = \l_chemmacros_phases_space_dim } -\char_set_catcode_math_subscript:N \@ \prop_new:N \l_chemmacros_phases_prop \prop_new:N \l_chemmacros_phases_german_prop @@ -1832,7 +2217,7 @@ \cs_set_nopar:cpn { #1 } { \bool_if:NTF \l_chemmacros_phases_sub_bool - { \ensuremath { @ { \text { (#2) } } } } + { \ensuremath { \c_math_subscript_token { \text { (#2) } } } } { \ensuremath { @@ -1851,7 +2236,7 @@ \NewDocumentCommand \phase { m } { \bool_if:NTF \l_chemmacros_phases_sub_bool - { \ensuremath { @ { \text { (#1) } } } } + { \ensuremath { \c_math_subscript_token { \text { (#1) } } } } { \ensuremath { @@ -1866,7 +2251,6 @@ \cs_new_eq:NN \solid \sld \cs_new_eq:NN \liquid \lqd } -\char_set_catcode_letter:N \@ % --------------------------------------------------------------------------- % % reaction environments @@ -1904,13 +2288,29 @@ % define \listofreactions \tl_new:N \l_chemmacros_reaction_lorname_tl +\tl_set:Nn \l_chemmacros_reaction_lorname_tl { Reaction ~ } \tl_new:N \reactionlistname -\tl_set:Nn \l_chemmacros_reaction_lorname_tl - { \bool_if:NTF \l_chemmacros_german_bool { Reaktion ~ } { Reaction ~ } } +\tl_set:Nn \reactionlistname { List~of~reactions } -\bool_if:NTF \l_chemmacros_german_bool - { \tl_set:Nn \reactionlistname { Reaktionsverzeichnis } } - { \tl_set:Nn \reactionlistname { List~of~reactions } } +% language settings +\AtBeginDocument + { + \bool_if:NT \l_chemmacros_german_bool + { + \tl_set:Nn \reactionlistname { Reaktionsverzeichnis } + \tl_set:Nn \l_chemmacros_reaction_lorname_tl { Reaktion ~ } + } + \bool_if:NT \l_chemmacros_italian_bool + { + \tl_set:Nn \reactionlistname { Elenco ~ delle ~ reazioni } + \tl_set:Nn \l_chemmacros_reaction_lorname_tl { Reazione ~ } + } + \bool_if:NT \l_chemmacros_french_bool + { + \tl_set:Nn \reactionlistname { Table ~ des ~ r\'eactions } + \tl_set:Nn \l_chemmacros_reaction_lorname_tl { R\'eaction ~ } + } + } \cs_new:Npn \listofreactions { \section* { \reactionlistname } \@starttoc { lor } } @@ -1942,8 +2342,6 @@ \bool_if:NTF \l_chemmacros_version_one_bool { \usetagform { CMreaction } } { \usetagform { reaction } } - % => this is problematic because it disallows resetting the counter: -% \tl_new:c { l_chemmacros_reaction_ \thereaction _tl } } % switch back to equation tags @@ -2117,7 +2515,6 @@ % old syntax (v2.0): % \State[<keyval>]{<Symbol>}{<subscript>} % {<subscript>} is an optional argument! -\char_set_catcode_math_subscript:N \@ \cs_new_nopar:Npn \chemmacros_state:nnn #1#2#3 { \group_begin: @@ -2128,10 +2525,10 @@ \bool_if:NT \l_chemmacros_State_delta_bool { \tl_use:N \l_chemmacros_State_delta_tl } \bool_if:NT \l_chemmacros_State_subscript_left_bool - { @ { \text { #3 } } } + { \c_math_subscript_token { \text { #3 } } } #2 \bool_if:NF \l_chemmacros_State_subscript_left_bool - { @ { \text { #3 } } } + { \c_math_subscript_token { \text { #3 } } } \bool_if:NT \l_chemmacros_State_exponent_bool { ^ { \tl_use:N \l_chemmacros_State_exponent_tl } } } @@ -2153,7 +2550,6 @@ \group_end: } } -\char_set_catcode_letter:N \@ % --------------------------------------------------------------------------- % \tl_new:N \l_chemmacros_thermod_subscript_left_tl @@ -3317,8 +3713,16 @@ Version history counter now doesn't cause errors any more - \AddRxnDesc added which allows to add descriptions to each reaction in the "reactions" environment +2012/05/07 - version 3.3 - new environment `experimental' that allows some + formatting for the for displaying of measurement + results + - more greek letters for the \iupac command + - new features in chemformula.sty + - small adjustments of the iupac commands \| and \- + - bug fix: option `upgreek' is now working and was + renamed to `greek' + - proper language support % --------------------------------------------------------------------------- % % TODO: -- ox-option xfrac vs math? -- resolve conflict with \listofreactions and \setcounter{reaction}{<int>}
\ No newline at end of file +- ox-option xfrac vs math?
\ No newline at end of file diff --git a/Master/texmf-dist/tex/latex/chemmacros/ghsystem.sty b/Master/texmf-dist/tex/latex/chemmacros/ghsystem.sty index 4c91a0b8796..e82ac0b0dcc 100644 --- a/Master/texmf-dist/tex/latex/chemmacros/ghsystem.sty +++ b/Master/texmf-dist/tex/latex/chemmacros/ghsystem.sty @@ -5,7 +5,7 @@ % - macros and commands for chemists - % % --------------------------------------------------------------------------- % % - Clemens Niederberger - % -% - 2012/03/20 - % +% - 2012/05/07 - % % --------------------------------------------------------------------------- % % - https://bitbucket.org/cgnieder/chemmacros/ - % % - contact@mychemistry.eu - % @@ -30,8 +30,8 @@ \RequirePackage{ expl3 } \ProvidesExplPackage {ghsystem} - {2012/03/20} - {3.2} + {2012/05/07} + {3.3} {globally harmonised system} % --------------------------------------------------------------------------- % @@ -137,8 +137,24 @@ \DeclareSIUnit { \GHSkilogram } { kg } \DeclareSIUnit { \GHSpounds } { lbs } -\bool_if:NTF \l_chemmacros_german_bool - { \input { language / ghsystem_german.def } \ExplSyntaxOn } +% language settings +\bool_new:N \l_ghsystem_language_file_loaded_bool +\bool_if:NT \l_chemmacros_english_bool + { + \bool_set_true:N \l_ghsystem_language_file_loaded_bool + \input { language / ghsystem_english.def } \ExplSyntaxOn + } +\bool_if:NT \l_chemmacros_german_bool + { + \bool_set_true:N \l_ghsystem_language_file_loaded_bool + \input { language / ghsystem_german.def } \ExplSyntaxOn + } +% \bool_if:NT \l_chemmacros_italian_bool +% { +% \bool_set_true:N \l_ghsystem_language_file_loaded_bool +% \input { language / ghsystem_italian.def } \ExplSyntaxOn +% } +\bool_if:NF \l_ghsystem_language_file_loaded_bool { \input { language / ghsystem_english.def } \ExplSyntaxOn } \cs_new_nopar:Nn \ghsystem_booktabs:n @@ -456,6 +472,8 @@ VERSION HISTORY 2012/03/03 - version 3.1b - changes in packages chemformula and chemmacros 2012/03/14 - version 3.1c - changes in packages chemformula and chemmacros 2012/03/20 - version 3.2 - changes in packages chemformula and chemmacros +2012/05/07 - version 3.3 - changes in packages chemformula and chemmacros + - support for chemmacros' new language settings %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% % TODO: |