summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/secnum/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/secnum/README.md')
-rw-r--r--macros/latex/contrib/secnum/README.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/macros/latex/contrib/secnum/README.md b/macros/latex/contrib/secnum/README.md
index 9ee10bcae8..48a2b3117d 100644
--- a/macros/latex/contrib/secnum/README.md
+++ b/macros/latex/contrib/secnum/README.md
@@ -1,12 +1,20 @@
# secnum
-This package provides a macro \setsecnum to format section numbering intuitively.
+This package provides a macro `\setsecnum` to format section numbering intuitively.
## Usage
-One can simply use `\setsecnum{1.1.1}` to set the section numbering
-format as `arabic.arabic.arabic` and depth to be 3.
+One can simply use `\setsecnum{A,1.i}` to set the section numbering
+format as `Alph` for the sections, `arabic` for the subsections and
+`arabic.roman` for the subsubsections and
+the `secnumdepth` and `tocdepth` will be 3.
+
+If one want to set the tocdepth manually,
+there is an option `tocdep` for it.
+
+One may notice that the comma `,` plays a special role in the numbering format:
+for deep levels, the numbering before the comma are hided.
## Installation
@@ -16,7 +24,7 @@ The installation is the same as usual Tex packages.
1. Run the following to create the package file `secnum.sty` (as well as this file `README.md`)
- XeTeX secnum.dtx
+ pdfTeX secnum.dtx
2. Move the following file into proper directories searched by TeX.
The recommended directory is
@@ -25,7 +33,7 @@ The installation is the same as usual Tex packages.
3. To produce the documentation run the following
- XeLaTeX secnum.dtx
+ pdfLaTeX secnum.dtx
4. The recommended directory for the documentation is