summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/docsurvey
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-01-18 23:24:55 +0000
committerKarl Berry <karl@freefriends.org>2018-01-18 23:24:55 +0000
commit7c230ea7dd1bae4eb4fceb4e1cceff1c425b0b53 (patch)
treec0d31a158924bbd9c64c2058f0e2d455f16662c4 /Master/texmf-dist/doc/latex/docsurvey
parent5c2f736443bc40440ca6b55d754e9f25619bca64 (diff)
docsurvey (18jan18)
git-svn-id: svn://tug.org/texlive/trunk@46375 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/docsurvey')
-rw-r--r--Master/texmf-dist/doc/latex/docsurvey/README.txt4
-rw-r--r--Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdfbin273567 -> 276238 bytes
-rw-r--r--Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex76
3 files changed, 54 insertions, 26 deletions
diff --git a/Master/texmf-dist/doc/latex/docsurvey/README.txt b/Master/texmf-dist/doc/latex/docsurvey/README.txt
index 78abb43bf7f..ffe7a95d535 100644
--- a/Master/texmf-dist/doc/latex/docsurvey/README.txt
+++ b/Master/texmf-dist/doc/latex/docsurvey/README.txt
@@ -4,8 +4,8 @@ The LaTeX docsurvey package
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
diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
index 6e00a34dd3e..37bbaffec5d 100644
--- a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
+++ b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
index af91ef543ae..a54d5ba994b 100644
--- a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
+++ b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex
@@ -78,8 +78,8 @@
% \def\dash{\d@sh\nobreak\endash}
% \def\Dash{\d@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@sh\empty{\hbox{\endash}\nobreak}}
\def\rdash{\d@sh\nobreak\endash}
\def\Ldash{\d@sh\empty{\hbox{\emdash}\nobreak}}
@@ -304,24 +304,34 @@ Keywords={LaTeX, programming, documentation, BD Tech Concepts LLC}%
\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@BDTechConcepts.com}{bd@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,13 +512,19 @@ it is programmed.~\cite{pakin:visual} \\
\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
@@ -533,6 +549,10 @@ so it is better to use the \verb+.dtx+ file instead.
\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 @@ Barring unusual circumstances, this will create a new documentation
-\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 @@ topics then shows you related packages.~\cite{ctan}
\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 @@ Documentation for those interested in creating their own package or class:
\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 @@ Using \LaTeX\ to keep away from the Dark Side:] An overview of the
\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 @@ Using \LaTeX\ to keep away from the Dark Side:] An overview of the
\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 @@ Tobias Oetiker,
\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 @@ Will Robertson, \\
\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 @@ Martin Scharrer, \\
\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}