summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex144
1 files changed, 96 insertions, 48 deletions
diff --git a/Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex b/Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex
index d7a12d09514..6cc4e45adb1 100644
--- a/Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex
+++ b/Master/texmf-dist/doc/latex/chemmacros/chemgreek_en.tex
@@ -1,5 +1,5 @@
-% arara: pdflatex
-% !arara: biber
+% !arara: pdflatex
+% arara: biber
% !arara: pdflatex
% arara: pdflatex
% --------------------------------------------------------------------------
@@ -52,9 +52,9 @@
add-cmds = {
abinitio, activatechemgreekmapping, AddRxnDesc, anti, aq, aqi,
ba, bond, bridge,
- cd, ch, changechemgreeksymbol, charrow, chcpd, chemabove, Chemalpha,
- Chembeta, Chemgamma, Chemdelta, ChemDelta, chemformula@bondlength,
- Chemomega, Chemphi, ChemPhi, chemsetup, chlewis, chname , cip, cis, ch,
+ cd, ch, changechemgreeksymbol, charrow, chcpd, chemabove, chemalpha,
+ chembeta, chemgamma, chemdelta, chemDelta, chemformula@bondlength,
+ chemomega, chemphi, chemPhi, chemsetup, chlewis, chname , cip, cis, ch,
CNMR,
data, DeclareChemArrow, DeclareChemBond, DeclareChemBondAlias,
declarechemgreekmapping, DeclareChemIUPAC, DeclareChemLatin,
@@ -63,21 +63,24 @@
el, ElPot, endo, Enthalpy, enthalpy, Entropy,
fmch, fpch, fscrm, fscrp,
gas, ghs, ghslistall, ghspic, Gibbs, gram,
- hapto, HNMR, Helmholtz,
+ hapto, HNMR, Helmholtz, hydrogen,
insitu, invacuo, iupac,
Ka, Kb, Kw,
- Lfi, listofreactions, lqd, ltn,
+ Lfi, listofreactions, lqd,
mch, mega, meta, mhName,
- newchemgreekmapping,
- newman, NMR, Nu, Nuc,
- orbital, ortho, ox, OX,
- para, pch, per, pH, phase, photon, pKa, pKb, pOH, pos, positron,
- Pot, prt,
+ NewChemArrow, NewChemBond, NewChemBondAlias,
+ newchemgreekmapping, NewChemIUPAC, NewChemLatin,
+ NewChemNMR, NewChemParticle, NewChemPhase,
+ NewChemReaction, NewChemState,
+ newman, nitrogen, NMR, Nu, Nuc,
+ orbital, ortho, ox, OX, oxygen,
+ para, pch, per, pH, phase, phosphorus, photon, pKa, pKb, pOH, pos,
+ positron, Pot, prt,
Rad, redox, RenewChemArrow, RenewChemBond, renewchemgreekmapping,
RenewChemIUPAC, RenewChemLatin, RenewChemNMR, RenewChemParticle,
RenewChemPhase, RenewChemState,
Sf, scrm, scrp, second, selectchemgreekmapping, setchemformula,
- ShowChemArrow, ShowChemBond, sld, Sod, State,
+ ShowChemArrow, ShowChemBond, sld, Sod, State, sulfur,
trans,
val
} ,
@@ -94,7 +97,7 @@
includegraphics, intertext, IUPAC,
joule,
kilo,
- latin, lewis, Lewis,
+ latin, lewis, Lewis, liquid, ltn,
metre, midrule, milli, mmHg, mole,
nano, nicefrac, num, numrange,
ominus, oplus,
@@ -103,9 +106,10 @@
sample, scriptscriptstyle, setatomsep, setbondoffset, sfrac, shorthandoff,
si, SI, sisetup, square, subsection,
textcolor, textendash, textsuperscript, tiny, toprule,
- upbeta, upeta, upgamma, usetikzlibrary,
+ upbeta, upeta, upgamma, upPhi, upphi, usetikzlibrary,
volt, vphantom, vspave,
- xspace
+ xspace,
+ z@, z@skip
}
}
@@ -283,18 +287,53 @@ used by \chemmacros\ and its \acs{iupac} naming commands.
\pkg{expl3}\footnote{\CTANurl{l3kernel}}~\cite{bnd:l3kernel} and
\pkg{xparse}\footnote{\CTANurl{l3packages}}~\cite{bnd:l3packages}.
+\section{News}
+\subsection{Version~0.2}
+\begin{itemize}
+ \item The mapping ``mathdesign'' has been added. In order to use it you
+ need the \pkg{mathdesign} package~\cite{pkg:mathdesign} loaded.
+ \item The mapping ``fourier'' has been added. In order to use it you
+ need the \pkg{fourier} package~\cite{pkg:fourier} loaded.
+\end{itemize}
+
+\subsection{Version~0.3}
+\begin{itemize}
+ \item The provided macros have been renamed from \cs*{Chem\meta{\ldots}}
+ into \cs*{chem\meta{\ldots}}. The uppercase version still are provided
+ for backwards compatibility but issue a warning message and will be
+ removed some time in the future.
+ \item The commands for defining mappings have gotten an optional argument
+ which allows to specify the name of the package a mapping needs. The
+ command \cs{selectchemgreekmapping} now checks for this package and gives
+ a warning if it doesn't find it loaded.
+ \item The mapping ``textalpha'' has been added. In order to use it you
+ need the \pkg{textalpha} package (part of
+ \bnd{greek-fontenc}~\cite{bnd:greek-fontenc}) loaded.
+ \item If the package \pkg{hyperref}~\cite{pkg:hyperref} is loaded with the
+ \code{unicode} option \emph{and} the \pkg{textalpha} package has been
+ loaded at begin document all the \cs*{chem\meta{\ldots}} commands are let
+ to \pkg{textalpha}'s \cs*{text\meta{\ldots}} commands for the \acs{pdf}
+ bookmarks. This allows Greek letters in the bookmarks without worrying
+ about \cs*{texorpdfstring}.
+\end{itemize}
+
\section{Define Mappings}
\selectchemgreekmapping{default}
\chemgreek's main commands are:
\begin{commands}
- \command{newchemgreekmapping}[\marg{name}\marg{mapping list}]
- Add a new mapping to \chemgreek. Issue an error if it already exists.
- \command{renewchemgreekmapping}[\marg{name}\marg{mapping list}]
- Renew a \chemgreek\ mapping. Issue an error if it doesn't exist yet.
- \command{declarechemgreekmapping}[\marg{name}\marg{mapping list}]
- Declare a new mapping to \chemgreek. If the mapping already exists it
- will be overwritten.
+ \command{newchemgreekmapping}[\oarg{package}\marg{name}\marg{mapping list}]
+ \changedversion{0.3}Add a new mapping to \chemgreek. Issue an error if it
+ already exists. With the optional argument the package that is needed for
+ this mapping can (and should) be specified.
+ \command{renewchemgreekmapping}[\oarg{package}\marg{name}\marg{mapping list}]
+ \changedversion{0.3}Renew a \chemgreek\ mapping. Issue an error if it
+ doesn't exist yet. With the optional argument the package that is needed
+ for this mapping can (and should) be specified.
+ \command{declarechemgreekmapping}[\oarg{package}\marg{name}\marg{mapping list}]
+ \changedversion{0.3}Declare a new mapping to \chemgreek. If the mapping
+ already exists it will be overwritten. With the optional argument the
+ package that is needed for this mapping can (and should) be specified.
\end{commands}
The command \cs{newchemgreekmapping} needs to get a comma separated list of
@@ -335,9 +374,9 @@ mapping is defined:
There \emph{must} be 24 pairs of entries, \ie, a complete mapping! Those
entries are the ones that will be used by the interface macros. For each
-letter a pair \cs{Chemalpha}/\cs{ChemAlpha} is defined that uses the entries
+letter a pair \cs{chemalpha}/\cs{chemAlpha} is defined that uses the entries
of the currently active mapping. That means there are 48 (robust) macros
-defined each beginning with \cs*{Chem...} followed by the lowercase or
+defined each beginning with \cs*{chem...} followed by the lowercase or
uppercase name of the Greek letter.
The default mapping is -- as you can probably see -- \emph{not an upright
@@ -347,7 +386,7 @@ package for example provides a package option that selects one of the
available mappings.
\begin{example}
- Default mapping: \Chemphi\ and \ChemPhi, $\phi$ and $\Phi$
+ Default mapping: \chemphi\ and \chemPhi, $\phi$ and $\Phi$
\end{example}
\section{Predefined Mappings and Selection of a Mapping}
@@ -355,7 +394,7 @@ available mappings.
packages to be loaded. The mapping names and the required packages are listed
in table~\ref{tab:mappings}.
-\begin{table}[hbp]
+\begin{table}
\centering
\begin{tabular}{>{\ttfamily}ll}
\toprule
@@ -365,10 +404,11 @@ in table~\ref{tab:mappings}.
var-default & --- \\
textgreek & \pkg{textgreek} \cite{pkg:textgreek} \\
upgreek & \pkg{upgreek} \cite{pkg:upgreek} \\
- newtx & \pkg{newtxmath} \cite{pkg:newtx} \\
+ newtx & \pkg*{newtxmath} \cite{pkg:newtx} \\
kpfonts & \pkg{kpfonts} \cite{pkg:kpfonts} \\
mathdesign & \pkg{mathdesign} \cite{pkg:mathdesign} \\
fourier & \pkg{fourier} \cite{pkg:fourier} \\
+ textalpha & \pkg{textalpha} \cite{bnd:greek-fontenc} \\
\bottomrule
\end{tabular}
\caption{Predefined mappings.}
@@ -377,27 +417,28 @@ in table~\ref{tab:mappings}.
A mapping is selected and activated with one of the following commands:
\begin{commands}
- \command{activatechemgreekmapping}[\sarg\oarg{options}\marg{name}]
- This commands selects and activates the mapping \meta{name}. If the star
- variant is used also the package \meta{name} is loaded with options
- \meta{options}. This obviously only makes sense if the package name is the
- same as the mapping name. The command can only be used in the document
- preamble.
+ \command{activatechemgreekmapping}[\sarg\marg{name}]
+ \changedversion{0.3}This commands selects and activates the mapping
+ \meta{name}. If the star variant is used also the package of mapping
+ \meta{name} (as defined with \cs{newchemgreekmapping} is loaded. The
+ command can only be used in the document preamble.
\command{selectchemgreekmapping}[\marg{name}]
- This commands selects and activates the mapping \meta{name}. A required
- package has to be loaded additionally the usual way via \cs*{usepackage}
- or \cs*{RequirePackage}. The command can be used throughout the document.
+ \changedversion{0.3}This commands selects and activates the mapping
+ \meta{name}. A required package has to be loaded additionally the usual
+ way via \cs*{usepackage} or \cs*{RequirePackage}. If the package hasn't
+ been loaded a warning will be written to the log. The command can be used
+ throughout the document.
\end{commands}
\begin{example}
% requires the `newtxmath' package to be loaded:
- \Chemphi\ and \ChemPhi, $\phi$ and $\Phi$\par
+ \chemphi\ and \chemPhi, $\phi$ and $\Phi$\par
\selectchemgreekmapping{newtx}
- \Chemphi\ and \ChemPhi, $\upphi$ and $\upPhi$
+ \chemphi\ and \chemPhi, $\upphi$ and $\upPhi$
\end{example}
\section{Changing a Specific Symbol in an Existing Mapping}
-If you should want to change a specifig entry of a specific mapping it would
+If you should want to change a specific entry of a specific mapping it would
be rather tedious to redefine the whole mapping. That is why \chemgreek\
provides a command for that purpose:
\begin{commands}
@@ -410,25 +451,32 @@ provides a command for that purpose:
In order to activate the change you need the (re-) activate the affected
mapping afterwards:
\begin{example}
- \changechemgreeksymbol{default}{lower}{alpha}{xxx}
+ \chemalpha
+ \changechemgreeksymbol{default}{lower}{alpha}{xxx}%
\selectchemgreekmapping{default}
- \Chemalpha
+ \chemalpha
\end{example}
\section{Inspecting a Mapping}
If you want to check if a mapping has been correctly set you can use the
-following command:
+following commands:
\begin{commands}
+ \command{printchemgreekmapping}[\marg{mapping}]
+ \sinceversion{0.3}This will typeset a table (using a simple \code{tabular}
+ environment) with all~48 characters like the one shown in
+ table~\ref{tab:showmapping}.
\command{showchemgreekmapping}[\marg{mapping}]
- This will typeset a table (using a simple \code{tabular} environment) with
- all 48 characters like the one shown in table~\ref{tab:showmapping}.
+ \changedversion{0.3}This command will write information about the
+ definition of all 48~macros for a mapping to the log file.
\end{commands}
-\begin{table}[htbp]
+\begin{table}
\centering
- \showchemgreekmapping{newtx}
- \caption{A demonstration of the \cs*{showchemgreekmapping} command.}
+ \printchemgreekmapping{newtx}
+ \caption{A demonstration of the \cs*{printchemgreekmapping} command.}
\label{tab:showmapping}
\end{table}
+\clearpage
+
\end{document}