texlive[46375] Master/texmf-dist/doc/latex/docsurvey: docsurvey

commits+karl at tug.org commits+karl at tug.org
Fri Jan 19 00:24:55 CET 2018 

Revision: 46375
          http://tug.org/svn/texlive?view=revision&revision=46375
Author:   karl
Date:     2018-01-19 00:24:55 +0100 (Fri, 19 Jan 2018)
Log Message:
-----------
docsurvey (18jan18)

Modified Paths:
--------------
    trunk/Master/texmf-dist/doc/latex/docsurvey/README.txt
    trunk/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
    trunk/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex

Modified: trunk/Master/texmf-dist/doc/latex/docsurvey/README.txt
===================================================================
--- trunk/Master/texmf-dist/doc/latex/docsurvey/README.txt	2018-01-18 23:24:44 UTC (rev 46374)
+++ trunk/Master/texmf-dist/doc/latex/docsurvey/README.txt	2018-01-18 23:24:55 UTC (rev 46375)
@@ -4,8 +4,8 @@
 Provides the document
 "Programming LaTeX — A survey of documentation and packages"
 
-October 4, 2017
-Copyright 2017 Brian Dunn — www.BDTechConcepts.com
+January 18, 2018
+Copyright 2017-2018 Brian Dunn — www.BDTechConcepts.com
 
 LaTeX Project Public License, version 1.3
 

Modified: trunk/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
===================================================================
(Binary files differ)

Modified: trunk/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex	2018-01-18 23:24:44 UTC (rev 46374)
+++ trunk/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex	2018-01-18 23:24:55 UTC (rev 46375)
@@ -78,8 +78,8 @@
 % \def\dash{\d at sh\nobreak\endash}
 % \def\Dash{\d at sh\nobreak\emdash}
 \newcommand{\thinbrspace}{\hspace{.16667em}\penalty\exhyphenpenalty\hspace{0pt}}
-\newcommand{\Dash}{\unskip\thinspace\textemdash\thinbrspace}
-\newcommand{\dash}{\unskip\thinspace\mbox{--}\thinbrspace}
+\newrobustcmd{\Dash}{\unskip\thinspace\textemdash\thinbrspace}
+\newrobustcmd{\dash}{\unskip\thinspace\mbox{--}\thinbrspace}
 \def\ldash{\d at sh\empty{\hbox{\endash}\nobreak}}
 \def\rdash{\d at sh\nobreak\endash}
 \def\Ldash{\d at sh\empty{\hbox{\emdash}\nobreak}}
@@ -304,24 +304,34 @@
 \predate{\begin{center}\small}
 
 
