summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/nicetext/niceverb.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-08-26 22:17:31 +0000
committerKarl Berry <karl@freefriends.org>2011-08-26 22:17:31 +0000
commit80219992c1ed63efeca5390194411fcdcedb17bb (patch)
tree71fa8ca43e70073fc77a5ff97454bf43549dee9a /Master/texmf-dist/source/latex/nicetext/niceverb.tex
parent87f1685a45c8f23851013817d1ead13ff8c20677 (diff)
nicetex 0.43 (24aug11)
git-svn-id: svn://tug.org/texlive/trunk@23703 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/nicetext/niceverb.tex')
-rw-r--r--Master/texmf-dist/source/latex/nicetext/niceverb.tex28
1 files changed, 17 insertions, 11 deletions
diff --git a/Master/texmf-dist/source/latex/nicetext/niceverb.tex b/Master/texmf-dist/source/latex/nicetext/niceverb.tex
index f4b380b985f..dd789adeae0 100644
--- a/Master/texmf-dist/source/latex/nicetext/niceverb.tex
+++ b/Master/texmf-dist/source/latex/nicetext/niceverb.tex
@@ -1,4 +1,4 @@
-\ProvidesFile{niceverb.tex}[2011/01/26 documenting niceverb.sty]
+\ProvidesFile{niceverb.tex}[2011/08/22 documenting niceverb.sty]
\title{\textsf{niceverb.sty}\\---\\Minimizing
Markup\\for Documenting \LaTeX\ packages\thanks{This
document describes version
@@ -10,14 +10,20 @@
\MakeJobDoc{19}{\SectionLevelThreeParseInput} }
\documentclass{article}%% TODO paper dimensions!?
\input{makedoc.cfg} %% shared formatting settings
-\usepackage{color}
+%% 2011/08/22:
+\MDkeywords{literate programming, syntactic sugar,
+ .txt to .tex enhancement, macro programming}
+\hypersetup{%
+ pdftitle=syntacic sugar for LaTeX documentation by niceverb.sty,
+ pdfsubject=documenting niceverb.sty
+}%% /2011/08/22
\begin{document}
\maketitle
-\begin{abstract}\noindent
+\begin{MDabstract}
'niceverb.sty' provides very decent syntax (through active characters)
for describing \LaTeX\ packages and the syntax of macros conforming to
\LaTeX\ syntax conventions.
-\end{abstract}
+\end{MDabstract}
\tableofcontents
%% TODO table listing of active characters
@@ -31,8 +37,8 @@ for describing \LaTeX\ packages and the syntax of macros conforming to
The 'niceverb' package provides ``minimal" markup for documenting \LaTeX\
packages, reducing the number of keystrokes/visible characters needed
% .\,.\,. %%% ... %% TODO nicedots
-(kind of poor man's WYSIWYG).\footnote{``What you see is what you
- get." Novices are always warned that WYSIWYG is essentially
+(kind of poor man's \acro{WYSIWYG}).\footnote{``What you see is what you
+ get." Novices are always warned that \acro{WYSIWYG} is essentially
impossible with \LaTeX.} %% TODO UK FAQ 2010/03/11
% One feature---\verb'&\foo'%%% badly self-documenting, `&' fails
It conveniently handles command names in arguments of macros
@@ -115,7 +121,7 @@ This was achieved by typing
\[\HardVerbBox+&\foo*[<opt-arg>]{<mand-arg>}+\]
In ``auto mode" of the package, even typing
\[\HardVerbBox+\foo*[<opt-arg>]{<mand-arg>}+\]
-would have sufficed---WYSIWYG! I call such mixtures of
+would have sufficed---\acro{WYSIWYG}! I call such mixtures of
\emph{verbatim} and ``meta-variables" \textit{\qtd{meta-code}}.
Outside macro arguments, you obtain the same by typing
@@ -237,8 +243,7 @@ so \verb+\item[\foo]+ works as wanted.
(some of the) special characters %% 2010/03/20
(as listed in the standard macro `\dospecials') verbatim in arguments
(where `\verb' and the like fail). It just acts similarly as \TeX's
-(as listed in the standard macro `\dospecials') verbatim in arguments
-(where `\verb' and the like fail). It just acts similarly as \TeX's
+ %% undoubled lines 2011/05/09
primitive `\string' (which it actually invokes---cf. discussion on the
left quote feature above).
@@ -273,7 +278,7 @@ environment.\footnote{This idea appeared 2009 on the 'LATEX-L'
%% <- changed 2010/03/11
Rather, \lq`#'\rq\ is an active character for taking the next
character (assuming it is a digit) to form a reference to a
-\emph{macro parameter}---\lq`#1'\rq\ becomes \lq#1\rq\---WYSIWYG
+\emph{macro parameter}---\lq`#1'\rq\ becomes \lq#1\rq\---\acro{WYSIWYG}
indeed! (So the general syntax is |#<digit>|.)
\item[Escaping from 'niceverb' (generally).]
To get rid of the functionality of some active character <char>
@@ -450,4 +455,5 @@ HISTORY
2010/12/29 \AddToNoVerbList
2011/01/26 using color.sty and readprov.sty;
ack. Stephan B. for <...>; auto headings issue
-
+2011/05/09 undoubled lines about `&'
+2011/08/22 using new makedoc.cfg features