Debian Codegraph @

texmf-dist/source/latex/uri/uri.dtx

raw
1 % \iffalse meta-comment
2 %
3 % File: uri.dtx
4 % Version: 2018/09/06 v2.0b
5 %
6 % Copyright (C) 2011 - 2018 by
7 % H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>
8 % Portions of code copyrighted by other people as marked.
9 %
10 % This work may be distributed and/or modified under the
11 % conditions of the LaTeX Project Public License, either
12 % version 1.3c of this license or (at your option) any later
13 % version. This version of this license is in
14 % http://www.latex-project.org/lppl/lppl-1-3c.txt
15 % and the latest version of this license is in
16 % http://www.latex-project.org/lppl.txt
17 % and version 1.3c or later is part of all distributions of
18 % LaTeX version 2005/12/01 or later.
19 %
20 % This work has the LPPL maintenance status "maintained".
21 %
22 % The Current Maintainer of this work is H.-Martin Muench.
23 %
24 % This work consists of the main source file uri.dtx,
25 % the README, and the derived files
26 % uri.sty, uri.pdf, uri.ins, uri.drv,
27 % uri-example.tex, uri-example.pdf.
28 %
29 % 'uri' is available on CTAN:
30 % https://www.ctan.org/pkg/uri
31 %
32 % Also a TDS.ZIP file is provided that contains all the files
33 % already sorted in a TDS tree:
34 % http://mirror.ctan.org/install/macros/latex/contrib/uri.tds.zip
35 %
36 %<*ignore>
37 \begingroup
38 \catcode123=1 %
39 \catcode125=2 %
40 \def\x{LaTeX2e}%
41 \expandafter\endgroup
42 \ifcase 0\ifx\install y1\fi\expandafter
43 \ifx\csname processbatchFile\endcsname\relax\else1\fi
44 \ifx\fmtname\x\else 1\fi\relax
45 \else\csname fi\endcsname
46 %</ignore>
47 %<*install>
48 \input docstrip.tex
49 \obeyspaces
50 \Msg{*****************************************************************************}
51 \Msg{* Installation}
52 \Msg{* Package: uri 2018/09/06 v2.0b Hyperlinks URIs like DOI,HDL,NBN,PubMed (HMM)}
53 \Msg{*****************************************************************************}
54
55 \keepsilent
56 \askforoverwritefalse
57
58 \let\MetaPrefix\relax
59 \preamble
60
61 This is a generated file.
62
63 Project: uri
64 Version: 2018/09/06 v2.0b
65
66 Copyright (C) 2011 - 2018 by
67 H.-Martin M"unch <Martin dot Muench at Uni-Bonn dot de>
68 Portions of code copyrighted by other people as marked.
69
70 IMPORTANT NOTICE: The package takes options.
71
72 The usual disclaimer applies:
73 If it doesn't work right that's your problem.
74 (Nevertheless, send an e-mail to the maintainer
75 when you find an error in this package.)
76
77 This work may be distributed and/or modified under the
78 conditions of the LaTeX Project Public License, either
79 version 1.3c of this license or (at your option) any later
80 version. This version of this license is in
81 http://www.latex-project.org/lppl/lppl-1-3c.txt
82 and the latest version of this license is in
83 http://www.latex-project.org/lppl.txt
84 and version 1.3c or later is part of all distributions of
85 LaTeX version 2005/12/01 or later.
86
87 This work has the LPPL maintenance status "maintained".
88
89 The Current Maintainer of this work is H.-Martin Muench.
90
91 This work consists of the main source file uri.dtx,
92 the README, and the derived files
93 uri.sty, uri.pdf, uri.ins, uri.drv,
94 uri-example.tex, uri-example.pdf.
95
96 In memoriam
97 Claudia Simone Barth + 1996/01/30
98 Tommy Muench + 2014/01/02
99 Hans-Klaus Muench + 2014/08/24
100
101 \endpreamble
102 \let\MetaPrefix\DoubleperCent
103
104 \generate{%
105 \file{uri.ins}{\from{uri.dtx}{install}}%
106 \file{uri.drv}{\from{uri.dtx}{driver}}%
107 \usedir{tex/latex/uri}%
108 \file{uri.sty}{\from{uri.dtx}{package}}%
109 \usedir{doc/latex/uri}%
110 \file{uri-example.tex}{\from{uri.dtx}{example}}%
111 }
112
113 \obeyspaces
114
115 \Msg{************************************************************************}
116 \Msg{*}
117 \Msg{* To finish the installation you have to move the following}
118 \Msg{* file into a directory searched by TeX:}
119 \Msg{*}
120 \Msg{* uri.sty}
121 \Msg{*}
122 \Msg{* To produce the documentation run the file `uri.drv'}
123 \Msg{* through (pdf)LaTeX, e.g.}
124 \Msg{* pdflatex uri.drv}
125 \Msg{* makeindex -s gind.ist uri.idx}
126 \Msg{* pdflatex uri.drv}
127 \Msg{* makeindex -s gind.ist uri.idx}
128 \Msg{* pdflatex uri.drv}
129 \Msg{*}
130 \Msg{* At least two runs are necessary e.g. to get the}
131 \Msg{* references right!}
132 \Msg{*}
133 \Msg{* Happy TeXing!}
134 \Msg{*}
135 \Msg{************************************************************************}
136
137 \endbatchfile
138 %</install>
139 %<*ignore>
140 \fi
141 %</ignore>
142 %
143 % \section{The documentation driver file}
144 %
145 % The next bit of code contains the documentation driver file for
146 % \TeX , i.\,e., the file that will produce the documentation you
147 % are currently reading. It will be extracted from this file by the
148 % \verb|docstrip| programme. That is, run \LaTeX{} on \verb|docstrip|
149 % and specify the \verb|driver| option when \verb|docstrip|
150 % asks for options.
151 %
152 % \begin{macrocode}
153 %<*driver>
154 \NeedsTeXFormat{LaTeX2e}[2015/01/01]
155 \ProvidesFile{uri.drv}[2018/09/06 v2.0b
156 Hyperlinks URIs like DOI,HDL,NBN,PubMed (HMM)]
157 \documentclass{ltxdoc}[2015/03/26]% v2.0w
158 \usepackage{pdflscape}[2008/08/11]% v0.10
159 \usepackage{holtxdoc}[2012/03/21]% v0.24
160 %% uri may work with earlier versions of LaTeX2e and those
161 %% class and packages, but this was not tested.
162 %% Please consider updating your LaTeX, class, and package
163 %% to the most recent version (if they are not already the most
164 %% recent version).
165 \hypersetup{%
166 pdfsubject={Hyperlinks URIs like DOI, HDL, NBN, PubMed (HMM)},%
167 pdfkeywords={LaTeX, uri, hyperlink, arXiv, ASIN, DOI, HDL, NBN, OCLC, OID, PubMed, TINY, TINY:P, preview, WebCite, citeurl, mailto, ukoeln, uref, Hans-Martin Muench},%
168 pdfencoding=auto,%
169 pdflang={en},%
170 breaklinks=true,%
171 linktoc=all,%
172 pdfstartview=FitH,%
173 pdfpagelayout=OneColumn,%
174 bookmarksnumbered=true,%
175 bookmarksopen=true,%
176 bookmarksopenlevel=3,%
177 pdfmenubar=true,%
178 pdftoolbar=true,%
179 pdfwindowui=true,%
180 pdfnewwindow=true%
181 }
182 \CodelineIndex
183 \hyphenation{created document doc-u-ment-a-tion every-thing ignored}
184 \gdef\unit#1{\mathord{\thinspace\mathrm{#1}}}
185 \begin{document}
186 \DocInput{uri.dtx}%
187 \end{document}
188 %</driver>
189 % \end{macrocode}
190 %
191 % \fi
192 %
193 % \CheckSum{455}
194 %
195 % \CharacterTable
196 % {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
197 % Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
198 % Digits \0\1\2\3\4\5\6\7\8\9
199 % Exclamation \! Double quote \" Hash (number) \#
200 % Dollar \$ Percent \% Ampersand \&
201 % Acute accent \' Left paren \( Right paren \)
202 % Asterisk \* Plus \+ Comma \,
203 % Minus \- Point \. Solidus \/
204 % Colon \: Semicolon \; Less than \<
205 % Equals \= Greater than \> Question mark \?
206 % Commercial at \@ Left bracket \[ Backslash \\
207 % Right bracket \] Circumflex \^ Underscore \_
208 % Grave accent \` Left brace \{ Vertical bar \|
209 % Right brace \} Tilde \~}
210 %
211 % \GetFileInfo{uri.drv}
212 %
213 % \begingroup
214 % \def\x{\#,\$,\^,\_,\~,\ ,\&,\{,\},\%}%
215 % \makeatletter
216 % \@onelevel@sanitize\x
217 % \expandafter\endgroup
218 % \expandafter\DoNotIndex\expandafter{\x}
219 % \expandafter\DoNotIndex\expandafter{\string\ }
220 % \begingroup
221 % \makeatletter
222 % \lccode`9=32\relax
223 % \lowercase{%^^A
224 % \edef\x{\noexpand\DoNotIndex{\@backslashchar9}}%^^A
225 % }%^^A
226 % \expandafter\endgroup\x
227 % \DoNotIndex{\8,\",\-,\\,\ldots,\indent,\noindent}
228 % \DoNotIndex{\documentclass,\usepackage,\small,\begin,\end}
229 % \DoNotIndex{\NeedsTeXFormat,\filedate,\fileversion,\DoNotIndex}
230 % \DoNotIndex{\def,\edef,\gdef}
231 % \DoNotIndex{\textbf,\textit,\textsf,\textsc}
232 % \DoNotIndex{\if,\ifx,\ifnum,\ifdim,\else,\fi}
233 % \DoNotIndex{\CodelineIndex,\DocInput}
234 % \DoNotIndex{\newpage,\pagebreak,\newline,\linebreak,\nolinebreak}
235 % \DoNotIndex{\MessageBreak}
236 % \DoNotIndex{\smallskip,\medskip,\bigskip,\space,\,}
237 % \DoNotIndex{\plainTeX,\TeX,\LaTeX,\pdfLaTeX}
238 % \DoNotIndex{\protect,\listfiles,\textquotedblleft,\textquotedblright}
239 % \DoNotIndex{\markboth,\section,\item}
240 % \DoNotIndex{\href,\url,\nolinkurl,\pagenumbering,\xext,\ProvidesPackage}
241 % \DoNotIndex{\aurl,\doipubmed,\holtxdoc,\kvoptions,\Oberdiek,\M\"{u}nch}
242 % \DoNotIndex{\DeclareRobustCommand,\DeclareStringOption,\DeclareUrlCommand}
243 % \DoNotIndex{\PackageWarning,\ProcessKeyvalOptions,\SetupKeyvalOptions}
244 % \DoNotIndex{\UrlLeft,\UrlRight,\verb}
245 %
246 % \title{The \xpackage{uri} package}
247 % \date{2018/09/06 v2.0b}
248 % \author{H.-Martin M\"{u}nch\\\xemail{Martin.Muench at Uni-Bonn.de}}
249 %
250 % \maketitle
251 %
252 % \begin{abstract}
253 % \noindent This package allows to automatically hyperlink uris of type
254 % arXiv, ASIN, DOI, HDL, NBN, OCLC, OID, PubMed, TINY, TINY with preview,
255 % and Web\-Cite in such a way that they are resolved to an address
256 % understood by web browsers without native support or add-ons for such types
257 % of uri and provides commands |\citeurl|, |\mailto|, |\ukoeln|, and |\uref|.
258 % \end{abstract}
259 %
260 % \bigskip
261 %
262 % \noindent Disclaimer for web links: The author is not responsible for any contents
263 % referred to in this work unless if having full knowledge of illegal contents.
264 % If any damage occurs by the use of information presented there, only the
265 % author of the respective pages might be liable, not the one who has referred
266 % to these pages.
267 %
268 % \noindent Save per page about $200\unit{ml}$ water,
269 % $2\unit{g}$ CO$_{2}$ and $2\unit{g}$ wood:
270 % Therefore please print only if this is really necessary.
271 %
272 % \bigskip
273 %
274 % \tableofcontents
275 %
276 % \newpage
277 %
278 % \section{Introduction}
279 % \indent Diverse types of URIs exists. While every web browser should know
280 % how to handle an uri like \url{https://www.ctan.org/}, there are probably
281 % quite a few web browsers which cannot handle e.\,g. \url{arXiv:math/9201303}
282 % (just test it by clicking the hyperlink). There are four types of solution:
283 % \begin{enumerate}
284 % \item Change the programme code of the web browser to recognise the uri.
285 %
286 % \item Use/write a plug-in for the browser to resolve the uri.
287 %
288 % \item Use only the full, expanded uri. Then they can be reliable accessed by
289 % every\-body, but those uris usually become quite long, which is not really
290 % nice (and line breaks have their own problems).
291 %
292 % \item
293 %
294 % \begin{enumerate}
295 % \item Write the short uri (\href{https://arxiv.org/abs/math/9201303}{arXiv:math/9201303}),
296 % but link to the long, expanded one. This combines reliability and aesthetics,
297 % but can be cumbersome to write, especially when a lot of those addresses are used.
298 %
299 % \item Do as described at (a), but automatically. This is the way this package
300 % can be used.
301 % \end{enumerate}
302 % \end{enumerate}
303 %
304 % \section{Usage}
305 % \indent Just load the package placing
306 % \begin{quote}
307 % |\usepackage[<|\textit{options}|>]{uri}|
308 % \end{quote}
309 % \noindent in the preamble of your \LaTeXe{} source file
310 % (preferably after calling the \xpackage{url} and \xpackage{hyperref} package).
311 % For the different types of uri and available options see the documented
312 % code below.
313 %
314 % \section{Alternatives\label{sec:Alternatives}}
315 % There are similar packages, which do (or do not) similar
316 % things. Here is a list of some possible alternatives:
317 %
318 % \DescribeMacro{aurl}
319 % \begin{description}
320 % \item[-] The \xpackage{aurl} package \textquotedblleft [e]xtends the hyperref package
321 % with a mechanism for hyperlinked URLs abbreviated with prefixes\textquotedblright,
322 % i.\,e. similar to this package here.
323 % \end{description}
324 %
325 % \DescribeMacro{doi}
326 % \begin{description}
327 % \item[-] The \xpackage{doi} package \textquotedblleft contains a user-level command
328 % |\doi{}|, which takes a doi number, and creates a hyperlink from it. The format
329 % of the doi can be controlled by redefining the |\doitext| command\textquotedblright
330 % \ (from the \xpackage{doi} package \verb|ReadMe|). It does not handle other types
331 % of uris, naturally.
332 % \end{description}
333 %
334 % \DescribeMacro{doipubmed}
335 % \begin{description}
336 % \item[-] The \xpackage{doipubmed} package handles |DOI| as well as |PubMed| uris.
337 % \end{description}
338 %
339 % \bigskip
340 %
341 % \noindent (You programmed or found another alternative,
342 % which is available at \url{https://www.CTAN.org}?
343 % OK, send an e-mail to me with the name, location at CTAN,
344 % and a short notice, and I will probably include it in the list above.)
345 %
346 % \smallskip
347 %
348 % \noindent About how to get those packages, please see subsection~\ref{ss:Downloads}.
349 %
350 % \newpage
351 % \begin{landscape}
352 %
353 % \section{Example}
354 %
355 % \begin{macrocode}
356 %<*example>
357 \documentclass[british]{article}[2014/09/29]% v1.4h
358 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
359 \PassOptionsToPackage{hyphens}{url}% url is loaded internally by hyperref
360 \usepackage{hyperref}[2011/02/07]% v6.82b
361 \hypersetup{%
362 extension=pdf,%
363 plainpages=false,%
364 pdfpagelabels=true,%
365 hyperindex=false,%
366 pdflang={en},%
367 pdftitle={uri package example},%
368 pdfauthor={Hans-Martin Muench},%
369 pdfsubject={Example for the uri package},%
370 pdfkeywords={LaTeX, uri, Hans-Martin Muench},%
371 pdfview=Fit,%
372 pdfstartview=Fit,%
373 pdfpagelayout=SinglePage,%
374 bookmarksopen=false%
375 }
376 \usepackage{uri}[2018/09/06]% v2.0b
377 \RequirePackage{amsmath}
378 \RequirePackage{relsize}
379 \gdef\doialternative{%
380 \hbox{\text{\fontfamily{lmss}\selectfont{\smaller{%
381 DO\hspace{-0.025em}I\raisebox{0.24ex}{:}}}\kern-0.01em}}\allowbreak%
382 }% used later for demonstration of \urisetup
383 \renewcommand*{\thesubsection}{\arabic{subsection}}
384 \listfiles
385 \begin{document}
386 \pagenumbering{arabic}
387
388 \section*{Example for uri}
389 This example demonstrates the use of package\newline
390 \textsf{uri}, v2.0b as of 2018/09/06 (HMM).\newline
391 No options were given, thereby the default options were used.\newline
392 For more details please see the documentation!
393
394 \subsection{Supported types of uri\label{uritypes}}
395 The \textsf{uri} package allows to hyperlink (with the
396 \textsf{hyperref} package of \textsc{Heiko Ober\-diek}) uris of type
397 \begin{itemize}
398 \item[--] arXiv (\url{https://www.arXiv.org/}), e.\,g. \arxiv{math/9201303}.
399
400 \item[--] ASIN %
401 (\url{https://www.amazon.co.uk/gp/help/customer/display.html/277-3416785-8259466?ie=UTF8&nodeId=898182}), %
402 (that one is a good example for using a TINY url: \tinyuri{y7ju25ln}) %
403 e.\,g. \asin{0201134489}.
404
405 \item[--] DOI (\url{https://www.doi.org/index.html}), e.\,g. \doi{10.1000/182} or\linebreak%
406 \doi{10.1111/coin.12165}. For DOIs also \url{http://www.shortdoi.org/} %
407 should be mentioned, which provides \doi{10/b8xfbg} as synonym for that long doi %
408 given in \hyperref[relaxation]{\ref*{relaxation} Stress test} %
409 (and also synonyms for all other DOIs).
410
411 \item[--] HDL (\url{https://www.handle.net/index.html}), e.\,g. \hdl{2128/2486}.
412
413 \item[--] NBN (\url{http://nbn-resolving.de/urn:nbn:de:1111-200606309}),\newline%
414 e.\,g. \nbn{urn:nbn:de:bsz:mit1-opus-3145}.
415
416 \item[--] OCLC (the global library cooperative %
417 \href{https://www.oclc.org/en/about.html}{OCLC} maintains %
418 \href{https://www.worldcat.org/whatis/default.jsp}{WorldCat}), %
419 e.\,g. \oclc{935889548}.
420
421 \item[--] OID (\url{http://www.oid-info.com/#oid}), e.\,g. \oid{2.16.840}.
422
423 \item[--] PubMed (\url{https://www.ncbi.nlm.nih.gov/pubmed/}),\newline%
424 e.\,g. \pubmed{24925405}.
425
426 \item[--] TINY (\url{https://tinyurl.com/}), e.\,g. \tinyuri{MST19-105603}\newline%
427 (uses \verb|\tinyuri| instead of \verb|\tiny|, because that command already existed).
428
429 \item[--] TINY with preview (\url{https://preview.tinyurl.com/}), %
430 e.\,g. \tinypuri{MST19-105603}.
431
432 \item[--] WebCite (\url{https://www.webcitation.org/}), e.\,g. \wc{71dxjl73I},
433 which is short for \wc{query?url=http%3A%2F%2Fctan.org&date=2018-08-13}{%
434 }.
435
436 \item[--] XMPP (\url{https://xmpp.org/about/}) changed, for example
437 \verb|URN:XMPP:time| was moved from \url{https://xmpp.org/protocols/urn:xmpp:time/}
438 to\linebreak \url{https://xmpp.org/extensions/xep-0202.html}. Therefore
439 \verb|\xmpp| is no longer provided by this package. For backward compatibility
440 \verb|\xmpp{...}| gives an error message and links to
441 \url{https://xmpp.org/extensions/}.
442 \end{itemize}
443
444 \subsection{Pre/post text, \texttt{\textbackslash urisetup}}
445 \noindent Text before (e.\,g. \textsf{DOI:}) and after (well, no example)
446 the uri to be displayed can be adapted by the package options.
447 After loading the package it is possible (even somewhere within the document's body)
448 to change these \hbox{\ldots \verb|pre|} (and \hbox{\ldots \verb|post|)} texts
449 by \verb|\urisetup|, e.\,g.\newline
450 \verb|\urisetup{arxivpre={\textsf{\scshape arXiv:}\hspace{.2em}}}|.\newline
451 This command can also be used in the preamble to define pre/post texts
452 which otherwise are not understood by \LaTeX. -- Compare
453 \arxiv{0905.0105v2} to
454 \urisetup{arxivpre={\textsf{\scshape arXiv:}\hspace{.2em}}}
455 \arxiv{0905.0105v2} or
456 \doi{10.1000/182} to
457 \urisetup{doipre={\doialternative}}% \doialternative was defined in the example's preamble.
458 \doi{10.1000/182}.
459
460 \subsection{\texttt{\textbackslash citeurl}, \texttt{\textbackslash mailto}, %
461 \texttt{\textbackslash ukoeln}, and \texttt{\textbackslash uref}}
462 Additionally some commands are provided by the uri package:
463 \begin{itemize}
464 \item[--] \verb|\citeurl| similar to the command of the \textsf{doipubmed} package,\newline%
465 \citeurl{https://ctan.org/pkg/doipubmed}.
466
467 \item[--] \verb|\mailto| for e-mail addresses (optionally with e-mail subject), e.\,g.\newline%
468 \mailto{[email protected]} or with subject %
469 \mailto[Some subject of the e-mail]{[email protected]}.
470
471 \item[--] \verb|\ukoeln| for short University of Cologne (Universit\"{a}t zu K\"{o}ln, %
472 U~Koeln; Germany; \url{https://www.portal.uni-koeln.de/8911.html?&L=1})
473 ad-\linebreak dresses, e.\,g. \ukoeln{PDGKL}.
474
475 \item[--] \verb|\uref| takes two arguments, the first gives the target of the hyperlink, %
476 the second gives the text to be displayed for it, e.\,g. information about the %
477 \uref{https://ctan.org/pkg/uri}{uri package}, similar to \verb|\href|. %
478 When \textsf{hyperref} was not loaded, \newline%
479 \verb|\uref{first argument}{second argument}| %
480 defaults to\newline
481 \verb|\url{second argument}|.
482 \end{itemize}
483
484
485 \subsection{Stress test\label{relaxation}}
486 Even \verb|\doi{1.2/3-.(5):<>;%A\8!$~&{}#X}|
487 would work (if that DOI would exist; same for the other types of uri):
488 \doi{1.2/3-.(5):<>;%A\8!$~&{}#X}{%
489 } (In the error message at doi.org the \verb|#X| is not included,
490 because it is interpreted as \textquotedblleft anchor X\textquotedblright{} at
491 page \verb|1.2/3-.(5):<>;%A\8!$~&{}|, which already is not found.)\newline
492 Adding \verb|opening bracket percent-sign line break closing bracket|\newline
493 (please see the source code of the example)
494 makes programs happy, which check for bracket pairs and take the
495 first percent sign as the start of a comment and therefore miss
496 the closing bracket (but therefore also the following opening one).
497 And this real DOI works:\newline
498 \doi{10.1002/1097-4636(200108)56:2<282::AID-JBM1096>3.0.CO;2-5}\newline
499 (short: \doi{10/b8xfbg}, see DOI in %
500 \hyperref[uritypes]{\ref*{uritypes} Supported types of uri}).
501 \pagebreak
502
503 \subsection{Name-to-Thing resolver}
504 It is also possible to resolve a lot of identifiers by
505 the Name-to-Thing resolver by just appending the identifier to
506 \url{https://n2t.net/}, e.\,g. \newline%
507 \url{https://n2t.net/arXiv:math/9201303}, \newline%
508 \url{https://n2t.net/ASIN:0201134489}, \newline%
509 \url{https://n2t.net/DOI:10.1111/coin.12165}, \newline%
510 \url{https://n2t.net/HDL:2128/2486}, \newline%
511 \url{https://n2t.net/urn:nbn:de:bsz:mit1-opus-3145}, \newline%
512 \url{https://n2t.net/OCLC:935889548}, \newline%
513 \url{https://n2t.net/PubMed:24925405}, and also \newline%
514 \url{https://n2t.net/ISBN:9783638922005} and \newline%
515 \url{https://n2t.net/ARK:12148/bpt6k15385d}.\newline%
516 (And for resolving OIDs like OID:2.16.840 instead of %
517 \url{http://www.oid-info.com/cgi-bin/display?oid=2.16.840&submit=Display&action=display} %
518 it is possible to use %
519 \url{https://identifiers.org/OID:2.16.840}.)\newline%
520 Disadvantages: It is longer and requires \href{https://n2t.net/}{n2t.net} to work %
521 (or \href{https://identifiers.org/}{identifiers.org} for OID).\newline%
522 Advantage: Anybody reading the printed document can just enter %
523 the url as given into their browser without thinking about how to resolve %
524 that type of uri.
525
526
527 \subsection{Disclaimer for web links}
528 The author is not responsible for any contents referred
529 to in this work unless if having full knowledge of illegal contents. If any damage
530 occurs by the use of information presented there, only the author of the respective
531 pages might be liable, not the one who has referred to these pages.
532 \end{document}
533 %</example>
534 % \end{macrocode}
535 %
536 % \StopEventually{}
537 %
538 % \newpage
539 % \section{The implementation}
540 %
541 % We start off by checking that we are loading into \LaTeXe{} and
542 % announcing the name and version of this package.
543 %
544 % \begin{macrocode}
545 %<*package>
546 % \end{macrocode}
547 %
548 % \begin{macrocode}
549 \NeedsTeXFormat{LaTeX2e}[2015/01/01]
550 \ProvidesPackage{uri}[2018/09/06 v2.0b
551 Hyperlinks URIs like DOI,HDL,NBN,PubMed (HMM)]
552
553 % \end{macrocode}
554 %
555 % A short description of the \xpackage{uri} package:
556 %
557 % \begin{macrocode}
558 %% Allows to automatically hyperlink uris of types
559 %% arXiv, ASIN, DOI, HDL, NBN, OCLC, OID, PubMed, TINY, TINY with preview,
560 %% and WebCite
561 %% in such a way that they are resolved to an address understood by browsers
562 %% independent of native support or add-ons for such types of uri
563 %% and provides commands \citeurl, \mailto, \ukoeln, and \uref.
564 % \end{macrocode}
565 %
566 % For the handling of the options we need the \xpackage{kvoptions}
567 % package of \textsc{Heiko Oberdiek} (see subsection~\ref{ss:Downloads}):
568 %
569 % \begin{macrocode}
570 \RequirePackage{kvoptions}[2011/06/30]% v3.11
571 % \end{macrocode}
572 %
573 % We need the \xpackage{url} package of \textsc{Donald Arseneau} and
574 % \textsc{Robin Fairbairns} (see subsection~\ref{ss:Downloads}):
575 %
576 % \begin{macrocode}
577 \RequirePackage{url}[2013/09/16]% v3.4
578
579 % \end{macrocode}
580 %
581 % When spaces shall be kept, |\usepackage[obeyspaces]{url}| should be used
582 % in the document (and |\ | in the options), and for using special characters even
583 % |\usepackage[obeyspaces,T1]{url}| could be a good idea.~-
584 % When the \xpackage{hyperref} package has been loaded, we hyperlink the uris,
585 % otherwise we do not do this.\newline
586 % \textbf{So, if you want hyperlinks, load \xpackage{uri} after \xpackage{hyperref},
587 % otherwise before} (or no \xpackage{hyperref} at all, of course).
588 %
589 % For each supported uri type there are two options, |...pre| and |...post|,
590 % e.\,g. |doipre| and |doipost|. For example the option |doipre={DOI:\ }|
591 % results in \hbox{\textquotedblleft{}DOI:\ \textquotedblright}
592 % (without the quotation marks, of course) to be written before the DOIs.\newline
593 % (There are more brackets and braces then necessary here, but better
594 % save than sorry, i.\,e. make it robust.)
595 %
596 % \begin{macrocode}
597 \SetupKeyvalOptions{family = uri, prefix = uri@}
598
599 \DeclareStringOption[arXiv:]{arxivpre}[arXiv:]
600 \DeclareStringOption[]{arxivpost}[]
601
602 \DeclareStringOption[ASIN:]{asinpre}[ASIN:]
603 \DeclareStringOption[]{asinpost}[]
604
605 \DeclareStringOption[DOI:]{doipre}[DOI:]
606 \DeclareStringOption[]{doipost}[]
607
608 \DeclareStringOption[HDL:]{hdlpre}[HDL:]
609 \DeclareStringOption[]{hdlpost}[]
610
611 \DeclareStringOption[]{nbnpre}[]
612 \DeclareStringOption[]{nbnpost}[]
613
614 \DeclareStringOption[OCLC:]{oclcpre}[OCLC:]
615 \DeclareStringOption[]{oclcpost}[]
616
617 \DeclareStringOption[URN:OID:]{oidpre}[URN:OID:]
618 \DeclareStringOption[]{oidpost}[]
619
620 \DeclareStringOption[PubMed:]{pubmedpre}[PubMed:]
621 \DeclareStringOption[]{pubmedpost}[]
622
623 % \end{macrocode}
624 %
625 % The commands are \verb|tinyuri| and \verb|tinypuri|,
626 % thus the according options are
627 % tinyuripre, tinyuripre, tinyuripost, tinypuripost, and tinypuripre.
628 % In older versions they were
629 % tinypre, tinypre, tinypost, tinyppost, and tinyppre.
630 % For backward compatibility we need to define and handle them:
631 %
632 % \begin{macrocode}
633 \def\uri@tiny@pre@default{TINY:}
634 \def\uri@tiny@post@default{}
635
636 \def\uri@tinyp@pre@default{TINY:P:}
637 \def\uri@tinyp@post@default{}
638
639 \DeclareStringOption[\uri@tiny@pre@default]{tinypre}[\uri@tiny@pre@default]
640 \DeclareStringOption[\uri@tiny@post@default]{tinypost}[\uri@tiny@post@default]
641
642 \DeclareStringOption[\uri@tinyp@pre@default]{tinyppre}[\uri@tinyp@pre@default]
643 \DeclareStringOption[\uri@tinyp@post@default]{tinyppost}[\uri@tinyp@post@default]
644
645 \DeclareStringOption[\uri@tiny@pre@default]{tinyuripre}[\uri@tiny@pre@default]
646 \DeclareStringOption[\uri@tiny@post@default]{tinyuripost}[\uri@tiny@post@default]
647
648 \DeclareStringOption[\uri@tinyp@pre@default]{tinypuripre}[\uri@tinyp@pre@default]
649 \DeclareStringOption[\uri@tinyp@post@default]{tinypuripost}[\uri@tinyp@post@default]
650
651 \DeclareStringOption[WC:]{wcpre}[WC:]
652 \DeclareStringOption[]{wcpost}[]
653
654 \DeclareStringOption[URN:XMPP:]{xmpppre}[]
655 \DeclareStringOption[]{xmpppost}[]
656
657 \DeclareStringOption[<]{citeurlpre}[<]
658 \DeclareStringOption[>]{citeurlpost}[>]
659
660 \DeclareStringOption[mailto:]{mailtopre}[mailto:]
661 \DeclareStringOption[]{mailtopost}[]
662
663 \DeclareStringOption[http://UKoeln.de/]{ukoelnpre}[http://UKoeln.de/]
664 \DeclareStringOption[]{ukoelnpost}[]
665
666 \ProcessKeyvalOptions*
667
668 % \end{macrocode}
669 %
670 % To set options with more complicated/problematic content,
671 % \verb|\urisetup| is needed. With this the user can set
672 % the according option(s) after loading this package
673 % (please see the example file).
674 %
675 % \begin{macrocode}
676 \gdef\urisetup{\kvsetkeys{uri}}
677
678 % \end{macrocode}
679 %
680 % Handling of deprecated options
681 % tinypre, tinypre, tinypost, tinyppost, and tinyppre:
682 %
683 % \begin{macrocode}
684 \def\uri@wrapper{\uri@tiny@pre@default}
685 \ifx\uri@tinypre\uri@wrapper%
686 \else%
687 \ifx\uri@tinyuripre\uri@wrapper%
688 \PackageWarning{uri}{Option tinypre deprecated.\MessageBreak%
689 Please use tinyuripre instead!\MessageBreak%
690 Transfering content of option tinypre to tinyuripre now;\MessageBreak%
691 }%
692 \let\uri@tinyuripre\uri@tinypre%
693 \else%
694 \PackageError{uri}{Conflicting options tinypre and tinyuripre used}{%
695 Option tinypre deprecated.\MessageBreak%
696 Please use ONLY option tinyuripre instead!\MessageBreak%
697 Ignoring option tinypre now.\MessageBreak%
698 }%
699 \fi%
700 \fi%
701
702 \def\uri@wrapper{\uri@tiny@post@default}
703 \ifx\uri@tinypost\uri@wrapper%
704 \else%
705 \ifx\uri@tinyuripost\uri@wrapper%
706 \PackageWarning{uri}{Option tinypost deprecated.\MessageBreak%
707 Please use tinyuripost instead!\MessageBreak%
708 Transfering content of option tinypost to tinyuripost now;\MessageBreak%
709 }%
710 \let\uri@tinyuripost\uri@tinypost%
711 \else%
712 \PackageError{uri}{Conflicting options tinypost and tinyuripost used}{%
713 Option tinypost deprecated.\MessageBreak%
714 Please use ONLY option tinyuripost instead!\MessageBreak%
715 Ignoring option tinypost now.\MessageBreak%
716 }%
717 \fi%
718 \fi%
719
720 \def\uri@wrapper{\uri@tinyp@pre@default}
721 \ifx\uri@tinyppre\uri@wrapper%
722 \else%
723 \ifx\uri@tinypuripre\uri@wrapper%
724 \PackageWarning{uri}{Option tinyppre deprecated.\MessageBreak%
725 Please use tinypuripre instead!\MessageBreak%
726 Transfering content of option tinyppre to tinypuripre now;\MessageBreak%
727 }%
728 \let\uri@tinypuripre\uri@tinyppre%
729 \else%
730 \PackageError{uri}{Conflicting options tinyppre and tinypuripre used}{%
731 Option tinyppre deprecated.\MessageBreak%
732 Please use ONLY option tinypuripre instead!\MessageBreak%
733 Ignoring option tinyppre now.\MessageBreak%
734 }%
735 \fi%
736 \fi%
737
738 \def\uri@wrapper{\uri@tinyp@post@default}
739 \ifx\uri@tinyppost\uri@wrapper%
740 \else%
741 \ifx\uri@tinypuripost\uri@wrapper%
742 \PackageWarning{uri}{Option tinyppost deprecated.\MessageBreak%
743 Please use tinypuripost instead!\MessageBreak%
744 Transfering content of option tinyppost to tinypuripost now;\MessageBreak%
745 }%
746 \let\uri@tinypuripost\uri@tinyppost%
747 \else%
748 \PackageError{uri}{Conflicting options tinyppost and tinypuripost used}{%
749 Option tinyppost deprecated.\MessageBreak%
750 Please use ONLY option tinypuripost instead!\MessageBreak%
751 Ignoring option tinyppost now.\MessageBreak%
752 }%
753 \fi%
754 \fi%
755
756 % \end{macrocode}
757 %
758 % We disable the deprecated options. If not disabled,
759 % it would be possible to use \verb|\urisetup| with them
760 % without error message, but this would not have any effect,
761 % because only the newer options
762 % tinyuripre, tinyuripre, tinyuripost, tinypuripost, and tinypuripre
763 % are regarded.
764 %
765 % \begin{macrocode}
766 \DisableKeyvalOption[action={error},package=uri]{uri}{tinypre}
767 \DisableKeyvalOption[action={error},package=uri]{uri}{tinypost}
768 \DisableKeyvalOption[action={error},package=uri]{uri}{tinyppre}
769 \DisableKeyvalOption[action={error},package=uri]{uri}{tinyppost}
770
771 % \end{macrocode}
772 %
773 % Now we define the commands, using |\tinyuri| instead of |\tiny|,
774 % because that command already existed before
775 % (and accordingly |\tinypuri|, even if |\tinyp| did not exist).
776 %
777 % \begin{macrocode}
778 \@ifpackageloaded{hyperref}{%
779 \DeclareRobustCommand{\uref}[2]{\protect\href{#1}{\protect\nolinkurl{#2}}}%
780 %% arXiv
781 \DeclareUrlCommand\arxiv{\def\UrlLeft##1\UrlRight{\href{https://arxiv.org/abs/##1}{\uri@arxivpre##1\uri@arxivpost}}}%
782 %% ASIN
783 \DeclareUrlCommand\asin{\def\UrlLeft##1\UrlRight{\href{https://amzn.com/##1}{\uri@asinpre##1\uri@asinpost}}}%
784 %% DOI
785 \DeclareUrlCommand\doi{\def\UrlLeft##1\UrlRight{\href{https://dx.doi.org/##1}{\uri@doipre##1\uri@doipost}}}%
786 %% HDL
787 \DeclareUrlCommand\hdl{\def\UrlLeft##1\UrlRight{\href{https://hdl.handle.net/##1}{\uri@hdlpre##1\uri@hdlpost}}}%
788 %% NBN
789 \DeclareUrlCommand\nbn{\def\UrlLeft##1\UrlRight{\href{https://nbn-resolving.org/urn/resolver.pl?urn=##1}{\uri@nbnpre##1\uri@nbnpost}}}%
790 %% OCLC
791 \DeclareUrlCommand\oclc{\def\UrlLeft##1\UrlRight{\href{https://www.worldcat.org/oclc/##1}{\uri@oclcpre##1\uri@oclcpost}}}%
792 %% OID
793 \DeclareUrlCommand\oid{\def\UrlLeft##1\UrlRight{\href{http://www.oid-info.com/cgi-bin/display?oid=##1&submit=Display&action=display}{%
794 \uri@oidpre##1\uri@oidpost}}}%
795 %% PubMed
796 \DeclareUrlCommand\pubmed{\def\UrlLeft##1\UrlRight{%
797 \href{https://www.ncbi.nlm.nih.gov/entrez/query.fcgi?cmd=Retrieve&db=PubMed&list_uids=##1&dopt=Abstract}{\uri@pubmedpre##1\uri@pubmedpost}}}%
798 %% TINY
799 \DeclareUrlCommand\tinyuri{\def\UrlLeft##1\UrlRight{\href{https://tinyurl.com/##1}{\uri@tinyuripre##1\uri@tinyuripost}}}%
800 %% TINYP (tiny with preview)
801 \DeclareUrlCommand\tinypuri{\def\UrlLeft##1\UrlRight{\href{https://preview.tinyurl.com/##1}{\uri@tinypuripre##1\uri@tinypuripost}}}%
802 %% WebCite
803 \DeclareUrlCommand\wc{\def\UrlLeft##1\UrlRight{\href{https://www.webcitation.org/##1}{\uri@wcpre##1\uri@wcpost}}}%
804 %% XMPP
805 \DeclareUrlCommand\xmpp{%
806 \PackageError{uri}{Command \string\xmpp\space deprecated}{%
807 XMPP (https://xmpp.org/about/) changed, for example URN:XMPP:time\MessageBreak%
808 was moved from https://xmpp.org/protocols/urn:xmpp:time/\MessageBreak%
809 to https://xmpp.org/extensions/xep-0202.html. Therefore\MessageBreak%
810 \string\xmpp\space is no longer provided by this package.\MessageBreak%
811 For backward compatibility \string\xmpp\space links to\MessageBreak%
812 https://xmpp.org/extensions/.\MessageBreak%
813 Please replace \string\xmpp\space in your document by the appropriate url.\MessageBreak%
814 }%
815 \def\UrlLeft##1\UrlRight{\href{https://xmpp.org/extensions/}{\uri@xmpppre##1\uri@xmpppost}}%
816 }%
817 %% citeurl
818 \DeclareUrlCommand\citeurl{\def\UrlLeft##1\UrlRight{\href{##1}{\uri@citeurlpre##1\uri@citeurlpost}}}%
819 %% mailto
820 \DeclareUrlCommand\mailto@{\def\UrlLeft##1\UrlRight{\href{mailto:##1\mailto@subject}{\uri@mailtopre##1\uri@mailtopost}}}%
821 \DeclareRobustCommand\mailto[1][]{\def\mailto@subject{?subject=#1}\mailto@}%
822 % \end{macrocode}
823 %
824 % \verb|\mailto| code provided by \textsc{Frank Mittelbach} (thanks!),
825 % making possible \verb|\mailto{[email protected]}| as well as\newline
826 % \verb|\mailto[Some subject of the e-mail]{[email protected]}|,
827 % i.\,e. \verb|mailto:[email protected]?subject=Some subject of the e-mail|.
828 %
829 % \begin{macrocode}
830 %% ukoeln
831 \DeclareUrlCommand\ukoeln{\def\UrlLeft##1\UrlRight{\href{https://UKoeln.de/##1}{\uri@ukoelnpre##1\uri@ukoelnpost}}}%
832 }{% otherwise, i.e. if hyperref has not been loaded:
833 \DeclareRobustCommand{\uref}[1]{\url}%
834 %% arXiv
835 \DeclareUrlCommand\arxiv{\def\UrlLeft##1\UrlRight{\uri@arxivpre##1\uri@arxivpost}}%
836 %% ASIN
837 \DeclareUrlCommand\asin{\def\UrlLeft##1\UrlRight{\uri@asinpre##1\uri@asinpost}}%
838 %% DOI
839 \DeclareUrlCommand\doi{\def\UrlLeft##1\UrlRight{\uri@doipre##1\uri@doipost}}%
840 %% HDL
841 \DeclareUrlCommand\hdl{\def\UrlLeft##1\UrlRight{\uri@hdlpre##1\uri@hdlpost}}%
842 %% NBN
843 \DeclareUrlCommand\nbn{\def\UrlLeft##1\UrlRight{\uri@nbnpre##1\uri@nbnpost}}%
844 %% OCLC
845 \DeclareUrlCommand\oclc{\def\UrlLeft##1\UrlRight{\uri@oclcpre##1\uri@oclcpost}}%
846 %% OID
847 \DeclareUrlCommand\oid{\def\UrlLeft##1\UrlRight{\uri@oidpre##1\uri@oidpost}}%
848 %% PubMed
849 \DeclareUrlCommand\pubmed{\def\UrlLeft##1\UrlRight{\uri@pubmedpre##1\uri@pubmedpost}}%
850 %% TINY
851 \DeclareUrlCommand\tinyuri{\def\UrlLeft##1\UrlRight{\uri@tinyuripre##1\uri@tinyuripost}}%
852 %% TINYP (tiny with preview)
853 \DeclareUrlCommand\tinypuri{\def\UrlLeft##1\UrlRight{\uri@tinypuripre##1\uri@tinypuripost}}%
854 %% WebCite
855 \DeclareUrlCommand\wc{\def\UrlLeft##1\UrlRight{\uri@wcpre##1\uri@wcpost}}%
856 %% XMPP
857 \DeclareUrlCommand\xmpp{\def\UrlLeft##1\UrlRight{\uri@xmpppre##1\uri@xmpppost}}%
858 %% citeurl
859 \DeclareUrlCommand\citeurl{\def\UrlLeft##1\UrlRight{\uri@citeurlpre##1\uri@citeurlpost}}%
860 %% mailto
861 \DeclareUrlCommand\mailto@{\def\UrlLeft##1\UrlRight{\uri@mailtopre##1\uri@mailtopost}}%
862 \DeclareRobustCommand\mailto[1][]{\mailto@}%
863 %% ukoeln
864 \DeclareUrlCommand\ukoeln{\def\UrlLeft##1\UrlRight{\uri@ukoelnpre##1\uri@ukoelnpost}}%
865 }
866
867 % \end{macrocode}
868 %
869 % Note that you cannot create those addresses by this way, only link to existing ones.
870 %
871 % That was already everything which was necessary.
872 %
873 % (Once you get the syntax for the |\DeclareUrlCommand| right, it is straight forward.
874 % Emphasis is at \textquotedblleft Once\textquotedblright\ldots )
875 %
876 % \pagebreak
877 % \begin{macro}{\AtBeginDocument}
878 % \indent |\AtBeginDocument| it is checked whether any of the
879 % \xpackage{aurl}, \xpackage{doi}, or \xpackage{doipubmed} packages are loaded.
880 %
881 % \begin{macrocode}
882 \AtBeginDocument{%
883 \@ifpackageloaded{aurl}%
884 {\PackageWarning{uri}{Packages uri AND aurl detected.\MessageBreak%
885 Results might depend on order of loading;\MessageBreak}%
886 }{\relax}%
887 \@ifpackageloaded{doi}%
888 {\PackageWarning{uri}{Packages uri AND doi detected.\MessageBreak%
889 Results will depend on order of loading!\MessageBreak%
890 Consider using only one package.\MessageBreak%
891 The uri package alone should be sufficient;\MessageBreak}%
892 }{\relax}%
893 \@ifpackageloaded{doipubmed}%
894 {\PackageWarning{uri}{Packages uri AND doipubmed detected.\MessageBreak%
895 Results will depend on order of loading!\MessageBreak%
896 Consider using only one package.\MessageBreak%
897 The uri package alone should be sufficient;\MessageBreak}%
898 }{\relax}%
899 }%
900 % \end{macrocode}
901 % \end{macro}
902 %
903 % \begin{macrocode}
904 %</package>
905 % \end{macrocode}
906 %
907 % \end{landscape}
908 % \newpage
909 %
910 % \section{Installation}
911 %
912 % \subsection{Downloads\label{ss:Downloads}}
913 %
914 % Everything is available on CTAN: \url{https://www.ctan.org/pkg/}
915 % but may need additional packages themselves.
916 %
917 % \DescribeMacro{uri.dtx}
918 % For unpacking the |uri.dtx| file and constructing the documentation it is required
919 % (newer versions should be OK):
920 % \begin{description}
921 % \item[-] \TeX{} Format \LaTeXe, 2016/03/31, v2$\varepsilon $:
922 % \url{https://www.CTAN.org}
923 %
924 % \item[-] document class \xclass{ltxdoc}, 2015/03/26, v2.0w,
925 % \url{https://www.ctan.org/pkg/ltxdoc}
926 %
927 % \item[-] package \xpackage{pdflscape}, 2008/08/11, v0.10,
928 % \url{https://www.ctan.org/pkg/pdflscape}
929 %
930 % \item[-] package \xpackage{holtxdoc}, 2012/03/21, v0.24,
931 % \url{https://www.ctan.org/pkg/holtxdoc}
932 %
933 % \item[-] package \xpackage{hypdoc}, 2011/08/19, v1.11,
934 % \url{https://www.ctan.org/pkg/hypdoc}
935 % \end{description}
936 %
937 % \DescribeMacro{uri.sty}
938 % The |uri.sty| for \LaTeXe{} (i.\,e. all documents using
939 % the \xpackage{uri} package) requires:
940 % \begin{description}
941 % \item[-] \TeX{} Format \LaTeXe, 2016/03/31, v2$\varepsilon $:
942 % \url{https://www.CTAN.org}
943 %
944 % \item[-] package \xpackage{kvoptions}, 2011/06/30, v3.11,
945 % \url{https://www.ctan.org/pkg/kvoptions}
946 %
947 % \item[-] package \xpackage{url}, 2013/09/16, v3.4,
948 % \url{https://www.ctan.org/pkg/url}
949 % \end{description}
950 %
951 % \DescribeMacro{uri-example.tex}
952 % The |uri-example.tex| requires the same files as all
953 % documents using the \xpackage{uri} package, especially:
954 % \begin{description}
955 % \item[-] package \xpackage{hyperref}, 2012/11/06, v6.83m,
956 % \url{https://www.ctan.org/pkg/hyperref}\newline
957 % (not generally necessary but probably used most often)
958 % \item[-] package \xpackage{uri}, 2018/09/06, v2.0b,
959 % \url{https://www.ctan.org/pkg/uri}\newline
960 % (Well, it is the example file for this package, and because you are reading the
961 % documentation for the \xpackage{uri} package, it can be assumed that you already
962 % have some version of it~-- is it the current one?)
963 % \end{description}
964 % \noindent and additionally (for demonstration purposes)
965 % \begin{description}
966 % \item[-] package \xpackage{amsmath}, 2016/03/10, v2.15b,
967 % \url{https://www.ctan.org/pkg/amsmath}
968 % \item[-] package \xpackage{relsize}, 2013/03/29, v4.1,
969 % \url{https://www.ctan.org/pkg/relsize}
970 % \end{description}
971 %
972 % As possible alternatives to \xpackage{uri} in section \ref{sec:Alternatives}
973 % there are listed
974 % \DescribeMacro{aurl}
975 % \DescribeMacro{doi}
976 % \DescribeMacro{doipubmed}
977 % \begin{description}
978 % \item[-] package \xpackage{aurl}, 2016/08/12, v?.?,
979 % \url{https://www.ctan.org/pkg/aurl}
980 %
981 % \item[-] package \xpackage{doi}, 2007/07/24, v?.?,
982 % \url{https://www.ctan.org/pkg/doi}
983 %
984 % \item[-] package \xpackage{doipubmed}, 2007/08/20, v1.01,
985 % \url{https://www.ctan.org/pkg/doipubmed}
986 % \end{description}
987 %
988 % \DescribeMacro{Oberdiek}
989 % \DescribeMacro{holtxdoc}
990 % \DescribeMacro{kvoptions}
991 % All packages of \textsc{Heiko Oberdiek}'s bundle `oberdiek'
992 % (especially \xpackage{holtxdoc} and \xpackage{kvoptions})
993 % are also available in a TDS compliant ZIP archive:\newline
994 % \url{http://mirror.ctan.org/install/macros/latex/contrib/oberdiek.tds.zip}.\newline
995 % It is probably best to download and use this, because the packages in there
996 % should be both recent and compatible.
997 %
998 % \DescribeMacro{M\"{u}nch}
999 % A list of my packages can be found at \url{https://www.ctan.org/author/muench-hm}.
1000 %
1001 % \subsection{Package, unpacking TDS}
1002 % \paragraph{Package.} This package is available on \url{https://www.CTAN.org}.
1003 % \begin{description}
1004 % \item[\url{http://mirror.ctan.org/macros/latex/contrib/uri/uri.dtx}]\hspace*{0.1cm}
1005 % The source file.
1006 % \item[\url{http://mirror.ctan.org/macros/latex/contrib/uri/uri.pdf}]\hspace*{0.1cm}
1007 % The documentation.
1008 % \item[\url{http://mirror.ctan.org/macros/latex/contrib/uri/uri-example.pdf}]\hspace*{0.1cm}
1009 % The compiled example file, as it should look like.
1010 % \item[\url{http://mirror.ctan.org/macros/latex/contrib/uri/README}]\hspace*{0.1cm}
1011 % The README file.
1012 % \end{description}
1013 % There is also a uri.tds.zip available:
1014 % \begin{description}
1015 % \item[\url{http://mirror.ctan.org/install/macros/latex/contrib/uri.tds.zip}]\hspace*{0.1cm}\newline
1016 % Everything in TDS compliant, compiled format.
1017 % \end{description}
1018 % which additionally contains\newline
1019 % \begin{tabular}{ll}
1020 % uri.ins & The installation file.\\
1021 % uri.drv & The driver to generate the documentation.\\
1022 % uri.sty & The \xext{sty}le file.\\
1023 % uri-example.tex & The example file.%
1024 % \end{tabular}
1025 %
1026 % \bigskip
1027 %
1028 % \noindent For required other packages, see the preceding subsection.
1029 %
1030 % \paragraph{Unpacking.} The \xfile{.dtx} file is a self-extracting
1031 % \docstrip{} archive. The files are extracted by running the
1032 % \xfile{.dtx} through \plainTeX:
1033 % \begin{quote}
1034 % \verb|tex uri.dtx|
1035 % \end{quote}
1036 %
1037 % About generating the documentation see paragraph~\ref{GenDoc} below.\newline
1038 %
1039 % \paragraph{TDS.} Now the different files must be moved into
1040 % the different directories in your installation TDS tree
1041 % (also known as \xfile{texmf} tree):
1042 % \begin{quote}
1043 % \def\t{^^A
1044 % \begin{tabular}{@{}>{\ttfamily}l@{ $\rightarrow$ }>{\ttfamily}l@{}}
1045 % uri.sty & tex/latex/uri.sty\\
1046 % uri.pdf & doc/latex/uri.pdf\\
1047 % uri-example.tex & doc/latex/uri-example.tex\\
1048 % uri-example.pdf & doc/latex/uri-example.pdf\\
1049 % uri.dtx & source/latex/uri.dtx\\
1050 % \end{tabular}^^A
1051 % }^^A
1052 % \sbox0{\t}^^A
1053 % \ifdim\wd0>\linewidth
1054 % \begingroup
1055 % \advance\linewidth by\leftmargin
1056 % \advance\linewidth by\rightmargin
1057 % \edef\x{\endgroup
1058 % \def\noexpand\lw{\the\linewidth}^^A
1059 % }\x
1060 % \def\lwbox{^^A
1061 % \leavevmode
1062 % \hbox to \linewidth{^^A
1063 % \kern-\leftmargin\relax
1064 % \hss
1065 % \usebox0
1066 % \hss
1067 % \kern-\rightmargin\relax
1068 % }^^A
1069 % }^^A
1070 % \ifdim\wd0>\lw
1071 % \sbox0{\small\t}^^A
1072 % \ifdim\wd0>\linewidth
1073 % \ifdim\wd0>\lw
1074 % \sbox0{\footnotesize\t}^^A
1075 % \ifdim\wd0>\linewidth
1076 % \ifdim\wd0>\lw
1077 % \sbox0{\scriptsize\t}^^A
1078 % \ifdim\wd0>\linewidth
1079 % \ifdim\wd0>\lw
1080 % \sbox0{\tiny\t}^^A
1081 % \ifdim\wd0>\linewidth
1082 % \lwbox
1083 % \else
1084 % \usebox0
1085 % \fi
1086 % \else
1087 % \lwbox
1088 % \fi
1089 % \else
1090 % \usebox0
1091 % \fi
1092 % \else
1093 % \lwbox
1094 % \fi
1095 % \else
1096 % \usebox0
1097 % \fi
1098 % \else
1099 % \lwbox
1100 % \fi
1101 % \else
1102 % \usebox0
1103 % \fi
1104 % \else
1105 % \lwbox
1106 % \fi
1107 % \else
1108 % \usebox0
1109 % \fi
1110 % \end{quote}
1111 % If you have a \xfile{docstrip.cfg} that configures and enables \docstrip's
1112 % TDS installing feature, then some files can already be in the right
1113 % place, see the documentation of \docstrip.
1114 %
1115 % \subsection{Refresh file name databases}
1116 %
1117 % If your \TeX~distribution (\TeX{} Live, \mikTeX, \teTeX, \dots) relies on
1118 % file name databases, you must refresh these. For example, \teTeX{} users run
1119 % \verb|texhash| or \verb|mktexlsr|.
1120 %
1121 % \subsection{Some details for the interested}
1122 %
1123 % \paragraph{Unpacking with \LaTeX{}.}
1124 % The \xfile{.dtx} chooses its action depending on the format:
1125 % \begin{description}
1126 % \item[\plainTeX:] Run \docstrip{} and extract the files.
1127 % \item[\LaTeX:] Generate the documentation.
1128 % \end{description}
1129 % If you insist on using \LaTeX{} for \docstrip{} (really,
1130 % \docstrip{} does not need \LaTeX ), then inform the autodetect routine
1131 % about your intention:
1132 % \begin{quote}
1133 % \verb|latex \let\install=y\input{uri.dtx}|
1134 % \end{quote}
1135 % Do not forget to quote the argument according to the demands
1136 % of your shell.
1137 %
1138 % \paragraph{Generating the documentation.\label{GenDoc}}
1139 % You can use both the \xfile{.dtx} or the \xfile{.drv} to generate
1140 % the documentation. The process can be configured by a
1141 % configuration file \xfile{ltxdoc.cfg}. For instance, put the following
1142 % line into this file, if you want to have A4 as paper format:
1143 % \begin{quote}
1144 % \verb|\PassOptionsToClass{a4paper}{article}|
1145 % \end{quote}
1146 %
1147 % \noindent An example follows how to generate the
1148 % documentation with \pdfLaTeX :
1149 %
1150 % \begin{quote}
1151 %\begin{verbatim}
1152 %pdflatex uri.drv
1153 %makeindex -s gind.ist uri.idx
1154 %pdflatex uri.drv
1155 %makeindex -s gind.ist uri.idx
1156 %pdflatex uri.drv
1157 %\end{verbatim}
1158 % \end{quote}
1159 %
1160 % \subsection{Compiling the example}
1161 %
1162 % The example file, \xpackage{uri-example.tex}, can be compiled via\newline
1163 % \indent \verb|(pdf)latex uri-example.tex|\newline
1164 % but will need probably three compiler runs to get everything right.
1165 %
1166 % \section{Acknowledgements}
1167 %
1168 % I (H.-Martin M\"{u}nch) would like to thank \textsc{Heiko Oberdiek}
1169 % for providing a~lot~(!) of useful packages (from
1170 % which I also got everything I know about creating a file in \xfile{dtx}
1171 % format, ok, say it: copying), \textsc{Frank Mittelbach} for several bug reports
1172 % and for code for improving the package, \textsc{Volker RW Schaa} for a bug report,
1173 % everybody of the CTAN team for managing CTAN, and the
1174 % \Newsgroup{comp.text.tex} and \Newsgroup{de.comp.text.tex}
1175 % newsgroups and everybody at \url{https://tex.stackexchange.com/}
1176 % for their help in all things \hbox{\TeX{}.}
1177 %
1178 % \phantomsection
1179 % \begin{History}\label{History}
1180 % \begin{Version}{2011/03/04 v1.0a}
1181 % \item First version of this package.
1182 % \end{Version}
1183 % \begin{Version}{2011 -- 2018 v1.0\ldots}
1184 % \item Several versions, which where not officially published.
1185 % \end{Version}
1186 % \begin{Version}{2018/09/01 v2.0a}
1187 % \item Now using the \xpackage{pdflscape} package instead of \xpackage{lscape} package.
1188 % \item The \xpackage{holtxdoc} package was fixed (recent: 2011/02/04, v0.21), therefore
1189 % the warning in \xfile{drv} could be removed.-- Adapted the style of this
1190 % doc\-u\-ment\-a\-tion to new \textsc{Oberdiek} \xfile{dtx} style.
1191 % \item Made |\newcommand|s robust.
1192 % \item OCLC and WebCite added; alternative package aurl added,
1193 % URLs and documentation updated.
1194 % \item Name-to-Thing resolver added to the example.
1195 % \item XMPP removed due to changes at XMPP.
1196 % \item New \verb|\urisetup| to be able to use complicated pre/post text
1197 % (and change it mid-document!).
1198 % \item Added an optional argument to \verb|\mailto| for providing the e-mail's subject.
1199 % \item Options tinypre, tinypre, tinypost, tinyppost, and tinyppre
1200 % replaced by tinyuripre, tinyuripre, tinyuripost, tinypuripost, and tinypuripre,
1201 % because the commands are \verb|tinyuri| and \verb|tinypuri|.
1202 % \item Bugs fixed.
1203 % \end{Version}
1204 % \begin{Version}{2018/09/06 v2.0b}
1205 % \item Bug fix: README file format, .tds placement, wrong word, OID not n2t, description.
1206 % \end{Version}
1207 % \end{History}
1208 %
1209 % \bigskip
1210 %
1211 % When you find a mistake or have a suggestion for an improvement of this package,
1212 % please send an e-mail to the maintainer, thanks! (Please see BUG REPORTS in the README.)
1213 %
1214 % \PrintIndex
1215 %
1216 % \Finale
1217 \endinput