summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-08-20 22:39:24 +0000
committerKarl Berry <karl@freefriends.org>2012-08-20 22:39:24 +0000
commitfcbf59f6f4e30fd0acf97087ff5e62b11af41c2d (patch)
tree651d5582008b30782a7d450140bb825a03beae0a /Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex
parente2ed98d1225ce866bbcaf6263ad27a2e8f8d0991 (diff)
new latex package chkfloat (20aug12)
git-svn-id: svn://tug.org/texlive/trunk@27473 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex')
-rw-r--r--Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex39
1 files changed, 39 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex b/Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex
new file mode 100644
index 00000000000..008bd8c669b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/chkfloat/chkfloat.tex
@@ -0,0 +1,39 @@
+\documentclass{article}
+
+\usepackage{hyperref,url,a4wide}
+
+\title{The {\sffamily chkfloat} package ver.\@ 0.1}
+\author{Tom\'a\v s Hejda \\ \href{mailto:tohecz@gmail.com}{tohecz@gmail.com}}
+\date{19 August 2012}
+
+\begin{document}
+
+\maketitle
+
+\paragraph{Overview.}
+The package {\sffamily chkfloat} provides one single feature.
+It shows a warning whenever a float is placed more than \verb:tolerance: pages from its orinigal page.
+
+\paragraph{Interference.}
+The package should interfere well with other float-related packages like {\sffamily float} or {\sffamily floatrow}.
+If any problem is spotted, feel free to contact the package author.
+
+\paragraph{Package options.}
+The package has a single option \verb:tolerance: which is preset to \verb:1:.
+To change the value, use e.g. \verb:\usepackage[tolerance=0]{chkfloat}:.
+
+\paragraph{Implementation.}
+The package code is documented.
+The implementation is based on the macros that create `List of Figures' and similar lists.
+A new fake list is created with file extension \verb:.fof: and we store the information
+ about each float's ``original'' page and ``final'' page.
+On the next run, these lines are loaded and processed.
+
+\paragraph{Version history.}
+Version 0.1 is the first version.
+
+\paragraph{Licence.}
+This material is subject to the \LaTeX{} Project Public Licence.
+See \url{http://www.ctan.org/tex-archive/help/Catalogue/licenses.lppl.html} for the details of that licence.
+
+\end{document} \ No newline at end of file