summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bracketkey/bracketkey.tex
blob: 85e8dbd0143ce0fdf0733f6d9d7d4db58c106211 (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
\documentclass[parskip=half, pagesize=auto, version=last]{scrartcl}

\usepackage{fixltx2e}
\usepackage{lmodern}
\usepackage[T1]{fontenc}
\usepackage{textcomp}
\usepackage{microtype}
\usepackage{hyperref}

\addtokomafont{title}{\rmfamily}

\title{The \textsf{bracketkey} package\thanks{This manual corresponds to \textsf{bracketkey}~v1.0, dated~2009/09/24.}}
\subtitle{A \LaTeX\ class for producing bracketed identication keys}
\author{Christoph Heibl}
\date{2009/09/24}


\begin{document}

\maketitle

\noindent
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
\url{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 \textsf{bracketkey} is explained below. See also the example in 
\texttt{Malva.tex} for how to use \textsf{bracketkey}. 
%
\begin{enumerate}
\item Use \verb+\begin{key}{<text>}+ and \verb+\end{key}+ to define the 
  \texttt{bracketkey} environment.

\item The second argument of \verb+\begin key+ can be used to pass 
  an abbreveated (genus) name to the `\texttt{name}' command.

\item The two alternatives of each couplet are defined by:
  
  \verb+\leadONE{<backref>}{<text>}+~~and \\
  \verb+\leadTWO{<text>}+.
  
  \verb+<backref>+ is an integer which refers to the previous couplet 
  number, in case that the current and the previouos couplet
  numbers are not consecutive.

\item Each `\texttt{lead}' command is followed by a `\texttt{name}' command:
  
  \verb+\name{<text>}{<text|integer>}{<text>}+
  
  \verb+<text>+ in the first argument is set in boldface. It can be used 
  for taxon ranks which do not require italized writing.

  \verb+<text>+ in the second argument is set in italics. It typically 
  takes names of genus rank and below. Alternatively, \verb+<integer>+
  refers to the next couplet.
  
  \verb+<text>+ in the third argument is set ``as is''. It can be used to provide 
  authority names.
\end{enumerate}

Please email commentaries, questions, etc. to \texttt{heibl at lmu.de}.

\end{document}