summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pax/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pax/README')
-rw-r--r--Master/texmf-dist/doc/latex/pax/README196
1 files changed, 0 insertions, 196 deletions
diff --git a/Master/texmf-dist/doc/latex/pax/README b/Master/texmf-dist/doc/latex/pax/README
deleted file mode 100644
index 546bfc12d39..00000000000
--- a/Master/texmf-dist/doc/latex/pax/README
+++ /dev/null
@@ -1,196 +0,0 @@
-README for project pax (PDFAnnotExtractor), 2007/07/12 v0.1e
-
-
-TABLE OF CONTENTS
-=================
-
-A. Project pax
-B. Copyright, License
-C. Files
-D. Author
-E. Download
-F. Installation
-G. Use
-H. History
-
-
-A. PROJECT PAX
-==============
-
-If PDF files are included using pdfTeX, PDF annotations
-are stripped. This project tries a solution without
-altering pdfTeX. A Java program (pax.jar) parses the PDF file that
-will later be included. It writes the data of the annotations
-in a file that can be read by TeX. Then a LaTeX package (pax.sty)
-extends the graphics package. If a PDF file is included, the package
-looks for the file with the annotation data, reads them and puts
-the annotations in the right place.
-
-Project status: experimental
-
-
-B. COPYRIGHT, LICENSE
-=====================
-
-Copyright (C) 2006, 2007 Heiko Oberdiek.
-
-The project consists of two parts:
-* The Java program pax.jar with sources.
- License is GPL, see license/gpl.txt.
-* The LaTeX package pax.sty.
- License is LPPL 1.3.
-The file README belongs to both parts.
-
-The Java program uses the PDF library PDFBox,
-see http://www.pdfbox.org/.
-
-
-C. FILES
-========
-
-The project is available in CTAN (ftp.ctan.org):
- CTAN:macros/latex/contrib/pax/
-
-There are the following files:
-* README
- This file.
-* pax-tds.zip
- The whole project, ready to unpack in a TDS (texmf) tree.
-
-The files inside pax-tds.zip:
-* doc/latex/pax/README
- This file.
-* scripts/pax/pax.jar
- The Java program.
-* source/latex/pax/license/LaTeX/lppl.txt
- License (LPPL) for the LaTeX package.
-* source/latex/pax/license/PDFAnnotExtractor/gpl.txt
- License (GPL) for the Java program.
-* source/latex/pax/src/Constants.java
- source/latex/pax/src/Entry.java
- source/latex/pax/src/EntryWriteException.java
- source/latex/pax/src/PDFAnnotExtractor.java
- source/latex/pax/src/StringVisitor.java
- Java source files.
-* source/latex/pax/src/MANIFEST.MF
- Manifest file for the JAR file.
-* source/latex/pax/src/build.xml
- Ant build file for generating the JAR file.
-* tex/latex/pax/pax.sty
- The LaTeX package.
-
-
-D. AUTHOR
-=========
-
-Heiko Oberdiek <oberdiek@uni-freiburg.de>
-
-
-E. DOWNLOAD
-===========
-
-1. Download pax-tds.zip from CTAN:
- ftp://ftp.ctan.org/tex-archive/macros/latex/contrib/pax/pax-tds.zip
-
-2. Download PDFBox-0.7.2.jar from http://www.pdfbox.org/:
- http://prdownloads.sourceforge.net/pdfbox/PDFBox-0.7.2.zip?download
-
-F. INSTALLATION
-===============
-
-Examples are given for linux.
-
-3. Install PDFBox. In the following it is assumed, that the JAR file
- is available as:
- /usr/local/share/PDFBox-0.7.2/lib/PDFBox-0.7.2.jar
-
-4. Unzip pax-tds.zip inside the TDS tree, where you want to put this
- project, e.g.:
- unzip pax-tds -d /usr/local/share/texmf
- Don't forget to update the database (texhash, mktexlsr, ...).
-
-5. Put the PDFBox library in the right place:
- mkdir /usr/local/share/texmf/scripts/pax/lib
- ln /usr/local/share/PDFBox-0.7.2/lib/PDFBox-0.7.2.jar \
- /usr/local/share/texmf/scripts/pax/lib/
- (A symbol link does not seam to work, a hard link or copy is needed.)
- Alternatively, include PDFBox-0.7.2.jar in your CLASSPATH and/or
- adjust the Class-Path entry in MANIFEST.MF of pax.jar for the
- right location of the PDFBox library.
-
-6. Write a wrapper script or whatever to ease the call of the
- Java program, e.g.:
- #!/bin/sh
- java -jar /usr/local/share/texmf/scripts/pax/pax.jar "$@"
-
-Version of PDFBox
------------------
-Developing the pax project I have used and tested version 0.7.2.
-However, you may try a more uptodate version of PDFBox.
-Then fix the entry in the file MANIFEST.MF inside pax.jar or
-create a symbol link that TDS:scripts/pax/lib/PDFBox-0.7.2.jar
-points to the new JAR file.
-
-
-G. USE
-======
-
-As example I am using usrguide.pdf (with links from project latex-tds)
-that will be included in test.tex:
-
-%%% cut %%% test.tex %%% cut %%%
-\documentclass[a4paper,12pt,landscape]{article}
-\usepackage[
- hmargin=1in,
- vmargin=1in,
-]{geometry}
-
-\usepackage{pdfpages}
-% pdfpages loads graphicx
-
-\usepackage{pax}
-
-\iffalse
- \usepackage{hyperref}
- \hypersetup{
- filebordercolor={1 1 0},
- }
-\fi
-
-\begin{document}
- \includepdf[pages=-,nup=2x1]{usrguide}
-\end{document}
-%%% cut %%% test.tex %%% cut %%%
-
-First run the Java program on usrguide.pdf:
-
- $ java -jar pax.jar usrguide.pdf
-
-It generates usrguide.pax.
-Next run pdflatex on test.tex twice at least:
-
- $ pdflatex test
- $ pdflatex test
-
-Then the links should work.
-
-Additionally package hyperref can be used (replace \iffase by \iftrue).
-Then the links can be configured using hyperref settings.
-(But keep in mind, the colored links by option colorlinks can't
-be changed in included documents.
-
-
-H. History
-==========
-
-2006/08/24 v0.1a
- * First release.
-2006/09/04 v0.1b
- * Bug fix in PDFAnnotExtractor.add_dest()/named destinations.
-2007/06/29 v0.1c
- * \l@addto@macro renamed to \PAX@l@addto@macro to avoid
- collision with classes of KOMA-Script.
-2007/06/30 v0.1d
- * Use of package `etexmcds'.
-2007/07/12 v0.1e
- * The Java program can be called with several files.