From f84ad68091d24f72d878a47af2c7aedf859be453 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 28 Jun 2018 21:16:56 +0000 Subject: docsurvey (28jun18) git-svn-id: svn://tug.org/texlive/trunk@48108 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/docsurvey/docsurvey.pdf | Bin 317074 -> 349007 bytes .../texmf-dist/doc/latex/docsurvey/docsurvey.tex | 215 ++++++++++++++++----- 2 files changed, 166 insertions(+), 49 deletions(-) (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf index c0546e29c5d..0db102184ec 100644 Binary files a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf and b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf differ diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex index 41b0d11f2a1..eabe17b7325 100644 --- a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex +++ b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex @@ -280,7 +280,13 @@ \usepackage{graphicx} \usepackage{ifpdf} \ifpdf -\usepackage[breaklinks,hidelinks]{hyperref} +\definecolor{myurlcolor}{rgb}{.4,0,0} +\definecolor{mylinkcolor}{rgb}{.4,0,0} +\definecolor{mycitecolor}{rgb}{.4,0,0} +\usepackage[breaklinks,colorlinks, + linkcolor=mylinkcolor, + urlcolor=myurlcolor, + citecolor=mycitecolor]{hyperref} \else \usepackage{url} \fi @@ -313,6 +319,7 @@ Keywords={LaTeX, programming, documentation, BD Tech Concepts LLC}% \newrobustcmd*{\prop}[1]{\textsl{\texttt{#1}}} \newrobustcmd*{\epub}{\acro{EPUB}} \newrobustcmd*{\texdoc}[1]{\hspace*{\fill}\mbox{(\texttt{texdoc #1})}} +\newrobustcmd*{\hfurl}[1]{\hspace*{\fill}\mbox{(\url{#1})}} \newrobustcmd*{\userentry}[1]{% \leavevmode\par\hspace*{2em}\texttt{#1}\smallskip\\} @@ -406,8 +413,8 @@ 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} +\item[Additional books:] Listed at the \acro{\TeX\ FAQ}.~\cite{TeX:FAQ} + \hfurl{https://texfaq.org/} \end{description} @@ -434,17 +441,17 @@ program. \begin{description} \item[Getting something out of \LaTeX:] Create your first document in \LaTeX.~\cite{hefferon:first} - \hfill \url{https://ctan.org/pkg/first-latex-doc} + \hfurl{https://ctan.org/pkg/first-latex-doc} \item[The very short guide to typesetting with \LaTeX:] A four-page introduction.~\cite{flynn:veryshort} - \hfill \url{https://ctan.org/pkg/latex-veryshortguide} + \hfurl{https://ctan.org/pkg/latex-veryshortguide} \item[Formatting Information:] A beginner’s introduction to typesetting with \LaTeX.~\cite{flynn:formatting} - \hfill \url{https://ctan.org/pkg/beginlatex} + \hfurl{https://ctan.org/pkg/beginlatex} -\item[\LaTeX for Complete Novices:] +\item[\LaTeX\ for Complete Novices:] An extensive introduction for a non-technical person.~\cite{talbot:novices} \texdoc{dickimaw-novices} @@ -455,12 +462,12 @@ program. \item[Writing Scientific Documents Using \LaTeX:] An introduction to typesetting scientific documents.~\cite{Bennieston:scientific} \\ - \hspace*{\fill} \url{https://ctan.org/pkg/intro-scientific} + \hfurl{https://ctan.org/pkg/intro-scientific} \item[The Not So Short Introduction to \LaTeXe:] Covers introductory material, customizations, - and a simple package.~\cite{oetiker:introduction} - \texdoc{lshort} + and a simple package. Available in many languages~\cite{oetiker:introduction} + \texdoc{-l lshort} \hfurl{https://ctan.org/pkg/lshort} \item[\LaTeXe: An unofficial reference manual:] A thorough but concise reference manual for \LaTeXe, @@ -469,18 +476,13 @@ program. \item[LaTeX WikiBook:] An online book, includes information about creating \LaTeX\ packages and classes. \\ - \hspace*{\fill} \url{https://en.wikibooks.org/wiki/LaTeX} - -\item[Initiation à LATEX:] A French guide on \LaTeX — for beginners - or advanced users.~\cite{bouzigues:guide} \\ - \hspace*{\fill} \url{https://ctan.org/pkg/guide-latex-fr} - + \hfurl{https://en.wikibooks.org/wiki/LaTeX} \end{description} \subsection{Lua\LaTeX} \begin{description} -\item [A guide to lua\LaTeX:] An introduction. \texdoc{lualatex-doc} +\item [A guide to Lua\LaTeX:] An introduction. \texdoc{lualatex-doc} \item [Lua\TeX\ Reference:] The full manual. \texdoc{luatex.pdf} \end{description} @@ -506,7 +508,7 @@ 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} \\ +More than 14,000 symbols and \LaTeX\ commands.~\cite{pakin:list} \texdoc{symbols-letter} \\ \texdoc{symbols-a4} \item[Every symbol (most symbols) defined by unicode-math:] @@ -521,8 +523,8 @@ 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} + something really works.~\cite{latexteam:sources} + \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 @@ -537,17 +539,85 @@ The source code for \LaTeXe\ itself is also included in the distribution. %Frequently-Asked Questions \begin{description} -\item[UK TUG FAQ:] A wide-ranging list of -fre\-quently-asked questions.~\cite{UK:FAQ} -\texdoc{letterfaq} +\item[\TeX\ FAQ:] A wide-ranging list of +fre\-quently-asked questions. +(formerly the UK TUG FAQ) +~\cite{TeX:FAQ} \\ +\texdoc{letterfaq} \\ \texdoc{newfaq} \item[Visual \LaTeX\ FAQ:] Click on a visual element to learn how -it is programmed.~\cite{pakin:visual} \\ +it is programmed.~\cite{pakin:visual} \texdoc{visualFAQ} \end{description} +\subsection{Non-English} + +\begin{description} +\item[Initiation à LATEX:] A French guide on \LaTeX — for beginners + or advanced users.~\cite{bouzigues:guide} \\ + \hfurl{https://ctan.org/pkg/guide-latex-fr} + +\item[\LaTeXe\ Via Exemplos:] A study course +in Brazilian Portuguese.~\cite{massago:exemplos} + \hfurl{https://ctan.org/pkg/latex-via-exemplos} + +\item[The Not So Short Introduction to \LaTeXe:] + Covers introductory material, customizations, + and a simple package. Available in many languages~\cite{oetiker:introduction} + \texdoc{-l lshort} \hfurl{https://ctan.org/pkg/lshort} + +\item[\LaTeXe: An unofficial reference manual:] + A thorough but concise reference manual for \LaTeXe, + available in several languages.~\cite{greenwade:reference} \\ + \texdoc{-l latex2e-help} + +\item [Ebook Foundation — Free Programming Books:] A variety +of \TeX-related and other programming books and documents, +in a number of languages.~\cite{ebookfoundation:free} +\hfurl{https://github.com/EbookFoundation/free-programming-books} +\end{description} + +\subsection{General typeseting theory} + +Discussion about general typesetting theory, +presented by various \TeX-related authors. + +\begin{description} +\item[A Few Notes on Book Design:] + Discussion about book design and typography. + 100+ pages.~\cite{wilson:design} + \texdoc{memdesign} + +\item[KOMA-Script — The Guide --- Calculating the Page Layout with typearea:] + Discussion about the page layout of a book.~\cite{kohm:typearea} + \texdoc{typearea} + +\item[A TUFTE-STYLE BOOK --- The Design of Tufte's Books:] + Emulating ideas from the books of Edward R. Tufte.~\cite{tufte:book} + \texdoc{tufte-latex} + +\item[The Octavo Package:] + Design principles and guidelines emulating books + from the Renaissance.~\cite{revets:octavo} + \texdoc{octavo} + +\item[Package canoniclayout:] + Ideas regarding text-block proportions.~\cite{beccari:canoniclayout} + \texdoc{canoniclayout} + +\item[Publication-quality tables in \LaTeX:] + Improved design of tabular layouts.~\cite{fear:booktabs} + \texdoc{booktabs} + +\item[The Ti\textit{k}Z and PGF Packages --- Guidelines on Graphics:] + ``General guidelines and principles concerning the creation of graphics + for scientific presentations, papers, and books''.~\cite{tantu:pgf} + \texdoc{pgfmanual} + +\end{description} + \section{Accessing embedded information} \subsection{\pkg{texdoc}} @@ -557,8 +627,8 @@ Most can be accessed with the \prog{texdoc} program. Enter ``\prog{texdoc -l }'' 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. +\prog{texdoc} is also available online~\cite{texdocnet}, +with popular packages sorted by category. \hfurl{texdoc.net} \subsection{\prog{kpsewhich}} @@ -743,7 +813,7 @@ Using \LaTeX\ to keep away from the Dark Side:] An overview of the \section{Change log} -\begin{description} +\begin{description}[style=standard] \item[2017/03/06:] Initial version. \item[2017/10/04:] Added users groups, mailing lists, distributions, \LuaTeX, \XeTeX, \pkg{chktex}. @@ -755,6 +825,9 @@ Using \LaTeX\ to keep away from the Dark Side:] An overview of the \pkg{intro-scientific}, \pkg{guide-latex-fr}. \item[2018/03/24:] Added \pkg{interface3}, \pkg{dickimaw-novices}, \pkg{dickimaw-thesis}. \item[2018/04/01:] Added TeXnique.fr. +\item[2018/06/28:] Added sections for non-English documents and general typesetting theory. + Updated host and name for \TeX\ FAQ. Added \pkg{latex-via-exemplos} and + Ebook Foundation free programming books. \end{description} @@ -785,7 +858,7 @@ Packt Publishing, 2011, ISBN 1847199860. \bibitem{kottwitz:cookbook} \pub{\LaTeX\ Cookbook}, Stefan Kottwitz, Packt Publishing, 2015, -ISBN-13 9781784395148, \\ +ISBN-13 9781784395148. \\ \url{http://latex-cookbook.net} \bibitem{mittelbachgossens:companion} @@ -799,7 +872,7 @@ ISBN 0201362996. \bibitem{eijkhout:topic} \pub{\TeX\ by Topic}, A \TeX{}nician's Reference, Victor Eijkhout, -Addison-Wesley UK, 1991, ISBN 0201568829, +Addison-Wesley UK, 1991, ISBN 0201568829. \url{http://eijkhout.net/texbytopic/texbytopic.html} \bibitem{hefferon:first} @@ -843,11 +916,6 @@ George~D. Greenwade, Stephen Gilmore, Torsten~Martinsen, and Karl Berry. \url{http://home.gna.org/latexrefman} -\bibitem{bouzigues:guide} -\pub{Initiation à \LaTeX}, Pour débutants ou jeunes utilisateurs, -Adrien Bouzigues, 2017. \\ -\url{https://ctan.org/pkg/guide-latex-fr}. - \bibitem{pakin:list} \pub{The Comprehensive \LaTeX\ Symbol List}, Scott Pakin, 2017. @@ -861,65 +929,114 @@ Will Robertson, 2018. \\ \bibitem{latexteam:sources} \pub{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} \pub{List of internal \LaTeXe\ Macros useful to Package Authors}, -Martin Scharrer, \\ +Martin Scharrer. \\ \url{https://ctan.org/pkg/macros2e} -\bibitem{UK:FAQ} -UK TUG FAQ, -UK \TeX\ Users Group, -\url{http://www.tex.ac.uk} +\bibitem{TeX:FAQ} +\TeX\ FAQ. +\url{https://texfaq.org/} \bibitem{pakin:visual} \pub{The Visual \LaTeX\ FAQ}, -Scott Pakin, +Scott Pakin. \url{https://ctan.org/pkg/visualfaq} +\bibitem{bouzigues:guide} +\pub{Initiation à \LaTeX}, Pour débutants ou jeunes utilisateurs, +Adrien Bouzigues, 2017. \\ +\url{https://ctan.org/pkg/guide-latex-fr} + +\bibitem{massago:exemplos} +\pub{\LaTeXe\ Via Exemplos}, +Sadao Massago, 2018. +\url{https://ctan.org/pkg/latex-via-exemplos} + +\bibitem{ebookfoundation:free} +\pub{Free Programming Books}, +Ebook Foundation. \\ +\url{https://github.com/EbookFoundation/free-programming-books} + +\bibitem{wilson:design} +\pub{A Few Notes on Book Design}, +Peter Wilson, 2009. +\url{https://ctan.org/pkg/memdesign} + +\bibitem{kohm:typearea} +\pub{KOMA-Script — The Guide}, +Markus Kohm, 2018. +\url{https://ctan.org/pkg/koma-script} + +\bibitem{tufte:book} +\pub{A TUFTE-STYLE BOOK}, +The Tufte-LaTeX Developers, 2015. +\url{https://ctan.org/pkg/tufte-latex} + +\bibitem{revets:octavo} +\pub{The Octavo Package}, +Stefan A. Revets, +\pub{TUGboat} 23 3/4 (2002), p.~269. +\url{https://ctan.org/pkg/octavo} + +\bibitem{beccari:canoniclayout} +\pub{Package canoniclayout}, +Claudio Beccari, 2011. +\url{https://ctan.org/pkg/canoniclayout} + +\bibitem{fear:booktabs} +\pub{Publication-quality tables in \LaTeX}, +Simon Fear, 2016. +\url{https://ctan.org/pkg/booktabs} + +\bibitem{tantu:pgf} +\pub{Till Tantau}, 2015. +\url{https://ctan.org/pkg/pgf} + \bibitem{texdocnet} -TeXdoc Online, +TeXdoc Online. \url{http://texdoc.net} \bibitem{ctan} -Comprehensive \TeX\ Archive Network (CTAN), +Comprehensive \TeX\ Archive Network (CTAN). \url{https://ctan.org} \bibitem{pakin:dtxtut} \pub{How to Package Your \LaTeX\ Package}, -Scott~Pakin, +Scott~Pakin. \url{https://ctan.org/pkg/dtxtut} \bibitem{latexteam:class} \pub{\LaTeXe\ for class and package writers}, -\LaTeX3 Project, +\LaTeX3 Project. \url{https://ctan.org/pkg/clsguide} \bibitem{mittelbach:doc} \pub{The doc and shortvrb packages}, -Frank Mittelbach, +Frank Mittelbach. \url{https://ctan.org/pkg/doc} \bibitem{mittelbach:docstrip} \pub{The DocStrip program}, Frank Mittelbach, Denys Duchier, Johannes Braams, -Marcin Woli\'nski, and Mark Wooding, +Marcin Woli\'nski, and Mark Wooding. \url{https://ctan.org/pkg/docstrip} \bibitem{flynn:article} \pub{Rolling your own Document Class: Using \LaTeX\ to keep away from the Dark Side}, Peter~Flynn, -\TUB\ 28:1 (2007), pp.\,110--123, +\TUB\ 28:1 (2007), pp.\,110--123. \url{http://tug.org/TUGboat/tb28-1/tb88flynn.pdf} \bibitem{pakin:goodthings} \pub{Good things come in little packages: An introduction to writing \texttt{.ins} and \texttt{.dtx} files}, Scott~Pakin, -\TUB\ 29:2 (2008), pp.\,305--314, +\TUB\ 29:2 (2008), pp.\,305--314. \url{http://tug.org/TUGboat/tb29-2/tb92pakin.pdf} \bibitem{mansfield:class} -- cgit v1.2.3