enotez (18mar13)

git-svn-id: svn://tug.org/texlive/trunk@29422 c570f23f-e606-0410-a88d-b1316a301751

4 files changed, 132 insertions, 58 deletions

diff --git a/Master/texmf-dist/doc/latex/enotez/README b/Master/texmf-dist/doc/latex/enotez/README
index b31236b513e..1f2948b06b6 100644
--- a/Master/texmf-dist/doc/latex/enotez/README
+++ b/Master/texmf-dist/doc/latex/enotez/README
@@ -1,15 +1,15 @@
 --------------------------------------------------------------------------
-the ENOTEZ package
+the ENOTEZ package v0.5a
 
   Endnotes for LaTeX2e
 
-2012/12/30 v0.4
+2013/03/18
 --------------------------------------------------------------------------
 Clemens Niederberger
 Web:    https://bitbucket.org/cgnieder/enotez/
 E-Mail: contact@mychemistry.eu
 --------------------------------------------------------------------------
-Copyright 2012 Clemens Niederberger
+Copyright 2012-2013 Clemens Niederberger
 
 This work may be distributed and/or modified under the
 conditions of the LaTeX Project Public License, either version 1.3
diff --git a/Master/texmf-dist/doc/latex/enotez/enotez_en.pdf b/Master/texmf-dist/doc/latex/enotez/enotez_en.pdf
index d12c08660cd..4fc79487da8 100644
--- a/Master/texmf-dist/doc/latex/enotez/enotez_en.pdf
+++ b/Master/texmf-dist/doc/latex/enotez/enotez_en.pdf
diff --git a/Master/texmf-dist/doc/latex/enotez/enotez_en.tex b/Master/texmf-dist/doc/latex/enotez/enotez_en.tex
index a949b6cae48..f250b918129 100644
--- a/Master/texmf-dist/doc/latex/enotez/enotez_en.tex
+++ b/Master/texmf-dist/doc/latex/enotez/enotez_en.tex
@@ -1,7 +1,7 @@
 % arara: pdflatex
-% arara: makeindex: { sort: true, style: enotez_en.ist }
-% arara: biber
-% arara: pdflatex
+% !arara: makeindex: { sort: true, style: enotez_en.ist }
+% !arara: biber
+% !arara: pdflatex
 % arara: pdflatex
 % --------------------------------------------------------------------------
 % the ENOTEZ package
@@ -13,7 +13,7 @@
 % Web:    https://bitbucket.org/cgnieder/enotez/
 % E-Mail: contact@mychemistry.eu
 % --------------------------------------------------------------------------
