summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/endfloat/endfloat.dtx
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-12-28 23:43:35 +0000
committerKarl Berry <karl@freefriends.org>2011-12-28 23:43:35 +0000
commitc0cb4ee097d7f8d233ffd040b5c7cae9ebcdf3cc (patch)
tree823cb00fd36fec0aafe571ace77dc68a9897a034 /Master/texmf-dist/source/latex/endfloat/endfloat.dtx
parent009b91d976b3b16341a11461f1cc41f072bdaffa (diff)
endfloat 2.5d (28dec11)
git-svn-id: svn://tug.org/texlive/trunk@24962 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/endfloat/endfloat.dtx')
-rw-r--r--Master/texmf-dist/source/latex/endfloat/endfloat.dtx119
1 files changed, 74 insertions, 45 deletions
diff --git a/Master/texmf-dist/source/latex/endfloat/endfloat.dtx b/Master/texmf-dist/source/latex/endfloat/endfloat.dtx
index 0d273de2141..3bab85d61dc 100644
--- a/Master/texmf-dist/source/latex/endfloat/endfloat.dtx
+++ b/Master/texmf-dist/source/latex/endfloat/endfloat.dtx
@@ -1,9 +1,9 @@
\def\filename{endfloat}
-\def\fileversion{v2.5c}
-\def\filedate{2011/12/23}
+\def\fileversion{v2.5d}
+\def\filedate{2011/12/25}
\def\docdate{2011/12/05}
%
-% \CheckSum{706}
+% \CheckSum{714}
%% \CharacterTable
%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
@@ -100,7 +100,7 @@
% \changes{v2.1}{1994/06/25}{Modify documentation text. jpg}
% This documentation was put in its current form by Jeff Goldberg,
% who has tried to indicate when he is (when
-% I am) speaking. See section~\ref{sec:history} for more detail.
+% I am) speaking. See \autoref{sec:history} for more detail.
% However, both the original author, Darrell McCauley, and
% a major contributor, Brian Junker, use the first person
% singular. In this version I no longer work to keep it clear
@@ -179,7 +179,7 @@
%
% This puts all figures and tables at the end of your document
% each on a page by itself\footnote{This
-% is the default. See section~\ref{sec:separator} to see how
+% is the default. See \autoref{sec:separator} to see how
% to have multiple floats per page.}
% and creates a List of Figures and/or List of Tables section
% at the end (when appropriate and controllable by options).
@@ -189,7 +189,7 @@
% \begin{quote}
% |\AtBeginDelayedFloats{\renewcommand{\baselinestretch}{1.4}}|
% \end{quote}
-% which is available from version 2.4. See section~\ref{sec:hooks}
+% which is available from version 2.4. See \autoref{sec:hooks}
% for more discussion.
%
% It also leaves notes in the text (i.e., ``[Figure 4 about here.]'').
@@ -197,7 +197,7 @@
% using the |nomarkers| options. If you
% do not like the look of this marker, you can change
% their text and appearance
-% (see section~\ref{sec:language}).
+% (see \autoref{sec:language}).
%
% \subsection{Starred floats}
% The |figure*| and |table*| versions are supported by the current
@@ -358,7 +358,7 @@
% \end{quote}
%
% These redefinitions may be placed in the \file{endfloat.cfg}
-% file (see section~\ref{sec:extra} for more information).
+% file (see \autoref{sec:extra} for more information).
%
% WARNING! The name of the counters |post|\x|tbl| and |post|\x|fig|
% have been changed to |post|\x|table| and |post|\x|figure| in version 2.5.
@@ -411,7 +411,7 @@
% environments are restored.
%
% These commands can be used either in the preamble of your document,
-% or in the \file{endfloat.cfg} file (see section~\ref{sec:extra}).
+% or in the \file{endfloat.cfg} file (see \autoref{sec:extra}).
%
% \section{Processing delayed floats before the end}
%
@@ -432,7 +432,7 @@
% the current chapter. Using lists may have other odd consequences.
% \item It is your responsibility to set |\table|\x|place| and
% |\figure|\x|place| correctly, as well as to possibly reset
-% the counters |\the|\x|post|\x|table| and |\the|\x|post|\x|figure| (section~\ref{sec:language})
+% the counters |\the|\x|post|\x|table| and |\the|\x|post|\x|figure| (\autoref{sec:language})
% as you wish. If you do not reset them, they will continue to
% increase throughout the document.
% \end{enumerate}
@@ -450,7 +450,7 @@
% |\renewcommand{\efloatseparator}{\mbox{}}|
% \end{quote}
% It makes most sense to place such a redefinition in the configuration
-% file (see section~\ref{sec:extra}).
+% file (see \autoref{sec:extra}).
%
% Do not be mislead by my misleading name for this command. This
% actually appears after each float including the last one, so is
@@ -501,7 +501,7 @@
%
% \subsection{Modified figures and tables}
%
-% As stated in section~\ref{sec:envnames}, \pkg{endfloat} will
+% As stated in \autoref{sec:envnames}, \pkg{endfloat} will
% utterly fail if one does something like
% \begin{quote}
% |\newenvironment{foo}{...\begin{table}...}|\\
@@ -544,7 +544,7 @@
% that file, you should include it as a package (possibly renamed)
% \emph{after} you include \pkg{endfloat}. Or you could simple rename
% it to \file{endfloat.cfg} and \pkg{endfloat} will include it automatically.\par
-% For a description of those commands see section~\ref{sec:config}.
+% For a description of those commands see \autoref{sec:config}.
% \else
% This can be archived with
% \begin{quote}
@@ -658,7 +658,7 @@
% |\captionsetup{labelsep=none,textformat=empty}|
% \end{quote}
% to the preamble of your document.~\footnote{%
-% This needs at least version $3.2c$ of the \pkg{caption} package.}
+% This needs at least version $3.2$ of the \pkg{caption} package.}
% If this should be done for figures (or tables) only one can use the
% optional argument of |\caption|\x|setup|, e.g.:
% \begin{quote}
@@ -699,7 +699,7 @@
% that.
%
% Again, first of all a solution for usage with the \pkg{caption} package:~\footnote{%
-% This needs at least version $3.2f$ of the \pkg{caption} package.}
+% This needs at least version $3.3$ of the \pkg{caption} package.}
% \begin{quote}
% |\captionsetup{list-entry=heading}|
% \end{quote}
@@ -807,7 +807,7 @@
% that either someone from ScientificWord or one of its
% users will create something for \verb"\FFRAME" similarly to
% what I have done for \verb"\sidewaystable" in the sample configuration
-% file (section~\ref{sec:extra}).
+% file (\autoref{sec:extra}).
%
% \iffalse % commented out by Axel Sommerfeldt
% Steps are slowly being taken to allow for new delayed environments
@@ -816,7 +816,7 @@
% the package includes few changes visible to the user, but may
% contain substantial internal changes to move the package in the desired
% direction. Version~2.4 now contains a configuration file in which
-% various things can be defined. See section~\ref{sec:extra} for
+% various things can be defined. See \autoref{sec:extra} for
% more information.
%
% Once it does become easier to delay other environments, the
@@ -851,7 +851,7 @@
% In any particular instance, the user can use either re-redefine
% |\XXX| before the end of document, or can re-redefine it using
% on of the hooks, |\At|\x|Begin|\x|Delayed|\x|Floats|, |\At|\x|Begin|\x|Tables|,
-% or |\At|\x|Begin|\x|Figures|, which are discussed in section~\ref{sec:hooks}.
+% or |\At|\x|Begin|\x|Figures|, which are discussed in \autoref{sec:hooks}.
%
% \subsection{Verbatim in delayed floats}\label{sec:verbatim}
%
@@ -979,7 +979,7 @@
% figure and first table.
%
% The natural solution to this problem will require that the bug
-% in described in section~\ref{sec:gobble} be resolved.
+% in described in \autoref{sec:gobble} be resolved.
%
% \subsection{Known incompatibilities}
%
@@ -992,7 +992,7 @@
% \subsubsection{Environment names}
%
% The packages listed here all have the problem described in
-% section~\ref{sec:envnames}. The work-arounds are also described
+% \autoref{sec:envnames}. The work-arounds are also described
% there. \pkg{rotating}, \emph{Scientific Word}.
%
% \subsubsection{Ordering end material}
@@ -1000,10 +1000,10 @@
% The following packages put things at the end of the document, and
% peculiar results are possible if you don't pay attention to the
% order in which packages are loaded. This is described in
-% section~\ref{sec:order}. The package \pkg{lastpage} is among
+% \autoref{sec:order}. The package \pkg{lastpage} is among
% these, as are recent versions of the package \pkg{harvard}.
%
-% \subsubsection{Conflicting \texttt{\bs enddocument}}
+% \subsubsection{Conflicting \cs{enddocument}}
%
% Prior to \LaTeXe's provision of the hook |\AtEndDocument|, package
% writers were forced to redefine |\enddocument|. Some did so
@@ -1056,7 +1056,7 @@
% I may very well fail at that. If you
% need a feature added, see whether the hooks will allow you to
% do what you want. If something goes wrong look over
-% section~\ref{sec:caveats}. But if you need to get in touch
+% \autoref{sec:caveats}. But if you need to get in touch
% with the maintainer, you should send email to me at
% \texttt{jeffrey@goldmark.org}.
%
@@ -1140,12 +1140,12 @@
% \item
% This version adds various user hooks, both as commands:
% |\At|\x|Begin|\x|Figures|, |\At|\x|Begin|\x|Tables|, and
-% |\At|\x|Begin|\x|Delayed|\x|Floats| (section~\ref{sec:hooks}),
-% and |\efloat|\x|separator| (section~\ref{sec:separator}).
+% |\At|\x|Begin|\x|Delayed|\x|Floats| (\autoref{sec:hooks}),
+% and |\efloat|\x|separator| (\autoref{sec:separator}).
%
% \item
% Most importantly, there is the addition of a configuration file
-% (section~\ref{sec:extra}). An example configuration file contains
+% (\autoref{sec:extra}). An example configuration file contains
% code which allows \pkg{endfloat} to work properly with
% the \texttt{sidewaystable} environment of the \pkg{rotating}
% package.
@@ -1170,7 +1170,7 @@
%
% \item
% Documentation changes to reflect user level changes. Also added
-% more to the Caveats section (section~\ref{sec:caveats}).
+% more to the Caveats section (\autoref{sec:caveats}).
%
% \end{itemize}
%
@@ -1198,13 +1198,13 @@
% which led me (jpg) to finally sit down and make some of the changes
% I had been planning on making. The effect of the |tablesfirst| option
% was specifically requested, and also work on the bug discussed
-% in section~\ref{sec:buggyheads}. Although my bug fix is partial,
+% in \autoref{sec:buggyheads}. Although my bug fix is partial,
% version 2.2 includes the means to suppress the headers altogether.
%
% \subsubsection{Package options}
%
% I, jpg, have used the package option facility of \LaTeXe\
-% to get other options (described in section~\ref{sec:options}).
+% to get other options (described in \autoref{sec:options}).
% I also made some cosmetic changes (breaking up lines to reduce
% the number of overfull boxes when printing the documentation,
% line breaks and indentation to make the code more readable.
@@ -1379,12 +1379,25 @@
%<*driver>
\documentclass{ltxdoc}
\setlength\hfuzz{2pt} % ignore small overfulls
+%
+\usepackage{ifpdf}
+\ifpdf
+ \usepackage{mathptmx,courier}
+ \usepackage[scaled=0.90]{helvet}
+\fi
+%
+\usepackage{hypdoc}
+\ifpdf\usepackage{hypdestopt}\fi
+\hypersetup{pdfkeywords={LaTeX, package, endfloat},pdfstartpage={},pdfstartview={}}
+%
\CodelineIndex
\EnableCrossrefs
%\DisableCrossrefs % Say \DisableCrossrefs if index is ready
%\RecordChanges % Gather update information
- %\OnlyDescription % comment out for implementation details
+ \OnlyDescription % comment out for implementation details
\begin{document}
+ \let\subsectionautorefname\sectionautorefname
+ \let\subsubsectionautorefname\sectionautorefname
\DocInput{endfloat.dtx}
\end{document}
%</driver>
@@ -1844,19 +1857,19 @@
% \end{macro}
%
% \begin{macro}{\efloat@AtBeginDocument}
-% The \pkg{apa} and \pkg{apa6} document classes are both bound to the fact
-% that the \pkg{endfloat} package is doing the redefinition of |\figure| and |\table| immediately.
-% So we still do if |\def@noapacite| is defined.
+% To be compatible to version $2.4$ we usually redefine |\figure| and |\table| immediately.
+% But if the \pkg{floatrow} package is loaded we can't, so we have to use
+% |\At|\x|Begin|\x|Document| here.
+% (Note: |\efloat@At|\x|Begin|\x|Document| will be defined using |\provide|\x|command|
+% so document classes and packages can pre-define it if needed.)
% \changes{v2.5c}{2011/12/22}{This command added. as}
+% \changes{v2.5d}{2011/12/23}{Revised. as}
% \begin{macrocode}
-\@ifundefined{apa@startsection}{% defined by apa.cls
- \@ifundefined{@noendfloatfig}{% defined by (old) apa6.cls
- \newcommand*\efloat@AtBeginDocument{\AtBeginDocument}
- }{%
- \newcommand*\efloat@AtBeginDocument{\@iden}
- }%
+\@ifpackageloaded{floatrow}{%
+ \PackageInfo{endfloat}{`floatrow' package detected, delaying redefinitions}
+ \providecommand*\efloat@AtBeginDocument{\AtBeginDocument}
}{%
- \newcommand*\efloat@AtBeginDocument{\@iden}
+ \providecommand*\efloat@AtBeginDocument{\@iden}
}
% \end{macrocode}
% \end{macro}
@@ -2015,6 +2028,12 @@
% \begin{macrocode}
\ProcessOptions*
% \end{macrocode}
+% For compatibility reasons we still store the original code of `figure' and `table'
+% to |\@bfig| and |\@btab| although we don't make use of it anymore.
+% \begin{macrocode}
+\let\@bfig\figure % bj
+\let\@btab\table % bj
+% \end{macrocode}
% Declare `figure' and `table' as delayed floating environment, if requested
% \begin{macrocode}
\if@tablesfirst
@@ -2058,7 +2077,6 @@
%
% Now we get the utilities for parsing needed to
% get unmodified code into files.
-% \changes{v2.1}{1994/06/25}{Use LaTeX2e documentation form. jpg}
% \begin{macrocode}
\let\efloat@float\relax
% \end{macrocode}
@@ -2074,7 +2092,7 @@
% input each line, until a line is found that looks like
% |\end{figure}|. Thus the actual name of the environment
% is hardcoded into the use of the macros
-% (see section~\ref{sec:envnames}). ---jpg]
+% (see \autoref{sec:envnames}). ---jpg]
%
% \changes{v1.1}{1992/03/13}{verified that floats were
% used before a section was
@@ -2118,8 +2136,7 @@
% |\@currenvir| (current environment) it set to fool
% latex into expecting the end of this environment
% to match the environment name. It will be used more extensively
-% when dealing with
-% the problem discussed in section~\ref{sec:envnames}.
+% when dealing with the problem discussed in \autoref{sec:envnames}.
% \begin{macrocode}
\def\@currenvir{efloat@float}%
% \end{macrocode}
@@ -2309,7 +2326,7 @@
\efloat@ifflag{#2head}{%
\section*{\@nameuse{#2section}}% % bj
% \end{macrocode}
-% See the discussion in section~\ref{sec:place} for what problem
+% See the discussion in \autoref{sec:place} for what problem
% the |suppressfloats[t]| is here to solve. If I understand the
% \textit{Companion} correctly (page 144), this was not available
% in previous versions of \LaTeX.
@@ -2322,12 +2339,24 @@
% \end{macrocode}
% Use any user defined hooks just before inputting the file.
% \begin{macrocode}
+ \def\efloat@type{#2}%
+ \processdelayedfloat@hook
\@nameuse{process#2s@hook}%
\@input{\jobname.#1}%
}{}}
% \end{macrocode}
% \end{macro}
%
+% \begin{macro}{\processdelayedfloat@hook}
+% For generic changes document classes can use the hook
+% |\process|\x|delayed|\x|float@hook|. If the float type is needed,
+% it can be extracted from |\efloat@type|.
+% \changes{v2.5d}{2011/12/25}{This hook added}
+% \begin{macrocode}
+\newcommand*\processdelayedfloat@hook{}
+% \end{macrocode}
+% \end{macro}
+%
% \begin{macro}{\efloat@listof}
% This one will do the ``List of Figures'' resp. ``List of Tables''.
% \changes{v2.5}{2011/11/26}{This macro added}