summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/url
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/url
Initial commit
Diffstat (limited to 'macros/latex/contrib/url')
-rw-r--r--macros/latex/contrib/url/miscdoc.sty8
-rw-r--r--macros/latex/contrib/url/url.pdfbin0 -> 260786 bytes
-rw-r--r--macros/latex/contrib/url/url.sty313
-rw-r--r--macros/latex/contrib/url/url.tex325
4 files changed, 646 insertions, 0 deletions
diff --git a/macros/latex/contrib/url/miscdoc.sty b/macros/latex/contrib/url/miscdoc.sty
new file mode 100644
index 0000000000..179939fc98
--- /dev/null
+++ b/macros/latex/contrib/url/miscdoc.sty
@@ -0,0 +1,8 @@
+\ProvidesPackage{miscdoc}[2010/01/20 macros for documenting latex/misc pkgs]
+
+% T1 encoding assumed
+\newcommand\cs[1]{\texttt{\char`\\#1}}
+
+\newcommand\newitem{\par\addvspace{1ex}\noindent}
+
+\newcommand\meta[1]{\ensuremath{\langle}\emph{#1}\ensuremath{\rangle}}
diff --git a/macros/latex/contrib/url/url.pdf b/macros/latex/contrib/url/url.pdf
new file mode 100644
index 0000000000..ef4066d19b
--- /dev/null
+++ b/macros/latex/contrib/url/url.pdf
Binary files differ
diff --git a/macros/latex/contrib/url/url.sty b/macros/latex/contrib/url/url.sty
new file mode 100644
index 0000000000..801214f6df
--- /dev/null
+++ b/macros/latex/contrib/url/url.sty
@@ -0,0 +1,313 @@
+% url.sty ver 3.4 16-Sep-2013 Donald Arseneau asnd@triumf.ca
+% Copyright 1996-2013 Donald Arseneau, Vancouver, Canada.
+% This program can be used, distributed, and modified under the terms
+% of the LaTeX Project Public License, version 2 or later.
+%
+% A form of \verb that allows linebreaks at certain characters or
+% combinations of characters, accepts reconfiguration, and can usually
+% be used in the argument to another command. It is intended for email
+% addresses, hypertext links, directories/paths, etc., which normally
+% have no spaces. The font may be selected using the \urlstyle command,
+% and new url-like commands can be defined using \urldef.
+%
+% Usage: Conditions:
+% \url{ } If the argument contains any "%" or "^^", or ends with
+% "\", it can't be used in the argument to another command.
+% The argument must not contain unbalanced braces.
+% \url| | ...where "|" is any character not used in the argument and not
+% "{" or a space. The same restrictions as above except that the
+% argument may contain unbalanced braces.
+% \urldef\xyz\url{ }
+% \xyz a defined-url: "\xyz" can be used anywhere, no matter what
+% characters it contains.
+% \DeclareUrlCommand\abc{settings}: makes \abc{ } like \url{ } with settings
+%
+% See url.tex/url.pdf for documentation. Some info after \endinput
+%
+% Required catcodes during loading: letters @ = letter,
+% ` = > < . [ ] + - digits = other,
+% { } \ ~ # % $ _ ^ = their normal
+
+% default style assignments
+\def\UrlBreaks{\do\.\do\@\do\\\do\/\do\!\do\_\do\|\do\;\do\>\do\]%
+ \do\)\do\,\do\?\do\&\do\'\do+\do\=\do\#}%
+\def\UrlBigBreaks{\do\:\do@url@hyp}%
+\def\UrlNoBreaks{\do\(\do\[\do\{\do\<}%
+% any ordinary characters that aren't usually:
+\def\UrlOrds{\do\*\do\-\do\~\do\'\do\"\do\-}%
+\def\UrlSpecials{\do\ {\Url@space}\do\%{\Url@percent}\do\^^M{\Url@space}%
+ \Url@force@Tilde}% package option may force faked text-ascii-tilde
+
+\@namedef{Url@OT1encSpecials}{%
+ % *Some* latin-1 or windows characters that ot1 has elsewhere: OE oe ss
+ \do\^^8c{\mathchar30 }\do\^^9c{\mathchar27 }\do\^^df{\mathchar25 }%
+ \do\~{\lower.45ex\hbox{\m@th$\mathchar126$}}% For tt style
+ % lots more to add, but I should later link into inputenc
+ \do\^^b5{\mu}%
+ \Url@OTnonTT % more for any but typewriter
+ }
+
+\def\Url@OTnonTT{\do\<{\langle}\do\>{\mathbin{\rangle}}\do
+ \_{\_\penalty\@m}\do\|{\mid}\do\{{\lbrace}\do\}{\mathbin{\rbrace}}\do
+ \\{\mathbin{\backslash}}\UrlTildeSpecial}
+
+% *Some* latin-1 or windows characters. Most will pass through safely to T1 enc
+% mu inverted-? OE oe
+% lots more to add, but I should later link into inputenc
+\@namedef{Url@T1encSpecials}{\do\^^b5{\mu}\do\^^bf{\mathchar190 }%
+ \do\^^8c{\mathchar215 }\do\^^9c{\mathchar247 }\do\^^df{\mathchar255 }%
+ \do\^^ff{\mathchar184 }}
+
+\@namedef{Url@LY1encSpecials}{\do\~{\mathchar158 }}
+
+\def\UrlTildeSpecial{\do\~{\raise.45ex\hbox{\m@th$\scriptstyle\sim$}}}
+\let\Url@force@Tilde\relax
+
+\def\url@ttstyle{%
+ \@ifundefined{selectfont}{\def\UrlFont{\tt}}{\def\UrlFont{\ttfamily}}}
+
+\def\url@rmstyle{%
+ \@ifundefined{selectfont}{\def\UrlFont{\rm}}{\def\UrlFont{\rmfamily}}}
+
+\def\url@sfstyle{%
+ \@ifundefined{selectfont}{\def\UrlFont{\sf}}{\def\UrlFont{\sffamily}}}
+
+\def\url@samestyle{\def\UrlFont{}}
+
+\@ifundefined{strip@prefix}{\def\strip@prefix#1>{}}{}
+\@ifundefined{verbatim@nolig@list}{\def\verbatim@nolig@list{\do\`}}{}
+
+% \Url sets up the reading the argument verbatim if possible
+\def\Url{%
+ \Url@movingtest
+ \ifmmode\@inmatherr$\fi %$
+ \let\do\@makeother \dospecials % verbatim catcodes
+ \catcode`{\@ne \catcode`}\tw@ % with exceptions
+ \catcode`\ =10 % allow "\url {x}"
+ \catcode`\#=6 % always # -> ##, so I can later convert ## -> #
+ \@ifnextchar\bgroup{\obeyspaces\obeylines\Url@z}\Url@y}
+
+% \Url@y read arguments delimited like |...|, passing to \Url@z
+\def\Url@y#1{\catcode`{11 \catcode`}11\obeyspaces\obeylines
+ \def\@tempa##1#1{\Url@z{##1}}\@tempa}
+
+% \Url@z read arguments delimited like {...}, verbatimizes with \meaning,
+% performs character translations, then invokes the formatter.
+\def\Url@z#1{\toks@{#1}\edef\Url@String{\the\toks@}%
+ \edef\Url@String{\expandafter\strip@prefix\meaning\Url@String}%
+%\if\urldebug \message{------------------------------------------------------}%
+%\message{ \Url@String}\fi
+% \meaning introduces spurious spaces in the text, so it would be nice
+% to preserve the real spaces before \meaning, but that doesn't work --
+% we can only do replacement on streams of non-syntactic characters.
+ \Url@ObeySp % may be no-op; otherwise put ordinary (12) space characters
+%\if\urldebug \message{ \Url@String}\fi
+% we left the catcode of # with its normal value (6) so \meaning
+% doubles it to ##. Now we convert back to single #. This allows
+% \url{#} to appear in the arguments of other commands, where we can't
+% make # be an ordinary character. We make the single # active rather
+% than `other' to support hyperref.sty.
+ \Url@acthash
+%\if\urldebug \message{ \Url@String}\fi
+% Also make % active to support hyperref.
+ \Url@actpercent
+% now do any hyper referencing due to hyperref (or perform a url-def)
+ \Url@HyperHook
+% Now do the formatting in a group (can also have \Url@HyperHook take
+% this as an argument.
+ {\Url@FormatString}%
+ \endgroup}
+
+\let\Url@ObeySp\@empty
+\let\UrlRight\@empty
+\let\UrlLeft\@empty
+\let\Url@HyperHook\@empty
+
+% This is the normal way to format the strings, using math mode.
+\def\Url@FormatString{%
+ \UrlFont \Url@MathSetup
+ $\fam\z@ \textfont\z@\font
+ \expandafter\UrlLeft\Url@String\UrlRight
+ \m@th$%
+% \if\urldebug \showlists \fi
+}%
+
+\def\Url@MathSetup{%
+ \medmuskip\Urlmuskip \thickmuskip\medmuskip \thinmuskip0mu%
+ \relpenalty\UrlBigBreakPenalty \binoppenalty\UrlBreakPenalty
+ \expandafter\let\expandafter\UrlEncSpecials\csname Url@\f@encoding encSpecials\endcsname
+ % Insert test for unknown encodings here \ifx\UrlEncSpecials\relax
+ \ifdim\fontdimen\thr@@\font=\z@ \let\Url@OTnonTT\relax \fi
+ \@tempcnta\z@ % \fam\multiply\@tempcnta\@cclvi
+ \let\do\set@mathcode \UrlOrds % ordinary characters that were special
+ \advance\@tempcnta 8192 \UrlBreaks % bin
+ \advance\@tempcnta 4096 \UrlBigBreaks % rel
+ \advance\@tempcnta 4096 \UrlNoBreaks % open
+ \let\do\set@mathact \UrlSpecials \UrlEncSpecials % active
+ \let\do\set@mathnolig \verbatim@nolig@list % prevent ligatures
+}
+
+\def\set@mathcode#1{\count@`#1\advance\count@\@tempcnta
+%\message{Set mathcode of \string #1 (\number`#1) = \number`#1 + \number\@tempcnta. }%
+\mathcode`#1\count@}
+\def\set@mathact#1#2{\mathcode`#1=32768 \begingroup
+ \lccode`\~`#1\lowercase{\endgroup\def~}{#2}}
+\def\set@mathnolig#1{\ifnum\mathcode`#1<32768
+ \begingroup\lccode`\~`#1\lowercase{\endgroup
+ \edef~}{\mathchar\number\mathcode`#1\sb{\/}}%
+ \mathcode`#1=32768 \fi}
+
+\def\Url@movingtest{\begingroup
+ \ifx\let\HyPsd@LetCommand % we are already in a pdf string!
+ \expandafter\Url@unmove \fi % give the argument and hope for the best
+ \let\Url@moving\relax\relax\relax
+ \ifx\Url@moving\relax\else \expandafter\Url@unmove \fi
+ \endgroup}
+\long\def\Url@unmove#1\Url@y{\endgroup \ifx\protect\relax\else\protect\Url\fi}
+\edef\Url@moving{\csname Url Error\endcsname}
+\expandafter\edef\Url@moving
+ {\csname url used in a moving argument.\endcsname}
+\expandafter\expandafter\expandafter \let \Url@moving\@undefined
+
+\def\urldef#1#2{\begingroup \setbox\z@\hbox\bgroup
+ \def\Url@HyperHook##1\endgroup{\Url@def{#1}{#2}}%
+ % Because hyperref breaks \urldef and does not define its own (Grrrr!)...
+ \def\url@##1{\egroup\endgroup\DeclareRobustCommand#1{#2{##1}}}%
+ #2}
+\def\Url@def#1#2{%
+ \toks0\expandafter{\Url@String}%
+ \protected@edef\Url@String{\Url@String}%
+ \toks1\expandafter{\Url@String}%
+ \edef\Url@String{\endgroup\egroup\endgroup\def
+ \expandafter\noexpand\csname\expandafter\@gobble\string#1 \endcsname
+ {\noexpand\Url@eitherdef{\the\toks1}{\noexpand#2{\the\toks0}}}}%
+ \Url@String
+ \edef#1{\noexpand\protect
+ \expandafter\noexpand\csname\expandafter\@gobble\string#1 \endcsname}%
+ }
+\def\Url@eitherdef{\ifx\let\HyPsd@LetCommand % we are already in a pdf string!
+ \expandafter\@firstoftwo \else \expandafter\@secondoftwo \fi}
+
+\def\urlstyle#1{\expandafter\protect\csname url@#1style\endcsname}
+
+\def\DeclareUrlCommand#1#2{\def#1{\leavevmode\begingroup #2\Url}}
+
+% Sample (and default) configuration:
+%
+\DeclareUrlCommand\url{}
+\urlstyle{tt}
+%
+\newmuskip\Urlmuskip \Urlmuskip=0mu
+\mathchardef\UrlBreakPenalty=\binoppenalty
+\mathchardef\UrlBigBreakPenalty=\relpenalty
+%
+% picTeX defines \path, so declare it optionally:
+\@ifundefined{path}{\DeclareUrlCommand\path{\urlstyle{tt}}}{}
+%
+% too many styles define \email like \address, so I will not define it.
+% \DeclareUrlCommand\email{\urlstyle{rm}}
+
+% Process LaTeX \package options
+%
+\let\Url@sppen\@M
+\def\Url@space{\penalty\Url@sppen}
+\def\do@url@hyp{}% by default, no breaks after hyphens
+
+\@ifundefined{ProvidesPackage}{
+}{\ProvidesPackage
+ {url}[2013/09/16 \space ver 3.4 \space Verb mode for urls, etc.]
+\DeclareOption{hyphens}{\def\do@url@hyp{\do\-}}% allow breaks after hyphens
+\DeclareOption{obeyspaces}{\let\Url@ObeySp\relax}% a flag for later
+\DeclareOption{spaces}{\def\Url@sppen{\UrlBreakPenalty}}
+\DeclareOption{LY1}{}
+\DeclareOption{T1}{}
+\DeclareOption{allowmove}{\let\Url@moving\@empty}
+\DeclareOption{lowtilde}{%
+ \def\UrlTildeSpecial{\do\~{\raise.2ex\hbox{\m@th$\scriptstyle\sim$}}}
+ \let\Url@force@Tilde\UrlTildeSpecial
+}
+\ProcessOptions\relax
+\ifx\Url@ObeySp\relax % [obeyspaces] was declared
+ \begingroup \lccode`+=32 \lowercase
+ {\endgroup \def\Url@ObeySp{\Url@Edit\Url@String{ }{+}}}
+ \def\Url@space{\penalty\Url@sppen\ }
+\fi
+}
+\ifx\f@encoding\undefined \def\f@encoding{OT1}\fi
+
+\begingroup
+% \Url@acthash: convert `other' (doubled) ## to active #
+% \Url@actpercent: convert `other' % to active %
+ \lccode`+=`\# \lccode`\~=`\#
+ \lowercase {\long\gdef\Url@acthash{\Url@Edit\Url@String{++}{~}%
+ \ifnum\mathcode`\#<32768 \def~{\#}\fi}}%
+ \lccode`+=`\% \lccode`\~=`\%
+ \lowercase {\long\gdef\Url@actpercent{\Url@Edit\Url@String{+}{~}%
+ \ifnum\mathcode`\%<32768 \def~{\%}\fi}}%
+ \catcode13=12 %
+ \gdef\Url@percent{\@ifnextchar^^M{\@gobble}{\mathbin{\mathchar`\%}}}%
+\endgroup%
+
+% Edit macro #1 changing all appearances of pattern #2 to replacement #3.
+% The replacement is recursive, so don't put the search pattern into the
+% replacement text!
+
+{ \catcode`Q=3
+
+\gdef\Url@Edit#1#2#3{%
+ \begingroup % \tracingall
+ \def\DOE@a{\endgroup\def#1}% Just so I can \expandafter it safely.
+ \def\DOE@b##1#2##2Q##3{\@ifblank{##2}% if finished,
+ {\DOE@c ##1Q}% then remove \@empty's and redefine macro
+ {\DOE@b##1##3##2Q{##3}}% else, re-iterate
+ }% the leading \@empty preserves braces, as does the trailing pattern:
+ \expandafter\DOE@b\expandafter\@empty #1\@empty#2Q{#3}}
+\gdef\DOE@c#1\@empty Q{\expandafter\DOE@a\expandafter{#1}}
+%
+% \@ifblank (LaTeX syntax) --- checks if parameter is blank (Spaces
+% count as blank) use \@ifblank{#1}{true case}{false case} etc
+\long\gdef\@ifblank#1{\@Ifbl@nk#1QQ\@secondoftwo\@firstoftwo!}%
+\long\gdef\@Ifbl@nk#1#2Q#3#4#5!{#4}
+
+} % restore Q catcode
+
+
+%\ifx\urldebug\@undefined \def\urldebug{01}\fi
+
+\endinput
+% For documentation, please see accompanying url.tex (url.pdf)
+% Package Options: obeyspaces, hyphens, spaces, lowtilde
+%
+% Revision History:
+% ver 1.1 6-Feb-1996:
+% Fix hyphens that wouldn't break and ligatures that weren't suppressed.
+% ver 1.2 19-Oct-1996:
+% Package option for T1 encoding; Hooks: "\UrlLeft" and "\UrlRight".
+% ver 1.3 21-Jul-1997:
+% Prohibit spaces as delimiter characters; change ascii tilde in OT1.
+% ver 1.4 02-Mar-1999:
+% LaTeX license; moving-argument-error
+% ver 1.5 28-Mar-1999:
+% possibility of spacing around break characters; re-settable penalties
+% ver 1.6 20-Jun-2002:
+% un-double #, fix obeyed-spaces, ignore trailing %, hook for hyperref
+% (\Url@HyperHook), no macros in pre-processed url string (in \Url@String),
+% limit catcode change of ~.
+% ver 3.0 June 2003/Nov 2003:
+% \DeclareUrlCommand; make font encoding automatic (only a few inputenc characters
+% are supported yet - needs refactoring); reverse penalties.
+% ver 3.1 Mar 2004:
+% Remove spurious spaces in \url@XXstyle commands.
+% ver 3.2 June 2005:
+% Fix cmsy-symbols in tt bug (from 3.0); LY1 encoding bug; Enable plain
+% with miniltx (again); Define the \urldef for hyperref; Lower "sim" tilde
+% a little; fix \lowercase error in \UrlSpecials handling.
+% ver 3.3 April 2006:
+% Fix some encoding bugs and remove 8-bit characters. lowtilde option
+% ver 3.4 Sept 2013:
+% \@nomatherr->\@inmatherr. & is now another \UrlBreak character.
+% The End
+
+Test file integrity: ASCII 32-57, 58-126: !"#$%&'()*+,-./0123456789
+:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~
+
diff --git a/macros/latex/contrib/url/url.tex b/macros/latex/contrib/url/url.tex
new file mode 100644
index 0000000000..a53a3a8fa5
--- /dev/null
+++ b/macros/latex/contrib/url/url.tex
@@ -0,0 +1,325 @@
+\documentclass[a4paper,11pt]{article}
+\usepackage[T1]{fontenc}
+\usepackage{lmodern}
+\usepackage{miscdoc,url,booktabs,microtype}
+\addtolength\textwidth{1cm}
+\addtolength\oddsidemargin{-.5cm}
+\addtolength\evensidemargin{-.5cm}
+\raggedbottom
+\setlength\parskip{4pt plus 2pt}
+
+\begin{document}
+\title{\texttt{url.sty} version 3.4}
+\date{2013-09-16}
+\author{Donald Arseneau%
+ \thanks{Thanks to Robin Fairbairns for documentation conversion!}}
+\maketitle
+
+% url.sty ver 3.4 16-Sep-2013 Donald Arseneau asnd@triumf.ca
+% Copyright 1996-2013 Donald Arseneau, Vancouver, Canada.
+% This program can be used, distributed, and modified under the terms
+% of the LaTeX Project Public License, version 2 or later.
+
+The package defines a form of \cs{verb} command that allows linebreaks
+at certain characters or combinations of characters, accepts
+reconfiguration, and can usually be used in the argument to another
+command. It is intended for formatting email addresses, hypertext links,
+directories/paths, etc., which normally have no spaces. The font used
+may be selected using the \cs{urlstyle} command, and new url-like
+commands may be defined using \cs{urldef}.
+This package does not make hyper-links! For that purpose, see the hyperref
+package (or some other deprecated ones).
+
+\begin{center}
+ \begin{tabular}{lp{3.5in}}
+ \toprule
+ Usage & Conditions \\
+ \midrule
+ \verb+\url{ }+ & The argument must not contain unbalanced braces.
+ If used in the argument to another command, the
+ \cs{url} argument cannot contain any ``\verb+%+'',
+ ``\verb+#+'', or ``\verb+^^+'', or end with
+ ``\verb+\+''.\\
+ \verb+\url| |+ & where ``\texttt{|}'' is any character not used
+ in the argument and not ``\verb+{+'' or a space.
+ The same restrictions apply as above except that
+ the argument may contain unbalanced braces.\\
+ \cs{xyz} & for the defined-url ``\cs{xyz}''; such a command can be
+ used anywhere, no matter what characters it contains. \\
+ \bottomrule
+ \end{tabular}
+ \end{center}
+
+\noindent The ``\cs{url}'' command is fragile, and its argument is likely to be
+very fragile, but a defined-url is robust.
+
+\section{Package options}
+
+\newitem Package Option: \texttt{obeyspaces}
+
+Ordinarily, all spaces are ignored in the url-text. The
+``\texttt{[obeyspaces]}'' option allows spaces, but may introduce
+spurious spaces when a url containing ``\cs{}'' characters is given in
+the argument to another command.
+So if you need to obey spaces you can say
+``\cs{usepackage}\texttt{[obeyspaces]\char`\{url\char`\}}'', and if
+you need both spaces and backslashes, use a defined-url.
+
+\newitem Package Option: \texttt{hyphens}
+
+Ordinarily, breaks are not allowed after ``\texttt{-}'' characters
+because this leads to confusion. (Is the ``\texttt{-}'' part of the
+address or just a hyphen?)
+The package option ``\texttt{[hyphens]}'' allows breaks after explicit
+hyphen characters. The \cs{url} command will \textbf{never ever}
+hyphenate words.
+
+\newitem Package Option: \texttt{spaces}
+
+Likewise, given the ``\texttt{[obeyspaces]}'' option, breaks are not
+usually allowed after the spaces, but if you give the options
+``\texttt{[obeyspaces,spaces]}'', \cs{url} will allow breaks at those
+spaces.
+\begin{quote}
+ Note that it seems logical to allow the sole option
+ ``\texttt{[spaces]}'' to let input spaces indicate break points, but
+ not to display them in the output. This would be easy to implement,
+ but is left out to avoid(?)\ confusion.
+\end{quote}
+
+\newitem Package Option: \texttt{lowtilde}
+
+Normal treatment of the \verb+~+ character is to use the font's
+``\cs{textasciitilde}'' character, if it has one (or claims to).
+Otherwise, the character is faked using a mathematical ``\cs{sim}''.
+The ``\texttt{[lowtilde]}'' option causes a faked character to be used
+always (and a bit lower than usual).
+
+\newitem Package Option: \texttt{allowmove}
+
+This option suppresses the test for \cs{url} being used in a so-called
+moving argument (check ``fragile command''). Using it will enable \cs{url}
+to function in more contexts, but when it does fail, the error message
+may be incomprehensible.
+
+
+\section{Defining a defined-url}
+
+Take for example the email address ``\url{myself%node@gateway.net}"
+which could not be given (using ``\cs{url}'' or ``\cs{verb}'') in a
+caption or parbox due to the percent sign. This address can be
+predefined with
+\begin{quote}
+ \verb|\urldef{\myself}\url{myself%node@gateway.net}| or\\
+ \verb+\urldef{\myself}\url|myself%node@gateway.net|+
+\end{quote}
+and then you may use ``\cs{myself}'' instead of
+``\verb+\url{myself%node@gateway.net}+''
+in an argument, and even in a moving argument like a caption because a
+defined-url is robust.
+
+\section{Style}
+
+You can switch the style of printing using ``\verb+\urlstyle{+$xx$\verb+}+'',
+where ``$xx$'' can be any defined style. The pre-defined styles are
+``\texttt{tt}'', ``\texttt{rm}'', ``\texttt{sf}'' and ``\texttt{same}''
+which all allow the same linebreaks but use different fonts~--- the
+first three select a specific font and the ``\texttt{same}'' style
+uses the current text font. You can define your own styles with
+different fonts and/or line-breaking by following the explanations
+below. The ``\cs{url}'' command follows whatever the currently-set
+style dictates.
+
+\section{Alternate commands}
+
+It may be desireable to have different things treated differently, each
+in a predefined style; e.g., if you want directory paths to always be
+in typewriter and email addresses to be roman, then you would define new
+url-like commands as follows:
+\begin{quote}
+ \verb+\DeclareUrlCommand+\meta{command}\verb+{+\meta{settings}\verb+}+\\
+ \verb+\DeclareUrlCommand\email{\urlstyle{rm}}+\\
+ \verb+\DeclareUrlCommand\directory{\urlstyle{tt}}+.
+\end{quote}
+In fact, this \cs{directory} example is exactly the \cs{path}
+definition which might be pre-defined by the package. Furthermore,
+basic \cs{url} is defined with
+\begin{quote}
+ \verb+\DeclareUrlCommand\url{}+,
+\end{quote}
+without any \emph{settings}, so it uses whatever \cs{urlstyle}
+and other settings are already in effect.
+
+You can make a defined-url for these other styles, using the usual
+\cs{urldef} command as in this example:
+\begin{quote}
+\verb+\urldef{\myself}{\email}{myself%node.domain@gateway.net}+
+\end{quote}
+which makes \cs{myself} act like
+\verb+\email{myself%node.domain@gateway.net}+,
+if the \cs{email} command is defined as above. The \cs{myself}
+command would then be robust.
+
+\section{Defining styles}
+
+Before describing how to customize the printing style, it is best to
+mention something about the unusual implementation of \cs{url}. Although
+the material is textual in nature, and the font specification required
+is a text-font command, the text is actually typeset in \emph{math} mode.
+This allows the context-sensitive linebreaking, but also accounts for
+the default behavior of ignoring spaces. (Maybe that underlying design
+will eventually change.) Now on to defining styles.
+
+To change the font or the list of characters that allow linebreaks, you
+could redefine the commands \cs{UrlFont}, \cs{UrlBreaks},
+\cs{UrlSpecials}, etc., directly in the document, but it is better to
+define a new `url-style' (following the example of \cs{url@ttstyle}
+and \cs{url@rmstyle}) which defines all of \cs{UrlBigbreaks},
+\cs{UrlNoBreaks}, \cs{UrlBreaks}, \cs{UrlSpecials}, and \cs{UrlFont}.
+
+\subsection{Changing font}
+The \cs{UrlFont} command selects the font. The definition of
+\cs{UrlFont} done by the pre-defined styles varies to cope with a
+variety of \LaTeX{} font selection schemes, but it could be as simple
+as \verb+\def\UrlFont{\tt}+. Depending on the font selected, some
+characters may need to be defined in the \cs{UrlSpecials} list because
+many fonts don't contain all the standard input characters.
+
+\subsection{Changing linebreaks}
+The list of characters after which line-breaks are permitted is
+given by the two commands (list macros)
+\cs{UrlBreaks} and \cs{UrlBigBreaks}. They consist of repeating
+\cs{do}\cs{c} for each relevant character \texttt{c}.
+
+The differences are that `BigBreaks' typically have a lower penalty (more
+easily chosen) and do not break within a repeating sequence (e.g.,
+``\verb+DEC::NODE+'').
+(For gurus: `BigBreaks' are treated as mathrels while `Breaks' are mathbins;
+see \textit{The TeXbook}, p.\,170.) The result is that a series of
+consecutive `BigBreak'
+characters will break at the end and only at the end; a series of
+`Break' characters will break after the first and after every following
+\emph{pair}; there will be no break between a `Break' character and a
+following `BigBreak' char; breaks are permitted when a `BigBreak'
+character is followed by `Break' or any other char. In the case
+of \texttt{http://} it doesn't matter whether \texttt{:} is a
+`Break' or `BigBreak'~--- the breaks are the same in either case; but
+for (now ancient) \emph{DECnet} addresses using \texttt{::} it was
+important to prevent breaks \emph{between} the colons, and that is why
+colons are `BigBreaks'. (The only other `BigBreak' character is,
+optionally, the hyphen; slashes are regular `Break's.)
+
+It is possible for characters to prevent breaks after the next
+following character (this is used for parentheses). Specify these in
+\cs{UrlNoBreaks}.
+
+You can allow some spacing around the breakable characters by assigning
+\begin{quote}
+\verb+\Urlmuskip = 0mu plus 1mu+
+\end{quote}
+(with \texttt{mu} units because of math mode).
+You can change the penalties used for BigBreaks and Breaks by assigning
+\begin{quote}
+\verb+\mathchardef\UrlBreakPenalty=100+\\
+\verb+\mathchardef\UrlBigBreakPenalty=100+
+\end{quote}
+The default penalties are \cs{binoppenalty} and \cs{relpenalty}.
+These have such odd non-\LaTeX{} syntax because I don't expect people
+to need to change them often. (The \verb+\mathchardef+ does not relate to
+math mode; it is only a way to store a number without consuming registers.)
+
+\subsubsection{Arbitrary character actions}
+
+You can do arbitrarily complex things with characters by specifying
+their definition(s) in \cs{UrlSpecials}. This makes them `active' in
+math mode (mathcode \texttt{"8000}). The format for setting
+each special character \texttt{c} is:
+\verb+\do\c{+\meta{definition}\verb+}+, but other definitions not
+following this style can also be included.
+
+Here is an example to make ``\texttt{!}''\ inside \cs{url} force a line break
+instead of being treated verbatim (it uses \LaTeX's \cs{g@addto@macro}):
+
+\begin{quote}
+\verb+\makeatletter \g@addto@macro\UrlSpecials{\do\!{\newline}}+
+\end{quote}
+
+Here is another overly-complicated example to put extra flexible
+muglue around each ``\texttt{/}'' character, except when followed
+by another ``\texttt{/}'', as in ``\texttt{http://}'', where extra
+spacing looks poor.
+
+\begin{quote}
+\begin{verbatim}
+% what we'll insert before and after each (lone) slash:
+\newmuskip\Urlslashmuskip
+\Urlslashmuskip=2mu plus2mu minus2mu
+
+% change what / does:
+\g@addto@macro\UrlSpecials{\do\/{\Urlspaceyslash}}
+
+% need to look ahead:
+\def\Urlspaceyslash{\futurelet\Urlssnext\finishUrlspaceyslash}
+
+\def\finishUrlspaceyslash{%
+ \mskip\Urlslashmuskip % extra space before
+ \mathchar8239 % "202f, i.e., binary op, \fam, / char
+ % if we see //, eliminate the extra space to taste:
+ \ifx\Urlssnext/\mskip-\Urlslashmuskip
+ \else\mskip\Urlslashmuskip \fi
+ }
+\end{verbatim}
+\end{quote}
+
+If this sounds confusing~\dots{} well, it is! But I hope you
+won't need to redefine breakpoints~--- the default assignments seem to
+work well for a wide variety of applications. If you do need to make
+changes, you can test for breakpoints using regular math mode and the
+characters ``\texttt{+=(a}''.
+
+
+\section{Yet more flexibility}
+You can also customize the presentation of verbatim text by defining
+\cs{UrlRight} and/or \cs{UrlLeft}. An example for ISO formatting of
+urls surrounded by \verb+< >+ is
+\begin{quote}
+\begin{verbatim}
+\DeclareUrlCommand\url{\def\UrlLeft{<url:\ }\def\UrlRight{>}%
+ \urlstyle{tt}}
+\end{verbatim}
+\end{quote}
+The meanings of \cs{UrlLeft} and \cs{UrlRight} are \emph{not}
+reproduced verbatim. This lets you use formatting commands there, but
+you must be careful not to use \TeX's special characters
+(\verb+\^_%~#$&{}+ etc.)\ improperly. You can also define \cs{UrlLeft}
+to reprocess the verbatim text, but the format of the definition is special:
+\begin{quote}
+\verb+\def\UrlLeft#1\UrlRight{+\,\dots\ do things with \verb+#1+ \dots\,\verb+}+
+\end{quote}
+Yes, that is \verb+#1+ followed by \cs{UrlRight} then the definition (a \TeX\
+macro with delimited arguments). For example, to produce a hyper\TeX\ hypertext
+link:
+\begin{quote}
+\verb+\def\UrlLeft#1\UrlRight{%+\\
+\verb+ \special{html:<a href="#1">}#1\special{html:</a>}}+
+\end{quote}
+Using this technique, \path{url.sty} can provide a convenient
+interface for performing various operations on verbatim text. You
+don't even need to print out the argument! For greatest efficiency in
+such obscure applications, you can define a null url-style where all
+the lists like \cs{UrlBreaks} are empty.
+
+Please note that this method is \emph{not} how the hyperref package
+manages urls for its \cs{url} command, even though it makes use of
+\path{url.sty}. Instead, hyperref's \cs{url} reads its argument in
+a less-verbatim manner than described above, produces its hyperlink,
+and invokes \cs{nolinkurl} to format the text. \cs{nolinkurl} is
+the \cs{url} command descibed herein.
+
+\end{document}
+
+
+%%% Local Variables:
+%%% mode: latex
+%%% TeX-master: t
+%%% End: