summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r--Master/texmf-dist/doc/latex/uri/README145
-rw-r--r--Master/texmf-dist/doc/latex/uri/uri-example.pdfbin0 -> 82019 bytes
-rw-r--r--Master/texmf-dist/doc/latex/uri/uri-example.tex135
-rw-r--r--Master/texmf-dist/doc/latex/uri/uri.pdfbin0 -> 306332 bytes
4 files changed, 280 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/uri/README b/Master/texmf-dist/doc/latex/uri/README
new file mode 100644
index 00000000000..60a265cfd49
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/uri/README
@@ -0,0 +1,145 @@
+README for uri package, 2011/03/04, v1.0a
+
+
+TABLE OF CONTENTS
+=================
+
+1 Introduction
+2 Download
+3 Installation
+4 Additional Packages
+5 New Features
+6 Package Compatibility
+7 Authors/Maintainers
+8 Bug Reports
+9 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.
+
+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.
+
+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
+
+`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 `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.)
+Example:
+ cd /...somewhere.../texmf
+ unzip /...downloadpath.../uri.tds.zip
+Do not forget to refresh the file name database of this
+TDS tree.
+Example:
+ texhash /...somewhere.../texmf
+
+Manual installation
+-------------------
+a) Download the uri files from CTAN or the TUG server.
+ 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/
+ 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:
+ mktexlsr .../texmf
+
+
+4 ADDITIONAL PACKAGES
+=====================
+
+Depending on the driver and option settings, uri loads
+other packages:
+* kvoptions.sty:
+ CTAN:macros/latex/contrib/oberdiek/kvoptions.pdf
+* url.sty:
+ CTAN:macros/latex/contrib/url/url.dtx
+which again load other packages
+(see the result of the \listfiles comman in the log-file
+ of the example).
+
+
+5 PACKAGE COMPATIBILITY
+=======================
+
+uri should be loaded
+AFTER package hyperref,if hyperlinks are wanted,
+and BEFORE package hyperref, if hyperlinks are not wanted.
+
+
+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
diff --git a/Master/texmf-dist/doc/latex/uri/uri-example.pdf b/Master/texmf-dist/doc/latex/uri/uri-example.pdf
new file mode 100644
index 00000000000..90ab88c7eaa
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/uri/uri-example.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/uri/uri-example.tex b/Master/texmf-dist/doc/latex/uri/uri-example.tex
new file mode 100644
index 00000000000..a5ae4d0633f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/uri/uri-example.tex
@@ -0,0 +1,135 @@
+%%
+%% This is file `uri-example.tex',
+%% generated with the docstrip utility.
+%%
+%% The original source files were:
+%%
+%% uri.dtx (with options: `example')
+%%
+%% This is a generated file.
+%%
+%% IMPORTANT NOTICE:
+%% The package takes options.
+%%
+%% The usual disclaimers apply:
+%% If it doesn't work right that's your problem.
+%% (Nevertheless, send an e-mail to the maintainer
+%% when you find an error in this package.)
+%%
+%% 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.
+%%
+%% This work has the LPPL maintenance status "maintained".
+%%
+%% The Current Maintainer of this work is H.-Martin Muench
+%% (Martin dot Muench at Uni-Bonn dot de).
+%%
+%% This work consists of the main source file uri.dtx
+%% and the derived files
+%% uri.sty, uri.pdf, uri.ins, uri.drv,
+%% uri-example.tex.
+%%
+\documentclass{article}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\usepackage{hyperref}[2011/02/07]% v6.82b
+\hypersetup{%
+ extension=pdf,%
+ plainpages=false,%
+ pdfpagelabels=true,%
+ hyperindex=false,%
+ pdflang={en},%
+ pdftitle={uri package example},%
+ pdfauthor={Hans-Martin Muench},%
+ pdfsubject={Example for the uri package},%
+ pdfkeywords={LaTeX, uri, Hans-Martin Muench},%
+ pdfview=Fit,%
+ pdfstartview=Fit,%
+ pdfpagelayout=SinglePage,%
+ bookmarksopen=false%
+}
+\usepackage{uri}[2011/03/04]% v1.0a
+\listfiles
+\begin{document}
+\pagenumbering{arabic}
+
+\section*{Example for uri}
+\markboth{Example for uri}{Example for uri}
+
+This example demonstrates the use of package\newline
+\textsf{uri}, v1.0a as of 2011/03/04 (HMM).\newline
+No options were given, thereby the default options were used.\newline
+For more details please see the documentation!\newline
+
+\bigskip
+
+The \textsf{uri} package allows to hyperlink (with the \textsf{hyperref} package
+of \textsc{Heiko Oberdiek}) uris of type
+\begin{itemize}
+\item[--] arXiv (\url{http://www.arXiv.org/}), e.\,g. \arxiv{0905.0105v2}.
+
+\item[--] ASIN \newline
+(\url{%
+http://www.amazon.co.uk/gp/help/customer/display.html/277-3416785-8259466?ie=UTF8&nodeId=898182}%
+), \newline
+(that one is a good example for using a TINY url: \tinyuri{687j3oh})\newline
+ e.\,g. \asin{0471491039}.
+
+\item[--] DOI (\url{http://www.doi.org/index.html}), e.\,g. \doi{10.1000/182}.
+
+\item[--] HDL (\url{http://www.handle.net/factsheet.html}), e.\,g. \hdl{2128/2486}.
+
+\item[--] NBN (\url{http://nbn-resolving.de/urn:nbn:de:1111-200606309}), \newline
+ e.\,g. \nbn{urn:nbn:de:kobv:83-opus-16928}. (You could also use the option
+ \texttt{nbnpre=URN:NBN:DE:} and then \texttt{\textbackslash nbn\{kobv:83-opus-16928\}}.)
+
+\item[--] PubMed (\url{http://www.ncbi.nlm.nih.gov/pubmed/}), \newline
+ e.\,g. \pubmed{17822909}.
+
+\item[--] OID (\url{http://www.oid-info.com/#oid}), e.\,g. \oid{2.16.840}.
+
+\item[--] TINY (\url{http://tinyurl.com}), e.\,g. \tinyuri{MST19-105603} \newline
+ (uses \texttt{tinyuri} instead of \texttt{tiny}, because that command already existed).
+
+\item[--] TINY with preview, e.\,g. \tinypuri{MST19-105603}.
+
+\item[--] XMPP (\url{http://xmpp.org/about/}), e.\,g. \xmpp{time}.
+\end{itemize}
+
+Additionally some commands are provided by the uri package:
+\begin{itemize}
+\item[--] \texttt{siteurl} similar to the command of the \textsf{doipubmed} package, \newline
+ \citeurl{http://ctan.org/pkg/doipubmed}.
+
+\item[--] \texttt{mailto} for e-mail addresses, e.\,g. \mailto{spam@dante.de}.
+ Adding something like \texttt{?subject=Concerning uri package} after \texttt{mailto:\#\#1}
+ in the style file would even add this subject to (every!) e-mail hyperlink.
+
+\item[--] \texttt{ukoeln} for short University of Cologne (Universit\"{a}t zu K\"{o}ln,
+ U~Koeln; Germany; \url{http://www.pressoffice.uni-koeln.de/}) addresses, \newline
+ e.\,g. \ukoeln{XM492}.
+
+\item[--] \texttt{uref} takes two arguments, the first gives the target of the hyperlink,
+the second gives the text to be displayed for it, e.\,g. information about
+the \uref{http://ctan.org/pkg/pageslts}{pagesLTS} package, similar to \texttt{\textbackslash href}.
+\end{itemize}
+
+\bigskip
+
+Text before (e.\,g. \textsf{DOI:}) and after (well, no example) the uri to be displayed can be
+adapted by the package options.\newline
+
+Even \begin{verbatim} \doi{1.2/3-4(5)6:7<8::A-B9>0.9.C8;7-\654%23!$} \end{verbatim}
+would work (if that DOI would exist):\newline
+\doi{1.2/3-4(5)6:7<8::A-B9>0.9.C8;7-\654%23!$}.
+
+\end{document}
+\endinput
+%%
+%% End of file `uri-example.tex'.
diff --git a/Master/texmf-dist/doc/latex/uri/uri.pdf b/Master/texmf-dist/doc/latex/uri/uri.pdf
new file mode 100644
index 00000000000..dd129dccf54
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/uri/uri.pdf
Binary files differ