diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/footnoterange/README |
Initial commit
Diffstat (limited to 'macros/latex/contrib/footnoterange/README')
-rw-r--r-- | macros/latex/contrib/footnoterange/README | 162 |
1 files changed, 162 insertions, 0 deletions
diff --git a/macros/latex/contrib/footnoterange/README b/macros/latex/contrib/footnoterange/README new file mode 100644 index 0000000000..30812580a5 --- /dev/null +++ b/macros/latex/contrib/footnoterange/README @@ -0,0 +1,162 @@ +README for footnoterange package, 2018/10/15, v1.0b + + +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 LaTeX 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 published under the LPPL 1.3c: 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 +https://www.latex-project.org/lppl/lppl-1-3c.txt +and the latest version of this license is in +https://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. + + +2 DOWNLOAD +========== + +`footnoterange' is available on CTAN: +https://www.ctan.org/pkg/footnoterange + +Also a ZIP file is provided that contains the files: +the manual (footnoterange.pdf), +the compiled example (footnoterange-example.pdf), +driver (footnoterange.drv), footnoterange.dtx, +installation file (footnoterange.ins), +the style file (footnoterange.sty), +and this README, already sorted in a TDS tree: +http://mirror.ctan.org/install/macros/latex/contrib/footnoterange.tds.zip + + +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 https://www.ctan.org/TDS-guidelines 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, driver, and example files: + tex footnoterange.ins + footnoterange.ins can also be created by + tex footnoterange.dtx +c) Install the file `footnoterange.sty' in your TDS tree: + cp footnoterange.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 +h) 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, https://www.ctan.org/pkg/ltxcmds +* letltxmacro, https://www.ctan.org/pkg/letltxmacro +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 +================ + +The footnoterange package does not handle \footnotemark +in footnoteranges (see \fnr@rangefootnotemark in the +documentation).
\ No newline at end of file |