catcodes (8nov12)

git-svn-id: svn://tug.org/texlive/trunk@28210 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 105 insertions, 15 deletions

diff --git a/Master/texmf-dist/source/generic/catcodes/catcodes.tex b/Master/texmf-dist/source/generic/catcodes/catcodes.tex
index 8f38766e4b3..c88a5ea7625 100644
--- a/Master/texmf-dist/source/generic/catcodes/catcodes.tex
+++ b/Master/texmf-dist/source/generic/catcodes/catcodes.tex
@@ -1,4 +1,4 @@
-\ProvidesFile{catcodes.tex}[2012/09/20 documenting catcodes files]
+\ProvidesFile{catcodes.tex}[2012/11/07 documenting catcodes files]
 \title{\pkg{catcodes}\\---\\``Generic" Switching of Category Codes}
 % \listfiles
 { \RequirePackage{makedoc} \ProcessLineMessage{}
@@ -18,8 +18,11 @@
 \newcommand*{\headersec}{%
     \subsection{Package File Header---\pkg{plainpkg} and Legalese}}
 \usepackage{ngerman} \originalTeX
-\usepackage{catchdq}
+\usepackage{catchdq}    %% try it more often! TODO 2012/11/07
+\usepackage{langcode}                           %% 2012/11/07
+\usepackage{filedate}                           %% 2012/11/06
 \sloppy
+% \flushbottom                                    %% 2012/11/07
 \begin{document}
 \maketitle
 \begin{MDabstract}
@@ -33,7 +36,9 @@ switching their category codes and assigning meanings to
 ``active-character tokens." \ 
 (iii)\enspace
 %% 2012/09/16:
-\pkg{catchdq.sty} uses the ``double quote" as an active character 
+\pkg{catchdq.sty} uses the 
+``\acro{ASCII}                          %% 2012/11/06
+double quote" as an active character 
 for simplified access to typographical double quotes.---These 
 packages are ``generic" in the sense that they should 
 be usable at least both with \LaTeX\ and Plain \TeX, 
@@ -47,6 +52,9 @@ based on 'plainpkg.tex'.
 \ctanpkgref{csquotes}.  %% 2012/09/16
 \end{MDabstract}
 \tableofcontents
+\section{Overview}
+Sorry, \dots, the abstract and the table of contents 
+must suffice for today (2012-11-07) \TODO
 
 \section{Shared Features of Usage}
 %%% rm. 2012/09/17:
@@ -66,6 +74,7 @@ in the sense of the
 \ctanpkgref{plainpkg}\foothttpurlref{ctan.org/pkg/plainpkg}
 documentation that exhibits details of what is summarized here. 
 Therefore:
+\pagebreak[2]                               %% 2012/11/07
 \begin{itemize}
   \item All of them require that \TeX\ finds `plainpkg.tex' 
         as well as `stackrel.sty'.
@@ -77,25 +86,94 @@ Therefore:
         $\dots$ \ or perhaps `\input{<catcodes>.sty}'? 
 \end{itemize}
 
-\pagebreak
-\section{'stacklet.sty'---Private Letters}
-See Section~\ref{sec:stacklet-cmds} for the commands provided.
-\headersec
-\input{stacklet.doc}
-
-\pagebreak
 \section{'actcodes.sty'---Active Characters}
-See Section~\ref{sec:actcodes-cmds} for the commands provided.
+%% intro 2012/11/07:
+\subsection{Introduction}
+Active characters can simplify syntax often, i.e., the code 
+may be very pleasant to type and read. But sometimes something 
+may fail. See Section~\ref{sec:actcodes-cmds} for how to cope
+with possibilities and difficulties.
 \headersec
 \input{actcodes.doc}
 
-\section{'catchdq.sty'---Proper Double Quotes by Toggling}
-See Section~\ref{sec:catchdq-cmds} for the commands provided.
-Note that the \ctanpkgref{csquotes} provides more comprehensive 
-functionality.
+\section{'catchdq.sty'---Typographical Double Quotes}
+%% <- TODO cf. morgan.sty 2012/11/06 ->
+% \section{'catchdq.sty'---Automatic Typographical Double Quotes by Toggling}
+% \section{'catchdq.sty'---Proper Double Quotes by Toggling}
+%% <- morgan.sty 2012/11/06 ->
+\subsection{Introduction}
+\catchdqs
+The 'catchdq' package allows getting typographical double quotes 
+by just using the "\acro{ASCII} double quote" |"|. A more precise overview:
+\begin{enumerate}
+  \item Typically, "typographical" quotation marks mean distinguishing 
+        between "opening" and "closing" quotation marks. 
+        Usually, you must enter different characters or commands for 
+        the distinction, such as |``| for "opening" and |''| for 
+        \emph{closing}---in \emph{English} with \emph{\TeX}. 
+        For \emph{English} with \emph{Plain~\TeX}, even |"| suffices for "closing."
+  \item There are much different conventions especially for \emph{German} 
+        and \emph{French}. They require different characters or \TeX~commands
+        than for \emph{English}. The packages \ctanpkgref{german}, 
+        \ctanpkgref{ngerman}, and \ctanpkgref{babel} have dealt with 
+        such conventions. 
+  \item Understanding the ideas mentioned before has been difficult 
+        for a long time, probably because typewriter and computer \emph{keyboards} 
+        never have offered the appropriate keys. Rather, they only offered 
+        the "\acro{ASCII} double quote" that produced an approximation 
+        ("neutral quotation marks")
+        \emph{not} making the difference. Many users and readers 
+        have not realized the difference, they have not realized 
+        how their screen or printer output differed from double quotes 
+        in books and newspapers. Cf.~the 
+        \wikienref{Quotation mark}{Wikipedia article}\footnote{%
+            \urlhttpref{en.wikipedia.org/wiki/Quotation mark}} 
+  \item The idea of the 'catchdq' package is that the user indeed should 
+        not worry about that difference and just type 
+        "\acro{ASCII} double quotes", and they should be "converted" 
+        into the appropriate typographical quotation marks \emph{automatically}. 
+        This should work by "toggling," i.e., the first 
+        "\acro{ASCII} double quote" is interpreted as "opening," 
+        the second as "closing," the next one as "opening"~\dots
+        ---Word processors have provided this feature (as an option) 
+        as well.
+  \item Language-dependency of the feature currently is managed 
+        through the \ctanpkgref{langcode} package.
+  \item The feature may cause problems sometimes. 
+        Therefore, explicit switching the feature "on" 
+        and "off" is required.
+  \item The \ctanpkgref{csquotes} package addresses the issue 
+        in a more comprehensive and perhaps more stable way.
+\end{enumerate}
+See Section~\ref{sec:catchdq-cmds} for 
+% the commands provided.
+% Note that the \ctanpkgref{csquotes} 
+% provides more comprehensive functionality.
+additional details.                         %% 2012/11/06
+\MakeOther\"                                %% TODO 2012/11/06
+
 \headersec
 \input{catchdq.doc}
 
+\pagebreak
+\section{'stacklet.sty'---Private Letters}
+\subsection{Introduction}
+\catchdqs           %% 2012/11/07
+\uselangcode{en}    %% 2012/11/07, \dedqtd above
+"Private letters" \emph{here} are meant to be 
+characters that belong to the "letter" 
+category only within packages. A package typically provides 
+user commands as well as internal commands, and the latter 
+are characterized by containing funny letters in commands such 
+as `\@gobble.' This is to avoid conflicts.
+See Section~\ref{sec:stacklet-cmds} for the commands provided.
+\MakeOther\"        %% 2012/11/07
+\headersec
+\input{stacklet.doc}
+
+%% 'filedate' check 2012/11/06:
+\noNiceVerb 
+\input{fdatechk.tex}
 \end{document}
 
 VERSION HISTORY
@@ -107,3 +185,15 @@ VERSION HISTORY
 2012/09/19                      "plainpkg packages", \pagebreaks, 
                                 Roman numbers in abstract, \headersec
 2012/09/19                      trying ngerman.sty
+
+             UPLOADED with `catcodes' r0.1 2012-09-20
+
+2012/11/06                      supplementing missing word; 
+                                TODO on catchdq, `filedate' checks, 
+                                typeset with recent `niceverb';
+                                more accurate about `catchdq', 
+                                long introduction
+2012/11/07                      final formatting, some more info on 
+                                `stacklet' and `actcodes', TODOs, 
+                                some \catchdqs, `Overview',
+                                2 more \subsec...Intro...