summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/refenums/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/refenums/README.md')
-rw-r--r--Master/texmf-dist/doc/latex/refenums/README.md12
1 files changed, 10 insertions, 2 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