docsurvey (4oct17)

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

3 files changed, 144 insertions, 65 deletions

diff --git a/Master/texmf-dist/doc/latex/docsurvey/README.txt b/Master/texmf-dist/doc/latex/docsurvey/README.txt
index f8a7661e470..78abb43bf7f 100644
--- a/Master/texmf-dist/doc/latex/docsurvey/README.txt
+++ b/Master/texmf-dist/doc/latex/docsurvey/README.txt
@@ -4,7 +4,7 @@ The LaTeX docsurvey package
 Provides the document
 "Programming LaTeX — A survey of documentation and packages"
 
-March 6, 2017
+October 4, 2017
 Copyright 2017 Brian Dunn — www.BDTechConcepts.com
 
 LaTeX Project Public License, version 1.3
@@ -12,10 +12,10 @@ LaTeX Project Public License, version 1.3
 ---
 
 A survey of programming-related documentation for LaTeX.
-Included are references to printed and electronic books,
-symbol lists, FAQs, compiling documentation when necessary,
-the LaTeX source code, CTAN, programming-related packages,
-creating documentation for packages, and online communities.
+Included are references to printed and electronic books and manuals,
+symbol lists, FAQs, the LaTeX source code, CTAN and distributions,
+programming-related packages, users groups and online communities,
+and information on creating packages and documentation.
 
 ---
 
diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
index 27d39d77635..6e00a34dd3e 100644
--- a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
+++ b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
index 87ce2bcb567..af91ef543ae 100644
--- a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
+++ b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
@@ -13,7 +13,13 @@
 \usepackage[T1]{fontenc} 
 \usepackage[utf8]{inputenc}
 
+\usepackage[bottom=1in]{geometry}
 
+\usepackage{graphicx}
+
+\usepackage{needspace}
+
+\usepackage[nottoc,numbib]{tocbibind}
 
 \setcounter{secnumdepth}{0}
 
@@ -51,6 +57,10 @@
 \pagestyle{pageheadfoot}
 
 
+\newcommand*{\XeTeXrevE}
+{\protect\hspace{-.1667em}\protect\raisebox{-.5ex}{\protect\reflectbox{E}}\protect\hspace{-.125em}}
+\providecommand*{\XeTeX}{\mbox{X\XeTeXrevE\TeX}}
+\providecommand*{\XeLaTeX}{\mbox{X\XeTeXrevE\LaTeX}}
 
 \newcommand{\shortTitle}[1]{}
 \newcommand{\thisnetaddress}{}
@@ -274,6 +284,15 @@
 \usepackage{url}
 \fi
 
+\hypersetup{%
+pdfinfo={%
+Title={Programming LaTeX - A survey of documentation and packages},%
+Author={Brian Dunn},%
+Subject={LaTeX programming documentation},%
+Keywords={LaTeX, programming, documentation, BD Tech Concepts LLC}%
+}}
+
+
 \usepackage{enumitem}
 \setlist[description]{style=nextline,font=\small}
 
