summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/uri/README
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-09-01 22:17:45 +0000
committerKarl Berry <karl@freefriends.org>2018-09-01 22:17:45 +0000
commit95255951c26abc51018d66c287c71bc96576a899 (patch)
tree9be83aa868e95b5a10653d039dbd1662f9fe2ca5 /Master/texmf-dist/doc/latex/uri/README
parent1aa09bbe7c7947051bd2c25388be7f8d502eb728 (diff)
uri (1sep18)
git-svn-id: svn://tug.org/texlive/trunk@48538 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/uri/README')
-rw-r--r--Master/texmf-dist/doc/latex/uri/README124
1 files changed, 72 insertions, 52 deletions
diff --git a/Master/texmf-dist/doc/latex/uri/README b/Master/texmf-dist/doc/latex/uri/README
index 60a265cfd49..3875313eced 100644
--- a/Master/texmf-dist/doc/latex/uri/README
+++ b/Master/texmf-dist/doc/latex/uri/README
@@ -1,4 +1,4 @@
-README for uri package, 2011/03/04, v1.0a
+README for uri package, 2018/09/01, v2.0a
TABLE OF CONTENTS
@@ -8,46 +8,50 @@ TABLE OF CONTENTS
2 Download
3 Installation
4 Additional Packages
-5 New Features
-6 Package Compatibility
-7 Authors/Maintainers
-8 Bug Reports
-9 Known Problems
+5 Package Compatibility
+6 Author/Maintainer
+7 Bug Reports
+8 Known Problems
1 INTRODUCTION
==============
-This package allows to automatically hyperlink uris of type arXiv, ASIN,
-DOI, HDL, NBN, PubMed, OID, TINY, TINY with preview, and XMPP in
-such a way that they are resolved to an address understood by web browsers
-without native support or add-ons for such types of uri and provides com-
-mands citeurl, mailto, ukoeln, and uref.
+This package allows to automatically hyperlink uris of type
+arXiv, ASIN, DOI, HDL, NBN, OCLC, OID, PubMed, TINY, TINY with preview,
+and WebCite in such a way that they are resolved to an address understood
+by browsers and provides commands \citeurl, \mailto, \ukoeln, and \uref.
Trademarks appear throughout this README without any trademark symbol;
they are the property of their respective trademark owner.
There is no intention of infringement; the usage is to the benefit of
the trademark owner.
+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
+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.
+
+
2 DOWNLOAD
==========
`uri' is available on CTAN:
- CTAN:macros/latex/contrib/uri/
-
-Also a ZIP file is provided that contains the files, already
-sorted in a TDS tree:
- CTAN:install/macros/latex/contrib/uri.tds.zip
+https://www.ctan.org/pkg/uri
-`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/
+Also a ZIP file is provided that contains the files:
+the manual (uri.pdf), the example (uri-example.tex),
+the compiled example (uri-example.pdf),
+driver (uri.drv), uri.dtx,
+installation file (uri.ins),
+the style file (uri.sty),
+and this README, already sorted in a TDS tree:
+http://mirror.ctan.org/install/macros/latex/contrib/uri.tds.zip
3 INSTALLATION
@@ -55,10 +59,11 @@ corresponds to
Installation with ZIP file in TDS format
----------------------------------------
-The ZIP file `uri.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.)
+The ZIP file `uri.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.../uri.tds.zip
@@ -69,19 +74,30 @@ Example:
Manual installation
-------------------
-a) Download the uri files from CTAN or the TUG server.
+a) Download the uri files from CTAN.
If necessary, unpack them.
b) Generate the package and driver files:
tex uri.ins
-c) Install the files `*.sty', and `*.cfg' in your TDS tree:
- cp *.sty *.cfg TDS:tex/latex/uri/
+c) Install the file `uri.sty' in your TDS tree:
+ cp uri.sty TDS:tex/latex/uri/
Replace `TDS:' by the prefix of your TDS tree
(texmf directory).
-d) Copy the documentation files to
- "TDS:doc/latex/uri/":
- README, uri.pdf, uri-example.tex, uri-example.pdf.
-e) Update the databases if necessary, e. g. for teTeX:
+d) Create the documentation, if necessary, e.g.
+ pdflatex uri.dtx
+ makeindex -s gind.ist uri.idx
+ pdflatex uri.dtx
+ makeindex -s gind.ist uri.idx
+ pdflatex uri.dtx
+e) Update the databases if necessary, e.g. for teTeX:
mktexlsr .../texmf
+f) Create the uri-example.pdf, if necessary, e.g.
+ pdflatex uri-example.tex
+ pdflatex uri-example.tex
+ pdflatex uri-example.tex
+g) Copy the documentation files to
+ "TDS:doc/latex/uri/":
+ README, uri.pdf, uri-example.tex,
+ uri-example.pdf.
4 ADDITIONAL PACKAGES
@@ -90,11 +106,11 @@ e) Update the databases if necessary, e. g. for teTeX:
Depending on the driver and option settings, uri loads
other packages:
* kvoptions.sty:
- CTAN:macros/latex/contrib/oberdiek/kvoptions.pdf
+ https://ctan.org/pkg/kvoptions
* url.sty:
- CTAN:macros/latex/contrib/url/url.dtx
+ https://ctan.org/pkg/url
which again load other packages
-(see the result of the \listfiles comman in the log-file
+(see the result of the \listfiles command in the log-file
of the example).
@@ -102,31 +118,34 @@ which again load other packages
=======================
uri should be loaded
-AFTER package hyperref,if hyperlinks are wanted,
-and BEFORE package hyperref, if hyperlinks are not wanted.
+AFTER package hyperref, if hyperlinks are wanted, and
+BEFORE package hyperref, if hyperlinks are not wanted.
+
+When any of the packages aurl, doi, doipubmed is used,
+there might be conflicts or results might depend on order of loading.
6 AUTHOR/MAINTAINER
-=====================
+===================
-* Hans-Martin Münch
+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 informations in TeX error 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 informations is printed at the end
- of the LaTeX run.
+* 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.
@@ -135,11 +154,12 @@ A bug report should contain:
Bug address
-----------
Bug reports can be send to the maintainer:
- Hans-Martin Münch
+ H.-Martin Münch
<Martin [dot] Muench [at] Uni-Bonn [dot] de>
8 KNOWN PROBLEMS
-=================
+================
-* as yet: none... \ No newline at end of file
+When any of the packages aurl, doi, doipubmed is used,
+there might be conflicts or results might depend on order of loading. \ No newline at end of file