fnpct (28may12)

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

1 files changed, 115 insertions, 51 deletions

diff --git a/Master/texmf-dist/doc/latex/fnpct/fnpct_en.tex b/Master/texmf-dist/doc/latex/fnpct/fnpct_en.tex
index 000f7269181..2a5dc365c38 100644
--- a/Master/texmf-dist/doc/latex/fnpct/fnpct_en.tex
+++ b/Master/texmf-dist/doc/latex/fnpct/fnpct_en.tex
@@ -3,7 +3,7 @@
 % 
 %   footnote kerning
 % 
-% 2012/05/22
+% 2012/05/25
 % --------------------------------------------------------------------------
 % Clemens Niederberger
 % Web:    https://bitbucket.org/cgnieder/fnpct/
@@ -68,7 +68,7 @@
   thempfootnote,
   writeinnernotes
 }
-\setfnpct{multiple}
+\setfnpct{multiple,add-punct-marks=:[0pt][-.05em]}
 \usepackage{endnotes}
 \usepackage{parnotes}
 
@@ -197,11 +197,14 @@
  suffix_3p "\\nohyperpage{\\,ff.}"
 \end{filecontents}
 
-\newcommand\setapart[1]{\medskip\hspace{1em}#1\medskip}
+\newcommand\setapart[1]{%
+  \begin{quote}
+   #1
+  \end{quote}}
 \let\verb\lstinline
 
 \TitlePicture{\parbox{.75\textwidth}{The \fnpct package basically does two things
-to footnotes: if footnote marks are followed by a comma or a full stop the order
+to footnotes: if footnote marks are followed by a punctuation mark the order
 of footnote and punctuation mark is reversed and the kerning gets adjusted. As a
 side effect a new method of creating multiple footnotes and some other features are
 provided.}}
@@ -212,15 +215,16 @@ provided.}}
 \section{License and Requirements}
 \fnpct is placed under the terms of the LaTeX Project Public License,
 version 1.3 or later (\url{http://www.latex-project.org/lppl.txt}).
-It has the status \enquote{maintained}.
+It has the status ``maintained.''
 
-\fnpct depends on the \paket{l3kernel} and \paket*{xparse} which is part of the
-\paket{l3packages} bundle.
+\fnpct depends on the \paket*{l3kernel}, \paket*{xparse}, \paket*{l3keys2e} and
+\paket*{scrlfile}.
 
 \section{What's it all about?}
 \subsection{Basics}\secidx{basics}
 The \fnpct package basically does two things to footnotes: if footnote marks are
-followed by a comma or a full stop the order of footnote and punctuation mark is
+followed by a comma or a full stop\footnote{More punctuation marks can be added
+through a package option.} the order of footnote and punctuation mark is
 reversed and the kerning gets adjusted. As a side effect a new method of creating
 multiple footnotes\footnote{like;this} is provided, see section \ref{sec:multiple}
 for details.
@@ -237,7 +241,7 @@ the amount specified by the option \key{before-footnote-space} (see section
 
 All examples in this documentation use
 
-\setapart{\cmd{renewcommand}\cmd{thempfootnote}{\cmd{arabic}{mpfootnote}}}.
+\setapart{\cmd{renewcommand}\cmd{thempfootnote}{\cmd{arabic}{mpfootnote}}.}
 
 Now, let's see some action:
 \begin{beispiel}
@@ -250,13 +254,29 @@ Now, let's see some action:
 \end{beispiel}
 
 To ensure that the kerning is set the right way the footnote \emph{must} be placed
-\emph{before} the dot or the comma. \emph{The command can look ahead but not look back}.
-This means if you place the \cmd{footnote} command after a dot or a comma it is
-treated as if following a word, \ie a thin space is inserted: effectivly the opposite 
+\emph{before} the full stop or the comma. \emph{The command can look ahead but not look back}.
+This means if you place the \cmd{footnote} command after a full stop or a comma it is
+treated as if following a word, \ie a thin space is inserted: effectively the opposite 
 of the desired behaviour.
 
 The order-switching can be prevented using a package option since not all countries
-and languages have the same typographic conventions.
+and languages have the same typographic conventions. In this case the full stop
+and the comma are move a bit back.
+
+\bigskip\hfil
+\begin{minipage}{.25\linewidth}
+\setlength\parindent{0pt}%
+without \fnpct:\\
+{\setfnpct{dont-mess-around}%
+\null\quad text.\footnotemark[1]\\
+\null\quad text\footnotemark[1]}.
+
+with \fnpct:\\
+\null\quad text\footnotemark[1].\\
+\setfnpct{punct-after}%
+\null\quad text\footnotemark[1].
+\end{minipage}\hfil
+
 \begin{beschreibung}
  \option{punct-after}{\default{true}/false} when \code{true} the punctuation sign
  will be placed \emph{after} the footnote.
@@ -281,12 +301,15 @@ Like all options it can also be set using the setup command.
 One maybe want to put some footnote marks \emph{before} the punctuation and some
 after, for example because the first one describes a single word but the second
 one a whole sentence. For this purpose \fnpct adds a \code{*} argument to \cmd{footnote}
-and \cmd{footnotemark}:
+and \cmd{footnotemark}. The complete new syntax now is as follows:
 \begin{beschreibung}
- \befehl[footnotea]{footnote}*[<num>]{<footnote text>} new \code{*} argument added.
- \befehl[footnotemarka]{footnotemark}*[<num>] new \code{*} argument added.
+ \Befehl{footnote}*[<num>]{<footnote text>}\code{<tpunct>} \cnpkgdocarrow\ new
+ \code{*} argument added. \code{<tpunct>} is the optional trailing punctuation
+ mark.
+ \Befehl{footnotemark}*[<num>]\code{<tpunct>} \cnpkgdocarrow\ new \code{*} argument
+ added. \code{<tpunct>} is the optional trailing punctuation mark.
 \end{beschreibung}
-This argument temporarily turns off the punctuation/footnote switching.
+The \code{*} argument temporarily turns off the punctuation/footnote switching.
 \begin{beispiel}
  \begin{minipage}{.4\linewidth}
   \noindent The three little pigs built their houses
@@ -300,24 +323,38 @@ This argument temporarily turns off the punctuation/footnote switching.
 \section{Options}\secidx{options}\label{sec:options}
 Most package options are listed below. They all can be set as a package option or
 with the \cmd{setfnpct} command. Most of them are for adjusting the kerning.
+
+\default{Underlined} values are set if the option is used without value.
 \begin{beschreibung}
- \option{after-dot-space}{<dim>} space to be inserted after a dot and before the
- footnote mark. Default = \code{-.06em}
- \option{after-comma-space}{<dim>} space to be inserted after a comma and before
- the footnote mark. Default = \code{-.06em}
- \option{after-punct-space}{<dim>} set both spaces.
+ \option{add-punct-marks}{<mark>[<space after>][<space before>]} add another punctuation
+ mark for the position switching and spacify kerning if necessary. An existing entry
+ will be overwritten. This option accepts list of marks.
+ \option{remove-punct-marks}{<mark>} remove punctuation mark from the kerning/position
+ switching behaviour. This option accepts a list of marks.
+ \option{after-dot-space}{<dim>} space to be inserted after a footnote mark and
+ before the full stop (``footnote \emph{after} dot''). A negative space
+ will move the full stop further to the footnote mark. Default = \code{-.06em}
+ \option{after-comma-space}{<dim>} space to be inserted after a footnote mark and
+ before the comma (``footnote \emph{after} comma''). A negative space
+ will move the comma further to the footnote mark.  Default = \code{-.06em}
+ \option{after-punct-space}{<dim>} set \emph{all} spaces, \ie also the ones for
+ marks you've added with \key{add-punct-marks}.
  \option{punct-after}{\default{true}/false} when \code{true} the punctuation sign
  will be placed \emph{after} the footnote.
- \option{before-dot-space}{<dim>} space to be inserted before a dot and after the
- footnote mark, \ie with \key{punct-after}{true}. Default = \code{-.15em}
- \option{before-comma-space}{<dim>} space to be inserted before a comma and after
- the footnote mark, \ie with \key{punct-after}{true}. Default = \code{-.15em}
- \option{before-punct-space}{<dim>} set both spaces.
- \option{before-footnote-space}{<dim>} space to be inserted between a word and the
- following footnote mark. Default = \code{.06em}
- \option{dont-mess-around} sets all mentioned lengths to \code{0} and \key{punct-after}{true}.
- Basically this is as if you hadn't loaded \fnpct except the multiple footnote
- command is still available, see section \ref{sec:multiple}.
+ \option{before-dot-space}{<dim>} space to be inserted after a footnote mark and
+ before the full stop (``footnote \emph{before} dot''), \ie with
+ \key{punct-after}{true}. Default = \code{-.15em}
+ \option{before-comma-space}{<dim>} space to be inserted after a footnote mark and
+ before the comma (``footnote \emph{before} comma''), \ie with
+ \key{punct-after}{true}. Default = \code{-.15em}
+ \option{before-punct-space}{<dim>} set \emph{all} spaces, \ie also the ones for
+ marks you've added with \key{add-punct-marks}.
+ \option{before-footnote-space}{<dim>} space to be inserted between a word and
+ the following footnote mark. Default = \code{.06em}
+ \option{dont-mess-around} sets all mentioned lengths to \code{0pt} and
+ \key{punct-after}{true}. Basically this is as if you hadn't loaded \fnpct except
+ the multiple footnote commands and \cmd{innernote} are still available, see
+ sections \ref{sec:multiple} and \ref{sec:nested}, respectively.
  \option{multiple}{\default{true}/false} lets \cmd{footnote} be equal to
  \cmd{multfootnote}
  \option{mult-fn-delim}{<delimiter>} sets the delimiter for the \cmd{multfootnote}
@@ -331,6 +368,29 @@ with the \cmd{setfnpct} command. Most of them are for adjusting the kerning.
  = \code{false}
 \end{beschreibung}
 
+So if you want to extend the punctuation switching and kerning to other punctuation
+marks you can do something like this:
+\begin{beispiel}
+ \setfnpct{add-punct-marks=!?}
+ \begin{minipage}{.4\linewidth}
+  \noindent The three little pigs built their houses
+  out of straw\footnote{not to be confused with hay}?
+  Sticks\footnote{or lumber according to some sources}
+  and bricks\footnote{probably fired clay bricks}!
+ \end{minipage}
+\end{beispiel}
+
+Or with some additional spacing:
+\begin{beispiel}
+ \setfnpct{add-punct-marks=![.03em]?[.03em]}
+ \begin{minipage}{.4\linewidth}
+  \noindent The three little pigs built their houses
+  out of straw\footnote{not to be confused with hay}?
+  Sticks\footnote{or lumber according to some sources}
+  and bricks\footnote{probably fired clay bricks}!
+ \end{minipage}
+\end{beispiel}
+
 Let's take a look at an example with some ridiculous settings:
 \begin{beispiel}
  % some ridiculous settings:
@@ -372,9 +432,9 @@ Some of the options are explained in a bit more detail in the next sections.
 Since multiple footnotes have to be treated differently\footnote{see these footnotes;for an example},
 \fnpct provides an extra command for that:
 \begin{beschreibung}
- \befehl{multfootnote}*{<list>;<of>;<footnotes>} different footnotes are separated
- with a semicolon. The \code{*} turns the footnote/punctuation switching temporarily
- off.
+ \Befehl{multfootnote}*{<list>;<of>;<footnotes>}\code{<tpunct>} \cnpkgdocarrow\
+ different footnotes are separated with a semicolon. The \code{*} turns the
+ footnote/punctuation switching temporarily off.
 \end{beschreibung}
 \begin{beispiel}
  \begin{minipage}{.4\linewidth}
@@ -386,8 +446,11 @@ Since multiple footnotes have to be treated differently\footnote{see these footn
  \end{minipage}
 \end{beispiel}
 
-Every of the items of the list has an optional argument equivalent to the optional
-argument of \cmd{footnote}:
+Every of the items of the list has an optional \code{*} argument and an optional
+argument equivalent to the optional argument of \cmd{footnotetext}:
+\begin{beschreibung}
+ \Befehl{multfootnote}{*[<mark>]<footnote text>;...}
+\end{beschreibung}
 \begin{beispiel}
  \begin{minipage}{.4\linewidth}
   \noindent The three little pigs built their houses
@@ -410,7 +473,7 @@ without disrupting the multiple setting. The following example is shown in figur
   margin=5pt,
   bottom=1.5cm]{geometry}
 
-\usepackage[multiple]{fnpct}
+\usepackage{fnpct}
 
 \begin{document}
   \noindent The three little pigs built their houses
@@ -427,10 +490,10 @@ without disrupting the multiple setting. The following example is shown in figur
  \caption{nested footnotes}\label{fig:nested:mult}
 \end{figure}
 
-
+\newpage
 \subsection{The delimiter and separator}\secidx[delimiter]{multiple footnotes}\secidx[separator]{multiple footnotes}
 Since the semicolon might be part of the footnote text you might have some trouble.
-But there are ways around. Maybe try enclosing it with braces:
+But there are ways around. Maybe try enclosing it in braces:
 \begin{beispiel}
  \begin{minipage}{.4\linewidth}
   \noindent The three little pigs built their houses
@@ -441,7 +504,7 @@ But there are ways around. Maybe try enclosing it with braces:
  \end{minipage}
 \end{beispiel}
 
-There are options which lets you choose the (input) delimiter and the (output)
+There also are options which lets you choose the (input) delimiter and the (output)
 separator:
 \begin{beschreibung}
  \option{mult-fn-delim}{<delimiter>} choose delimiter for the \cmd{multfootnote}.
@@ -488,12 +551,12 @@ If you want you can turn all footnotes into \cmd{multfootnote}s.
 \end{beispiel}
 \secidx*{multiple footnotes}
 
-\section{Nested Footnotes}\secidx{nested footnotes}
+\section{Nested Footnotes}\secidx{nested footnotes}\label{sec:nested}
 \fnpct provides some support for nested footnotes. There are some restrictions,
 though. The command below can be used inside \cmd{footnote} and \cmd{multfootnote},
 but not inside another \cmd{innernote}:
 \begin{beschreibung}
- \befehl{innernote}*[<mark>]{<text>} a nested footnote.
+ \Befehl{innernote}*[<mark>]{<text>}\code{<tpunct>} \cnpkgdocarrow\ a nested footnote.
 \end{beschreibung}
 The inner node uses a \cmd{footnotemark} internally and the mark will be set with
 the definition it has at begin document.
@@ -707,7 +770,8 @@ The \paket{endnotes} \cite{endnotes} package povides the commands \cmd{endnote}
 and \cmd{endnotemark} which can be used to output all notes at the end of a chapter,
 say.
 
-If the package is loaded both commands are adapted:
+If the package is loaded both commands are adapted\footnote*{see section \ref{sec:adapt}
+on manual adaption}:
 \begin{beispiel}[code only]
  % `fnpct' does this for you:
  \AdaptNote\endnote\multendnote
@@ -748,8 +812,8 @@ repeat the footnote text on the same page in the bottom. The document needs
 several runs to get all the numbers and footnotes right.
 
 Every fixed footnote declared with \cmd{DeclareFixedFootnote} gets an optional
-\code{*} to prevent the punctuation switching. There is \emph{no} mult-variant
-of the fixed notes!
+\code{*} to prevent the punctuation switching. \emph{There is \emph{no} mult-variant
+of the fixed notes!}
 
 Since this document cannot easily combine \emph{every} footnote package at the same
 time for demonstration purposes the following code is shown in figure \ref{fig:fixfoot}:
@@ -799,8 +863,8 @@ escaping mechanism through \cmd{makesavenoteenv}.
 \subsection{manyfoot}\secidx[manyfoot]{other packages}
 The \paket{manyfoot} package \cite{manyfoot} is not and will not directly be
 supported. It is loaded by \paket{bigfoot} (see section \ref{ssec:bigfoot}), anyway.
-And since the latter states this in its documentation
-\begin{zitat}[David Kastrup \cite{bigfoot}]
+And since the latter states in its documentation
+\begin{zitat}[David Kastrup \textup{\cite{bigfoot}}]
  Purpose of this package is to provide a one-stop solution to almost all problems
  related to footnotes. You can use it as a drop-in replacement of the `\paket{manyfoot}'
  package, but without many of its shortcomings, and quite a few features of its
@@ -890,7 +954,7 @@ of the \paket{yafoot} \cite{yafoot} bundle. Just for reference: these packages a
 \paket*{pfnote}, \paket*{fnpos} and \paket*{dblfnote}.
 \secidx*{other packages}
 
-\section{Adapting note commands}\secidx{adapting notes}
+\section{Adapting note commands}\secidx{adapting notes}\label{sec:adapt}
 If a package is not natively supported you can try and adapt commands yourself.
 You'll need to use one of the following commands. Please be aware that if the
 adapted command does not match the required syntax it will get the required syntax
@@ -946,8 +1010,8 @@ text in a sidenote.;A second sidenote.}.
 
 \subsection{Adapting \code{\textbackslash\textcolor{code}{footcite}} and siblings}
 \secidx[biblatex]{adapting notes}\label{ssec:adapt:footcite}
-If you're willing to sacrifice \cmd{footcite}'s \code{*} argument which it has
-in some styles you can adapt the commands provided by \paket{biblatex} as well:
+If you're willing to sacrifice \cmd{footcite}'s \code{*} argument (which it has
+in some styles) you can adapt the commands provided by \paket{biblatex} as well:
 
 \begin{beispiel}
  % used in preamble: \AdaptNoteOpt\footcite\multfootcite