diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex | 167 |
1 files changed, 84 insertions, 83 deletions
diff --git a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex index 290da2d63b4..aadee3048bc 100644 --- a/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex +++ b/Master/texmf-dist/doc/latex/chemnum/chemnum_doc_en.tex @@ -3,7 +3,7 @@ % - a comprehensive approach for the numbering of chemical compounds - % % ------------------------------------------------------------------------------------- % % - Clemens NIEDERBERGER - % -% - 2011/12/08 - % +% - 2012/02/26 - % % ------------------------------------------------------------------------------------- % % - http://www.mychemistry.eu/ - % % - contact@mychemistry.eu - % @@ -11,7 +11,7 @@ % - If you have any ideas, questions, suggestions or bugs to report, please feel free - % % - to contact me. - % % ------------------------------------------------------------------------------------- % -% - Copyright 2011 Clemens Niederberger - % +% - Copyright 2011-2012 Clemens Niederberger - % % - - % % - This work may be distributed and/or modified under the - % % - conditions of the LaTeX Project Public License, either version 1.3 - % @@ -34,16 +34,14 @@ \usepackage[T1]{fontenc} \usepackage[utf8]{inputenx} \usepackage[textgreek]{chemnum} -\usepackage{textcomp,microtype,libertine,url,xspace,longtable,tabu,booktabs,chemscheme,makeidx} -\usepackage[version=3]{mhchem} +\usepackage{textcomp,microtype,libertine,url,xspace,longtable,tabu,booktabs,chemscheme,makeidx,multicol} +\usepackage[scaled=.95]{inconsolata} +\usepackage[iupac=strict]{chemmacros} + \DeclareChemIUPAC\a{\textalpha} + \DeclareChemIUPAC\b{\textbeta} +\usepackage{chemfig} \usepackage[normalem]{ulem} -\usepackage[dvipsnames]{xcolor} - \colorlet{code}{RawSienna} - \colorlet{shadecolor}{yellow!20} - \definecolor{myblue}{rgb}{0.02,0.04,0.48} - \definecolor{myred}{rgb}{0.65,0.04,0.07} \usepackage[runs=2]{auto-pst-pdf} -\usepackage{chemfig,chemmacros} \input{chemnum-codehelper} \begin{filecontents}{index_en.ist} @@ -60,28 +58,29 @@ \end{filecontents} \usepackage{hyperref} - \hypersetup{colorlinks=true, - allcolors=myblue, - plainpages=false, - bookmarksopen=true, - bookmarksopenlevel=2, - bookmarksnumbered=true, - pdfauthor={Clemens Niederberger}, - pdftitle={chemnum - Manual}, - pdfsubject={Numbering chemical compounds}, - pdfkeywords={chemmnum}, - pdfcreator={LaTeX} + \hypersetup{colorlinks = true, + allcolors = myblue, + plainpages = false, + bookmarksopen = true, + bookmarksopenlevel = 2, + bookmarksnumbered = true, + pdfauthor = {Clemens Niederberger}, + pdftitle = {chemnum - English documentation}, + pdfsubject = {Numbering chemical compounds}, + pdfkeywords = {chemmnum}, + pdfcreator = {LaTeX} + pdfstartview = FitH } \ExplSyntaxOn \NewDocumentCommand \keyentry { mmm } { \noindent - \textcolor{key}{ \texttt { #1 } } + \textcolor { key } { \texttt { #1 } } \texttt { ~=~#2 } \hfill type:~ \texttt { #3 } - \index { #1 @ \textcolor{key}{ \texttt { #1 } } } + \index { #1 @ \textcolor { key } { \texttt { #1 } } } } \ExplSyntaxOff @@ -107,7 +106,7 @@ \vskip.5cm \large Clemens \textsc{Niederberger} \vskip.25cm - \normalsize\url{http://www.mychemistry.eu/}\\ + \normalsize\url{https://bitbucket.org/cgnieder/chemnum/}\\ \href{mailto:contact@mychemistry.eu}{contact@mychemistry.eu} \begin{center} \Large\color{myblue} \CNinfo \\[16pt] @@ -130,11 +129,13 @@ \arrow(@chainlabel--){0}[,2.5] \normalsize\cmpd[cmpd-delim]{glucose.beta} \arrow(@chainlabel--){0}[180,2.3] \normalsize\cmpd[cmpd-delim]{glucose.alpha} \schemestop - \caption{In a solution the \textalpha- and the \textbeta-anomer of \Dfi-glucose \cmpd[list-delim]{glucose.alpha,glucose.beta} are in equilibrium via the open-chain form \cmpd[cmpd-delim]{glucose.chain}.} + \caption{In a solution the \a- and the \b-anomer of \D-glucose \cmpd[list-delim]{glucose.alpha,glucose.beta} are in equilibrium via the open-chain form \cmpd[cmpd-delim]{glucose.chain}.} \end{scheme} \end{titlepage} \cmpdreset -\tableofcontents +\begin{multicols}{2} + \tableofcontents +\end{multicols} \section{A very short readme} \chemnum \CNversion underlies the \LaTeX\ Project Public License Version 1.3 or later.\newline(\url{http://www.latex-project.org/lppl.txt}) @@ -323,15 +324,15 @@ If one uses label with sublabel ranges, one might want to use \emph{only} the su \keyentry{sub-only}{true/false}{boolean} \end{framed} \begin{beispiel} - % uses packages `chemfig', `mhchem' and `booktabs' + % uses packages `chemfig', `chemmacros' and `booktabs' \cmpd*{benzene.H,benzene.Me,benzene.OH,benzene.NH2} \chemname{\chemfig{*6(=-=-(-R)=-)}}{\cmpd[cmpd-all]{benzene}} \begin{tabular}{lll} - & \ce{{}-R} & Name \\\midrule - \cmpd[sub-only]{benzene.H} & \ce{{}-H} & Benzene \\ - \cmpd[sub-only]{benzene.Me} & \ce{{}-CH3} & Toluene \\ - \cmpd[sub-only]{benzene.OH} & \ce{{}-OH} & Phenol \\ - \cmpd[sub-only]{benzene.NH2} & \ce{{}-NH2} & Phenylamine (Aniline) + & \ch{-R} & Name \\\midrule + \cmpd[sub-only]{benzene.H} & \ch{-H} & Benzene \\ + \cmpd[sub-only]{benzene.Me} & \ch{-CH3} & Toluene \\ + \cmpd[sub-only]{benzene.OH} & \ch{-OH} & Phenol \\ + \cmpd[sub-only]{benzene.NH2} & \ch{-NH2} & Phenylamine (Aniline) \end{tabular} \end{beispiel} @@ -913,7 +914,7 @@ A small example how a customized input could look like: \section{Language support}\label{sec:language_support}\secidx{Language support} \subsection{Cooperation with \textsf{babel}} -\chemnum supports the language choice made with the \paket{babel} package for a number of languages. This is done with the \lstinline=\translate= command of the \paket*{translator} package, if it is available. If \paket*{translator} cannot be loaded, language support must be done manually, see section \ref{sssec:last-sep}. Manual language settings can of course still be done, if \paket*{translator} has been loaded. +\chemnum supports the language choice made with the \paket{babel} package for a number of languages. This is done with the \lstinline=\translate= command of the \paket*{translator} package, if it is available. If \paket*{translator} cannot be loaded, language support must be done manually, see section \ref{sssec:last-sep}. Manual language settings can of course still be done if \paket*{translator} has been loaded. \begin{beispiel} \selectlanguage{ngerman}DE: \cmpd{r,s,t}\\ \selectlanguage{english}EN: \cmpd{r,s,t}\\ @@ -952,45 +953,45 @@ If you choose the language manually, please note that this resets the default be In this section all keys are listed. \begin{center} \label{tab:keys} - \begin{longtabu*}{l>{\ttfamily}l>{\ttfamily}l>{\ttfamily}l}\toprule - \bfseries key & \normalfont\bfseries default & \normalfont\bfseries predefined & \normalfont\bfseries type \\\midrule - \key{cmpd-style} & & & macro \\ - \key{cmpd-weight} & bold & bold & choice \\ - \key{cmpd-label} & & & literal \\ - \key{cmpd-delim}$^\mathrm{a}$ & () & & literal \\ - \key{cmpd-odelim} & & & literal \\ - \key{cmpd-cdelim} & & & literal \\ - \key{cmpd-prefix} & & & literal \\ - \key{cmpd-suffix} & & & literal \\ - \key{cmpd-space} & \lstinline=\penalty\@m\ = & \lstinline=\penalty\@m\ = & literal \\ - \key{cmpd-counter} & arabic & arabic & choice \\ - \key{cmpd-all} & true & false & boolean \\\midrule - \key{sub-only} & true & false & boolean \\ - \key{sub-counter} & alph & alph & choice \\ - \key{sub-output-sep} & & , & literal \\ - \key{sub-input-sep} & . & . & literal \\ - \key{sublist-output-sep} & , & , & literal \\ - \key{sublist-input-sep} & , & , & literal \\ - \key{subrange-output-sep} & -- & -- & literal \\ - \key{subrange-input-sep} & .. & .. & literal \\\midrule - \key{list-delim}$^\mathrm{a}$ & () & & literal \\ - \key{list-odelim} & & & literal \\ - \key{list-cdelim} & & & literal \\ - \key{list-prefix} & & & literal \\ - \key{list-suffix} & & & literal \\ - \key{list-input-sep} & , & , & literal \\ - \key{list-output-sep} & , & , & literal \\ - \key{list-lang} & US & US$^\mathrm{b}$ & choice \\ - \key{list-last-sep} & and$^\mathrm{c}$ & & literal \\ - \key{list-serial-comma} & true & true$^\mathrm{c}$ & boolean \\\midrule - \key{ref-tag} & TMP & TMP & literal \\ - \key{ref-style} & & \lstinline=\sffamily= & macro \\\midrule - \key{init-strict} & true & false & boolean \\ - \key{init-sub} & true & false & boolean \\ - \key{init-input-sep} & , & , & literal \\\midrule - \key{hyper-use} & true & false & boolean \\ - \key{hyper-target} & & & literal \\ - \key{hyper-link} & & & literal \\\bottomrule + \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 + cmpd-style & & & macro \\ + cmpd-weight & bold & bold & choice \\ + cmpd-label & & & literal \\ + cmpd-delim$^\mathrm{a}$ & () & & literal \\ + cmpd-odelim & & & literal \\ + cmpd-cdelim & & & literal \\ + cmpd-prefix & & & literal \\ + cmpd-suffix & & & literal \\ + cmpd-space & \lstinline=\penalty\@m\ = & \lstinline=\penalty\@m\ = & literal \\ + cmpd-counter & arabic & arabic & choice \\ + cmpd-all & true & false & boolean \\\midrule + sub-only & true & false & boolean \\ + sub-counter & alph & alph & choice \\ + sub-output-sep & & , & literal \\ + sub-input-sep & . & . & literal \\ + sublist-output-sep & , & , & literal \\ + sublist-input-sep & , & , & literal \\ + subrange-output-sep & -- & -- & literal \\ + subrange-input-sep & .. & .. & literal \\\midrule + list-delim$^\mathrm{a}$ & () & & literal \\ + list-odelim & & & literal \\ + list-cdelim & & & literal \\ + list-prefix & & & literal \\ + list-suffix & & & literal \\ + list-input-sep & , & , & literal \\ + list-output-sep & , & , & literal \\ + list-lang & US & US$^\mathrm{b}$ & choice \\ + list-last-sep & and$^\mathrm{c}$ & & literal \\ + list-serial-comma & true & true$^\mathrm{c}$ & boolean \\\midrule + ref-tag & TMP & TMP & literal \\ + ref-style & & \lstinline=\sffamily= & macro \\\midrule + init-strict & true & false & boolean \\ + init-sub & true & false & boolean \\ + init-input-sep & , & , & literal \\\midrule + hyper-use & true & false & boolean \\ + hyper-target & & & literal \\ + hyper-link & & & literal \\\bottomrule \end{longtabu*} \setlength\extrarowheight{-1pt} \begin{tabular}{>{\footnotesize}r>{\footnotesize\raggedright}p{.7\linewidth}} @@ -1005,17 +1006,17 @@ In this section all commands provided by \chemnum as well as their variants are \begin{center} \label{tab:commands} \begin{tabu*} to \linewidth {X[l]X[p]}\toprule - \bfseries command & \bfseries description \tabularnewline\midrule - \cmd{cmpd}[<keyval>]{<labels>} & basic command, declares and prints labels or lists of labels, see pages \pageref{sec:nummerieren}ff. \tabularnewline - \cmd[cmpda]{cmpd*}{<labels>} & invisible, declares label, see page \pageref{cmd:unsichtbares_label} \tabularnewline - \cmd[cmpdc]{cmpd-}[<keyval>]{<labels>} & without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline - \cmd[cmpdd]{cmpd+-}[<keyval>]{<labels>} & label is read from auxiliary file, see page \pageref{cmd:cmpd_plus} \tabularnewline\midrule - \cmd{cmpdinit}[<keyval>]{<labels>} & initialise and declare labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline - \cmd[cmpdinita]{cmpdinit*}[<keyval>]{<labels>} & initialise labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline\midrule - \cmd{cmpdref}[<keyval>][<marker>]{<label>} & replace temporary markers in \texttt{eps} files by labels, see page \pageref{ssec:cmpdref} \tabularnewline - \cmd[cmpdrefc]{cmpdref-}[<keyval>][<marker>]{<label>} & replace temporary markers in \texttt{eps} files by labels without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule - \cmd{cmpdreset}[<num>] & reset counter, siehe page \pageref{sec:cmpdreset} \tabularnewline\midrule - \cmd{cmpdsetup}{<keyval>} & setup \chemnum, siehe pages \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule + \bfseries command & \bfseries description \tabularnewline\midrule + \cmd*{cmpd}[<keyval>]{<labels>} & basic command, declares and prints labels or lists of labels, see pages \pageref{sec:nummerieren}ff. \tabularnewline + \cmd*[cmpda]{cmpd*}{<labels>} & invisible, declares label, see page \pageref{cmd:unsichtbares_label} \tabularnewline + \cmd*[cmpdc]{cmpd-}[<keyval>]{<labels>} & without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline + \cmd*[cmpdd]{cmpd+-}[<keyval>]{<labels>} & label is read from auxiliary file, see page \pageref{cmd:cmpd_plus} \tabularnewline\midrule + \cmd*{cmpdinit}[<keyval>]{<labels>} & initialise and declare labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline + \cmd*[cmpdinita]{cmpdinit*}[<keyval>]{<labels>} & initialise labels, see pages \pageref{sec:cmpdinit}f. \tabularnewline\midrule + \cmd*{cmpdref}[<keyval>][<marker>]{<label>} & replace temporary markers in \texttt{eps} files by labels, see page \pageref{ssec:cmpdref} \tabularnewline + \cmd*[cmpdrefc]{cmpdref-}[<keyval>][<marker>]{<label>} & replace temporary markers in \texttt{eps} files by labels without delimiters, see page \pageref{cmd:ohne_begrenzer} \tabularnewline\midrule + \cmd*{cmpdreset}[<num>] & reset counter, siehe page \pageref{sec:cmpdreset} \tabularnewline\midrule + \cmd*{cmpdsetup}{<keyval>} & setup \chemnum, siehe pages \pageref{sec:cmpdsetup}ff. \tabularnewline\bottomrule \end{tabu*} \end{center} |