-\newcommand*{\pkg}[1]{\textsf{#1}}
-\newcommand*{\environ}[1]{\texttt{#1}}
-\newcommand*{\prog}[1]{\texttt{#1}}
-\newcommand*{\LuaLaTeX}{Lua\-\LaTeX}
-\newcommand*{\LuaTeX}{Lua\-\TeX}
-\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*{\userentry}[1]{%
+\newrobustcmd*{\pkg}[1]{\textsf{#1}}
+\newrobustcmd*{\prog}[1]{\texttt{#1}}
+\newrobustcmd*{\LuaLaTeX}{Lua\-\LaTeX}
+\newrobustcmd*{\LuaTeX}{Lua\-\TeX}
+\newrobustcmd*{\tag}[1]{\texttt{<#1>}}
+\newrobustcmd*{\prop}[1]{\textsl{\texttt{#1}}}
+\newrobustcmd*{\epub}{\acro{EPUB}}
+\newrobustcmd*{\texdoc}[1]{\hspace*{\fill}\mbox{(\texttt{texdoc #1})}}
+\newrobustcmd*{\userentry}[1]{%
 \leavevmode\par\hspace*{2em}\texttt{#1}\smallskip\\}
 
+\pdfstringdefDisableCommands{
+\renewcommand*{\quad}{ }
+\renewcommand*{\pkg}[1]{#1}
+\renewcommand*{\prog}[1]{#1}
+\renewcommand*{\LuaLaTeX}{LuaLaTeX}
+\renewcommand*{\XeLaTeX}{XeLaTeX}
+\renewcommand*{\TeX}{TeX}
+\renewcommand*{\LaTeX}{LaTeX}
+\renewcommand*{\Dash}{ --- }
+\renewcommand*{\dash}{ -- }
+}
 
 \title{Programming \LaTeX\Dash \\ A survey of documentation and packages}
 
 \author{Brian Dunn \\
 	\small \href{mailto:bd at BDTechConcepts.com}{bd at BDTechConcepts.com} \\
-	\small Copyright 2017 Brian Dunn\thanks{
+	\small Copyright 2017--2018 Brian Dunn\thanks{
 		This work may be distributed and/or modified under the
 		conditions of the \LaTeX\ Project Public License, either version 1.3
 		of this license or (at your option) any later version.
@@ -502,14 +512,20 @@
 \end{description}
 
 
-\section{Accessing embedded documentation}
+\section{Accessing embedded information}
 
+\subsection{\pkg{texdoc}}
+
 A large amount of documentation is included in a \TeX\ distribution.
 Most can be accessed with the \prog{texdoc} program.
-Use \prog{texdoc -l name} to select from many choices of
+Enter ``\prog{texdoc -l <name>}'' to search for
 matching package, file, or program names.  In some cases the same document
 is available in both letter or A4 paper sizes, or in several languages.
+\prog{texdoc} is also available online~\cite{texdocnet} at \url{texdoc.net},
+with popular packages sorted by category.
 
+\subsection{\prog{kpsewhich}}
+
 The program \prog{kpsewhich} may be used to find out where a file is
 located.  \prog{kpsewhich filename} searches for and returns the
 path to the given filename.
@@ -533,6 +549,10 @@
 \item The \verb+.dtx+ file is usually available,
 and will have the package's source code.
 \userentry{kpsewhich package.dtx}
+If it is not installed on your local system, it will
+be necessary to download the \verb+.dtx+ file from
+CTAN (see the next section).
+
 The comments are not yet typeset and so
 will not be as easily read.
 \item To typeset the documentation with the source code,
@@ -549,7 +569,9 @@
 
 
 
-\section{Obtaining packages \Dash Comprehensive \TeX\ Archive Network \protect\quad (CTAN)}
+\section{%
+    Obtaining packages \Dash Comprehensive \TeX\ Archive Network \protect\quad (CTAN)%
+}
 
 The Comprehensive \TeX\ Archive Network
 (\CTAN) provides a master collection of
@@ -563,7 +585,7 @@
 
 
 \needspace{7\baselineskip}
-\section{Packages useful for programming \protect\LaTeX}
+\section{Packages useful for programming \LaTeX}
 
 A number of packages are especially useful for \LaTeX\ programmers:
 \texdoc{<packagename>}
@@ -618,7 +640,7 @@
 	\texdoc{docstrip}
 \end{description}
 
-\subsection{Published articles about creating \protect\LaTeX\ packages}
+\subsection{Published articles about creating \LaTeX\ packages}
 
 Related articles from \TUB:
 
@@ -670,7 +692,7 @@
 \end{description}
 
 
-\section{Distributions \protect\Dash \protect\LaTeX\ for various operating systems}
+\section{Distributions \Dash \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
@@ -686,6 +708,8 @@
 \item[2017/10/04:] Added users groups, mailing lists,
     distributions, \LuaTeX, \XeTeX, \pkg{chktex}.
     Organization and formatting improvements.
+\item[2017/10/14:] More information about accessing embedded documentation.
+\item[2018/01/18:] Added \url{texdoc.net}.
 \end{description}
 
 
@@ -735,7 +759,7 @@
 \bibitem{greenwade:reference}
 \LaTeXe: An unofficial reference manual,
 George~D. Greenwade, Stephen Gilmore,
-Torsten~Martinsen, and Karl Berry, \\
+Torsten~Martinsen, and Karl Berry,
 \url{http://home.gna.org/latexrefman}
 
 \bibitem{eijkhout:topic}
@@ -756,18 +780,22 @@
 
 \bibitem{UK:FAQ}
 UK TUG FAQ,
-UK \TeX\ Users Group, \\
+UK \TeX\ Users Group, 
 \url{http://www.tex.ac.uk/}
 
 \bibitem{pakin:visual}
 The Visual \LaTeX\ FAQ,
-Scott Pakin, \\
+Scott Pakin, 
 \url{https://ctan.org/pkg/visualfaq}
 
+\bibitem{texdocnet}
+TeXdoc Online, 
+\url{http://texdoc.net/}
+
 \bibitem{latexteam:sources}
 The \LaTeXe\ Sources,
 Johannes Braams, David Carlisle, Alan Jeffrey, Leslie Lamport,
-Frank Mittelbach, Chris Rowley, and Rainer Sch\"opf, \\
+Frank Mittelbach, Chris Rowley, and Rainer Sch\"opf,
 \url{https://ctan.org/pkg/source2e}
 
 \bibitem{scharrer:listinternal}
@@ -776,7 +804,7 @@
 \url{https://ctan.org/pkg/macros2e}
 
 \bibitem{ctan}
-Comprehensive \TeX\ Archive Network (CTAN), \\
+Comprehensive \TeX\ Archive Network (CTAN),
 \url{https://ctan.org}
 
 \bibitem{pakin:dtxtut}

More information about the tex-live-commits mailing list