summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/fncylab/fncylab.tex
blob: 1faab4c28fac954f29ee81c97bf66b647d6e1b8e (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
\documentclass[a4paper]{article}
\usepackage[a4paper]{geometry}
\usepackage{miscdoc}
\usepackage[scaled=0.85]{luximono}
\begin{document}
\title{The \Package{fncylab} package}
\author{Robin Fairbairns\thanks{Email:
    \emph{robin.fairbairns@cl.cam.ac.uk}}}
\date{2003-08-13, version 1.0}
\maketitle

The package provides support for arbitrary structuring of the way
label references look.  The command \cmdinvoke*{labelformat}{ctr}{defn}
specifies the structure of a label:
\begin{description}
\item[\emph{\texttt{ctr}}] the counter that will define the label
  (e.g., \texttt{section}, \texttt{figure}, \texttt{enumi} for outer
  level list label references, etc.)
\item[\emph{\texttt{defn}}] the definition of how the counter will be
  formatted in a reference.  In this argument, \texttt{\#1}
  (\emph{not} \texttt{\#\#1} as one might expect) substitutes the
  `raw' value of the thing which is the source of the label.
\end{description}

The package makes use of a built-in LaTeX facility (which actually
needs a bit of patching before it's usable); this allows the precise
layout of the references to labels generated from any LaTeX counter
to be altered.  Note that the way in which the counter itself is
represented in references depends on \cs{the\meta{counter}}\,---\,it's
the same as the way the counter gets printed.

\section{An example}

The \LaTeX{} code:
\begin{quote}
\begin{verbatim}
\labelformat{section}{section #1}
...
\section{The Blah Field}\label{blah}
...
... As we saw above in~\ref{blah} ...
\end{verbatim}
\end{quote}
will typeset its last line as
\begin{quote}
  \dots\@ As we saw above in section 3 \dots
\end{quote}

For references at the start of a sentence, the package defines a
command \cs{Ref}, which is used as one might expect:
\begin{quote}
\begin{verbatim}
... \Ref{blah} shows us that ...
\end{verbatim}
\end{quote}
which will typeset as
\begin{quote}
  \dots\@ Section 3 shows us that \dots
\end{quote}

A demonstration of \cs{labelformat}, using the \Package{enumerate}
package, may be found in the file \texttt{fncylab-example.tex}, which
is part of the distribution.
\end{document}