summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-01-29 23:21:30 +0000
committerKarl Berry <karl@freefriends.org>2013-01-29 23:21:30 +0000
commit966c0674997ff51e5ea9e4a79e6c873c4d93a9cf (patch)
tree5be91b484cec2431f63e8717793dcbe83538090c /Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex
parent13bacf6392e96e4d46c40e1d4b50b9e70055fb18 (diff)
chemmacros (29jan13)
git-svn-id: svn://tug.org/texlive/trunk@28982 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex124
1 files changed, 75 insertions, 49 deletions
diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex
index 45a9f081866..2a1f9bd8ac9 100644
--- a/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex
+++ b/Master/texmf-dist/doc/latex/chemmacros/chemmacros_en.tex
@@ -1,7 +1,7 @@
% arara: xelatex
% arara: biber
% arara: xelatex
-% arara: xelatex
+% !arara: xelatex
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% -----------------------------------------------------------------------------
% - the CHEMMACROS bundle
@@ -52,10 +52,11 @@
code-box = {skipabove=1ex,skipbelow=1ex}
}
-\usepackage[varioref=false]{chemstyle}
+% \usepackage{scrhack}
+% \usepackage[varioref=false,floats=float]{chemstyle}
\usepackage{chemfig,upgreek,textgreek,booktabs,cancel}
\usepackage[version=3]{mhchem}
-\usepackage{hologo}
+\usepackage{hologo,libertinehologopatch}
\usepackage{fnpct}
\usepackage[biblatex]{embrac}
\ChangeEmph{[}[,.02em]{]}[.055em,-.08em]
@@ -64,10 +65,33 @@
\pagestyle{headings}
\usepackage{acro}
-\DeclareAcronym{ghs}{GHS}{Globally Harmonized System of Classification and
- Labelling of Chemicals}
-\DeclareAcronym{eu}{EU}{European Union}
-\DeclareAcronym{iupac}{IUPAC}{International Union of Pure and Applied Chemistry}
+\acsetup{long-format=\scshape}
+\DeclareAcronym{ghs}{
+ short = GHS ,
+ long = Globally Harmonized System of Classification and Labelling of Chemicals
+}
+\DeclareAcronym{eu}{
+ short = EU ,
+ long = European Union
+}
+\DeclareAcronym{iupac}{
+ short = IUPAC ,
+ long = International Union of Pure and Applied Chemistry
+}
+\DeclareAcronym{UN}{
+ short = UN ,
+ long = United Nations
+}
+\DeclareAcronym{dvi}{
+ short = dvi ,
+ long = device independent file format ,
+ format = \scshape
+}
+\DeclareAcronym{pdf}{
+ short = pdf ,
+ long = portable document file ,
+ format = \scshape
+}
\chemsetup[option]{synchronize}
\colorlet{chemformula}{darkgray}
@@ -147,8 +171,8 @@
\newcommand*\Ghsystem{{\fontspec[Color=cnpkgblue,Scale=1.2]{Linux Biolinum Shadow O}ghsystem}}
\renewcommand*\AmS{\hologo{AmS}}
-\newcommand*\pdfTeX{\hologo{pdfTeX}}
-\renewcommand*\LuaTeX{\hologo{LuaTeX}}
+% \newcommand*\pdfTeX{\hologo{pdfTeX}}
+% \renewcommand*\LuaTeX{\hologo{LuaTeX}}
\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}}" {}- }
@@ -157,14 +181,14 @@
\addcmds{
a,abinitio,AddRxnDesc,anti,aq,aqi,
- b,ba,bottomrule,bridge,
+ b,ba,bond,bottomrule,bridge,
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,DeclareChemBond,DeclareChemIUPAC,DeclareChemLatin,
- DeclareChemNMR,DeclareChemParticle,DeclareChemPhase,DeclareChemReaction,
- DeclareChemState,DeclareInstance,DeclareSIUnit,definecolor,delm,delp,Delta,
- Dfi,draw,
+ d,D,data,DeclareChemArrow,DeclareChemBond,DeclareChemBondAlias,DeclareChemIUPAC,
+ DeclareChemLatin,DeclareChemNMR,DeclareChemParticle,DeclareChemPhase,
+ DeclareChemReaction,DeclareChemState,DeclareInstance,DeclareSIUnit,definecolor,
+ delm,delp,Delta,Dfi,draw,
E,el,electronvolt,ElPot,endo,Enthalpy,enthalpy,Entropy,
footnotesize,fmch,fpch,fscrm,fscrp,
g,gas,ghs,ghslistall,ghspic,Gibbs,glqq,gram,grqq,
@@ -258,9 +282,9 @@ 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 \ac{ghs} as a global replacement for the various different
-systems in different countries. While it has not been implemented by all countries
+As a chemist you are probably aware of the fact that the \acl{UN} have developed
+the \ac{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 is only a matter of time.
The package \ghsystem now enables you to typeset all the hazard and precautionary
@@ -357,10 +381,15 @@ be set using the setup command.
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
+ \option[option]{greek}{\default{auto}|math|textgreek|upgreek} This Option 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})
+ Please note that this options \emph{does not load either \paket{upgreek} nor
+ \paket{textgreek}}! It only determines which one to choose if available. The
+ option will detect if either \paket{upgreek} or \paket{textgreek} have been
+ loaded and use them if available. If you explicitly choose \code{upgreek} or
+ \code{textgreek} you also have to load the corresponding package.
+ (default = \code{auto})
% iupac
\option[option]{iupac}{auto|restricted|strict} Take care of how \ac{iupac} naming
commands are defined, see page~\pageref{desc:iupac} (default = \code{auto})
@@ -634,10 +663,9 @@ 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\relax\cmd{^}}
- as a shortcut for \lstinline=\textsuperscript=\footnote{Actually another
- mechanism is used, but the effect is essentially the same.}.
+ \Befehl{iupac}{<IUPAC name>} Inside this command use \cmd{|} and \cmd{-} to
+ indicate a breaking point or a breaking dash. Use {\catcode`\^=11\relax\cmd{^}}
+ as a shortcut for \lstinline=\textsuperscript=.
\end{beschreibung}
\begin{beispiel}
@@ -739,7 +767,7 @@ common ones.
\iupac{\O\-ethyl hexanethioate}
\end{beispiel}
-\paragraph{Cahn-Ingold-Prelog}\index{Cahn-Ingold-Prelog}\secidx[Cahn-Ingold-Prelog]{IUPAC Names}\label{par:cip}% TODO Jonas (label neu)
+\paragraph{Cahn-Ingold-Prelog}\index{Cahn-Ingold-Prelog}\secidx[Cahn-Ingold-Prelog]{IUPAC Names}\label{par:cip}
\begin{beschreibung}
\befehl{cip}{<conf>} \eg: \cmd{cip}{R,S} \cip{R,S}
\befehl{R} \iupac{\R}
@@ -748,13 +776,12 @@ common ones.
Since the command \cmd{S} has another meaning already (\S) it is only available
inside \cmd{iupac} in the default setting.
-% TODO Jonas
Both these commands and the entgegen/zusammen descriptors get a small additional
amount of kerning after the closing parenthesis. This amount can be changed through
the following option:
\begin{beschreibung}
\option[iupac]{cip-kern}{<dim>} amount of kerning after the closing parenthesis.
- Default = \code{.1ex}
+ Default = \code{.075em}
\end{beschreibung}
\paragraph{Fischer}\index{Fischer}\secidx[Fischer]{IUPAC Names}
@@ -865,12 +892,8 @@ commands:
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}
+depends on \paket{chemstyle}'s option \code{abbremph}.
+
The commands are defined through
\begin{beschreibung}
\Befehl{DeclareChemLatin}{<cmd>}\ma{<phrase>}
@@ -878,7 +901,7 @@ The commands are defined through
\end{beschreibung}
\begin{beispiel}
\DeclareChemLatin\ltn{latin text}
- \ltn \cstsetup{abbremph=false} \ltn
+ \ltn
\end{beispiel}
If you have \emph{not} loaded \paket{chemstyle} you can change the appearance with
this option:
@@ -2031,6 +2054,7 @@ Additionally there are two options, with which the \TikZ behaviour can be change
\bspmidlength{dist}{7mm}
\secidx*{Orbitals}\secidx*{CHEMMACROS}
+\newpage
\part{\texorpdfstring{\Chemformula}{chemformula}}\secidx{CHEMFORMULA}\label{part:chemformula}
\chemsetup[chemformula]{
font-spec =
@@ -2143,8 +2167,8 @@ There are a few possibilities to customize the output.
\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}
+ \option{stoich-space}{<skip>} The space that is placed after the stoichiometric
+ factor. A rubber length. Default = \code{.1667em plus .0333em minus .0117em}
\end{beschreibung}
\begin{beispiel}
\ch[decimal-marker={,}]{3.5} \ch[decimal-marker={$\cdot$}]{3,5}
@@ -2329,6 +2353,9 @@ In addition to the three native bonds there are a few more which can be called b
The predefined bond types are shown in table~\ref{tab:bond_types}.
\begin{table}
+ \centering
+ \caption{Bonds available with \protect\cmd{bond}.}
+ \label{tab:bond_types}
\begin{tabular}{lcl}
\toprule
\bfseries name & \bfseries appearance & \bfseries aliases \\
@@ -2343,8 +2370,6 @@ The predefined bond types are shown in table~\ref{tab:bond_types}.
\code{<co} & \bond{<co} & \code{coordleft} \\
\bottomrule
\end{tabular}
- \caption{Bonds available with \protect\cmd{bond}.}
- \label{tab:bond_types}
\end{table}
\begin{beispiel}
@@ -2401,14 +2426,14 @@ These options allow you to customize the ouptut of the compounds:
\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}
+ Default = \code{.25em}\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 = \code{1.1667ex}
+ \option{bond-length}{<dim>} The length of the bonds. Default = \code{.5833em}
\option{bond-offset}{<dim>} Space between bond and atoms. Default = \code{.07em}
\option{bond-style}{<tikz>} \TikZ\ options for the bonds. Initially empty.
\option{radical-style}{<tikz>} \TikZ\ options for the radical point. Initially
@@ -2511,7 +2536,7 @@ following ones:
The space left and right of the plus sign can be set with this option:
\begin{beschreibung}
- \option{plus-space}{<dim>} Default = \lstinline+.3em+
+ \option{plus-space}{<skip>} A rubber length. Default = \code{.3em plus .1em minus .1em}
\end{beschreibung}
\begin{beispiel}
\ch{A + B}\\
@@ -2575,7 +2600,8 @@ This output is different from the escaped text as it is followed by a space.
The space that is inserted after a math group can be edited:
\begin{beschreibung}
- \option{math-space}{<dim>} Default = \code{.1667em}
+ \option{math-space}{<skip>} A rubber length. Default =
+ \code{.1667em plus .0333em minus .0117em}
\end{beschreibung}
\begin{beispiel}
\ch{$2n$ Na + $n$ Cl2 -> $2n$ NaCl} \\
@@ -2655,14 +2681,14 @@ These are the options which enable you to customize the arrows:
\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}
+ Default = \code{.75em}
\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}
+ Default = \code{.5em}
\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.
@@ -3094,15 +3120,15 @@ want to rotate the pictogram for some reason, use this option:
\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.
-\hologo{pdfTeX} in \textsc{dvi} mode \emph{needs} \code{eps} pictures while
-\hologo{pdfTeX} in \textsc{pdf} mode, \hologo{XeTeX} and \hologo{LuaTeX} convert
+\pdfTeX{} in \acs{dvi} mode \emph{needs} \code{eps} pictures while
+\pdfTeX{} in \acs{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 \code{jpg} and \code{png} without any problems,
-while \hologo{pdfTeX} in \textsc{dvi} mode can't.
+while \pdfTeX{} in \acs{dvi} mode can't.
-To resolve this \ghsystem tests which engine is used and if \hologo{pdfTeX} which
+To resolve this \ghsystem tests which engine is used and if \pdfTeX{} which
mode is used and then chooses either \code{eps} or \code{pdf} for the pictograms.
You are free to choose the picture type yourself with the option
\begin{beschreibung}
@@ -3129,7 +3155,7 @@ You can also choose the language explicitly.
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
+I would provide you with a template file, a \acs{pdf} containing the official
translations, and help to all your questions.
\section{List of All Statements}\secidx{List of All Statements}
@@ -3217,7 +3243,7 @@ The options belonging to the modules \code{\textcolor{module}{chemformula}} and
\multicolumn{5}{l}{\ac{iupac} commands:} \\
break-space & iupac & <dim> & .01em & page~\pageref{key:iupac_break-space} \\
bridge-number & iupac & sub|super & sub & page~\pageref{key:iupac_bridge-number} \\
- cip-kern & iupac & <dim> & .1ex & page~\pageref{key:iupac_cip-kern} \\
+ cip-kern & iupac & <dim> & .075em & page~\pageref{key:iupac_cip-kern} \\
coord-use-hyphen & iupac & \default{true}|false & true & page~\pageref{key:iupac_coord-use-hyphen} \\
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} \\