summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/nicetext
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-11-09 22:44:22 +0000
committerKarl Berry <karl@freefriends.org>2015-11-09 22:44:22 +0000
commita83576956cae969d5f301b82d893b6f5a5949276 (patch)
tree15f57d70e5770dfe9f1229790f3c562edf6c491c /Master/texmf-dist/source/latex/nicetext
parent6eb3a7b847e716cc912c1273d6d03bc960e4cdc1 (diff)
nicetext (9nov15)
git-svn-id: svn://tug.org/texlive/trunk@38808 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/nicetext')
-rw-r--r--Master/texmf-dist/source/latex/nicetext/niceverb.tex47
-rwxr-xr-xMaster/texmf-dist/source/latex/nicetext/updsfl.sh30
2 files changed, 71 insertions, 6 deletions
diff --git a/Master/texmf-dist/source/latex/nicetext/niceverb.tex b/Master/texmf-dist/source/latex/nicetext/niceverb.tex
index 6203d5f302b..76b503cd8bb 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}[2012/10/10 documenting niceverb.sty]
+\ProvidesFile{niceverb.tex}[2014/03/28 documenting niceverb.sty]
\title{\textsf{niceverb.sty}\\---\\Minimizing
Markup\\for Documenting \LaTeX\ packages\thanks{This
document describes version
@@ -8,8 +8,9 @@
% \listfiles 2010/03/19
{ \RequirePackage{makedoc} \ProcessLineMessage{} %% 2010/03/11
\MakeJobDoc{19}{\SectionLevelThreeParseInput} }
-\documentclass{article}%% TODO paper dimensions!?
+\documentclass[fleqn]{article}%% TODO paper dimensions!?
\input{makedoc.cfg} %% shared formatting settings
+\newcommand*{\secref}[1]{Sec.~\ref{sec:#1}} %% 2014/03/27
%% 2011/08/22:
\MDkeywords{literate programming, syntactic sugar,
.txt to .tex enhancement, macro programming}
@@ -22,6 +23,7 @@
\begin{document}
\maketitle
\begin{MDabstract}
+% \tracingmacros=1 \tracingonline=1
'niceverb.sty' provides very decent syntax (through active characters)
for describing \LaTeX\ packages and the syntax of macros conforming to
\LaTeX\ syntax conventions.
@@ -95,7 +97,7 @@ works without changing category codes (which is the usual idea of
typesetting code), therefore it works even in macro arguments.
\item %% 2011/01/26
\lq\HardNVerb+<meta-variable>+\rq\ produces \lq<meta-variable>\rq.
-(\qtd{&\lessthan} stores the original \qtd{&<}.)
+(\qtd{&\lt} stores the original \qtd{&<}.) %% was \lessthan 2014/03/28
\end{enumerate}
\subsection{The Commands and Features of 'niceverb'}
@@ -122,6 +124,7 @@ A typical example is this:
This was achieved by typing
\[\HardVerbBox+&\foo*[<opt-arg>]{<mand-arg>}+\]
In ``auto mode" of the package, even typing
+% \tracingmacros=1 \tracingonline=1
\[\HardVerbBox+\foo*[<opt-arg>]{<mand-arg>}+\]
would have sufficed---\acro{WYSIWYG}! I call such mixtures of
\emph{verbatim} and ``meta-variables" \textit{\qtd{meta-code}}.
@@ -305,10 +308,27 @@ indeed! (So the general syntax is |#<digit>|.)
syntax \emph{alltogether} by |\noNiceVerb| and revive it
by |\useNiceVerb| (without ``auto mode").{\sloppy\par}
- \textbf{Right Quotes:} Disabling\slash reviving replacement
+ \strong{Right Quotes:} Disabling\slash reviving replacement
of `\textsf' by single right quotes requires
\[|\nvRightQuoteNormal| \mbox{\quad or\quad } |\nvRightQuoteSansSerif|\]
- respectively.
+ %% 2014/03/27:
+ respectively.---The feature fails in certain occasions
+ because a single right quote must not always be interpreted
+ as `\textsf', and deciding this by macros became quite
+ laborious for me and is most likely still not perfect.
+ There is a command |\nvAllRightQuotesSansSerif|
+ to be used with care that interpretes \emph{all} single
+ right quotes as `\textsf', which, e.g., means that you
+ must use `\rq' for apostrophes.
+
+ \strong{``Moving" arguments:} %% 2014/03/27
+ |\NiceVerbMove{<text>}| with v0.6 is for ``moving" arguments so that
+ 'niceverb' syntax operates \emph{locally} at the destination
+ (table of contents or page headings).
+ It is automatically used by 'niceverb''s variant of \LaTeX's
+ sectioning commands; while with `\markboth', `\markright',
+ `\addcontentsline' etc.\ you must it include yourself
+ (currently, \TODO?).
\end{description}
\subsection{Examples}
@@ -424,7 +444,12 @@ These are the first applications of 'niceverb''s ``auto mode" to
features, I need to find out $\dots$
\end{enumerate}
-\section{Implementation of the Markup Syntax}
+\newpage %% 2014/03/28
+\section{The Package File} %% 2014/03/19
+% \section{The ``Package" File} %% test for page heading 2014/03/24
+% \section{`nicetext.sty'} %% tests for pageheadings 2014/03/27
+\subsection{Preliminaries} %% 2014/03/19
+\subsubsection{File Header} %% 2014/03/19
\input{niceverb.doc}
\end{document}
@@ -468,3 +493,13 @@ HISTORY
2011/10/07 `syntacic'
2011/11/05 modified pdftitle
2012/10/10 \AddQuotes, \DontAddQuotes
+
+FOR V0.6:
+2014/03/19 subsec. Preliminaries, subsubsec. Header, `Implementation
+ of the Markup Syntax' -> `The Package File'
+2014/03/24 experiment with former
+2014/03/25 debugging in abstract
+2014/03/26 trying class option `fleqn' / debugging again
+2014/03/27 \secref; |\NiceVerbMove|, |\nvAllRightQuotesSansSerif|;
+ tests
+2014/03/28 debugging; \lessthan -> \lt; \newpage
diff --git a/Master/texmf-dist/source/latex/nicetext/updsfl.sh b/Master/texmf-dist/source/latex/nicetext/updsfl.sh
new file mode 100755
index 00000000000..4e6735173eb
--- /dev/null
+++ b/Master/texmf-dist/source/latex/nicetext/updsfl.sh
@@ -0,0 +1,30 @@
+## long names for srcfiles.tex, dummy files:
+ln -s substr/DOCSRC/SUBSTR.TEX substr.tex
+ln -s wiki/WIKICHEA.TEX wikicheat.tex
+ln -s DOCSRC/MDOCCHEA.TEX mdoccheat.tex
+ln -s Arseneau/SRC/ARSENEAU.TEX arseneau.tex
+ln -s RUN/SOURCE/ATARI.CFG atari.cfg
+ln -s RUN/SOURCE/ATARI.FDF atari.fdf
+blogsrc='../../blog/convert/SRC'
+ln -s $blogsrc/U8ATABLG.FDF u8atablg.fdf
+ln -s RUN/SOURCE/COPYFILE.CFG copyfile.cfg
+ln -s RUN/SOURCE/COPYFILE.TEX copyfile.tex
+#ln -s RUN/SOURCE/fddialog.sty fddialog.sty
+ln -s RUN/SOURCE/FDDIAL0G.STY fddial0g.sty
+#ln -s RUN/SOURCE/FDTXTTEX.CFG fdtxttex.cfg
+ln -s $blogsrc/FDTXTTEX.CFG fdtxttex.cfg
+#ln -s RUN/SOURCE/FDTXTTEX.TEX fdtxttex.tex
+ln -s $blogsrc/FDTXTTEX.TEX fdtxttex.tex
+ln -s RUN/SOURCE/FDTXTTEX.TPL fdtxttex.tpl
+ln -s RUN/SOURCE/MAKEDOC.TPL makedoc.tpl
+ln -s substr/DOCSRC/SUBSTR.TEX substr.tex
+ln -s wiki/wiki.sty wiki.sty
+echo \\ProvidesFile{DOCSRC....}[] > DOCSRC....
+echo \\ProvidesFile{RUN....}[] > RUN....
+echo \\ProvidesFile{RUNUSE....}[] > RUNUSE....
+echo \\ProvidesFile{USE....}[] > USE....
+echo \\ProvidesFile{BUNDLE....}[] > BUNDLE....
+latex srcfiles.tex
+rm *.... *.fdf *.tpl
+rm atari.* copyfile.* fd*.*
+rm *cheat.tex arseneau.tex substr.tex wiki.sty