Index of /applications/hyperref/ctan

      Name                    Last modified       Size  Description

[DIR] Parent Directory 18-Mar-2002 16:20 - [TXT] ChangeLog 15-Mar-2002 18:12 51k [TXT] Makefile 15-Mar-2002 03:45 1k [TXT] backref.dtx 19-Jan-2000 13:39 7k [DIR] doc/ 15-Mar-2002 02:56 - [TXT] hylatex.ltx 31-May-1999 20:03 1k [TXT] hyperref.dtx 15-Mar-2002 18:11 380k [TXT] hyperref.ins 30-Aug-2000 04:48 3k [TXT] manifest.txt 15-Mar-2002 16:28 3k [TXT] minitoc-hyper.sty 31-May-1999 20:03 85k [TXT] nameref.dtx 09-Nov-2001 07:17 11k [TXT] ntheorem-hyper.sty 31-May-1999 20:03 33k [DIR] test/ 15-Mar-2002 02:47 - [TXT] xr-hyper.sty 22-Mar-2000 07:55 4k

README for hyperref bundle 2002/03/15

TABLE OF CONTENTS
=================

Introduction
Download
Installation
Additional Packages
Package Compatibility
Authors/Maintainers
Bugreports
Known Problems
ToDo


INTRODUCTION
============

This package is used to emend cross-referencing commands in LaTeX to
produce some sort of \special commands; there are backends for the
\special set defined for HyperTeX dvi processors, for embedded pdfmark
commands for processing by Acrobat Distiller (dvips and dvipsone), for
dviwindo, for pdfTeX, for TeX4ht, and for VTEX's pdf and HTML
backends.

Included are:

  a) `backref' a package by David Carlisle to provide links back from 
     bibliography to the main text; these are hypertext links after using
     hyperref.
  b)  `nameref' a package to allow reference to the *names* of sections rather
     than their numbers.

Sebastian Rahtz <sebastian.rahtz@oucs.ox.ac.uk>
Heiko Oberdiek <oberdiek@ruf.uni-freiburg.de> 

December 1994-March 2002

DOWNLOAD
========

The main repository for hyperref is the server of the
international `TeX Users Group' (TUG):
  http://www.tug.org/applications/hyperref/
In the following this directory is abbreviated as `TUG:'.
`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

`hyperref' is available on CTAN:
  CTAN:macros/latex/contrib/supported/hyperref/
The files are organized in four directories:
  ./
    Main directory that contains `README', `.dtx',
    and `.ins' files.
  doc/
    Directory for documentation files.
  test/
    Directory for some test files.
  beta/
    Sometimes this directory exists and contains
    the latest beta/test versions of some files,
    often `hyperref.dtx'.

The hyperref directory at the TUG server has the following
structure:
  TUG:ctan/
    The stuff here will automatically be mirrored to
    CTAN with
      TUG:ctan/ = CTAN:macros/latex/contrib/supported/hyperref/
  TUG:ctan/.
  TUG:ctan/doc/
  TUG:ctan/test/
  TUG:ctan/beta/
    See explanation above.

  TUG:hyperref.zip
  TUG:hyperref-doc.zip
  TUG:hyperref-test.zip
  TUG:hyperref-beta.zip
    The files of the four directories, described above, are
    packed into four ZIP archives, so that they can be easily
    downloaded. (The ZIP files do not contain directories.)

  TUG:manual.html
  TUG:manual2.html
  TUG:manual.css
    HTML version of the quite old hyperref manual in `doc/manual.pdf'.

INSTALLATION
============

a) Download the hyperref files from CTAN or the TUG server.
   If necessary, unpack them.
b) Replace the files by the counterparts in the beta directory,
   if you want to use the latest versions.
c) Generate the package and driver files:
     tex hyperref.ins
d) Install the files `*.sty', `*.def', and `*.cfg' in your TDS tree:
     cp *.sty *.def *.cfg .../texmf/tex/latex/hyperref/
   Replace `...' by the prefix of your TDS tree.
e) Update the databases if necessary, eg. for teTeX:
     mktexlsr .../texmf

ADDITIONAL PACKAGES
===================

Depending on the driver, hyperref loads other packages:
* url.sty
    CTAN:macros/latex/contrib/other/misc/url.sty
* keyval.sty, color.sty:
    CTAN:macros/latex/required/graphics/
  An uptodate pdftex.def is available at
    http://www.tug.org/applications/pdftex/pdftex.def
    CTAN:macros/pdftex/graphics/pdftex.def


PACKAGE COMPATIBILITY
=====================

Currently only package loading orders are available:

algorithm:
  \usepackage{hyperref}
  \usepackage[chapter]{algorithm}% eg.

easyeqn: not compatible, breaks.

float:
  \usepackage{hyperref}
  \usepackage{float}

lastpage: compatible

sidecap:
  \usepackage{nameref}
  \usepackage{hyperref}
  \usepackage{sidecap}

subfigure 1995/03/06 v2.0:
  \usepackage{subfigure}
  \usepackage{hyperref}
  % hypertexnames is set to false.
subfigure v2.1: currently in development
  \usepackage{nameref}
  \usepackage{subfigure}
  \usepackage{hyperref}
  or
  \usepackage{hyperref}
  \usepackage{subfigure}

titleref:
  \usepackage{nameref}
  \usepackage{titleref}% without usetoc
  \usepackage{hyperref}

varioref:
  \usepackage{nameref}
  \usepackage{varioref}
  \usepackage{hyperref}


AUTHORS/MAINTAINERS
===================

* Sebastian Rahtz <sebastian.rahtz@computing-services.oxford.ac.uk>
* Heiko Oberdiek <oberdiek@uni-freiburg.de>


BUGREPORTS
==========

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" to get
    a list of version informations 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.

Bug address: Heiko Oberdiek <oberdiek@uni-freiburg.de>


KNOWN PROBLEMS
==============

* (half-done) hyper images (link from thumbnail in text)
* ...

TODO
====

* modules
* bookmark organisation
* documentation
* PDF threads
* more for PDF forms
  * per object setting
  * vary gap between text and box
* ...