summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chemformula
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-01-23 21:05:36 +0000
committerKarl Berry <karl@freefriends.org>2022-01-23 21:05:36 +0000
commitd11b1b6b6b0b118f4aa46e2b1aeef7319e08d16b (patch)
treee79beec4cff4e774f181b09e8b0b5bfc8c19975f /Master/texmf-dist/doc/latex/chemformula
parent758f4647877f0256f7ce096bc0d8a16523449a73 (diff)
chemformula (23jan22)
git-svn-id: svn://tug.org/texlive/trunk@61712 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemformula')
-rw-r--r--Master/texmf-dist/doc/latex/chemformula/HISTORY252
-rw-r--r--Master/texmf-dist/doc/latex/chemformula/README15
-rw-r--r--Master/texmf-dist/doc/latex/chemformula/chemformula-manual.cls29
-rw-r--r--Master/texmf-dist/doc/latex/chemformula/chemformula-manual.pdfbin899303 -> 851188 bytes
-rw-r--r--Master/texmf-dist/doc/latex/chemformula/chemformula-manual.tex81
5 files changed, 324 insertions, 53 deletions
diff --git a/Master/texmf-dist/doc/latex/chemformula/HISTORY b/Master/texmf-dist/doc/latex/chemformula/HISTORY
new file mode 100644
index 00000000000..0cc66d3a766
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/chemformula/HISTORY
@@ -0,0 +1,252 @@
+--------------------------------------------------------------------------
+the CHEMFORMULA package
+
+ typeset chemical compounds and reactions
+
+--------------------------------------------------------------------------
+Clemens Niederberger
+--------------------------------------------------------------------------
+https://github.com/cgnieder/chemformula/
+contact@mychemistry.eu
+--------------------------------------------------------------------------
+If you have any ideas, questions, suggestions or bugs to report, please
+feel free to contact me.
+--------------------------------------------------------------------------
+Copyright 2011--2022 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.
+--------------------------------------------------------------------------
+VERSION HISTORY
+2012/01/28 - version 3.0 - bundled with packages `chemmacros' and `ghs'
+2012/01/30 - version 3.0a - bugfix
+ - renamed formula => chemformula
+ (following a request by Karl Berry for TeXlive)
+2012/02/03 - version 3.0b - stepped number with `chemmacros'
+2012/02/05 - version 3.0c - stepped number with `chemmacros'
+2012/02/10 - version 3.0d - several bugfixes
+ - new arrow type <>
+2012/02/19 - version 3.1 - new arrow types -/>, </- and <o>
+ - new commands \DeclareChemArrow, \RenewChemArrow and
+ \ShowChemArrow
+2012/02/26 - version 3.1a - stepped number with `chemmacros'
+2012/03/03 - version 3.1b - arrow types are stored in a sequence to automate the
+ search and replace in the right order
+ - new arrow type ==
+ - IUPAC compliance for stoichiometric factors
+ - new handling of super- and subscripts to correct
+ various flaws: clear distinction between isotope and
+ formula
+ - new option charge-vshift
+2012/03/14 - version 3.1c - improved arrow labels
+2012/03/20 - version 3.2 - new: option input via @{<options>}
+2012/05/07 - version 3.3 - \ch now bypasses \ref{}, \label{}, and \intertext{}
+2012/05/13 - version 3.3a - stepped number with `chemmacros'
+2012/05/18 - version 3.3b - stepped number with `chemmacros'
+2012/05/18 - version 3.3c - stepped number with `chemmacros'
+2012/07/24 - version 3.3d - stepped number with `chemmacros'
+ - default bond length set to 1.1667ex
+ - bug fix in the bonds
+2012/08/21 - version 3.3e - stepped number with `chemmacros'
+2012/09/11 - version 3.4 - cleaned a little, minor bug fixes
+ - switched to internal scratch variables
+ - new command \bond, more bond types
+ - new commands \DeclareChemBond, \DeclareChemBondAlias,
+ \RenewChemBond and \ShowChemBond
+ - radical point thicker, new options `radical-style'
+ and `radical-radius'
+2012/10/03 - version 3.4a - stepped number with `chemmacros'
+2013/01/04 - version 3.4b - bug fix in the sub- and superscript handling
+2013/01/28 - version 3.5 - disallow breaks at bonds
+ - allow breaks after arrows
+ - made some spaces in chemformulas stretch- and
+ shrinkable
+ - various internal code improvements
+ - changed defaults for horizontal spaces that have in
+ set in ex into corresponding values in em.
+ - improvements to the placement of sub- and superscripts
+2013/02/19 - version 3.5a - stepped number with `chemmacros'
+2013/02/26 - version 3.6 - support for use with the `breqn' package
+ - math escaping also via \(\)
+ - internal: clearer escaping macros
+ - new options: `radical-vshift', `radical-hshift'
+ and `radical-space'
+ - bug fix: `radical-...' options are now correctly set
+ - stoichiometric factors: add leading 0 if missing
+ - new option: `stoich-paren-parse'
+ - internal changes: be way more rigid about protected
+ and expandable macros
+ - internal changes: clearer distinction between
+ private macros and accessable module macros
+ - internal changes: clearer distinction between
+ document commands and module level commands
+ - !()() syntax now also works with babel's French
+2013/02/27 - version 3.6a - bug fix: escaped text and math stays escaped, i.e.
+ also arrow code like `<=>'
+2013/04/19 - version 3.6b - new option `arrow-min-length'
+ - bug fix: stoichiometric fractions correctly displayed
+2013/07/06 - version 4.0 - don't need `chemmacros' package any more,
+ `chemformula' can be used stand-alone;
+ this has lead to a few definitions that previously
+ were done by chemmacros; chemmacros will get them
+ now from chemformula when needed
+ - bug fix: allow braces in subscripts and superscripts
+ by disabling superfluous \chemformula_subscript:n
+ and \chemformula_superscript:n in the scripts write
+ commands
+ - remove superfluous rescanning at the begin of the
+ formula input; this is handled by the sanitize
+ command later anyway
+ - changed internal mathshifts from $ ... $ to \( ... \)
+ - removed superfluous \textstyle from math-frac
+ definition
+ - new command \charrow{}[][] that allows direct
+ access to chemformula's arrows
+ - new command \chname()() that allows direct access
+ to chemformula's naming
+ - new command \chcpd[]{} that allows typesetting a
+ simple single formula - also not nestable with \ch
+ - new command \setchemformula
+ - package option: `strict'
+ - don't allow a line break before a plus
+ (`chem-and')
+ - don't allow a line break between a stoichiometric
+ factor and a compound
+ - changed formal charges to match ``plain'' charges
+2013/07/26 - version 4.0a - added options `arrow-penalty' (0), `plus-penalty'
+ (700) and `bond-penalty' (10000) that determine if
+ there may be a break after an arrow, a bond or the
+ plus
+2013/08/24 - version 4.1 - changed `0' values in TikZ coordinates into `0pt'
+ see http://tex.stackexchange.com/q/128792/5049 and
+ http://tex.stackexchange.com/q/118467/5049 for
+ reference
+ - new option `tikz-external-disable'
+ - new option `frac-math-cmd'
+2013/10/24 - version 4.2 - \chemformula_font_inner: is only applied /once/ to
+ a formula, and at the beginning, fixes
+ https://bitbucket.org/cgnieder/chemmacros/issue/23
+ - fixed wrong setting of the TikZ bond style
+ - new option `arrow-style'
+ - new command \chlewis
+2013/11/04 - version 4.2a - bug fix in \chcpd,
+ - change sanitizing/restoring of category codes
+2014/01/24 - version 4.3 - changed behaviour of \DeclareChem to match
+ \DeclareRobustCommand, i.e., no check if command
+ is defined; added a \NewChem variant to each that
+ /does/ check; use \NewChem instead of \DeclareChem
+ for definitions
+ - new option stoich-print
+ - new command \chstoich
+2014/01/29 - version 4.4 - treat a single `-' as a minus sign
+2014/04/07 - version 4.5 - make sure that < and > have catcode 12 when read
+ as parts of arrows
+ - new arrow types `>=<', `>=<<', `>>=<' and `<==>'
+ - arrow lengths and compound offset now correctly
+ adapts to new fontsize if relative lengths (em,ex)
+ are used
+ - allow optional arguments to \\ in equation
+ environments
+ - allow optional arguments to \label in equation
+ environments
+ (credits: http://tex.stackexchange.com/a/166661/5049)
+ - support for Kröger-Vink notation
+2014/06/30 - version 4.6 - fix: a comma in a superscript is typeset according
+ to `decimal-marker' again
+ - fix charge type behaviour: option `circled' and
+ `circletype' are now obeyed if the option is
+ changed mid-document
+ - new option `chemformula/circled' similar to
+ `chemmacros/circled'
+ - new option `chemformula/circletype' similar to
+ `chemmacros/circletype'
+2014/08/04 - version 4.7 - change dependency: pgf library `arrows.meta'
+ instead of `arrows'
+ - new arrow tip definition allows redeclaration to
+ other existing tips by \pgfkeys{cf/.tip=<tip>}
+2014/08/08 - version 4.8 - fix bug introduced in last update: `butt cap' now
+ needs to be `Butt Cap' with the new `arrows.meta'
+ library
+ - split from `chemmacros' bundle as independent
+ package
+2014/10/07 - version 4.9 - new options: `minus-space', `minus-penalty',
+ `plus-output-symbol' and `minus-output-symbol'
+2015/03/16 - version 4.10 - new macros \NewChemCompoundProperty,
+ \RenewChemCompoundProperty,
+ \DeclareChemCompoundProperty,
+ \RemoveChemCompoundProperty
+2015/04/03 - version 4.10a - bug fix in \__chemformula_input_stoich:n
+2015/06/30 - version 4.11 - small changes in \chcpd
+ - remove unnecessary \mathchoice => noticable speed
+ improvement
+ - \NewChemAdditionSymbol
+ - \NewChemSymbol
+2015/08/12 - version 4.12 - remove chemmacros' `circletype' and `circled'
+ options. They really belong to chemmacros
+ - change requirement amsmath -> amstext
+ - shorten definition of double and triple bonds
+2015/08/29 - version 4.12a - \chemformula_formal_plus: ,
+ \chemformula_formal_minus:
+ \ProvideChem... equivalents to all \NewChem...
+ macros
+2015/09/08 - version 4.12b - trim spaces of \ch input -- due to a change in
+ l3kernel
+2015/01/01 - version 4.13 - clean up code
+ - check for blank input
+ - drop support for \[ and \]
+ - new option `atom-format'
+2015/10/21 - version 4.14 - fix issue
+ https://github.com/cgnieder/chemformula/issues/2
+ - new option `adduct-penalty'
+2016/01/07 - version 4.14a - \prop_get:Nn => \prop_item:Nn
+2016/05/03 - version 4.14b - local options now are correctly working again
+ - `atom-format' is only applied to formulas
+2016/05/11 - version 4.15 - arrow definitions don't have to be made in a
+ certain order any more
+ - new quasi equilibria arrows
+ - bug fix in \RenewChemArrow
+ - meaningful error if \charrow if used with an
+ unknown arrow type
+2016/06/08 - version 4.15a - change requirement amstext -> amsmath; \chname
+ uses \underset which needs amsmath
+2016/06/08 - version 4.15b - add missing variant of kernel function
+2016/08/21 - version 4.15c - corrected redundant definition of
+ \chemformula_single_bond:
+ - fix problem with TikZ externalization and
+ Kroeger-Vink notation
+2017/02/02 - version 4.15d - allow `name-format' to end with a macro that
+ takes an argument
+2017/03/23 - version 4.15e - small bug fix (issue #5)
+ - implement \shortintertext bypass
+2019/09/23 - version 4.15f - add missing definition for temporary variable
+2019/09/27 - version 4.15g - bug fix in fontspec option
+2019/10/13 - version 4.15h - new (undocumented) option `set-catcodes'
+ - fix behaviour with category codes
+ (https://tex.stackexchange.com/q/511592/)
+ - fix bug: local format changes are now applied
+ again
+2020/02/01 - version 4.15i - fix issue #12
+2020/03/07 - version 4.15j - make sure that < and > have catcode 12 when read
+ as arrows -- again...
+2020/03/15 - version 4.15k - fix https://tex.stackexchange.com/questions/532674/
+2020/12/22 - version 4.16 - new option `math-scripts'
+ - use LaTeX's new hooks
+ - get rid of unnecessary package dependencies
+2022/01/23 - version 4.17 - adjust options `stoich-print' and `frac-math-cmd'
+ and correct bug in `stoich-print'
+ - deprecate `stoich-print' and introduce `stoich-format'
+ - lazy boolean evaluation where possible
+ - fix deprecated file hook
+ - implement issue #17
+ - fix issue #18
+ - fix issue #19
+ - fix typos in code
diff --git a/Master/texmf-dist/doc/latex/chemformula/README b/Master/texmf-dist/doc/latex/chemformula/README
index c25182cc825..fd8728046ba 100644
--- a/Master/texmf-dist/doc/latex/chemformula/README
+++ b/Master/texmf-dist/doc/latex/chemformula/README
@@ -1,5 +1,5 @@
--------------------------------------------------------------------------
-the CHEMFORMULA package v4.16 2020/12/22
+the CHEMFORMULA package v4.17 2022/01/23
typeset chemical compounds and reactions
@@ -8,7 +8,7 @@ Clemens Niederberger
Web: https://github.com/cgnieder/chemformula/
E-Mail: contact@mychemistry.eu
--------------------------------------------------------------------------
-Copyright 2011--2020 Clemens Niederberger
+Copyright 2011--2022 Clemens Niederberger
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3c
@@ -23,9 +23,14 @@ This work has the LPPL maintenance status `maintained'.
The Current Maintainer of this work is Clemens Niederberger.
--------------------------------------------------------------------------
The chemformula package consists of the following files
- - chemformula.sty,
- - chemformula-manual.cls, chemformula-manual.tex, chemformula-manual.pdf,
- - README
+ == STYLE FILES ==
+ chemformula.sty
+ == DOCUMENTATION FILES ==
+ chemformula-manual.tex
+ chemformula-manual.pdf
+ chemformula-manual.cls
+ README
+ HISTORY
--------------------------------------------------------------------------
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/chemformula/chemformula-manual.cls b/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.cls
index e9da59b2c57..0c0061d1a43 100644
--- a/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.cls
+++ b/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.cls
@@ -12,7 +12,7 @@
% If you have any ideas, questions, suggestions or bugs to report, please
% feel free to contact me.
% --------------------------------------------------------------------------
-% Copyright 2011--2020 Clemens Niederberger
+% Copyright 2011--2022 Clemens Niederberger
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
@@ -26,7 +26,7 @@
%
% The Current Maintainer of this work is Clemens Niederberger.
% --------------------------------------------------------------------------
-\ProvidesClass{chemformula-manual}[2020/02/01]
+\ProvidesClass{chemformula-manual}[2022/01/23]
\LoadClass[load-preamble,add-index]{cnltx-doc}
\RequirePackage{imakeidx}
@@ -301,6 +301,30 @@
\itemize\let\change\item
}{\enditemize}
+\chemsetup{
+ greek = newtx ,
+ formula = chemformula ,
+ chemformula/format = \libertineLF
+}
+
+\usepackage{acro}
+\acsetup{
+ format/long = \scshape ,
+ format/short = \scshape
+}
+\DeclareAcronym{iupac}{
+ short = iupac ,
+ long = International Union of Pure and Applied Chemistry ,
+ pdfstring = IUPAC ,
+ short-acc = IUPAC
+}
+
+\sisetup{
+ detect-mode=false,
+ mode=text,
+ text-font-command=\libertineLF
+}
+
\chemformula@add@version{2012-01-28}{3.0}
\chemformula@add@version{2012-01-30}{3.0a}
\chemformula@add@version{2012-02-03}{3.0b}
@@ -360,5 +384,6 @@
\chemformula@add@version{2020-03-07}{4.15j}
\chemformula@add@version{2020-03-15}{4.15k}
\chemformula@add@version{2020-12-22}{4.16}
+\chemformula@add@version{2022-01-23}{4.17}
\endinput
diff --git a/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.pdf b/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.pdf
index 6ce31cd5de6..a313fc06d23 100644
--- a/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.pdf
+++ b/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.tex b/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.tex
index 00b7b2aa89a..e1d592a2635 100644
--- a/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.tex
+++ b/Master/texmf-dist/doc/latex/chemformula/chemformula-manual.tex
@@ -1,5 +1,5 @@
-% !arara: pdflatex
-% !arara: biber
+% arara: pdflatex
+% arara: biber
% arara: pdflatex
% arara: pdflatex
% --------------------------------------------------------------------------
@@ -16,7 +16,7 @@
% If you have any ideas, questions, suggestions or bugs to report, please
% feel free to contact me.
% --------------------------------------------------------------------------
-% Copyright 2011--2020 Clemens Niederberger
+% Copyright 2011--2022 Clemens Niederberger
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3c
@@ -33,31 +33,6 @@
\documentclass{chemformula-manual}
\addbibresource{cnltx.bib}
-
-\chemsetup{
- greek = newtx ,
- formula = chemformula ,
- chemformula/format = \libertineLF
-}
-
-\usepackage{acro}
-\acsetup{
- format/long = \scshape ,
- format/short = \scshape
-}
-\DeclareAcronym{iupac}{
- short = iupac ,
- long = International Union of Pure and Applied Chemistry ,
- pdfstring = IUPAC ,
- short-acc = IUPAC
-}
-
-\sisetup{
- detect-mode=false,
- mode=text,
- text-rm=\libertineLF
-}
-
\addbibresource{\jobname.bib}
\begin{filecontents*}{\jobname.bib}
@book{iupac:greenbook,
@@ -231,28 +206,29 @@ parentheses in the \acs{iupac} Green Book~\cite{iupac:greenbook}:
(1/5) K "\ox{7,Mn}" O4 + (8/5) HCl == (1/5) "\ox{2,Mn}" Cl2 + (1/2) Cl2 + (1/5) KCl + (4/5) H2O
\end{reaction*}
-There are a few possibilities to customize the output.
+There are a few possibilities to customize the output:
\begin{options}
\keyval{decimal-marker}{marker}\Default{.}
The symbol to indicate the decimal.
\keychoice{frac-style}{math,xfrac,nicefrac}\Default{math}
Determines how fractions are displayed.
- \keyval{frac-math-cmd}{command sequence}\Default{\cs*{frac}}
- \sinceversion{4.1}Allows you to choose which command is used with
- \keyis{frac-style}{math}. This needs to be a command sequence that takes
- two arguments that are set in math mode.
+ \keyval{frac-math-cmd}{command sequence}\Default{\cs*{frac}\Marg{\#1}\Marg{\#2}}
+ \changedversion{4.17}Allows you to choose which command is used with
+ \keyis{frac-style}{math}.
\keyval{stoich-space}{skip}\Default{.1667em plus .0333em minus .0117em}
The space that is placed after the stoichiometric factor. A rubber
length.
\keybool{stoich-paren-parse}\Default{false}
If set to true stoichiometric factors enclosed by parentheses also are
parsed.
- \keyval{stoich-print}{cs}\Default{\cs{chstoich}}
- This option allows to redefine the macro that prints the stoichiometric
- factors. \meta{cs} should be a macro that takes one mandatory argument.
- \emph{Please note that using this option will disable \chemformula's
- stoichiometric parsing as that is done by the default command
- \cs{chstoich}.}
+ \keyval{stoich-format}{code}\Default
+ \sinceversion{4.17}Allows formatting of the stoichiometric factors. The
+ last macro given may take an argument.
+ \keyval{stoich-print}{code containing \#1}\Default{\#1}
+ \changedversion{4.17}This option allows to use specify a macro for
+ printing the stoichiometric factors where \code{\#1} represents the
+ factor. \emph{This option is depecated and will be removed some time in
+ the future. Use \option{stoich-format} instead.}
\end{options}
\begin{example}
@@ -360,11 +336,6 @@ expands.
\end{sourcecode}
See section~\ref{ssec:text} for a way around this.
-Please also note that formulas are placed inside a group!
-\begin{example}[side-by-side]
- \ch{A2\color{red}B3 C4}
-\end{example}
-
\subsection{Charges and Other Superscripts}
\paragraph{Basics}
If a compound \emph{ends} with a plus or minus sign it will be treated as
@@ -870,7 +841,7 @@ the spacing. That's why there is an alternative:
\end{commands}
\begin{example}
\ch{H2O +}\textcolor{red}{\ch{H2SO4}}\ch{-> H3O+ + HSO4-} \par
- \ch{H2O + @{format=\color{red}} H2SO4 -> H3O+ + HSO4-} \par
+ \ch{H2O + @{atom-format=\color{red}} H2SO4 -> H3O+ + HSO4-} \par
or of course:\par
\ch{H2O + \textcolor{red}{H2SO4} -> H3O+ + HSO4-}\par\bigskip
\ch{H2O +}\ch[subscript-vshift=2pt]{H2SO4}\ch{-> H3O+ + HSO4-} \par
@@ -1020,6 +991,16 @@ of the labels. What stays constant is the part that protrudes the labels.
\ch{A ->[ "\chemfig{-[:30]-[:-30]OH}" ] B} \par
\end{example}
+The\sinceversion{4.17} labels are typeset inside of a \env*{tabular}\Marg{c}
+environment. This means you can get several lines:
+\begin{example}[side-by-side]
+ \ch{A ->[{a\\b}] B} \par
+ \ch{A ->[a \newline b] B}
+\end{example}
+The command \cs*{\textbackslash} must be hidden in order to
+work. \cs*{tabularnewline} does work, of course. For convenience \chemformula\
+also allows \cs*{newline} here.
+
\subsection{Customization}
These are the options which enable you to customize the arrows:
\begin{options}
@@ -1192,7 +1173,8 @@ creating a name you only have to make sure it isn't followed by parentheses.
\chemformula\ provides two options to customize the output of the names:
\begin{options}
\keyval{name-format}{commands}\Default{\cs*{scriptsize}\cs*{centering}}
- The format of the name. This can be arbitrary input.
+ \changedversion{4.15d}The format of the name. This can be arbitrary input
+ and the last macro may receive the name as an argument.
\keychoice{name-width}{\meta{dim},auto}\Default{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.
@@ -1578,6 +1560,13 @@ There are a number of options for customizations:
and code.
\end{changes}
+\begin{changes}{4.17}
+ \change Various bug fixes.
+ \change Lazy boolean evaluation where possible.
+ \change Place arrow's arguments in a tabular. This allows for multiple
+ lines.
+\end{changes}
+
\printbibliography
\end{document}