summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/dichokey/dichokey.tex
blob: 38cce0eb8ff73115921e4d58d78c0b93e97d6c71 (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
\documentclass[DIV=8, pagesize=auto]{scrartcl}

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

\newcommand*{\pkg}[1]{\textsf{#1}}
\newcommand*{\cs}[1]{\texttt{\textbackslash#1}}
\makeatletter
\newcommand*{\cmd}[1]{\cs{\expandafter\@gobble\string#1}}
\makeatother
\newcommand*{\env}[1]{\texttt{#1}}
\newcommand*{\meta}[1]{\textlangle\textsl{#1}\textrangle}
\newcommand*{\marg}[1]{\texttt{\{}\meta{#1}\texttt{\}}}
\newcommand*{\oarg}[1]{\texttt{[}\meta{#1}\texttt{]}}

\addtokomafont{title}{\rmfamily}

\title{The \pkg{dichokey} package}
\author{Nico Dam}
\date{17 dec 1999}


\begin{document}

\maketitle

\noindent
This \LaTeXe\ style file defines the environment \env{Key} in which
dichotomous identification keys can be constructed.
Numbering of alternatives and indentation are taken of care of
automatically.
The key should be \emph{strictly} dichotomous.


\minisec{Directions for use:}

The key should be constructed within the environment \env{Key}. The
environment has one parameter, that is used as first part of the name
when a species is keyed out (usually an abbreviation of the genus
name).

Within the key, every alternative should begin with the command \cmd{\alter}.
If a species is keyed out, use the command \cmd{\name}\oarg{option}\marg{name}
(otherwise just continue with the next alternative).
The optional argument will be used instead of the parameter provided
on entering the environment \env{Key}.


\minisec{To do:}

provide example file (e.\,g.\ \texttt{rhodocyb.tex})

\end{document}