-% Copyright 2011-2012 Clemens Niederberger
+% Copyright 2011-2013 Clemens Niederberger
 % 
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3
@@ -37,7 +37,7 @@
 \docsetup{
   pkg      = enotez ,
   code-box = {
-    backgroundcolor  = gray!7!white ,
+    backgroundcolor  = gray!3!white ,
     skipbelow        = .6\baselineskip plus .5ex minus .5ex ,
     skipabove        = .6\baselineskip plus .5ex minus .5ex ,
     roundcorner      = 3pt ,
@@ -69,7 +69,8 @@
 \DeclareInstance{enotez-list}{addsec}{paragraph}{heading=\addsec{#1}}
 
 % Layout:
-% \usepackage{libertine}
+\usepackage{libertinehologopatch}
+
 \cnpkgusecolorscheme{friendly}
 \renewcommand*\othersectionlevelsformat[3]{%
   \textcolor{main}{#3\autodot}\enskip}
@@ -81,18 +82,15 @@
 \ChangeEmph{[}[,.02em]{]}[.055em,-.08em]
 \ChangeEmph{(}[-.01em,.04em]{)}[.04em,-.05em]
 
-\ExplSyntaxOn
-\NewDocumentCommand \Default {g}
-  {
-    \hfill\llap
-      {
-        \IfNoValueTF { #1 }
-          {(initially~empty)}
-          {Default:~\code{#1}}
-      }
-    \newline
-  }
-\ExplSyntaxOff
+\newcommand*\Default[1]{%
+  \hfill\llap
+    {%
+      \ifblank{#1}%
+        {(initially~empty)}%
+        {Default:~\code{#1}}%
+    }%
+  \newline
+}
 
 \usepackage[backend=biber,style=alphabetic]{biblatex}
 \addbibresource{\jobname.bib}
@@ -135,24 +133,43 @@
 }
 \end{filecontents*}
 
-\usepackage{makeidx}
+\usepackage{imakeidx}
 \begin{filecontents*}{\jobname.ist}
  heading_prefix "{\\bfseries "
  heading_suffix "\\hfil}\\nopagebreak\n"
  headings_flag  1
- delim_0 "\\dotfill "
- delim_1 "\\dotfill "
- delim_2 "\\dotfill "
- delim_r "\\textendash"
+ delim_0 "\\dotfill\\hyperpage{"
+ delim_1 "\\dotfill\\hyperpage{"
+ delim_2 "\\dotfill\\hyperpage{"
+ delim_r "}\\textendash\\hyperpage{"
+ delim_t "}"
  suffix_2p "\\nohyperpage{\\,f.}"
  suffix_3p "\\nohyperpage{\\,ff.}"
 \end{filecontents*}
-\makeindex
+\indexsetup{noclearpage,othercode=\footnotesize}
+\makeindex[options={-s \jobname.ist},intoc,columns=3]
 
 \usepackage{kantlipsum}
 \usepackage{etoolbox}
 \AtBeginEnvironment{beispiel}{\setfnpct{dont-mess-around}}
 \usepackage{enumitem}
+
+\usepackage{marginnote,ragged2e}
+\makeatletter
+\providecommand*\sinceversion[1]{%
+  \@bsphack
+  \marginnote{%
+    \footnotesize\sffamily\RaggedRight
+    \textcolor{black!75}{Introduced in version~#1}}%
+  \@esphack}
+\providecommand*\changedversion[1]{%
+  \@bsphack
+  \marginnote{%
+    \footnotesize\sffamily\RaggedRight
+    \textcolor{black!75}{Changed in version~#1}}%
+  \@esphack}
+\makeatother
+
 \begin{document}
 
 \section{Licence and Requirements}
@@ -161,10 +178,8 @@ terms of the \LaTeX\ Project Public License, version 1.3 or later
 (\url{http://www.latex-project.org/lppl.txt}). The package has the status
 ``maintained.''
 
-\enotez needs and loads the following packages: \paket{expl3},
-\paket{xparse}, \paket{xtemplate} and \paket{l3keys2e}. If you're using
-\paket{memoir}, a \paket[http://www.ctan.org/pkg/koma-script]{KOMA-Script}
-class or the package \paket{caption} \enotez also needs and loads \paket{etoolbox}.
+\enotez needs and loads the following packages: \paket{expl3}, \paket{xparse},
+\paket{xtemplate}, \paket{l3keys2e}, \paket{xpatch} and \paket{scrlfile}.
 
 \section{Motivation}
 \enotez is a new implementation of endnotes for \LaTeXe\ since the \paket{endnotes}
@@ -176,21 +191,26 @@ best solution in every case\footnote{You have to write the actual notes in the
 preamble or a separate file and reference them in the text.}. It also does not
 allow nested endnotes.
 
+While \enotez worked in tests nicely with the \klasse{memoir} class please keep
+in mind that \klasse{memoir} provides its own endnote mechanism.
+
 \enotez enables nested endnotes properly and has another mechanism of customizing
 the list of endnotes which is easily extendable. One of the main 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 \paket{fnpct} package%
-\footnote{You'll have to use \cmd*{AdaptNote} for the time being, though.}.
+As an aside: \enotez is nicely compatible with the \paket{fnpct} package.
+Version~0.2j or newer of \paket{fnpct} automatically detects \enotez and adapts
+the \cmd{endnote} command.
 
 \section{Usage}
 \subsection{Placing the Notes}
 The usage is simple: use \cmd{endnote} in the text where you want to place the
 note mark.
 \begin{beschreibung}
- \befehl{endnote}[<mark>]{<text>} Add an endnote in the text.
+ \Befehl{endnote}[<mark>]{<text>}\newline
+   Add an endnote in the text.
 \end{beschreibung}
 \begin{beispiel}
  This is some text.\endnote{With an endnote.}
@@ -198,23 +218,27 @@ note mark.
 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. \cmd{endnote}
 works fine inside tables, minipages, floats and captions\footnote{This has been
-tested with the standard classes, \paket*{memoir}, and the \paket*{KOMA-Script}
+tested with the standard classes, \klasse{memoir}, and the \klasse{KOMA-Script}
 classes, with and without the \paket*{caption} package. If you're using another
-package that redefines \cmd*{caption} it might not work.}. Endnotes can also be
-nested. Since that seemed making a pair \cmd{endnotemark}/\cmd{endnotetext}
+package that redefines \cmd*{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 can also be nested.
+
+Since this functionality seemed making a pair \cmd{endnotemark}/\cmd{endnotetext}
 superfluous they are \emph{not} defined by \enotez.
 \begin{beispiel}
  This is some text.\endnote{With another endnote.\endnote{This is a
  nested\endnote{And another level deeper\ldots} endnote!}}
- % uses package `kantlipsum':
+ % uses package `kantlipsum' to produce dummy text:
  Of course you can have several paragraphs\endnote{\kant[1-3]} in an endnote.
 \end{beispiel}
 
 \subsection{Printing the Notes}
 The notes are printed by using the command \cmd{printendnotes}.
 \begin{beschreibung}
- \befehl{printendnotes}*[<style>] Print the list of endnotes. \code{<style>} is
-   one of the instances explained in section~\ref{ssec:customizing_the_list}.
+ \Befehl{printendnotes}*[<style>]\newline
+   Print the list of endnotes. \code{<style>} is one of the instances explained
+   in section~\ref{ssec:customizing_the_list}.
 \end{beschreibung}
 If used without argument it prints all notes set so far with \cmd{endnote}. The
 current list will then be cleared. All endnotes set after it are stored again
@@ -228,17 +252,42 @@ available to \cmd{printendnotes}. If you have nested endnotes they will be writt
 to the \code{aux} file the first time they're printed with \cmd{printendnotes}
 which means you might have to compile your file once more. If you change any of
 the endnotes or add another one you again will need at least two runs, maybe more.
-\enotez tries to warn you in these cases by invoking \LaTeX's warning
-\achtung{\code{Label(s) may have changed. Rerun to get cross-references right.}}
+\enotez tries to warn you in these cases by invoking the warning
+\achtung{\code{Endnotes may have changed. Rerun to get them right.}}
 but may not catch all cases.
 
-\section{Options}
+\enotez provides two commands that allow to set some kinds of preamble and
+postamble to a list, either to every list or only to the next one:
+\begin{beschreibung}
+ \Befehl{AtEveryEndnotesList}{<text>}\newline\sinceversion{0.5}%
+   inserts \code{<text>} between heading and the actual notes every time
+   \cmd{printendnotes} is used.
+ \Befehl{AtNextEndnotesList}{<text>}\newline\sinceversion{0.5}%
+   inserts \code{<text>} between heading and the actual notes the next time
+   \cmd{printendnotes} is used. This overwrites a possible preamble set with
+   \cmd{AtEveryEndnotesList} for this instance of \cmd{printendnotes}.
+ \Befehl{AfterEveryEndnotesList}{<text>}\newline\sinceversion{0.5}%
+   inserts \code{<text>} after the notes list every time \cmd{printendnotes} is
+   used.
+ \Befehl{AfterNextEndnotesList}{<text>}\newline\sinceversion{0.5}%
+   inserts \code{<text>} after the notes list the next time \cmd{printendnotes}
+   is used. This overwrites a possible postamble set with
+   \cmd{AfterEveryEndnotesList} for this instance of \cmd{printendnotes}.
+\end{beschreibung}
+If something is inserted with one of these commands the inserted \code{<text>}
+will be followed by a \cmd{par} and a vertical skip for the preamble. The postambles
+follow a \cmd{par} and a vertical skip. The skips can be set using 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 \verb=\usepackage[<options>]{enotez}=
 or with the setup command.
 \begin{beschreibung}
- \befehl{setenotez}{<options>} Setup command for setting \enotez' options.
+ \Befehl{setenotez}{<options>}\newline
+   Setup command for setting \enotez' options.
  \Option{list-name}{<list name>}\Default{Notes}
    The name of the notes list. This name is used for the heading of the list.
  \Option{reset}{\default{true}|false}\Default{false}
@@ -257,6 +306,14 @@ or with the setup command.
  \Option{list-style}{<style>}\Default{plain}
    Sets the default list style, see section \ref{ssec:customizing_the_list} for
    details.
+ \Option{list-preamble-skip}{<skip>}\Default{\cmd{medskipamount}}\sinceversion{0.5}%
+   Sets the vertical skip (a rubber length) that is inserted if a list preamble
+   is inserted by using either \cmd{AtNextEndnotesList} or \cmd{AtEveryEndnotesList}.
+   It's default is set equal to \cmd{medskipamount}.
+ \Option{list-postamble-skip}{<skip>}\Default{\cmd{medskipamount}}\sinceversion{0.5}%
+   Sets the vertical skip (a rubber length) that is inserted if a list postamble
+   is inserted by using either \cmd{AfterNextEndnotesList} or \cmd{AfterEveryEndnotesList}.
+   It's default is set equal to \cmd{medskipamount}.
 \end{beschreibung}
 
 \subsection{Customizing the List}\label{ssec:customizing_the_list}
@@ -312,7 +369,8 @@ be typeset with \verb=\textsuperscript=. You could now use it like this:
 
 If you wanted superscripted numbers, you could also redefine \cmd{enmark}. 
 \begin{beschreibung}
- \befehl{enmark} is defined like this: \verb=\newcommand*\enmark[1]{#1.}=
+ \Befehl{enmark}\newline
+   is defined like this: \verb=\newcommand*\enmark[1]{#1.}=
 \end{beschreibung}
 
 \subsubsection{The \code{list} Template}
@@ -343,7 +401,8 @@ Again you can define your own instances using whatever list you want, possibly
 one defined with the power of \paket{enumitem}.
 
 \section{Collect Notes Section-wise and Print List Stepwise}\label{sec:split}
-\emph{This feature is experimental and has some limitations}.
+\emph{This feature is experimental and surely has some limitations. Please let
+me know if something doesn't work as expected}.
 
 Not to be misunderstood: you can use \cmd{printendnotes} as often as you like,
 possibly after each section. That is \emph{not} what is meant here. Let's
@@ -365,9 +424,9 @@ You'll need to tell \enotez that you want to split the notes into groups.
    leading backslash. If the option is not used \enotez will choose
    \code{subsection*} for \key*{split}{section} and \code{section*} for
    \key*{split}{chapter}.
- \Option{split-title}{<tokenlist>}\Default{Notes from <name> <ref>}
+ \Option{split-title}{<tokenlist>}\Default{Notes for <name> <ref>}
    The title that will be inserted between the splits. \code{<name>} is replaced
-   by \code{Section} for \key*{split}{section} and \code{Chapter} for
+   by \code{section} for \key*{split}{section} and \code{chapter} for
    \key*{split}{chapter}. \code{<ref>} is replaced by the corresponding
    \cmd*{thesection} or \cmd*{thechapter}.
 \end{beschreibung}
@@ -404,11 +463,17 @@ p~\pageref{key:totoc}) the list title is linked via a \verb=\phantomsection=.
 If \paket{hyperref} is used with \code{hyperfootnotes} set to \code{true} the
 endnote marks are linked to the respective entries in the list.
 
+
+\AtNextEndnotesList{This is an example of a preamble to the list set with
+\cmd{AtNextEndnotesList}.}
+\AfterEveryEndnotesList{\noindent This is an example of a postamble to the list
+set with \cmd{AfterEveryEndnotesList}. Note that it would have started with a
+paragraph indent which was prevented here by using \cmd{noindent}.}
 \printendnotes[addsec]
 
-{\EmbracOff\printbibliography}
+\printbibliography
 
-\setindexpreamble{Section titles are indicated \textbf{bold}, packages
+\indexprologue{\noindent Section titles are indicated \textbf{bold}, packages
 \textsf{sans serif}, commands \code{\textbackslash\textcolor{code}{brown}}
  and options \textcolor{key}{\code{yellow}}.\par\bigskip}
 
diff --git a/Master/texmf-dist/doc/latex/enotez/enotez_split_example.tex b/Master/texmf-dist/doc/latex/enotez/enotez_split_example.tex
index 13d1da6e65e..f84f22b8c60 100644
--- a/Master/texmf-dist/doc/latex/enotez/enotez_split_example.tex
+++ b/Master/texmf-dist/doc/latex/enotez/enotez_split_example.tex
@@ -1,7 +1,8 @@
-\documentclass{scrartcl}
-% \documentclass{memoir}
+% \documentclass{scrartcl}
+\documentclass{memoir}
 % \documentclass{article}
-% \usepackage{caption}
+\usepackage[english]{babel}
+\usepackage{caption}
 \usepackage[T1]{fontenc}
 \usepackage{libertine}
 
@@ -9,20 +10,28 @@
 \usepackage{kantlipsum}
 
 \DeclareInstance{enotez-list}{section}{paragraph}{heading=\section{#1}}
-\setenotez{split=section,list-style=section,reset}
-% customize the titles in between, e.g.:
 \setenotez{
-  split-sectioning=textbf,
-  split-title=\par\noindent<name> <ref>:
+  split=section,
+  list-style=section,
+  reset,
+% customize the titles in between, e.g.:
+%   split-sectioning=addsec,
+%   split-title=\par\noindent<name> <ref>:
 }
 
 \usepackage{fnpct}
-\AdaptNote\endnote\multendnote
+% \AdaptNote\endnote\multendnote
 
 \usepackage{mwe}
 \usepackage[colorlinks]{hyperref}
 
 \begin{document}
+\makeatletter
+% \texttt{\meaning\@@makecaption}
+\makeatother
+
+\tableofcontents
+
 \section{Test}
 Text\endnote{\kant[1]}. Text\endnote{\kant[2]}. Text\endnote{This time
 with a \textbf{nested}\multendnote{\kant[3];\kant[4]} endnote.}.