diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemmacros/chemformula_en.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/chemmacros/chemformula_en.tex | 54 |
1 files changed, 53 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemformula_en.tex b/Master/texmf-dist/doc/latex/chemmacros/chemformula_en.tex index 36ff900a1fa..00ebc3d13d8 100644 --- a/Master/texmf-dist/doc/latex/chemmacros/chemformula_en.tex +++ b/Master/texmf-dist/doc/latex/chemmacros/chemformula_en.tex @@ -803,7 +803,7 @@ right. \end{example} They are shifted if they \emph{follow} a subscript which follows \ac{iupac} recommendations~\cite[][p.\,51]{iupac:greenbook}. The amount of the shift can -be set with the option \key{charge-hshift}. +be set with the option \option{charge-hshift}. \begin{example} \ch{SO4^2-} \ch{NH4+} \ch{Na+} \par \chemsetup[chemformula]{charge-hshift=.5ex} @@ -1015,10 +1015,16 @@ There are various different types: stoichiometric equation \command{ch}[\Marg{ <=> } \ch{<=>}] equilibrium arrow + \command{ch}[\Marg{ >=< } \ch{>=<}] + reversed equilibrium arrow \command{ch}[\Marg{ <=>> } \ch{<=>>}] unbalanced equilibrium arrow to the right + \command{ch}[\Marg{ >=<< } \ch{>=<<}] + reversed unbalanced equilibrium arrow to the right \command{ch}[\Marg{ <<=> } \ch{<<=>}] unbalanced equilibrium arrow to the left + \command{ch}[\Marg{ >>=< } \ch{>>=<}] + reversed unbalanced equilibrium arrow to the left \command{ch}[\Marg{ <o> } \ch{<o>}] isolobal arrow \end{commands} @@ -1456,6 +1462,52 @@ The next example shows the effect of some of the options: } \end{example} +\section{Kröger-Vink Notation}\label{sec:kroger-vink-notation} + +\chemformula\ also supports the Kröger-Vink notation\sinceversion{4.5}. +\begin{options} + \keybool{kroeger-vink}\Default{false} + Enable the Kröger-Vink notation. As most options this can be enabled + globally via the setup command or locally as option to \cs{ch}. +\end{options} + +With this option enabled several changes come into effect: \code{'} prodoces a +prime, a \code{x} in a superscript produces $\times$, and both a \code{.} and +a \code{*} produce a little filled circle. In the Kröger-Vink notation a prime +denotes a negative relative charge, the circle a positive relative charge, and +the cross denotes a neutral relative charge. + +\begin{example}[side-by-side] + \setchemformula{kroeger-vink=true} + \ch{Al_{Al}^'} + \ch{Al_{Al}'}\par + \ch{Ni_{Cu}^{x}}\par + \ch{V_{Cl}^.} + \ch{V_{Cl}^*}\par + \ch{Ca_i^{..}}\par + \ch{e^'}\par + \ch{Cl_i^{''}} + \ch{Cl_i''}\par + \ch{O_i^{''}} + \ch{O_i''} +\end{example} + +There are a number of options for customizations: +\begin{options} + \keyval{kv-positive-style}{\TikZ}\Default + \TikZ\ code for positive charge dot. + \keyval{kv-positive-radius}{dim}\Default{.3ex} + Radius of positive charge dot + \keyval{kv-positive-hshift}{dim}\Default{.15em} + Horizontal shift of positive charge dot + \keyval{kv-positive-vshift}{dim}\Default{.5ex} + Vertical shift positive charge dot + \keyval{kv-positive-offset}{dim}\Default{.4em} + The offset of two consecutive positive charge dots + \keyval{kv-neutral-symbol}{\TeX\ code}\Default{\$\cs*{times}\$} + Symbol for neutral particles. +\end{options} + \section{Further Examples} This section presents some examples of a possible usage. |