summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bracketkey/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/bracketkey/README')
-rw-r--r--macros/latex/contrib/bracketkey/README45
1 files changed, 45 insertions, 0 deletions
diff --git a/macros/latex/contrib/bracketkey/README b/macros/latex/contrib/bracketkey/README
new file mode 100644
index 0000000000..d5638e7ae4
--- /dev/null
+++ b/macros/latex/contrib/bracketkey/README
@@ -0,0 +1,45 @@
+bracketkey 1.0 -- A LaTeX class for producing bracketed identication keys
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in
+ http://www.latex-project.org/lppl.txt
+and version 1.3 or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
+
+The use of bracketkey is explained below. See also the example in
+Malva.tex for how to use bracketkey.
+
+1. Use \begin{key}{<text>} and \end{key} to define the
+ bracketkey environment.
+
+2. The second argument of \begin key can be used to pass
+ an abbreveated (genus) name to the 'name' command.
+
+3. The two alternatives of each couplet are defined by:
+
+ \leadONE{<backref>}{<text>} and
+
+ \leadTWO{<text>}.
+
+ <backref> is an integer which refers to the previous couplet
+ number, in case that the current and the previouos couplet
+ numbers are not consecutive.
+
+4. Each 'lead' command is followed by a 'name' command:
+
+ \name{<text>}{<text|integer>}{<text>}
+
+ <text> in the first argument is set in boldface. It can be used
+ for taxon ranks which do not require italized writing.
+
+ <text> in the second argument is set in italics. It typically
+ takes names of genus rank and below. Alternatively, <integer>
+ refers to the next couplet.
+
+ <text> in the third argument is set "as is". It can be used to provide
+ authority names.
+
+
+Please email commentaries, questions, etc. to heibl at lmu.de.