summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/fncylab
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-03-08 17:14:01 +0000
committerKarl Berry <karl@freefriends.org>2010-03-08 17:14:01 +0000
commitfa5f154fe81b5cfda43334d7f4caa424b5e0a302 (patch)
treec58719688fa833d24ed0a1e608c6431d64164ff2 /Master/texmf-dist/doc/latex/fncylab
parent7bc3d71af69b04734daa32de9bbfd2f9cddfeac4 (diff)
fncylab update (7mar10)
git-svn-id: svn://tug.org/texlive/trunk@17382 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/fncylab')
-rw-r--r--Master/texmf-dist/doc/latex/fncylab/fncylab-example.tex78
-rw-r--r--Master/texmf-dist/doc/latex/fncylab/fncylab.pdfbin0 -> 210727 bytes
-rw-r--r--Master/texmf-dist/doc/latex/fncylab/fncylab.tex64
3 files changed, 142 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/fncylab/fncylab-example.tex b/Master/texmf-dist/doc/latex/fncylab/fncylab-example.tex
new file mode 100644
index 00000000000..97f9d4173c8
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fncylab/fncylab-example.tex
@@ -0,0 +1,78 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% small sample file
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\documentclass{article}
+%
+% a brief demonstration of the use of fncylab
+%
+\usepackage{fncylab,enumerate}
+\begin{document}
+%
+% outer level lists (such as enumerate) use counter enumi for their
+% list tags.
+\begin{enumerate}[(i)]
+\item first item, defining a non-fancy label \label{first}
+%
+% that label was defined to look otherwise than it was printed for the
+% item:
+\item second item (see also item~\ref{first})
+%
+% redefine label formats for this list's labels:
+\labelformat{enumi}{(#1)}
+%
+% and label the another item in a different way:
+\item third item, defining a fancy label \label{third}
+%
+% redefine label formats for this list's labels again:
+\labelformat{enumi}{item~(#1)}
+%
+% we now see that the label has for item three has been defined
+% differently, and that for item four differently again. note the
+% reference starting a new sentence.
+\item fourth item, defining a fancy label in a different format (see
+ also item~\ref{third}). \Ref{fourth} shows how a sentence may start
+ with reference to a fancy label; note that it's the \emph{label}
+ that's fancy, so the second change to the label format only affects
+ the labels defined after it. \label{fourth}
+\end{enumerate}
+\end{document}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% small sample file
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+\documentclass{article}
+%
+% a brief demonstration of the use of fncylab
+%
+\usepackage{fncylab,enumerate}
+\begin{document}
+%
+% outer level lists (such as enumerate) use counter enumi for their
+% list tags.
+\begin{enumerate}[(i)]
+\item first item, defining a non-fancy label \label{first}
+%
+% that label was defined to look otherwise than it was printed for the
+% item:
+\item second item (see also item~\ref{first})
+%
+% redefine label formats for this list's labels:
+\labelformat{enumi}{(#1)}
+%
+% and label the another item in a different way:
+\item third item, defining a fancy label \label{third}
+%
+% redefine label formats for this list's labels again:
+\labelformat{enumi}{item~(#1)}
+%
+% we now see that the label has for item three has been defined
+% differently, and that for item four differently again. note the
+% reference starting a new sentence.
+\item fourth item, defining a fancy label in a different format (see
+ also item~\ref{third}). \Ref{fourth} shows how a sentence may start
+ with reference to a fancy label; note that it's the \emph{label}
+ that's fancy, so the second change to the label format only affects
+ the labels defined after it. \label{fourth}
+\end{enumerate}
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/fncylab/fncylab.pdf b/Master/texmf-dist/doc/latex/fncylab/fncylab.pdf
new file mode 100644
index 00000000000..93d495f05f1
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fncylab/fncylab.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/fncylab/fncylab.tex b/Master/texmf-dist/doc/latex/fncylab/fncylab.tex
new file mode 100644
index 00000000000..1faab4c28fa
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/fncylab/fncylab.tex
@@ -0,0 +1,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}