diff options
author | Karl Berry <karl@freefriends.org> | 2012-02-19 23:32:17 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-02-19 23:32:17 +0000 |
commit | bec520863474a2c3743eeefb46847f4c09de096f (patch) | |
tree | f82a7aeb044a03f4949638f351c107f444ba1ff7 /Master/texmf-dist/doc/latex/footnoterange | |
parent | e036bb82b6b1baa3531e717263613877c92587d6 (diff) |
new latex package footnoterange (19feb12)
git-svn-id: svn://tug.org/texlive/trunk@25430 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/footnoterange')
-rw-r--r-- | Master/texmf-dist/doc/latex/footnoterange/README | 163 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.pdf | bin | 0 -> 81029 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.tex | 142 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/footnoterange/footnoterange.pdf | bin | 0 -> 301230 bytes |
4 files changed, 305 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/footnoterange/README b/Master/texmf-dist/doc/latex/footnoterange/README new file mode 100644 index 00000000000..b17ef571e9b --- /dev/null +++ b/Master/texmf-dist/doc/latex/footnoterange/README @@ -0,0 +1,163 @@ +README for footnoterange package, 2012/02/17, v1.0a + + +TABLE OF CONTENTS +================= + +1 Introduction +2 Download +3 Installation +4 Additional Packages +5 Package Compatibility +6 Author/Maintainer +7 Bug Reports +8 Known Problems + + +1 INTRODUCTION +============== + +This LaTeX2e package provides the environments footnoterange +and footnoterange*. Multiple footnotes inside these +environments are not referenced as e.g. "1 2 3" but as +"1-3", i.e. the range (from first to last referred footnote +at that place) is given. Depending on loading of hyperref +package and use of its hyperfootnotes-option the references +are hyperlinked. (References to footnotes in the +footnoterange* environment are never hyperlinked.) +This material is subject to the LaTeX Project Public License +(LPPL). See http://www.ctan.org/tex-archive/help/Catalogue/ +licenses.lppl.html for the details of that license. + + +2 DOWNLOAD +========== + +`footnoterange' is available on CTAN: + CTAN:macros/latex/contrib/footnoterange/ + +Running +tex footnoterange.dtx +generates the files +footnoterange.ins, footnoterange.drv, footnoterange.sty, +and footnoterange-example.tex. + +Also a ZIP file is provided that contains these files, +the manual (footnoterange.pdf), the compiled example +(footnoterange-example.pdf), and this README, already +sorted in a TDS tree: + CTAN:install/macros/latex/contrib/footnoterange.tds.zip + +`CTAN:' means one of the `Comprehensive TeX Archive Network' +nodes or one of its mirrors. This is explained in + http://www.tex.ac.uk/cgi-bin/texfaq2html?label=archives + +The CTAN stuff will be mirrored automatically from the +ftp server, so + ftp://ftp.tug.org/pub/tex/footnoterange/ +corresponds to + CTAN:macros/latex/contrib/footnoterange/ + + +3 INSTALLATION +============== + +Installation with ZIP file in TDS format +---------------------------------------- +The ZIP file `footnoterange.tds.zip' contains the files +sorted in a TDS tree. Thus you can directly unpack the +ZIP file inside a TDS tree. +(See CTAN:tds.zip for an explanation of TDS.) +Example: + cd /...somewhere.../texmf + unzip /...downloadpath.../footnoterange.tds.zip +Do not forget to refresh the file name database of this +TDS tree. +Example: + texhash /...somewhere.../texmf + +Manual installation +------------------- +a) Download the footnoterange files from CTAN. + If necessary, unpack them. +b) Generate the package and driver files: + tex footnoterange.dtx +c) Install the file `*.sty' in your TDS tree: + cp *.sty TDS:tex/latex/footnoterange/ + Replace `TDS:' by the prefix of your TDS tree + (texmf directory). +d) Create the documentation (if necessary), e.g. + pdflatex footnoterange.dtx + makeindex -s gind.ist footnoterange.idx + pdflatex footnoterange.dtx + makeindex -s gind.ist footnoterange.idx + pdflatex footnoterange.dtx +e) Update the databases if necessary, e.g. for teTeX: + mktexlsr .../texmf +f) Create the footnoterange-example.pdf (if necessary), e.g. + pdflatex footnoterange-example.tex + pdflatex footnoterange-example.tex + pdflatex footnoterange-example.tex +g) Copy the documentation files to + "TDS:doc/latex/footnoterange/": + README, footnoterange.pdf, footnoterange-example.tex, + footnoterange-example.pdf. + + +4 ADDITIONAL PACKAGES +===================== + +footnoterange loads other packages: +* ltxcmds, http://ctan.org/pkg/ltxcmds +* xspace, http://ctan.org/pkg/xspace +which again load other packages +(see the result of the \listfiles command in the log-file + of the example). + + +5 PACKAGE COMPATIBILITY +======================= + +footnoterange should be loaded quite late, i.e. after +footnote handling is changed by other packages. +If the hyperref package is used, footnoterange should +be loaded after hyperref. + + +6 AUTHOR/MAINTAINER +===================== + +* H.-Martin Münch + + +7 BUG REPORTS +============== + +A bug report should contain: +* Comprehensive problem description. This includes error or + warning messages. +* \errorcontextlines=\maxdimen can be added in the + TeX code to get more information in TeX error messages. +* Minimal test file that shows the problem, but does not + contain any unnecessary packages and code. +* Used drivers/programs. +* Version information about used packages and programs. +* If you are using LaTeX, then add "\listfiles". Then + a list of version information is printed at the end + of the LaTeX run. +* Please no other files than the minimal test file. + The other files .log, .dvi, .ps, .pdf are seldom + necessary, so send them only on request. +* Please .zip or .tar.gz your file(s) before sending them! + +Bug address +----------- +Bug reports can be send to the maintainer: + H.-Martin Münch + <Martin [dot] Muench [at] Uni-Bonn [dot] de> + + +8 KNOWN PROBLEMS +================= + +* as yet: none.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.pdf b/Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.pdf Binary files differnew file mode 100644 index 00000000000..c936fb82d1c --- /dev/null +++ b/Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.pdf diff --git a/Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.tex b/Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.tex new file mode 100644 index 00000000000..659dad9b703 --- /dev/null +++ b/Master/texmf-dist/doc/latex/footnoterange/footnoterange-example.tex @@ -0,0 +1,142 @@ +%% +%% This is file `footnoterange-example.tex', +%% generated with the docstrip utility. +%% +%% The original source files were: +%% +%% footnoterange.dtx (with options: `example') +%% +%% This is a generated file. +%% +%% Project: footnoterange +%% Version: 2012/02/17 v1.0a +%% +%% Copyright (C) 2012 by +%% H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de> +%% +%% The usual disclaimer applies: +%% If it doesn't work right that's your problem. +%% (Nevertheless, send an e-mail to the maintainer +%% when you find an error in this package.) +%% +%% This work may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either +%% version 1.3c of this license or (at your option) any later +%% version. This version of this license is in +%% http://www.latex-project.org/lppl/lppl-1-3c.txt +%% and the latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.3c or later is part of all distributions of +%% LaTeX version 2005/12/01 or later. +%% +%% This work has the LPPL maintenance status "maintained". +%% +%% The Current Maintainer of this work is H.-Martin Muench. +%% +%% This work consists of the main source file footnoterange.dtx, +%% the README, and the derived files +%% footnoterange.sty, footnoterange.pdf, +%% footnoterange.ins, footnoterange.drv, +%% footnoterange-example.tex, footnoterange-example.pdf. +%% +\documentclass[british]{article}[2007/10/19]% v1.4h +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\usepackage[% + extension=pdf,% + plainpages=false,% + pdfpagelabels=true,% + hyperindex=false,% + pdflang={en},% + pdftitle={footnoterange package example},% + pdfauthor={H.-Martin Muench},% + pdfsubject={Example for the footnoterange package},% + pdfkeywords={LaTeX, footnoterange, H.-Martin Muench},% + pdfview=FitH,% + pdfstartview=FitH,% + pdfpagelayout=OneColumn,% + hyperfootnotes=true% +]{hyperref}[2012/02/06]% v6.82o + +\usepackage{footnoterange}[2012/02/17]% v1.0a + +\gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}% +\listfiles +\begin{document} +\pagenumbering{arabic} +\section*{Example for footnoterange} + +This example demonstrates the use of package\newline +\textsf{footnoterange}, v1.0a as of 2012/02/17 (HMM).\newline +The package does not use options.\newline + +\noindent For more details please see the documentation!\newline + +\noindent Save per page about $200\unit{ml}$ water, +$2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:\newline +Therefore please print only if this is really necessary.\newline + +This\footnote{Lorem} text bears a multiplicity of footnotes. +Because the \texttt{hyperref} package is used with option +\texttt{hyperfootnotes=true}, the footnotes% +\begin{footnoterange}% +\footnote{ipsum}% +\footnote{dolor}% +\footnote{sit}% +\footnote{amet,}% +\footnote{consectetur}% +\footnote{adipisicing}% +\footnote{elit,}% +\footnote{sed}% +\end{footnoterange}% + are hyperlinked.\footnote{do eiusmod\ldots} Using +\texttt{hyperfootnotes=false} or not using \texttt{hyperref} +will remove the hyperlinks to the footnotes.\newline + +This text also bears a multiplicity of footnotes, +but due to the use of the starred% +\begin{footnoterange*}% +\footnote{Ut purus elit,}% +\footnote{vestibulum ut,}% +\footnote{placerat ac,}% +\footnote{adipiscing vitae,}% +\footnote{felis.}% +\footnote{Curabitur}% +\footnote{dictum}% +\footnote{gravida}% +\end{footnoterange*}% + form of the environment they are not +hyperlinked.\footnote{mauris\ldots}\newline + +The use of the optional parameter for footnotes% +\begin{footnoterange}% +\footnote[101]{Nam arcu libero,}% +\footnote[102]{nonummy eget,}% +\footnote[103]{consectetuer id,}% +\footnote[104]{vulputate a,}% +\footnote[105]{magna.} +\end{footnoterange}% + is also possible, but should be used consistently. + +\pagebreak + +When there is only one footnote% +\begin{footnoterange}% +\footnote{a single footnote}% +\end{footnoterange}% + in the \texttt{footnoterange} environment, only one +footnotemark is used and an info is written into the +log-file.\newline + +The usage of other footnote-number-representations +(e.\,g.~\verb|\Roman|, \verb|\roman|, \verb|\Alph|, \verb|\alph|, +\verb|\fnsymbol|) is also possible, but two things must be taken +into account: The number of footnote references is restricted (for +example with \verb|\Alph| only references A to Z are possible), which +can be fixed e.\,g. with the \texttt{alphalph} package, and references +to footnote-symbol-ranges (\verb|\fnsymbol|) are probably +not very clear. + +\end{document} +\endinput +%% +%% End of file `footnoterange-example.tex'. diff --git a/Master/texmf-dist/doc/latex/footnoterange/footnoterange.pdf b/Master/texmf-dist/doc/latex/footnoterange/footnoterange.pdf Binary files differnew file mode 100644 index 00000000000..d986d81b496 --- /dev/null +++ b/Master/texmf-dist/doc/latex/footnoterange/footnoterange.pdf |