summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pagesLTS/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pagesLTS/README')
-rw-r--r--Master/texmf-dist/doc/latex/pagesLTS/README225
1 files changed, 225 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/pagesLTS/README b/Master/texmf-dist/doc/latex/pagesLTS/README
new file mode 100644
index 00000000000..9b55bb8c193
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/pagesLTS/README
@@ -0,0 +1,225 @@
+README for pagesLTS package, 2010/09/22, v1.1k
+
+
+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 package puts the labels LastPage (\AtEndDocument) and
+VeryLastPage (\AfterLastShipout) into the .aux file,
+allowing the user to refer to the (very) last page of a
+document. This might be particularly useful in places like
+headers or footers.
+When more than one page numbering scheme is used, these
+references do not give the total number of pages. For this
+case the label LastPages is introduced. Additionally, at the
+last page of each page numbering scheme a label
+pagesLTS.<numbering scheme> is placed, where
+<numbering scheme> is e. g. arabic, roman, Roman, alph, or
+Alph. For fnsymbol please use
+\lastpageref{pagesLTS.fnsymbol} instead of
+\pageref{pagesLTS.fnsymbol}. When the same numbering scheme
+is used twice, the page numbers are either reset to one or
+continued automatically, depending on the option given when
+the package is called. The command \theCurrentPage prints
+the current total/absolute page number - in contrast to
+\thepage, which gives only the page name in the current page
+numbering scheme. \theCurrentPageLocal gives the current
+number of pages in the current page numbering scheme.
+\thepage and \theCurrentPageLocal are different e. g. when
+\addtocounter{pageg}{...} or \setcounter{page}{...} were
+used.
+At the first page of the document a label pagesLTS.0 is
+created. This label can be referred to, too. Further labels
+are provided for special cases.
+The alphalph package is supported, i. e. page numbers alph
+or Alph > 26 and fnyambol > 9 can be used (with according
+options set). Even zero and negative page numbers can be
+used with arabic, alph, Alph, roman, Roman, and fnsymbol
+page numbering (with alphalph package and according
+options).
+\pageref* and \pageref*, for using hyperref but suppressing
+links, are supported.
+
+
+2 DOWNLOAD
+==========
+
+`pagesLTS' is available on CTAN:
+ CTAN:macros/latex/contrib/pagesLTS/
+
+Also a ZIP file is provided that contains the files, already
+sorted in a TDS tree (should become available on CTAN soon):
+ CTAN:install/macros/latex/contrib/pagesLTS.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/pagesLTS/
+corresponds to
+ CTAN:macros/latex/contrib/pagesLTS/
+
+
+3 INSTALLATION
+==============
+
+Installation with ZIP file in TDS format
+----------------------------------------
+The ZIP file `pagesLTS.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.../pagesLTS.tds.zip
+Do not forget to refresh the file name database of this
+TDS tree.
+Example:
+ texhash /...somewhere.../texmf
+
+Manual installation
+-------------------
+a) Download the pagesLTS files from CTAN or the TUG server.
+ If necessary, unpack them.
+b) If directory `beta' exists, replace the files by the
+ counterparts in this directory, if you want to use the
+ latest versions.
+c) Generate the package and driver files:
+ tex pagesLTS.ins
+d) Install the files `*.sty' and `*.cfg' in your TDS tree:
+ cp *.sty *.cfg TDS:tex/latex/pagesLTS/
+ Replace `TDS:' by the prefix of your TDS tree
+ (texmf directory).
+e) Copy the documentation files to
+ "TDS:doc/latex/pagesLTS/":
+ README, pagesLTS.pdf,pagesLTS-example.tex,
+ pagesLTS-example.pdf.
+f) Update the databases if necessary, e. g. for teTeX:
+ mktexlsr .../texmf
+
+
+4 ADDITIONAL PACKAGES
+=====================
+
+Depending on the driver and option settings, pagesLTS loads
+other packages:
+
+For unpacking the pagesLTS.dtx file and constructing the
+documentation it is required:
+- TeXFormat LaTeX2e, 1994/06/01, v2e
+- document class ltxdoc, 2007/11/11, v2.0u,
+ CTAN:macros/latex/base/ltxdoc.dtx
+- package holtxdoc, 2010/04/24, v0.19,
+ CTAN:macros/latex/contrib/oberdiek/holtxdoc.dtx
+- package hypdoc, 2010/03/26, v1.9,
+ CTAN:macros/latex/contrib/oberdiek/hypdoc.dtx
+- package geometry, 2010/07/13, v5.5,
+ CTAN:macros/latex/contrib/geometry/geometry.dtx
+
+The pagesLTS.sty for LATEX2e (i. e. all documents using the
+ pagesLTS package) requires:
+- TeXFormat LaTeX2e, 1994/06/01, v2e
+- package atveryend, 2010/03/24, v1.5,
+ CTAN:macros/latex/contrib/oberdiek/atveryend.dtx
+- package everyshi, 2001/05/15, v3.00,
+ CTAN:macros/latex/contrib/ms/everyshi.dtx
+- package kvoptions, 2010/02/22, v3.7,
+ CTAN:macros/latex/contrib/oberdiek/kvoptions.dtx
+- package undolabl, 2010/09/12, v1.0g,
+ CTAN:macros/latex/contrib/undolabl/undolabl.dtx
+
+The pagesLTS-example.tex requires the same files as all
+ documents using the pagesLTS package, and additionally:
+- package alphalph, 2010/04/18, v2.3,
+ CTAN:macros/latex/generic/oberdiek/alphalph.dtx
+- package lipsum, 2005/01/26, v1.0,
+ CTAN:macros/latex/contrib/lipsum/lipsum.dtx
+- package showkeys, 2007/08/07, v3.15,
+ CTAN:macros/latex/required/tools/showkeys.dtx
+- package hyperref, 2010/09/13, v6.81n,
+ CTAN:macros/latex/contrib/hyperref.zip
+- package pagesLTS, 2010/09/22, v1.1k,
+ CTAN:macros/latex/contrib/pagesLTS/pagesLTS.dtx
+ (Well, it is the example file for this package, and
+ because you are reading the README for the pagesLTS
+ package, it can be assumed that you already have some
+ version of it - is it the current one?)
+
+which again load other packages
+(see the result of the \listfiles comman in the log-file
+ of the example).
+
+
+5 PACKAGE COMPATIBILITY
+=======================
+
+* endfloat package
+ pagesLTS is not compatible with very old versions of
+ endfloat(2.0 and older).
+ Just get the recent version of the endfloat package
+ from CTAN.
+
+* lastpage package
+ \usepackage[pagecontinue=false,alphMult=0,AlphMulti=0,
+ fnsymbolmult=false,romanMult=false,RomanMulti=false]
+ {pagesLTS}
+ can simulate the behaviour of the lastpage package.
+ Loading old (!) versions of the lastpage package before
+ the pagesLTS package before the hyperref package results
+ in multiply definitions of the LastPage label.
+
+* undolabl package
+ Version >= 1.0g is needed.
+
+6 AUTHOR/MAINTAINER
+=====================
+
+* Hans-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 informations 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 informations 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:
+ Hans-Martin Münch
+ <Martin [dot] Muench [at] Uni-Bonn [dot] de>
+
+
+8 KNOWN PROBLEMS
+=================
+
+* as yet: none... \ No newline at end of file