summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-03-06 22:10:33 +0000
committerKarl Berry <karl@freefriends.org>2014-03-06 22:10:33 +0000
commit3731208d7fb52ead680b0a31cae7e086b536a97b (patch)
tree3e639885dc67904ab8a3867ec9b17a7ebeae3705 /Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex
parentdce368d510dc3ccdacfd71146a8fbd05bb74f82d (diff)
numberedblock (6mar14)
git-svn-id: svn://tug.org/texlive/trunk@33109 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex')
-rw-r--r--Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex24
1 files changed, 13 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex b/Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex
index b12dc3c6725..0e66a6a2628 100644
--- a/Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex
+++ b/Master/texmf-dist/doc/latex/numberedblock/testnumberedblock.tex
@@ -1,11 +1,11 @@
\documentclass[10pt]{article}
\usepackage{numberedblock}
-
+\textheight 7.7in
\begin{document}
-
-\parindent 0.3in
+%DEFAULTS:
%\setlength\maxblocklabelsize{-.4in}
-\setlength\blockindent{0.0in}
+%\setlength\blockindent{0.2in}
+%\renewcommand\blocklabel[1]{[\textit{\arabic{#1}}]}
This is a test of the \textsf{numberedblock} style packcage, which is
specially designed to produce sequentially numbered BLOCKS of code (note
@@ -15,20 +15,21 @@ can get numbered in a document). While specialized for numbering code
blocks, the commands can actually number other items, as well, in fact
anything that fits in a \LaTeX{} box.
-If the code block contains no special characters, one can simply use the
+If the code block contains no special characters
+(or is already a box), one can simply use the
command form, called \verb,\numblock,. It cannot handle verbatim text,
but must use standard \LaTeX{} escape sequences (for line breaks,
contiguous spaces, special characters, etc.). It puts the output in a
-tt font , which is the same used in the verbatim environment:
+tt font, which is the same as used in the verbatim environment:
\numblock{This text is the\\argument to the command\\where double
-slashes have been\\used for line breaks}
+slashes have been\\used for line breaks\nblabel{nb:A}}
Most useful, however, there is also the \verb,numVblock, environment,
which handles verbatim text, as seen in the next example:
-\begin{numVblock}
-This is the numVblock
+\begin{numVblock}[\nbVlabel{nb:B}]
+This is a labeled numVblock
environment, which (<--see contiguous spaces here)
succeeds in
incorporating verbatim text like
@@ -36,7 +37,9 @@ incorporating verbatim text like
\end{numVblock}
As envisioned the \verb,numVblock, environment would be ideally suited
-for displaying small code blocks as part of documentation. The code can
+for displaying small code blocks as part of documentation, and I can
+{\bfseries (NEW!!)} even reference
+the numbered blocks~\ref{nb:A} and \ref{nb:B}. The code can
contain contiguous spaces and special characters:
\begin{numVblock}
@@ -60,5 +63,4 @@ box, rather than as formatted text.
Don't forget, there are settable parameters to define the block
left-indent, the format of the label, and (if needed) the labels' max
width/placement.
-
\end{document}