summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/moreenum/README
blob: 72063c144aaa18e6e6ce94a3fad52d5347214b7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
This is the README for moreenum.sty
The author/maintainer of this work is Seamus Bradley.
tex@seamusbradley.net

This provides the following new enumerate styles.

 - \greek for lowercase Greek letters
 - \Greek for uppercase Greek letters
 - \enumHex for uppercase hexadecimal enumeration
 - \enumhex for lowercase hexadecimal enumeration
 - \enumbinary for binary enumeration
 - \enumoctal for octal enumeration
 - \raisenth for 1st, 2nd, 3rd etc with raised "th"s
 - \levelnth for 1st, 2nd 3rd with level "th"s
 - \Nthwords for "First", "Second", "Third" etc
 - \nthwords for "first", "second", "third" etc
 - \NTHWORDS for "FIRST", "SECOND", "THIRD" etc
 - \Nwords for "One", "Two", "Three" etc
 - \nwords for "one", "two", "three" etc
 - \NWORDS for "ONE", "TWO", "THREE" etc

Each of these works with enumitem's "starred variant" feature.
So \begin{enumerate}[label=\Hex*] will output a hex enumerated list.
Enumitem provides a start=0 option for starting your enumerations at
0.
A binzero environment is provided for binary starting at zero enumeration.
Likewise enumoctzero, enumHexzero and enumhexzero for the hex enumerations.

Currently requires amsmath, alphalph, enumitem and fmtcount 
all of which should be part of any modern TeX distribution.

This isn't so much a package designed for use as a list of recipes for
creating your own new kinds of enumeration.
All of the work is really done by the various packages loaded.

TWO WARNINGS:

 - You probably don't want to use uppercase greek numbering. Ever.
 - Be careful with uppercase Hex numbering for sections if you also
   have appendices. 
 - (A more general version of the last point) Don't mix \Alph and
   \enumHex, or \alph and \enumhex

TO DO:

 - Properly namespace the internal macros.
 - Make consistent the way the macros for counters and numbers are
   treated.
 - Test spacing of enumerations.


CHANGELOG
See https://github.com/scmbradley/moreenum for a full changelog

v1.02
  Spacing issues fixed
  \nwords and friends and \nthwords and friends are now the right way round.
v1.01
  NWORDS and friends now supported
v1.0
  levelnth and raisenth work with fmtcount
  fmtcount also replaces binhex.tex
  fmtcount also replaces numname
v0.95 
  levelnth and raisenth work through environments with engord's switch
  numname used for nwords and nthwords
v0.9 
  Initial version