summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex')
-rw-r--r--Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex44
1 files changed, 37 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex b/Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex
index 17b3009475b..26dd3625d76 100644
--- a/Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex
+++ b/Master/texmf-dist/doc/latex/shipunov/biokey-doc-en.tex
@@ -1,8 +1,8 @@
\documentclass{article}
-\usepackage[pdftex,bookmarks=false,colorlinks=true]{hyperref}
+\usepackage[bookmarks=false,colorlinks=true,hypertexnames=false]{hyperref}
\usepackage{biokey}
-\author{A.\,Shipunov\footnote{e-mail: \texttt{plantago at herba.msu.ru}}}
+\author{A.\,Shipunov\footnote{e-mail: \texttt{dactylorhiza at gmail}}}
\title{\texttt{biokey}, the package for precious and flexible identification keys}
\date{}
@@ -13,8 +13,8 @@ This package can be used for creating biological identification keys. Different
\section{General usage}
-This is the textual (``Swedish'') key:
-
+This is the textual key:
+
\begin{verbatim}
1. It is an animal ... 2.
- It is a plant ... 3.
@@ -30,6 +30,9 @@ The interpretation in suggested language is follows:
\bigskip\hrule
\begin{verbatim}
+
+\begin{biokey}
+
\Z1. It is an animal \T 2.
\AN It is a plant \T 3.
@@ -43,10 +46,15 @@ The interpretation in suggested language is follows:
\ZZ3(1). Lots of wood \TT Spruce
\AN No wood \TT Daisy
+
+\end{biokey}
+
\end{verbatim}
\hrule\bigskip
+\begin{biokey}
+
\Z1. It is an animal \T 2.
\AN It is a plant \T 3.
@@ -61,11 +69,13 @@ The interpretation in suggested language is follows:
\AN No wood \TT Daisy
+\end{biokey}
+
\bigskip\hrule\bigskip
For aesthetics, I recommend that text before \verb|\T| should not end with dot (with the exception of abbreviations). \verb|\T| and \verb|\TT| are just the same thing, but second is better to designate names, and first is better for numbers. Sometimes, these two commands cannot format the paragraph without overfulls, in these (rare) cases I recommend the \verb|\TTTT| or ``old-style'' \verb|\TTT| which results are less precious but require less handwork.
-\verb|\Z| and \verb|\ZZ| are different only for the second is used for reverse (``Williamsonian'') links, or for typical in serial zoological keys references for theses and antitheses. These two commands along with \verb|\AN|, \verb|\AAN|, and (not used in the example above) \verb|\AAAN| are used also for aesthetic hanging indentation.
+\verb|\Z| and \verb|\ZZ| are different only for the second is used for backreferences, or for typical in serial zoological keys references for theses and antitheses. These two commands along with \verb|\AN|, \verb|\AAN|, and (not used in the example above) \verb|\AAAN| are used also for aesthetic hanging indentation.
Commands \verb|\N|, \verb|\NN| and \verb|\NNN| are for end-level objects (species, for example). They did not produce leading dots, but justify following object right, next with some space, or on next line, respectively.
@@ -88,6 +98,9 @@ This sort of key can put numbers automatically. The example (needs two \LaTeX\ r
\bigskip\hrule
\begin{verbatim}
+
+\begin{biokey}
+
\TE{ani} It is an animal \SS{spi}
\AN It is a plant \SS{pla}
@@ -101,10 +114,15 @@ This sort of key can put numbers automatically. The example (needs two \LaTeX\ r
\SE{pla}{ani} Lots of wood \TT Spruce
\AN No wood \TT Daisy
+
+\end{biokey}
+
\end{verbatim}
\hrule\bigskip
+\begin{biokey}
+
\TE{ani} It is an animal \SS{spi}
\AN It is a plant \SS{pla}
@@ -119,17 +137,22 @@ This sort of key can put numbers automatically. The example (needs two \LaTeX\ r
\AN No wood \TT Daisy
+\end{biokey}
+
\bigskip\hrule\bigskip
The biggest advantage of this type of key is that it is much easier to correct. It is possible to convert ``ordinary'' key to ``automatic'' key and further to HTML, with the help of \texttt{biokey2html} scripts (see documentation). See also how hyper-references working here.
-\section{Leveled keys}
+\section{Indented keys}
-And, finally, the different key layout---so-called ``English'', or leveled keys:
+And, finally, the different key layout---so-called indented keys:
\bigskip\hrule
\begin{verbatim}
+
+\begin{biokey}
+
\Z A. It is an animal
\begin{LE}
@@ -157,10 +180,15 @@ And, finally, the different key layout---so-called ``English'', or leveled keys:
\Z DD. No wood \TT Daisy
\end{LE}
+
+\end{biokey}
+
\end{verbatim}
\hrule\bigskip
+\begin{biokey}
+
\Z A. It is an animal
\begin{LE}
@@ -189,6 +217,8 @@ And, finally, the different key layout---so-called ``English'', or leveled keys:
\end{LE}
+\end{biokey}
+
\bigskip\hrule\bigskip
It is more complicated then previous examples, so one may to consider \texttt{dichokey} package, but it is much less flexible.