summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-11-01 19:50:40 +0000
committerKarl Berry <karl@freefriends.org>2022-11-01 19:50:40 +0000
commitbb0b72659a9f57a4d360f919a7b00ade0d533030 (patch)
tree158b578054b8522e1498c5a006d54b97479b5739
parentaa6046aa8081d7aa6edd54c8ae2b746331548803 (diff)
ydoc (1nov22)
git-svn-id: svn://tug.org/texlive/trunk@64887 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt13
-rw-r--r--Master/texmf-dist/doc/latex/ydoc/README.md (renamed from Master/texmf-dist/doc/latex/ydoc/README)38
-rw-r--r--Master/texmf-dist/doc/latex/ydoc/ydoc.pdfbin327049 -> 340225 bytes
-rw-r--r--Master/texmf-dist/source/latex/ydoc/ydoc.dtx96
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc-code.sty4
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc-desc.sty4
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc-doc.sty83
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc-expl.sty4
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc.cfg4
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc.cls4
-rw-r--r--Master/texmf-dist/tex/latex/ydoc/ydoc.sty5
-rw-r--r--Master/tlpkg/tlpsrc/ydoc.tlpsrc14
12 files changed, 188 insertions, 81 deletions
diff --git a/Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt b/Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt
new file mode 100644
index 00000000000..a0206831038
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/ydoc/DEPENDS.txt
@@ -0,0 +1,13 @@
+hard newverbs
+hard hyperref
+hard needspace
+hard xcolor
+hard listings
+hard shortvrb
+hard etoolbox
+hard xspace
+hard url
+hard showexpl
+hard float
+
+soft needspace
diff --git a/Master/texmf-dist/doc/latex/ydoc/README b/Master/texmf-dist/doc/latex/ydoc/README.md
index 42216bd3c89..cb886a08f7b 100644
--- a/Master/texmf-dist/doc/latex/ydoc/README
+++ b/Master/texmf-dist/doc/latex/ydoc/README.md
@@ -1,29 +1,37 @@
-The 'ydoc' class and packages
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-'ydoc' provides macros and environments to document LaTeX packages and classes.
-It is an alternative to the 'ltxdoc' class and 'doc' package.
-It targets a different layout and tries to provide more modern styles (xcolor, hyperref, etc.).
+The `ydoc` class and packages
+=============================
+Copyright (c) 2011-2022 by Martin Scharrer <martin.scharrer@web.de>
+License: [LPPL v1.3c](https://www.latex-project.org/lppl/lppl-1-3c/)
+CTAN: https://www.ctan.org/pkg/ydoc
+Texdoc: https://texdoc.org/pkg/ydoc
+Homepage: https://github.com/MartinScharrer/ydoc
+Repository: https://github.com/MartinScharrer/ydoc.git
+Issue tracker: https://github.com/MartinScharrer/ydoc/issues
+
+`ydoc` provides macros and environments to document LaTeX packages and classes.
+It is an alternative to the `ltxdoc` class and `doc` package.
+It targets a different layout and tries to provide more modern styles (`xcolor`, `hyperref`, etc.).
This is an alpha release. It should not be used yet for other packages.
INSTALL
-~~~~~~~
+-------
This package might be part of your LaTeX distribution (TeX Live, MikTeX, ...) and then is installable using
-the distributions package manager (TeX Live: 'tlmgr install ydoc').
+the distributions package manager (TeX Live: `tlmgr install ydoc`).
However, it is also manually installable using the following ways:
-1) TDS ZIP FILE
+### TDS ZIP FILE ###
+
A TDS ZIP file includes all files in a installable format and using the required directory structure.
Simply unzip the TDS ZIP file over your TEXMF tree.
-
The TDS ZIP file can be downloaded from CTAN:
http://mirrors.ctan.org/install/macros/latex/contrib/ydoc.tds.zip
-2) DTX FILE
-The 'ydoc.dtx' file includes all required files, which can be extracted by compiling it using TeX (not LaTeX):
+### DTX FILE ###
+
+The `ydoc.dtx` file includes all required files, which can be extracted by compiling it using TeX (not LaTeX):
tex ydoc.dtx
@@ -34,8 +42,9 @@ To build the documentation compile the same file using LaTeX (preferable 'pdflat
pdflatex ydoc.dtx
Copy all files to their correct location of your local TEXMF tree.
-For example under Linux a personal TEXMF is normally located at '~/texmf' ('$HOME/texmf').
-The files can be installed using the following Linux commands. For
+For example under Linux a personal TEXMF is normally located at `~/texmf` (`$HOME/texmf`)
+and under Windows usually under `C:\Users\<username>\texmf`.
+The files can be installed using the following Linux commands:
mkdir -p "${TEXMF}/tex/latex/ydoc/"
mkdir -p "${TEXMF}/source/latex/ydoc/"
@@ -50,3 +59,4 @@ Update the tree database file (might be not required for modern versions and per
texhash ${TEXMF}
+
diff --git a/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf b/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf
index fb097616b79..be805174c4d 100644
--- a/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf
+++ b/Master/texmf-dist/doc/latex/ydoc/ydoc.pdf
Binary files differ
diff --git a/Master/texmf-dist/source/latex/ydoc/ydoc.dtx b/Master/texmf-dist/source/latex/ydoc/ydoc.dtx
index c285ee5ca96..4366e753023 100644
--- a/Master/texmf-dist/source/latex/ydoc/ydoc.dtx
+++ b/Master/texmf-dist/source/latex/ydoc/ydoc.dtx
@@ -103,11 +103,10 @@
% \fi
% \iffalse COPYRIGHT
%%
-%% Copyright (c) 2010-2011 by Martin Scharrer <martin@scharrer-online.de>
-%% WWW: http://latex.scharrer-online.de/
+%% Copyright (c) 2010-2022 by Martin Scharrer <martin.scharrer@web.de>
%%
%% This work may be distributed and/or modified under the
-%% conditions of the LaTeX Project Public License, either version 1.3
+%% conditions of the LaTeX Project Public License, either version 1.3c
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%% http://www.latex-project.org/lppl.txt
@@ -120,7 +119,7 @@
%%
%% This work consists of the files ydoc.dtx and ydoc.ins
%% and the derived file ydoc.cls, ydoc.sty, ydoc-code.sty,
-%% ydoc-expl.sty and ydoc-desc.sty.
+%% ydoc-expl.sty, ydoc-doc.sty and ydoc-desc.sty.
%%
% \fi
%
@@ -182,10 +181,10 @@
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesFile{ydoc.dtx}[%
%<=*DATE>
- 2012/05/03
+ 2022/10/26
%<=/DATE>
%<=*VERSION>
- v0.6alpha
+ v0.7alpha
%<=/VERSION>
DTX file of ydoc]
@@ -233,11 +232,12 @@
%
% \DoNotIndex{\newcommand,\newenvironment}
%
-% \GetFileInfoSVN{ydoc.dtx}
+% \GetFileInfo{ydoc.dtx}
%
% \title{The \textsf{\textbf{ydoc}} Class and Packages}
% \author{Martin Scharrer}
-% \repository{https://bitbucket.org/martin_scharrer/ydoc/}
+% \repository{https://github.com/MartinScharrer/ydoc/}
+% \github{MartinScharrer/ydoc}
% \email{martin@scharrer.de}
% \makeatletter
% \date{Version \expandafter\@gobble\fileversion\\[0.5ex]\filedate}
@@ -247,7 +247,7 @@
%
% \ifpdf
% \hypersetup{%
-% pdfauthor = {Martin Scharrer <martin@scharrer-online.de>},
+% pdfauthor = {Martin Scharrer <martin.scharrer@web.de>},
% pdftitle = {The ydoc package, \fileversion, \filedate},
% pdfsubject = {Documentation of LaTeX package ydoc.},
% pdfkeywords = {ydoc, documentation, LaTeX}
@@ -564,7 +564,6 @@
% \end{macrocode}
%
% \begin{macrocode}
-\RequirePackage{svn-prov}[2010/04/03]
\RequirePackage{ydoc-code}
\RequirePackage{ydoc-expl}
\RequirePackage{ydoc-desc}
@@ -1257,19 +1256,20 @@
\def\ctanlocation{\def\@ctanlocation##1}
-\ctanlocation{http://www.ctan.org/pkg/#1}
+\ctanlocation{https://www.ctan.org/pkg/#1}
\date{Version \fileversion\space -- \filedate}
\def\@homepage{%
- \begingroup
- \edef\@tempa{%
- \endgroup
- CTAN:
- \noexpand\url
- {\@ctanlocation{\ifx\@bundle\@empty\@package\else\@bundle\fi}}%
- }%
- \@tempa
+ CTAN: \@ctan
+}
+
+\def\@ctan{%
+ \ydoc@eurl{\@ctanlocation{\ifx\@bundle\@empty\@package\else\@bundle\fi}}%
+}
+
+\def\@texdoc{%
+ \ydoc@eurl{https://texdoc.org/pkg/\ifx\@bundle\@empty\@package\else\@bundle\fi}%
}
\let\@repository\@empty
@@ -1277,10 +1277,12 @@
\protected\def\homepage{\urldef\@homepage\url}
\protected\def\email{\hyper@normalise\email@}
\def\email@#1{\def\@plainemail{#1}\def\@email{\hyper@linkurl{\Hurl{#1}}{mailto:#1}}}
-
\let\@email\empty
-
\let\@plainemail\empty
+
+\let\@github\empty
+\protected\def\github{\def\@github}
+
\title{The \texorpdfstring{\pkgtitle{\@package}}{\@package} Package}
\def\@bundlesubtitle{Part of the \texorpdfstring{\pkgtitle{\@bundle}}{\@bundle} bundle}
@@ -1288,7 +1290,28 @@
\texorpdfstring{\textsf{#1}}{#1}%
}
+\def\@begintitlelinks{%
+ \vskip .5em
+\begingroup
+\large \lineskip .5em%
+\begin{tabular}[t]{rl}%
+}
+
+\def\@endtitlelinks{%
+\end{tabular}%
+\par
+\endgroup
+}
+\def\@maketitlelink#1#2{%
+#1: & #2\\[\medskipamount]
+}
+
+\def\@license{%
+\@maketitlelink{License}{\href{https://www.latex-project.org/lppl/lppl-1-3c/}{LPPL v1.3c or later}}%
+}
+
+\def\ydoc@eurl#1{{\edef\URL{{#1}}\expandafter\url\URL}}
\def\@maketitle{%
\newpage
@@ -1312,23 +1335,34 @@
\par}%
\fi
\vskip 1em
+ {\large \@date }%
+ \vskip 1em
+ \ifx\@github\@empty
{\large \lineskip .5em%
\begin{tabular}[t]{c}%
\@homepage
\end{tabular}%
\par}%
\vskip 1em
- \ifx\@repository\@empty\else
- {\large \lineskip .5em%
- \begin{tabular}[t]{c}%
- VC: \@repository
- \end{tabular}%
- \par}%
- \fi
- \vskip 1em
- {\large \@date }%
+\ifx\@repository\@empty\else
+{\large \lineskip .5em%
+\begin{tabular}[t]{c}%
+VC: \@repository
+\end{tabular}%
+\par}%
+\fi
+\else
+\@begintitlelinks
+\@license
+\@maketitlelink{CTAN}{\@ctan}%
+\@maketitlelink{Texdoc}{\@texdoc}%
+\@maketitlelink{Homepage}{\ydoc@eurl{https://github.com/\@github}}%
+\@maketitlelink{Repository}{\ydoc@eurl{https://github.com/\@github.git}}%
+\@maketitlelink{Issue tracker}{\ydoc@eurl{https://github.com/\@github/issues}}%
+\@endtitlelinks
+\fi
\end{center}%
- \par\vskip 1.5em
+ \par\vskip 1em
\aftergroup\ydocpdfsettings
}
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc-code.sty b/Master/texmf-dist/tex/latex/ydoc/ydoc-code.sty
index 77dead7767d..241d5579d95 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc-code.sty
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc-code.sty
@@ -8,8 +8,8 @@
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{ydoc-code}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
ydoc package to document macro code]
\RequirePackage{hyperref}
\hypersetup{colorlinks=true,pdfborder=0 0 0,pdfborderstyle={}}
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc-desc.sty b/Master/texmf-dist/tex/latex/ydoc/ydoc-desc.sty
index 77f039ff923..b0e28de785f 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc-desc.sty
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc-desc.sty
@@ -8,8 +8,8 @@
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{ydoc-desc}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
ydoc package to describe macros, environments, options etc.]
\IfFileExists{needspace.sty}{%
\RequirePackage{needspace}
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc-doc.sty b/Master/texmf-dist/tex/latex/ydoc/ydoc-doc.sty
index ec153742593..ecc66e8dfbb 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc-doc.sty
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc-doc.sty
@@ -8,8 +8,8 @@
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{ydoc-doc}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
ydoc package to provide 'doc' macros]
\newcount\ydoc@bslashcnt
\def\ydoc@countbslashes{%
@@ -153,19 +153,20 @@
\let\@bundle\@empty
\def\ctanlocation{\def\@ctanlocation##1}
-\ctanlocation{http://www.ctan.org/pkg/#1}
+\ctanlocation{https://www.ctan.org/pkg/#1}
\date{Version \fileversion\space -- \filedate}
\def\@homepage{%
- \begingroup
- \edef\@tempa{%
- \endgroup
- CTAN:
- \noexpand\url
- {\@ctanlocation{\ifx\@bundle\@empty\@package\else\@bundle\fi}}%
- }%
- \@tempa
+ CTAN: \@ctan
+}
+
+\def\@ctan{%
+ \ydoc@eurl{\@ctanlocation{\ifx\@bundle\@empty\@package\else\@bundle\fi}}%
+}
+
+\def\@texdoc{%
+ \ydoc@eurl{https://texdoc.org/pkg/\ifx\@bundle\@empty\@package\else\@bundle\fi}%
}
\let\@repository\@empty
@@ -173,10 +174,12 @@
\protected\def\homepage{\urldef\@homepage\url}
\protected\def\email{\hyper@normalise\email@}
\def\email@#1{\def\@plainemail{#1}\def\@email{\hyper@linkurl{\Hurl{#1}}{mailto:#1}}}
-
\let\@email\empty
-
\let\@plainemail\empty
+
+\let\@github\empty
+\protected\def\github{\def\@github}
+
\title{The \texorpdfstring{\pkgtitle{\@package}}{\@package} Package}
\def\@bundlesubtitle{Part of the \texorpdfstring{\pkgtitle{\@bundle}}{\@bundle} bundle}
@@ -184,6 +187,29 @@
\texorpdfstring{\textsf{#1}}{#1}%
}
+\def\@begintitlelinks{%
+ \vskip .5em
+\begingroup
+\large \lineskip .5em%
+\begin{tabular}[t]{rl}%
+}
+
+\def\@endtitlelinks{%
+\end{tabular}%
+\par
+\endgroup
+}
+
+\def\@maketitlelink#1#2{%
+#1: & #2\\[\medskipamount]
+}
+
+\def\@license{%
+\@maketitlelink{License}{\href{https://www.latex-project.org/lppl/lppl-1-3c/}{LPPL v1.3c or later}}%
+}
+
+\def\ydoc@eurl#1{{\edef\URL{{#1}}\expandafter\url\URL}}
+
\def\@maketitle{%
\newpage
\null\vskip 2em
@@ -206,23 +232,34 @@
\par}%
\fi
\vskip 1em
+ {\large \@date }%
+ \vskip 1em
+ \ifx\@github\@empty
{\large \lineskip .5em%
\begin{tabular}[t]{c}%
\@homepage
\end{tabular}%
\par}%
\vskip 1em
- \ifx\@repository\@empty\else
- {\large \lineskip .5em%
- \begin{tabular}[t]{c}%
- VC: \@repository
- \end{tabular}%
- \par}%
- \fi
- \vskip 1em
- {\large \@date }%
+\ifx\@repository\@empty\else
+{\large \lineskip .5em%
+\begin{tabular}[t]{c}%
+VC: \@repository
+\end{tabular}%
+\par}%
+\fi
+\else
+\@begintitlelinks
+\@license
+\@maketitlelink{CTAN}{\@ctan}%
+\@maketitlelink{Texdoc}{\@texdoc}%
+\@maketitlelink{Homepage}{\ydoc@eurl{https://github.com/\@github}}%
+\@maketitlelink{Repository}{\ydoc@eurl{https://github.com/\@github.git}}%
+\@maketitlelink{Issue tracker}{\ydoc@eurl{https://github.com/\@github/issues}}%
+\@endtitlelinks
+\fi
\end{center}%
- \par\vskip 1.5em
+ \par\vskip 1em
\aftergroup\ydocpdfsettings
}
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc-expl.sty b/Master/texmf-dist/tex/latex/ydoc/ydoc-expl.sty
index 257cc758ff8..cc00f8d94e3 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc-expl.sty
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc-expl.sty
@@ -8,8 +8,8 @@
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{ydoc-expl}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
ydoc package to insert live examples of LaTeX code]
\RequirePackage{listings}
\lst@RequireAspects{writefile}
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc.cfg b/Master/texmf-dist/tex/latex/ydoc/ydoc.cfg
index 56b98ace15f..44be718ff13 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc.cfg
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc.cfg
@@ -8,8 +8,8 @@
%%
%% Please delete the following line on manual changes:
\ProvidesFile{ydoc.cfg}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
Default config file for ydoc]
\usepackage[T1]{fontenc}
\IfFileExists{fourier.sty}{%
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc.cls b/Master/texmf-dist/tex/latex/ydoc/ydoc.cls
index f10f440395e..1588c9d1b48 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc.cls
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc.cls
@@ -8,8 +8,8 @@
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesClass{ydoc}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
ydoc class: document LaTeX class and packages]
\PassOptionsToClass{a4paper}{article}
\DeclareOption*{\expandafter\PassOptionsToClass\expandafter{\CurrentOption}{article}}
diff --git a/Master/texmf-dist/tex/latex/ydoc/ydoc.sty b/Master/texmf-dist/tex/latex/ydoc/ydoc.sty
index b888036fe95..1e064819f59 100644
--- a/Master/texmf-dist/tex/latex/ydoc/ydoc.sty
+++ b/Master/texmf-dist/tex/latex/ydoc/ydoc.sty
@@ -8,10 +8,9 @@
%%
\NeedsTeXFormat{LaTeX2e}[1999/12/01]
\ProvidesPackage{ydoc}[%
- 2012/05/03
- v0.6alpha
+ 2022/10/26
+ v0.7alpha
ydoc package: document LaTeX class and packages]
-\RequirePackage{svn-prov}[2010/04/03]
\RequirePackage{ydoc-code}
\RequirePackage{ydoc-expl}
\RequirePackage{ydoc-desc}
diff --git a/Master/tlpkg/tlpsrc/ydoc.tlpsrc b/Master/tlpkg/tlpsrc/ydoc.tlpsrc
index e69de29bb2d..b8e1db95aaa 100644
--- a/Master/tlpkg/tlpsrc/ydoc.tlpsrc
+++ b/Master/tlpkg/tlpsrc/ydoc.tlpsrc
@@ -0,0 +1,14 @@
+hard newverbs
+hard hyperref
+hard needspace
+hard xcolor
+hard listings
+#hard shortvrb
+hard etoolbox
+#hard xspace
+hard tools
+hard url
+hard showexpl
+hard float
+
+#soft needspace