From 8ddac8ab98c61fdef19e2178131be4d47b4ccd5f Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 23 Mar 2024 20:18:08 +0000 Subject: docsurvey (23mar24) git-svn-id: svn://tug.org/texlive/trunk@70729 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/docsurvey/README.txt | 2 +- .../texmf-dist/doc/latex/docsurvey/docsurvey.pdf | Bin 259054 -> 264764 bytes .../texmf-dist/doc/latex/docsurvey/docsurvey.tex | 130 ++++++++++++++++++--- 3 files changed, 117 insertions(+), 15 deletions(-) diff --git a/Master/texmf-dist/doc/latex/docsurvey/README.txt b/Master/texmf-dist/doc/latex/docsurvey/README.txt index 799c480702d..d8038d94349 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" -2024/03/18 +2024/03/23 Copyright 2017–2024 Brian Dunn https://github.com/bdtc/docsurvey diff --git a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.pdf index 431b7a19b76..d4508104221 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 d50543c7eeb..9bfa69d39c1 100644 --- a/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex +++ b/Master/texmf-dist/doc/latex/docsurvey/docsurvey.tex @@ -1038,6 +1038,30 @@ }, } +@article{wright:keyvalue, + title={Implementing key–value input: an introduction}, + author={Joseph Wright and Christian Feuersänger}, + journaltitle={TUGboat}, + volume=30, + number=1, + year=2009, + pagetotal=13, + url={https://tug.org/TUGboat/tb30-1/tb94wright-keyval.pdf}, + annotation={An introduction to various key/value packages.} +} + +@article{wright:l3keys, + title={Key–value setting handling in the LATEX kernel}, + author={Joseph Wright}, + journaltitle={TUGboat}, + volume=43, + number=2, + year=2022, + pagetotal=2, + url={https://tug.org/TUGboat/tb43-2/tb134wright-keyval.pdf}, + annotation={Modern kernel key/value support.} +} + @article{flynn:article, title={Rolling your own Document Class: Using \LaTeX\ to keep away from the Dark Side}, @@ -1973,6 +1997,10 @@ annotation,abstract,library,file} \addtocategory{typesetting}{wilson:design, kohm:typearea, tufte:book, revets:octavo, beccari:canoniclayout, fear:booktabs, tantu:pgf} + +\DeclareBibliographyCategory{programminglatex} +\addtocategory{programminglatex}{wright:keyvalue,wright:l3keys} + \DeclareBibliographyCategory{creating} \addtocategory{creating}{pakin:dtxtut, latexteam:class, mittelbach:doc, mittelbach:docstrip, flynn:article, pakin:goodthings, mansfield:class, latexwikibook} @@ -2159,7 +2187,7 @@ mittelbach:docstrip, flynn:article, pakin:goodthings, mansfield:class, latexwiki % \def\pcMF{\leavevmode\raise.5ex\hbox{p\kern-.3\p@ c}MF\@} % \def\PCTeX{PC\thinspace\TeX} % \def\pcTeX{\leavevmode\raise.5ex\hbox{p\kern-.3\p@ c}\TeX} -% \def\PDF{\acro{PDF}} + \def\PDF{\acro{PDF}} % \def\PGF{\acro{PGF}} % \def\PHP{\acro{PHP}} % \def\PiC{P\kern-.12em\lower.5ex\hbox{I}\kern-.075emC\@} @@ -2369,7 +2397,7 @@ Keywords={LaTeX, programming, documentation, BD Tech Concepts LLC}% } } -\date{March 18, 2024} +\date{March 23, 2024} \setcounter{secnumdepth}{0} @@ -2871,6 +2899,16 @@ Barring unusual circumstances, this will create a new documentation \end{enumerate} +\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 +\item[proTeXt:] \url{http://tug.org/protext/} \hfill Windows +\item[MacTeX:] \url{http://tug.org/mactex/} \hfill Mac +\item[BasicTeX:] \url{https://www.tug.org/mactex/morepackages.html} \hfill Mac (simplified) +\end{description} + + \section{Managing TeXLive} \printbibliography[ @@ -3136,7 +3174,7 @@ A number of packages are especially useful for \LaTeX\ programmers: \item[\pkg{iftex}:] Detect \TeX\ engine. \item[\pkg{ifplatform}:] Detect operating system. \item[\pkg{xstring}:] String manipulation. -\item[\pkg{keyval}, \pkg{xkeyval}, \pkg{kvsetkeys}:] Key\slash{}value arguments. +\item[\pkg{keyval}, \pkg{xkeyval}, \pkg{kvsetkeys}, \pkg{ltxkeys}:] Key\slash{}value arguments. \item[\pkg{pgfkeys}, \pkg{pgfkeyx}:] Another form of key\slash{}value arguments. \item[\pkg{kvoptions}:] Key\slash{}value package options. \item[\pkg{expl3}:] \LaTeX3 programming. @@ -3147,6 +3185,53 @@ A number of packages are especially useful for \LaTeX\ programmers: \end{description} \end{multicols} +\subsubsection{Programming-related documentation} + +\printbibliography[ + heading=none, + category=programminglatex, +] + + +\subsection{Advanced programming} + +Recent developments in the \LaTeX\ kernel. +For discussion, see news entries at The \LaTeX\ Project website: +\url{https://www.latex-project.org/news/latex2e-news/} +\texdoc{} + +\begin{multicols}{2} +\begin{description} +\item[\pkg{lthooks}:] Programming hooks to add code to standard functionality. +\item[\pkg{ltcmdhooks}:] Programming hooks to add code to existing commands. +\item[\pkg{ltsockets}:] Programming sockets to change functionality. +\item[\pkg{ltpara}:] Paragraph handling. +\item[\pkg{ltmeta}:] Document meta data. +\item[\pkg{ltproperties}:] Cross-referencing document properties. Extended referencing. +\item[\pkg{ltmarks}:] Running page marks, such as chapter name. +\item[\pkg{ltkeys}:] Modern key/value handling. \texdoc{source2e} +\item[\pkg{ltfilehooks}:] Programming hooks for packages and files. +\item[\pkg{ltshipout}:] Programming hooks for page shipout. +\item[\pkg{xtemplate}:] Customize the visual design of a document. +\end{description} +\end{multicols} + + +\subsection{Programming for \PDF\ management and tagging} + +Recent developments in \PDF\ document meta data and tagging. \\ +\url{https://www.latex-project.org/publications/indexbytopic/pdf/} +\texdoc{} + +\begin{multicols}{2} +\begin{description} +\item[\pkg{pdfmanagement}:] \cs{DocumentMetaData} and \PDF\ management activation. +\item[\pkg{l3pdfmanagement}:] Managing central \PDF\ resources. +\item[\pkg{tagpdf}:] Test various parts of tagging \PDF\ documents. +\item[\pkg{latex-lab}:] Experimental code for various aspects of \LaTeX. +\end{description} +\end{multicols} + \section{Creating and documenting new packages} @@ -3158,11 +3243,28 @@ Documentation for those interested in creating their own package or class: ] +\section{The \LaTeX\ Project} + +The \LaTeX\ Project maintains and develops the \LaTeX\ typesetting system. + +\begin{description} +\item[Website:] \url{https://www.latex-project.org} + + News updates and publications about modern \LaTeX\ developments and programming. + Contact information. + +\item[Code Repository:] \url{https://github.com/latex3} + + Code repository and bug tracker. +\end{description} + + \section{Users groups} \label{sec:groups} \begin{description}[style=unboxed] \item[\TeX\ Users Group:] \url{http://tug.org} +\needspace{2\baselineskip} \item[Lists of international users groups:] \ \begin{itemize} \item \url{http://tug.org/usergroups.html} @@ -3190,21 +3292,29 @@ Documentation for those interested in creating their own package or class: \url{https://topanswers.xyz/tex} \end{description} +\needspace{2\baselineskip} + \item[German forums:] \ \begin{description}[style=unboxed] \item[TeXwelt:] \url{http://texwelt.de/wissen/} \item[goLaTeX:] \url{http://golatex.de} \end{description} +\needspace{2\baselineskip} + \item[French forums:] \ \begin{description}[style=unboxed] \item[TeXnique.fr:] \url{http://texnique.fr} \end{description} +\needspace{2\baselineskip} + \item[Mailing lists:] Several dozen, spanning a wide range of \TeX-related topics. \url{http://tug.org/mailman/listinfo} +\needspace{2\baselineskip} + \item[Newsgroup:] \url{comp.text.tex} \end{description} @@ -3213,21 +3323,11 @@ Documentation for those interested in creating their own package or class: \section{Online editing and collaboration} \begin{description}[style=unboxed] -\item[Overleaf:] Collaborative editing of \LaTeX\ documents online. +\item[\textsc{Overleaf}:] Collaborative editing of \LaTeX\ documents online. \url{https://www.overleaf.com/} \end{description} -\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 -\item[proTeXt:] \url{http://tug.org/protext/} \hfill Windows -\item[MacTeX:] \url{http://tug.org/mactex/} \hfill Mac -\item[BasicTeX:] \url{https://www.tug.org/mactex/morepackages.html} \hfill Mac (simplified) -\end{description} - - \section{Change log} @@ -3268,6 +3368,8 @@ Documentation for those interested in creating their own package or class: \item[2024/01/14:] Updated \citetitle{latex:authors} and \citetitle{latex:usrguide}. \item[2024/03/01:] Added the section for TexLive, \citetitle{Gonzato:LaTeXforWP}. \item[2024/03/18:] Updated French resources, added \citetitle{lua:pil_fourth}. +\item[2024/03/23:] Added sections for the The \LaTeX\ Project, + advanced programming, \PDF\ management, key/value documentation. \end{description} -- cgit v1.2.3