summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/aurl/README.md
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-08-14 22:12:14 +0000
committerKarl Berry <karl@freefriends.org>2016-08-14 22:12:14 +0000
commit635b675b61742f94928c4805e82d0c7010b8f3da (patch)
treefa059c2ccbcfc99092ae8f0b0bb70cefff7d3efe /Master/texmf-dist/doc/latex/aurl/README.md
parent2ee47639dde156bb5ac897bf13c7fd80c9db507f (diff)
aurl
git-svn-id: svn://tug.org/texlive/trunk@41853 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/aurl/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/aurl/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/aurl/README.md b/Master/texmf-dist/doc/latex/aurl/README.md
new file mode 100644
index 00000000000..251ca3c0908
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/aurl/README.md
@@ -0,0 +1,28 @@
+# aurl&mdash;Abbreviated URLs for LaTeX
+Extends the hyperref package with a mechanism for hyperlinked URLs abbreviated with prefixes.
+
+# Purpose
+The Semantic Web community heavily uses prefixes to abbreviate URLs (AURLs), such as `owl:class` or `rdf:type`.
+The LaTeX `hyperref` package defines the `url` command to print and hyperlink a URL but if used for AURLs, the hyperlink fails.
+But `href` from `hyperref` is tedious to use.
+The aurl package introduces `\aurl{prefix}{suffix}` and includes the 100 most popular prefixes from [prefix.cc](http://prefix.cc).
+If you want to include the 1000 most popular prefixes instead, use `\usepackage[1000]{aurl}`.
+
+# Usage
+1. copy [aurl.sty](https://raw.githubusercontent.com/KonradHoeffner/latex/master/aurl/aurl.sty) to your working directory
+2. add `\usepackage{aurl}` to your preamble
+4. (optional) define non-default prefixes using `\daurl{prefix}{prefix expansion}`
+3. add your AURLs with `\aurl{prefix}{suffix}`
+
+# Example
+ \documentclass{article}
+ \usepackage{aurl}
+ \begin{document}
+ \aurl{rdfs}{label}
+ \aurl{owl}{class}
+ \daurl{bbc}{http://bbc.com/}
+ \aurl{bbc}{news}
+ \end{document}
+
+# License
+This is completely free, do whatever you want ([CC0 license](http://creativecommons.org/publicdomain/zero/1.0/)).