diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/enotez/enotez_en.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/enotez/enotez_en.tex | 66 |
1 files changed, 21 insertions, 45 deletions
diff --git a/Master/texmf-dist/doc/latex/enotez/enotez_en.tex b/Master/texmf-dist/doc/latex/enotez/enotez_en.tex index 85cf03b688d..33d0149b381 100644 --- a/Master/texmf-dist/doc/latex/enotez/enotez_en.tex +++ b/Master/texmf-dist/doc/latex/enotez/enotez_en.tex @@ -12,7 +12,7 @@ % Web: http://www.mychemistry.eu/forums/forum/enotez/ % E-Mail: contact@mychemistry.eu % -------------------------------------------------------------------------- -% Copyright 2012-2017 Clemens Niederberger +% Copyright 2012--2019 Clemens Niederberger % % This work may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.3 @@ -116,11 +116,6 @@ features of \enotez\ is a split list of endnotes in which the notes are automatically separated by the sections or chapters they were set in, see section~\ref{sec:split} for more information. -As an aside: \enotez\ is nicely compatible with the \pkg{fnpct} -package~\cite{pkg:fnpct}. Version~0.2j or newer of \pkg{fnpct} automatically -detects \enotez\ and adapts the \cs{endnote} command. - - \section{Usage} \subsection{Placing the Notes} The usage is simple: use \cs{endnote} in the text where you want to place the @@ -132,24 +127,17 @@ note mark. \sinceversion{0.9}Add an endnotemark. \command{endnotetext}[\marg{text}] \sinceversion{0.9}Add text to an endnote placed with \cs{endnotemark}. + % \command{refendnote}[\marg{label name}] + % \sinceversion{0.10}This command can be used to create an endnote mark by + % referencing an earlier endnote which has been marked with \cs*{label}. \end{commands} \begin{example} This is some text.\endnote{With an endnote.} \end{example} There's not really much more to it. It is possible to add a custom mark by -using the optional argument but that shouldn't be needed too often. -% \cs{endnote} works fine inside tables, minipages, floats and -% captions\footnote{This has been tested with the standard classes, -% \cls{memoir}, and the \cls{KOMA-Script} classes, with and without the -% \pkg*{caption} package. If you're using another package that redefines -% \cs*{caption} or are using another class it might not work. Before you -% place a note in a caption you should re-think the idea anyway.}. -Endnotes +using the optional argument but that shouldn't be needed too often. Endnotes can also be nested. -% Since this functionality seemed making a pair -% \cs{endnotemark}/\cs{endnotetext} superfluous they are \emph{not} defined by -% \enotez. \begin{example} This is some text.\endnote{With another endnote.\endnote{This is a nested\endnote{And another level deeper\ldots} endnote!}} @@ -162,27 +150,9 @@ The marks of the endnotes in the running text are printed through the command contains the current mark which is preceded by \cs{enmarkstyle}. Both of these commands can be redefined of course to adapt to custom settings. This can also be done using options, see section~\ref{sec:options}. The mark of -the endnote that has been set last is stored in % \cs{theendnote} and in +the endnote that has been set last is stored in \verbcode+\@currentlabel+.\sinceversion{0.6} -% This could be used to define a command which writes a mark: -% \begin{example} -% % we cannot use \newcommand -- the command starts with \end... -% \makeatletter -% \def\endnotemark{\@ifnextchar[{\@endnotemark}{\@endnotemark[\theendnote]}} -% \def\@endnotemark[#1]{\enotezwritemark{\enmarkstyle#1}} -% \makeatother -% Text\endnotemark -% \end{example} -% Please note that this definition \emph{does not} step the endnote counter but -% either refers to the last number (no optional argument) or uses the one -% provided in the optional argument. - -% \makeatletter -% \def\endnotemark{\@ifnextchar[{\@endnotemark}{\@endnotemark[\theendnote]}} -% \def\@endnotemark[#1]{\enotezwritemark{\enmarkstyle#1}} -% \makeatother - Endnotes can also be labelled and later be referred to: \begin{example} The next endnote\endnote{This endnote gets a label.}\label{en:test} has @@ -197,11 +167,12 @@ The notes are printed by using the command \cs{printendnotes}. Print the list of endnotes. \meta{style} is one of the instances explained in section~\ref{sec:customizing_the_list}. \end{commands} -If used without argument it prints all notes set so far with -\cs{endnote}. The current list will then be cleared. All endnotes set after -it are stored again for the next usage of \cs{printendnotes}. The starred -version will print \emph{all} endnotes but shouldn't be used more than once if -you have nested endnotes. +If used without argument it prints all notes set so far with \cs{endnote}. The +current list will then be cleared. All endnotes set after it are stored again +for the next usage of \cs{printendnotes}. The starred version will print +\emph{all} endnotes but shouldn't be used more than once if you have nested +endnotes. \emph{Unfortunately the starred version also does not work together + with the \option{split} option.} It may take several compilation runs until all notes are printed correctly. In a first run they are written to the \code{aux} file. In the second run @@ -244,8 +215,9 @@ an option, see section~\ref{sec:options}. \section{Options}\label{sec:options} \subsection{Package Options} \enotez\ has a few package options which should be pretty self-explanatory. -They can be set either as package options with -\cs*{usepackage}\oarg{options}\Marg{enotez} or with the setup command. +They can be set with the setup command\footnote{Earlier versions allowed to + use them as package options. This is not possible any more since + version~0.10.}. \begin{commands} \command{setenotez}[\marg{options}] Setup command for setting \enotez' options. @@ -272,8 +244,12 @@ They can be set either as package options with \sinceversion{0.7}If set to \code{true} and \pkg{hyperref} has been loaded backlinks from the notes in the list to the marks in the text are added. - \keychoice{totoc}{section,chapter,false}\Default{false}\label{key:totoc} - Add an entry to the table of contents. + \keychoice{totoc}{subsection,section,chapter,part,\default{auto},false}% + \Default{false}\label{key:totoc} + Add\changedversion{0.10} an entry to the table of contents. When used + with no value the value \code{auto} is chosen and \enotez\ tries to detect + the correct level by itself. If this fails the option will be ignored and + a warning is written to the log file. \keyval{list-heading}{sectioning command including argument} You can use this option to manually set the list heading command, \eg, \keyis{list-heading}{\cs{chapter}\Marg{\#1}} for a numbered heading. The |