diff options
author | Karl Berry <karl@freefriends.org> | 2014-01-04 00:18:44 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-01-04 00:18:44 +0000 |
commit | 70340ace6f83709cc9dac621b67502224b3baae5 (patch) | |
tree | 7f7d7c2698d2ead6d3528add819a3470df7ccc8b /Master/texmf-dist/doc/latex/refenums/README.md | |
parent | b726d3267b3e2c379d7e1e8e4302ab8339f0bccd (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/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/refenums/README.md | 12 |
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 |