@@ -293,15 +312,15 @@
 \newcommand*{\tag}[1]{\texttt{<#1>}}
 \newcommand*{\prop}[1]{\textsl{\texttt{#1}}}
 \newcommand*{\epub}{\acro{EPUB}}
-\newcommand*{\texdoc}[1]{\hspace*{\fill}\mbox{(\texttt{texdoc #1}})}
+\newcommand*{\texdoc}[1]{\hspace*{\fill}\mbox{(\texttt{texdoc #1})}}
 \newcommand*{\userentry}[1]{%
 \leavevmode\par\hspace*{2em}\texttt{#1}\smallskip\\}
 
 
-\title{Programming \LaTeX\Dash A survey of documentation and packages}
+\title{Programming \LaTeX\Dash \\ A survey of documentation and packages}
 
 \author{Brian Dunn \\
-	\small \href{mailto:bd@bdtechconcepts.com}{bd@bdtechconcepts.com} \\
+	\small \href{mailto:bd@BDTechConcepts.com}{bd@BDTechConcepts.com} \\
 	\small Copyright 2017 Brian Dunn\thanks{
 		This work may be distributed and/or modified under the
 		conditions of the \LaTeX\ Project Public License, either version 1.3
@@ -323,10 +342,15 @@
 
 \begin{abstract}
 \noindent
-A survey of documentation sources and
-packages useful for \LaTeX\ programmers.
+A survey of programming-related documentation for \LaTeX.
+Included are references to printed and electronic books and manuals,
+symbol lists, \acro{FAQ}s, the \LaTeX\ source code, CTAN and distributions,
+programming-related packages, users groups and online communities,
+and information on creating packages and documentation.
 \end{abstract}
 
+\tableofcontents
+
 \section{Introduction}
 
 Reinventing the wheel may be useful if you think that you can do it better.
@@ -371,17 +395,30 @@ electronic format.
 	Provides extended discussion and examples of the inner workings
 	of \LaTeX\ and numerous useful packages.
 	Second edition: 2004.~\cite{mittelbachgossens:companion}
+\item[Additional books:] Listed at the \acro{UK TUG FAQ}.
+\hfill \url{http://www.tex.ac.uk/FAQ-latex-books.html}
 \end{description}
-Other books are listed at the \acro{UK TUG FAQ}: \\
-\url{http://www.tex.ac.uk/FAQ-latex-books.html}
 
 
-\section{Electronic books}
+\section{Electronic books and documentation}
+
+Most of these are provided with the \TeX\ distribution, and may be updated
+with each release.
+Access the embedded documentation from a command line using the \texttt{texdoc}
+program.
+
+\subsection{\TeX}
 
-Provided with the \TeX\ distribution:
-% These are provided with the documentation built into a \TeX\ distribution,
-% and thus are occasionally updated alongside \TeX.
-% The \prog{texdoc} command can be used to display them.
+\begin{description}
+\item[\TeX\ by Topic, A \TeX{}nician's Reference:]
+    A reference for \TeX.
+    This may be useful for understanding the source code of \LaTeX\ packages,
+    many of which are quite old and written in
+    low-level \TeX.~\cite{eijkhout:topic}
+    \texdoc{texbytopic}
+\end{description}
+
+\subsection{\LaTeX}
 
 \begin{description}
 \item[The Not So Short Introduction to \LaTeXe:]
@@ -391,30 +428,39 @@ Provided with the \TeX\ distribution:
 
 \item[\LaTeXe: An unofficial reference manual:]
 	A thorough but concise reference manual for \LaTeXe,
-	available in several languages.~\cite{greenwade:reference}
+	available in several languages.~\cite{greenwade:reference} \\
 	\texdoc{-l latex2e-help}
 
 \item[LaTeX WikiBook:] An online book, includes information about
 	creating \LaTeX\ packages and classes. \\
-	\url{https://en.wikibooks.org/wiki/LaTeX}
+	\hspace*{\fill} \url{https://en.wikibooks.org/wiki/LaTeX}
+\end{description}
 
-\item[\TeX\ by Topic, A \TeX{}nician's Reference:]
-	A reference for \TeX.
-	This may be useful for understanding the source code of \LaTeX\ packages,
-	many of which are quite old and written in
-	low-level \TeX.~\cite{eijkhout:topic}
-	\texdoc{texbytopic}
+\subsection{Lua\LaTeX}
+
+\begin{description}
+\item [A guide to lua\LaTeX:] An introduction. \texdoc{lualatex-doc}
+\item [Lua\TeX\ Reference:] The full manual. \texdoc{luatex.pdf}
 \end{description}
 
+\subsection{\XeLaTeX}
 
-\section{Symbol references}
+\begin{description}
+\item [The \XeTeX\ reference guide:] A summary of additional features.
+    \texdoc{xetex-reference}
+\item [Font-change-xetex:] Macros for using fonts.
+    \texdoc{font-change-xetex}
+\end{description}
+
+
+\subsection{Symbol references}
 
 These are lists of the \LaTeX\ commands which produce symbols.
 
 \begin{description}
 \item[Comprehensive \LaTeX\ Symbol List:]
-More than 14,000 symbols and \LaTeX\ commands. \cite{pakin:list}
-\texdoc{symbols-letter} \texdoc{symbols-a4}
+More than 14,000 symbols and \LaTeX\ commands.~\cite{pakin:list} \\
+\texdoc{symbols-letter} \\ \texdoc{symbols-a4}
 
 \item[Every symbol (most symbols) defined\\\hspace*{-\leftmargin}by
 unicode-math:]
@@ -423,7 +469,24 @@ Unicode math symbols.~\cite{robertson:mathsymbols}
 \end{description}
 
 
-\section{FAQs}
+\subsection{Source code}
+
+The source code for \LaTeXe\ itself is also included in the distribution.
+
+\begin{description}
+\item[The \LaTeXe\ sources:] Occasionally useful for figuring out how
+    something really works.~\cite{latexteam:sources} \\
+        \hspace*{\fill} \texdoc{source2e}
+\item[List of internal \LaTeXe\ macros
+      \\\hspace*{-\leftmargin}useful to package authors:]
+    A list of the core \LaTeX\ macros, each of which is linked to the
+    source code.~\cite{scharrer:listinternal}
+    \texdoc{macros2e}
+\end{description}
+
+
+
+\subsection{FAQs}
 
 %Frequently-Asked Questions
 
@@ -486,23 +549,7 @@ Barring unusual circumstances, this will create a new documentation
 
 
 
-\section{Source code}
-
-The source code for \LaTeXe\ itself is also included in the distribution.
-
-\begin{description}
-\item[The \LaTeXe\ sources:] Occasionally useful for figuring out how
-	something really works.~\cite{latexteam:sources} \\
-		\hspace*{\fill} \texdoc{source2e}
-\item[List of internal \LaTeXe\ macros
-      \\\hspace*{-\leftmargin}useful to package authors:]
-	A list of the core \LaTeX\ macros, each of which is linked to the
-	source code.~\cite{scharrer:listinternal}
-	\texdoc{macros2e}
-\end{description}
-
-
-\section{Comprehensive \TeX\ Archive Network}
+\section{Obtaining packages \Dash Comprehensive \TeX\ Archive Network \protect\quad (CTAN)}
 
 The Comprehensive \TeX\ Archive Network
 (\CTAN) provides a master collection of
@@ -515,10 +562,11 @@ its description on \CTAN\ to see what topics are shown for it.  Selecting these
 topics then shows you related packages.~\cite{ctan}
 
 
-
-\section{Packages}
+\needspace{7\baselineskip}
+\section{Packages useful for programming \protect\LaTeX}
 
 A number of packages are especially useful for \LaTeX\ programmers:
+\texdoc{<packagename>}
 
 \begin{multicols}{2}
 
@@ -543,15 +591,16 @@ A number of packages are especially useful for \LaTeX\ programmers:
 \item[\pkg{kvoptions}:] Key\slash{}value package options.
 \item[\pkg{expl3}:] \LaTeX3 programming.
 \item[\pkg{l3keys}, \pkg{l3keys2e}:] Key\slash{}value for \LaTeX3.
+\item[\pkg{chktex}:] Locates typographic errors.
 \item[\CTAN\ topic \pkg{macro-supp}:] An entire topic of
 	useful programming macros.
 \end{description}
 \end{multicols}
 
 
-\section{Creating and documenting packages}
+\section{Creating and documenting new packages}
 
-\subsection{Packages and programs}
+\subsection{How-to}
 
 Documentation for those interested in creating their own package or class:
 \begin{description}
@@ -565,11 +614,11 @@ Documentation for those interested in creating their own package or class:
 	\texdoc{doc}
 \item[The DocStrip program:] The program which processes \verb+.dtx+
 	and \verb+.ins+ files to generate documentation and \verb+.sty+
-	files. \cite{mittelbach:docstrip}
+	files.~\cite{mittelbach:docstrip}
 	\texdoc{docstrip}
 \end{description}
 
-\subsection{Articles}
+\subsection{Published articles about creating \protect\LaTeX\ packages}
 
 Related articles from \TUB:
 
@@ -578,8 +627,8 @@ Related articles from \TUB:
 Using \LaTeX\ to keep away from the Dark Side:] An overview of the
 	\pkg{article} class.~\cite{flynn:article}
 \item[Good things come in little packages:\\\hspace*{-\leftmargin}An
-	introduction to writing .ins and .dtx files:] How and why to create
-	your own \verb+.dtx+ and \verb+.ins+ files.~\cite{pakin:goodthings}
+	introduction to writing \texttt{.ins} and \texttt{.dtx} files:] How and why
+    to create your own \verb+.dtx+ and \verb+.ins+ files.~\cite{pakin:goodthings}
 \item[How to develop your own document
      class\Dash\\\hspace*{-\leftmargin}our experience:]
 	A comparison of developing class vs.\ package
@@ -587,30 +636,59 @@ Using \LaTeX\ to keep away from the Dark Side:] An overview of the
 
 \end{description}
 
+\section{Users groups}
+
+\begin{description}[style=unboxed]
+\item[\TeX\ Users Group:] \url{http://tug.org}
+\item[List of international users groups:] \url{http://tug.org/usergroups.html}
+\end{description}
+
 \section{Online communities}
 
 \begin{description}[style=unboxed]
 \item[English forums:] \
-\begin{description}
+\begin{description}[style=unboxed]
 \raggedright
-\item[TeX\Dash \LaTeX\ Stack Exchange:] Almost any question has already
-	been asked, and a quick web search will find answers, ranked by vote. \\
-	\url{http://tex.stackexchange.com/}
-\item[\LaTeX\ Community:] A traditional forum with quick replies
-	to your questions. \\
-	\url{http://www.latex-community.org/}
+\item[TeX\Dash \LaTeX\ Stack Exchange:] 
+    \url{http://tex.stackexchange.com/} \\
+    Almost any question has already
+	been asked, and a quick web search will find answers, ranked by vote.
+\item[\LaTeX\ Community:]   \url{http://www.latex-community.org/} \\
+    A traditional forum with quick replies
+	to your questions
 \end{description}
 
 \item[German forums:] \
-\begin{description}
+\begin{description}[style=unboxed]
 \item[TeXwelt:] \url{http://texwelt.de/wissen/}
 \item[goLaTeX:] \url{http://golatex.de/}
 \end{description}
 
+\item[Mailing lists:] \url{http://tug.org/mailman/listinfo} \\
+    Several dozen, spanning a wide range of \TeX-related topics.
 \item[Newsgroup:] \url{comp.text.tex}
 \end{description}
 
 
+\section{Distributions \protect\Dash \protect\LaTeX\ for various operating systems}
+\begin{description}[style=unboxed]
+\item[TeXLive:] \url{http://tug.org/texlive/} \hfill Unix and Windows
+\item[MiKTex:] \url{https://miktex.org/}  \hfill Windows and Mac
+\item[proTeXt:] \url{http://tug.org/protext/}  \hfill Windows
+\item[MacTex:] \url{http://tug.org/mactex/} \hfill Mac
+\end{description}
+
+
+\section{Change log}
+
+\begin{description}
+\item[2017/03/06:] Initial version.
+\item[2017/10/04:] Added users groups, mailing lists,
+    distributions, \LuaTeX, \XeTeX, \pkg{chktex}.
+    Organization and formatting improvements.
+\end{description}
+
+
 \begin{thebibliography}{99}
 
 \bibitem{lamport:latex}
@@ -731,7 +809,7 @@ Peter~Flynn,
 
 \bibitem{pakin:goodthings}
 Good things come in little packages:
-An introduction to writing .ins and .dtx files,
+An introduction to writing \texttt{.ins} and \texttt{.dtx} files,
 Scott~Pakin,
 \TUB\ 29:2 (2008), pp.\,305--314,
 \url{http://tug.org/TUGboat/tb29-2/tb92pakin.pdf}
@@ -742,7 +820,8 @@ Niall Mansfield,
 \TUB\ 29:3 (2008), pp.\,356--361.
 \url{http://tug.org/TUGboat/tb29-3/tb93mansfield.pdf}
 
-
 \end{thebibliography}
-\vfilneg
+% \vfilneg
+
+
 \end{document}