summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/refenums
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-01-04 00:18:44 +0000
committerKarl Berry <karl@freefriends.org>2014-01-04 00:18:44 +0000
commit70340ace6f83709cc9dac621b67502224b3baae5 (patch)
tree7f7d7c2698d2ead6d3528add819a3470df7ccc8b /Master/texmf-dist/doc/latex/refenums
parentb726d3267b3e2c379d7e1e8e4302ab8339f0bccd (diff)
refenums (3jan14)
git-svn-id: svn://tug.org/texlive/trunk@32562 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/refenums')
-rw-r--r--Master/texmf-dist/doc/latex/refenums/README.md12
-rw-r--r--Master/texmf-dist/doc/latex/refenums/demo.pdfbin77576 -> 82477 bytes
-rw-r--r--Master/texmf-dist/doc/latex/refenums/demo.tex17
3 files changed, 25 insertions, 4 deletions
diff --git a/Master/texmf-dist/doc/latex/refenums/README.md b/Master/texmf-dist/doc/latex/refenums/README.md
index 9ff61d70d5e..d4d489d8251 100644
--- a/Master/texmf-dist/doc/latex/refenums/README.md
+++ b/Master/texmf-dist/doc/latex/refenums/README.md
@@ -1,4 +1,6 @@
-# ReferenceableEnumElement
+# refenums - ReferenceableEnumElements
+
+Define named items and provide back-references with that name
This package provides commands to define enumerable items with a number and a long name, which can be referenced referenced later with the name or just the short form.
For instance, "Milestone M1: Specification created" can be defined and later on be referenced with `M1` or `M1 ("Specification created")`.
@@ -12,6 +14,12 @@ This ensures consistency in the text.
\usepackage{refenums}
```
+Load the package after all packages (hyperref, cleveref, ...).
+For best results, use the `nameinlink` option at cleveref.
+The option `capitalise` is also useful if you use cleveref's `\cref` command, therefore we recommend loading `cleveref` before `refenums` with follwing line:
+`\usepackage[capitalise,nameinlink]{cleveref}`
+
+
### Define the "Referenceable Enum Environment"
Decide for `<EnumId>`.
@@ -88,4 +96,4 @@ The latest source code is available at https://github.com/koppor/refenums
* [refenums.sty](refenums.sty): the package
* [demo.tex](demo.tex): small demonstration
- [paralist]: http://mirror.ctan.org/tex-archive/macros/latex/contrib/paralist/
+ [paralist]: www.ctan.org/pkg/paralist
diff --git a/Master/texmf-dist/doc/latex/refenums/demo.pdf b/Master/texmf-dist/doc/latex/refenums/demo.pdf
index 9f44720f707..723dba5123b 100644
--- a/Master/texmf-dist/doc/latex/refenums/demo.pdf
+++ b/Master/texmf-dist/doc/latex/refenums/demo.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/refenums/demo.tex b/Master/texmf-dist/doc/latex/refenums/demo.tex
index ca41e7382db..f74589970be 100644
--- a/Master/texmf-dist/doc/latex/refenums/demo.tex
+++ b/Master/texmf-dist/doc/latex/refenums/demo.tex
@@ -1,6 +1,7 @@
\documentclass[parskip=full]{scrartcl}
\usepackage[colorlinks]{hyperref}
+\usepackage[capitalise,nameinlink]{cleveref}
\usepackage{refenums}
%Always add a dot behind the definition
@@ -9,13 +10,13 @@
\begin{document}
-\title{Demonstation of the refenums package}
+\title{Demonstration of the refenums package}
\date{}
\author{}
\maketitle
\vspace{-12ex}
-This documents demonstrates the usage and results of the \href{http://mirror.ctan.org/tex-archive/macros/latex/contrib/refenums/}{refenums} package.
+This documents demonstrates the usage and results of the \href{http://www.ctan.org/pkg/refenums}{refenums} package.
All content appearing in this work is fictitious.
Any resemblance to real artefacts, items, or persons, living or dead, is purely coincidental.
@@ -71,6 +72,15 @@ The heading is defined using the macro.
\defRefEnum[subsection]{Step}{Software Specification}{spec}
The heading is defined using the macro.
+\section{Other Steps}
+\label{sec:osteps}
+
+This section shows how an enum can be reused.
+One has to take care to use different labels as in the first usage.
+
+\setcounter{Step}{0}
+\defRefEnumInline{Step}{Think}{think} First think.
+\defRefEnumInline{Step}{Work}{work} Then work.
\section{Issues}
\defRefEnum{Issue}{Fictional}{fi}
@@ -95,6 +105,9 @@ In \cref{sec:steps}, we started with \refEnumFull{Step}{rqa}.
\LaTeX{} put that step into \cref{sec:rqa}.
Afterwards, \refEnumFull{Step}{spec} has been described.
+We reused the enumeration environment for other steps in \cref{sec:osteps}.
+There, we started with \refEnumFull{Step}{think}.
+
Some issues such as \refEnumFull{Issue}{fi} were raised.
First, the milestone \refEnumFull{M}{bm} has to be reached.