summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-04-23 23:29:20 +0000
committerKarl Berry <karl@freefriends.org>2012-04-23 23:29:20 +0000
commit1c5353c95c3d07498b0716382cd0b00489296e65 (patch)
tree4a04d526895cca00b0b87e6bcc5fc418660d1478 /Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
parent21a6bff8ac44bf57328c1902f823186f47ff8a25 (diff)
chemnum (23apr12)
git-svn-id: svn://tug.org/texlive/trunk@26107 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex72
1 files changed, 44 insertions, 28 deletions
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
index 788912e05e4..07c22f7b660 100644
--- a/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
+++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_en.tex
@@ -3,7 +3,7 @@
% - a comprehensive approach for the numbering of chemical compounds
% -----------------------------------------------------------------------------
% - Clemens NIEDERBERGER
-% - 2012/04/15
+% - 2012/04/20
% - contact@mychemistry.eu
% -----------------------------------------------------------------------------
% - If you have any ideas, questions, suggestions or bugs to report, please
@@ -41,13 +41,13 @@
@m,arrow,bf,ch,chemfig,chemname,cmpd,cmpdinit,cmpdref,cmpdreset,cmpdsetup,
CNlabel,CNlabelnoref,CNref,CNlabelsub,CNlabelsubnoref,CNrefsub,
declarecompound,color,compound,compoundprefix,compoundsuffix,fcite,
- includegraphics,midrule,penalty,renewcommand,schemename,schemestart,
+ includegraphics,midrule,penalty,psfrag,renewcommand,schemename,schemestart,
schemestop,selectlanguage,setarrowoffset,setatomsep,setcompoundsep,
setdoublesep,section,sf,subsection,subsubsection,tableofcontents,
texorpdfstring,textcolor,theffbibliography,uline}
\usepackage[ngerman,german,naustrian,austrian,english,british,american,canadian,frenchb,canadien,spanish,italian]{babel}
-\usepackage{textcomp,longtable,tabu,booktabs,chemscheme}
+\usepackage{textcomp,longtable,tabu,booktabs,chemscheme,hologo}
\usepackage[iupac=strict]{chemmacros}
\DeclareChemIUPAC\a{\textalpha}
\DeclareChemIUPAC\b{\textbeta}
@@ -108,6 +108,7 @@
\chemnum also needs the packages \paket{etoolbox}, \paket{psfrag} and either \paket{textgreek} or \paket{bm}, see section \ref{sec:package_options}.
\section{News and a word of apology}
+\subsection{Version 0.4}
In the update to v0.4 there have been some changes made with the options. There are a few new ones and some of the old ones got new names. They now have consistent names which in my opinion better reflect their function. This means that your documents set with an older version of \chemnum might not compile any more without errors. I am sorry for that. \chemnum still is actively developped. Once it reaches v1.0, such changes won't be made any more\footnote{Or only in absolutely necessary cases.}.
These options have new names:
@@ -140,6 +141,11 @@ Also new is the way how lists and ranges of sublabels are input. The option \key
Then there is the possibility of creating hyperlinked labels together with the package \paket{hyperref}, see section \ref{sec:hyperref}.
+\subsection{Version 0.5}
+With v0.5 there is a new option \key{ref-pos} which allows to change the positioning options of the \cmd{psfrag} command that is used by the \cmd{cmpdref} command internally, see p.\,\pageref{ssec:marker_in_bildern}.
+
+\achtung{The optional arguments of \cmd{cmpdref} have changed their order, see p.\,\pageref{ssec:cmpdref}!}
+
\section{Package options}\label{sec:package_options}\secidx{Package options}
\chemnum has one package option.
\begin{beschreibung}
@@ -370,7 +376,7 @@ This will give you a warning in these cases, too.
\subsection{Error instead of warning}
If you want \chemnum to produce an error instead of a warning when you use an unititialized label name, you can use \cmd{cmpdinit} like this:
\begin{beschreibung}
- \Befehl{cmpdinit}[\key{init-strict}{true}]{<comma separated list of label names>}
+ \Befehl{cmpdinit}[\key{init-strict}{true}]{<comma separated list ...>}
\end{beschreibung}
A usage of \key{init-strict}{false} would be the usage without optional argument. Of course the *-version has the same option.
@@ -378,7 +384,7 @@ With \key{init-strict}{true} the \LaTeX\ run will be aborted with a correspondin
Of course you can use \cmd{cmpdinit} with both options
\begin{beschreibung}
- \Befehl{cmpdinit}[\key{init-strict}{true}, \key{init-sub}{true}]{<comma separated list of label names>}
+ \Befehl{cmpdinit}[\key{init-strict}{true}, \key{init-sub}{true}]{<comma separated list ...>}
\end{beschreibung}
or use \cmd{cmpdsetup}, see section \ref{sec:cmpdsetup}.
@@ -460,13 +466,15 @@ This also works, of the floating environment is placed before the code, for inst
\subsection{Schemes created by external programs}\label{ssec:cmpdref}\secidx{Schemes by external programs}
If you create your schemes by external programs like for \eg \prog{ChemDraw} or \prog{Marvin\-Sketch}, and want to use \chemnum with them as well, you can use this command:
\begin{beschreibung}
- \Befehl{cmpdref}[<options>]\oa[<tag>]\ma{<label name>}
+ \Befehl{cmpdref}[<options>]\oa{<tag>}\ma{<label name>}
\end{beschreibung}
+\achtung{With v0.5 the order of the optional arguments has changed!}
+
This command is inspired by the \verb=\schemeref= command from the package \paket{chemscheme}. It works in a very similar way. You create the scheme and save it with temporary labels as an \verb=eps= file.
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
- \includegraphics{scheme-tmp}
+ \includegraphics{scheme-tmp.ps}
\caption{Scheme with temporary markers.}
\end{scheme}
\begin{scheme}[ht]
@@ -474,11 +482,11 @@ This command is inspired by the \verb=\schemeref= command from the package \pake
\cmpdref{Alc} % replaces TMP1
\cmpdref{EtherBr} % replaces TMP2
% \cmpdref{third} would replace TMP3
- \includegraphics{scheme-tmp}
+ \includegraphics{scheme-tmp.ps}
\caption{Scheme with automated labels.}
\end{scheme}
\end{beispiel}
-So you nummerate the compounds with \textsf{TMP1}, \textsf{TMP2} \etc These markers will then be replaced with the corresponding labels. Like \paket{chemscheme} \chemnum uses the \verb=\psfrag= command of the \paket{psfrag} package to do that. This means you have to either compile via \prog{latex}, \prog{dvips}, \prog{ps2pdf}, or for instance use the package \paket{auto-pst-pdf} to be able to use \prog{pdflatex}.
+So you nummerate the compounds with \textsf{TMP1}, \textsf{TMP2} \etc These markers will then be replaced with the corresponding labels. Like \paket{chemscheme} \chemnum uses the \cmd{psfrag} command of the \paket{psfrag} package to do that. This means you have to either compile via \prog{latex}, \prog{dvips}, \prog{ps2pdf}, or for instance use the package \paket{auto-pst-pdf} to be able to use \hologo{pdfLaTeX}. It doesn't work with \hologo{XeLaTeX}, neither probably with \hologo{LuaLaTeX}, the author didn't test that, though.
In each case it is important that the marker is saved as \emph{text} in the \verb=eps= file.
@@ -486,9 +494,10 @@ You can customize the labels with the options presented in section \ref{sec:cmpd
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
- \cmpdref[cmpd-style=\bf\sf\textcolor{green}]{Alc} % replaces TMP1
- \cmpdref[cmpd-style=\bf\sf\textcolor{green}]{EtherBr} % replaces TMP2
- \includegraphics{scheme-tmp}
+ \cmpdsetup{ref-style=\color{green}}
+ \cmpdref{Alc} % replaces TMP1
+ \cmpdref{EtherBr} % replaces TMP2
+ \includegraphics{scheme-tmp.ps}
\caption{Scheme with automated labels.}
\end{scheme}
\end{beispiel}
@@ -497,15 +506,15 @@ You also can replace arbitrary text by using the second optional argument.
\begin{beispiel}[code and float]
\begin{scheme}[ht]
\centering
- \includegraphics{scheme-bla}
+ \includegraphics{scheme-bla.ps}
\caption{Scheme with arbitrary markers.}
\end{scheme}
\begin{scheme}[ht]
\centering
- \cmpdref[][blah]{Alc}
- \cmpdref[][blub]{EtherBr}
+ \cmpdref[blah]{Alc}
+ \cmpdref[blub]{EtherBr}
% \cmpdref{third} would replace TMP1
- \includegraphics{scheme-bla}
+ \includegraphics{scheme-bla.ps}
\caption{Scheme with explicitly placed labels.}
\end{scheme}
\end{beispiel}
@@ -516,7 +525,7 @@ Of course sublabels work in the known way:
\centering
\cmpdref{cpd.red}
\cmpdref{cpd.ox}
- \includegraphics{scheme-tmp}
+ \includegraphics{scheme-tmp.ps}
\caption{Scheme with automated labels and sublabels.}
\end{scheme}
\end{beispiel}
@@ -625,12 +634,15 @@ one can choose the label associated with the label name.
\end{beispiel}
\secidx*{Own labels}
-\subsection{Own markers in images}\secidx{Own markers in images}
-If you don't want to use \code{TMP} as temporary markers for \cmd{cmpdref} (see page \pageref{ssec:cmpdref}), you can change this. For example into \code{tmp}: \label{key:key-tag}
-\begin{beispiel}[code only]
- \cmpdsetup{ref-marker = tmp}
-\end{beispiel}
-\secidx*{Own markers in images}
+\subsection{Markers in images}\secidx{Markers in images}\label{ssec:marker_in_bildern}
+There are several options that affect labels in external images placed with \cmd{cmpdref}.
+\begin{beschreibung}
+ \option{ref-marker}{<marker>} This changes the default marker that is to be replaced. Default = \code{TMP}
+ \option{ref-pos}{\{<tex-pos>\}\{<ps-pos>\}} Default = \code{bb}
+ \option{ref-style}{<style>} change the format of the labels in external schemes. Default = \verb=\sffamily=
+\end{beschreibung}
+With \key{ref-pos} you can change the default way how \cmd{cmpdref} places the label. The command \cmd{psfrag} that is used internally has two options for that. The first one determines the position of the \TeX-replacement, the second one how it is placed in the box from the marker that is replaced. For details please refer to the documentation of \paket{psfrag}.
+\secidx*{Markers in images}
\subsection{Counter}\label{ssec:counter}\secidx{Counter}
You can change the format of the counters, too, if you like.
@@ -908,16 +920,19 @@ If you choose the language manually, please note that this resets the default be
\secidx*{Harvard comma}\secidx*{Language support}
\section{Overview}
-\subsection{Keys}\label{ssec:keys_uebersicht}
+\subsection{Options}\label{ssec:keys_uebersicht}
In this section all options are listed.
\begin{center}
\label{tab:keys}
\begin{longtabu*}{>{\ttfamily\color{key}}l>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule
- \normalfont\bfseries\normalcolor key & \normalfont\bfseries default & \normalfont\bfseries predefined & \normalfont\bfseries type \\\midrule
+ \normalfont\bfseries\normalcolor option &
+ \normalfont\bfseries default &
+ \normalfont\bfseries predefined &
+ \normalfont\bfseries type \\\midrule
cmpd-style & & & macro \\
cmpd-weight & bold & bold & choice \\
cmpd-label & & & literal \\
- cmpd-delim$^\mathrm{a}$ & () & & literal \\
+ cmpd-delim\color{black}$^\mathrm{a}$ & () & & literal \\
cmpd-odelim & & & literal \\
cmpd-cdelim & & & literal \\
cmpd-prefix & & & literal \\
@@ -933,7 +948,7 @@ In this section all options are listed.
sublist-input-sep & , & , & literal \\
subrange-output-sep & -- & -- & literal \\
subrange-input-sep & .. & .. & literal \\\midrule
- list-delim$^\mathrm{a}$ & () & & literal \\
+ list-delim\color{black}$^\mathrm{a}$ & () & & literal \\
list-odelim & & & literal \\
list-cdelim & & & literal \\
list-prefix & & & literal \\
@@ -944,7 +959,8 @@ In this section all options are listed.
list-last-sep & and$^\mathrm{c}$ & & literal \\
list-serial-comma & true & true$^\mathrm{c}$ & boolean \\\midrule
ref-tag & TMP & TMP & literal \\
- ref-style & & \verb=\sffamily= & macro \\\midrule
+ ref-style & & \verb=\sffamily= & macro \\
+ ref-pos\color{black}$^\mathrm{a}$ & bb & bb & literal \\\midrule
init-strict & true & false & boolean \\
init-sub & true & false & boolean \\
init-input-sep & , & , & literal \\\midrule