From d6e9bde6a8ffa27e45e35126f586e4e5415242b6 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 23 Apr 2022 21:11:14 +0000 Subject: zref-check (23apr22) git-svn-id: svn://tug.org/texlive/trunk@63113 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/zref-check/CHANGELOG.md | 11 +- Master/texmf-dist/doc/latex/zref-check/MANIFEST.md | 284 --------------------- .../doc/latex/zref-check/zref-check-code.pdf | Bin 741661 -> 742306 bytes .../doc/latex/zref-check/zref-check-code.tex | 2 +- .../texmf-dist/doc/latex/zref-check/zref-check.pdf | Bin 451832 -> 452289 bytes .../texmf-dist/doc/latex/zref-check/zref-check.tex | 2 +- .../source/latex/zref-check/zref-check.dtx | 37 ++- .../source/latex/zref-check/zref-check.ins | 4 +- .../texmf-dist/tex/latex/zref-check/zref-check.sty | 15 +- 9 files changed, 52 insertions(+), 303 deletions(-) delete mode 100644 Master/texmf-dist/doc/latex/zref-check/MANIFEST.md (limited to 'Master') diff --git a/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md b/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md index 76f4d6b20b6..d74dbe3dad3 100644 --- a/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md +++ b/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md @@ -1,6 +1,15 @@ # Changelog -## [Unreleased](https://github.com/gusbrs/zref-check/compare/v0.2.5...HEAD) +## [Unreleased](https://github.com/gusbrs/zref-check/compare/v0.3.0...HEAD) + +## [v0.3.0](https://github.com/gusbrs/zref-check/compare/v0.2.5...v0.3.0) (2022-04-22) + +### Changed +- `zref-check` no longer accepts package options to be set a load-time, + `\zrefchecksetup` must be used instead. The use of load-time options now + results in "Unknown option" LaTeX error. This change requires that users + adjust their documents, and a suitable package warning has been provided so + that affected users know of the change directly and how to adjust. ## [v0.2.5](https://github.com/gusbrs/zref-check/compare/v0.2.4...v0.2.5) (2022-02-11) diff --git a/Master/texmf-dist/doc/latex/zref-check/MANIFEST.md b/Master/texmf-dist/doc/latex/zref-check/MANIFEST.md deleted file mode 100644 index 7a204e97823..00000000000 --- a/Master/texmf-dist/doc/latex/zref-check/MANIFEST.md +++ /dev/null @@ -1,284 +0,0 @@ -# Manifest for zref-check - -This file is a listing of all files considered to be part of this package. -It is automatically generated with `l3build manifest`. - - -## Repository manifest - -The following groups list the files included in the development repository of the package. -Files listed with a ‘†’ marker are included in the TDS but not CTAN files, and files listed -with ‘‡’ are included in both. - -### Source files - -These are source files for a number of purposes, including the `unpack` process which -generates the installation files of the package. Additional files included here will also -be installed for processing such as testing. - -* zref-check.dtx ‡ -* zref-check.ins ‡ - -### Typeset documentation source files - -These files are typeset using LaTeX to produce the PDF documentation for the package. - -* zref-check-code.tex ‡ -* zref-check.tex ‡ - -### Text files - -Plain text files included as documentation or metadata. - -* CHANGELOG.md ‡ -* MANIFEST.md ‡ -* README.md ‡ -* readme-ctan.md -* DEPENDS.txt ‡ - -### Derived files - -The files created by ‘unpacking’ the package sources. This typically includes -`.sty` and `.cls` files created from DocStrip `.dtx` files. - -* zref-check.sty † - -### Typeset documents - -The output files (PDF, essentially) from typesetting the various source, demo, -etc., package files. - -* zref-check-code.pdf ‡ -* zref-check.pdf ‡ - -### Test files - -These files form the test suite for the package. `.lvt` or `.lte` files are the individual -unit tests, and `.tlg` are the stored output for ensuring changes to the package produce -the same output. These output files are sometimes shared and sometime specific for -different engines (pdfTeX, XeTeX, LuaTeX, etc.). - -* zc-babel01.lvt -* zc-babel02.lvt -* zc-babel03.lvt -* zc-babel04.lvt -* zc-check-above01.lvt -* zc-check-after01.lvt -* zc-check-before01.lvt -* zc-check-below01.lvt -* zc-check-chapsafter01.lvt -* zc-check-chapsbefore01.lvt -* zc-check-close01.lvt -* zc-check-facing01.lvt -* zc-check-facing02.lvt -* zc-check-facing03.lvt -* zc-check-far01.lvt -* zc-check-multi01.lvt -* zc-check-nextchap01.lvt -* zc-check-nextpage01.lvt -* zc-check-nextpage02.lvt -* zc-check-nextsec01.lvt -* zc-check-otherpage01.lvt -* zc-check-otherpage02.lvt -* zc-check-pagegap01.lvt -* zc-check-pagesafter01.lvt -* zc-check-pagesafter02.lvt -* zc-check-pagesbefore01.lvt -* zc-check-pagesbefore02.lvt -* zc-check-ppafter01.lvt -* zc-check-ppafter02.lvt -* zc-check-ppbefore01.lvt -* zc-check-ppbefore02.lvt -* zc-check-prevchap01.lvt -* zc-check-prevpage01.lvt -* zc-check-prevpage02.lvt -* zc-check-prevsec01.lvt -* zc-check-secsafter01.lvt -* zc-check-secsbefore01.lvt -* zc-check-thischap01.lvt -* zc-check-thispage01.lvt -* zc-check-thispage02.lvt -* zc-check-thissec01.lvt -* zc-opt-closerange01.lvt -* zc-opt-closerange02.lvt -* zc-opt-hyperref01.lvt -* zc-opt-hyperref02.lvt -* zc-opt-hyperref03.lvt -* zc-opt-hyperref04.lvt -* zc-opt-hyperref05.lvt -* zc-opt-ignore01.lvt -* zc-opt-ignore02.lvt -* zc-opt-msglevel01.lvt -* zc-opt-msglevel02.lvt -* zc-opt-msglevel03.lvt -* zc-opt-msglevel04.lvt -* zc-opt-msglevel05.lvt -* zc-opt-msglevel06.lvt -* zc-opt-msglevel07.lvt -* zc-opt-msglevel08.lvt -* zc-opt-msglevel09.lvt -* zc-opt-msglevel10.lvt -* zc-opt-onpage01.lvt -* zc-opt-onpage02.lvt -* zc-opt-onpage03.lvt -* zc-opt-onpage04.lvt -* zc-opt-onpage05.lvt -* zc-opt-onpage06.lvt -* zc-opt-onpage07.lvt -* zc-opt-onpage08.lvt -* zc-opt-onpage09.lvt -* zc-babel01.luatex.tlg -* zc-babel01.luatexdev.tlg -* zc-babel01.tlg -* zc-babel01.xetex.tlg -* zc-babel01.xetexdev.tlg -* zc-babel02.luatex.tlg -* zc-babel02.luatexdev.tlg -* zc-babel02.tlg -* zc-babel02.xetex.tlg -* zc-babel02.xetexdev.tlg -* zc-babel03.luatex.tlg -* zc-babel03.luatexdev.tlg -* zc-babel03.tlg -* zc-babel03.xetex.tlg -* zc-babel03.xetexdev.tlg -* zc-babel04.luatex.tlg -* zc-babel04.luatexdev.tlg -* zc-babel04.tlg -* zc-babel04.xetex.tlg -* zc-babel04.xetexdev.tlg -* zc-check-above01.tlg -* zc-check-after01.tlg -* zc-check-before01.tlg -* zc-check-below01.tlg -* zc-check-chapsafter01.tlg -* zc-check-chapsbefore01.tlg -* zc-check-close01.tlg -* zc-check-facing01.tlg -* zc-check-facing02.tlg -* zc-check-facing03.tlg -* zc-check-far01.tlg -* zc-check-multi01.tlg -* zc-check-nextchap01.tlg -* zc-check-nextpage01.tlg -* zc-check-nextpage02.tlg -* zc-check-nextsec01.tlg -* zc-check-otherpage01.tlg -* zc-check-otherpage02.tlg -* zc-check-pagegap01.tlg -* zc-check-pagesafter01.tlg -* zc-check-pagesafter02.tlg -* zc-check-pagesbefore01.tlg -* zc-check-pagesbefore02.tlg -* zc-check-ppafter01.tlg -* zc-check-ppafter02.tlg -* zc-check-ppbefore01.tlg -* zc-check-ppbefore02.tlg -* zc-check-prevchap01.tlg -* zc-check-prevpage01.tlg -* zc-check-prevpage02.tlg -* zc-check-prevsec01.tlg -* zc-check-secsafter01.tlg -* zc-check-secsbefore01.tlg -* zc-check-thischap01.tlg -* zc-check-thispage01.tlg -* zc-check-thispage02.tlg -* zc-check-thissec01.tlg -* zc-opt-closerange01.tlg -* zc-opt-closerange02.tlg -* zc-opt-hyperref01.luatex.tlg -* zc-opt-hyperref01.luatexdev.tlg -* zc-opt-hyperref01.tlg -* zc-opt-hyperref01.xetex.tlg -* zc-opt-hyperref01.xetexdev.tlg -* zc-opt-hyperref02.luatex.tlg -* zc-opt-hyperref02.luatexdev.tlg -* zc-opt-hyperref02.tlg -* zc-opt-hyperref02.xetex.tlg -* zc-opt-hyperref02.xetexdev.tlg -* zc-opt-hyperref03.luatex.tlg -* zc-opt-hyperref03.luatexdev.tlg -* zc-opt-hyperref03.tlg -* zc-opt-hyperref03.xetex.tlg -* zc-opt-hyperref03.xetexdev.tlg -* zc-opt-hyperref04.luatex.tlg -* zc-opt-hyperref04.luatexdev.tlg -* zc-opt-hyperref04.tlg -* zc-opt-hyperref04.xetex.tlg -* zc-opt-hyperref04.xetexdev.tlg -* zc-opt-hyperref05.luatex.tlg -* zc-opt-hyperref05.luatexdev.tlg -* zc-opt-hyperref05.tlg -* zc-opt-hyperref05.xetex.tlg -* zc-opt-hyperref05.xetexdev.tlg -* zc-opt-ignore01.tlg -* zc-opt-ignore02.tlg -* zc-opt-msglevel01.tlg -* zc-opt-msglevel02.tlg -* zc-opt-msglevel03.tlg -* zc-opt-msglevel04.tlg -* zc-opt-msglevel05.tlg -* zc-opt-msglevel06.tlg -* zc-opt-msglevel07.tlg -* zc-opt-msglevel08.tlg -* zc-opt-msglevel09.tlg -* zc-opt-msglevel10.tlg -* zc-opt-onpage01.tlg -* zc-opt-onpage02.tlg -* zc-opt-onpage03.tlg -* zc-opt-onpage04.tlg -* zc-opt-onpage05.tlg -* zc-opt-onpage06.tlg -* zc-opt-onpage07.tlg -* zc-opt-onpage08.tlg -* zc-opt-onpage09.tlg - - -## TDS manifest - -The following groups list the files included in the TeX Directory Structure used to install -the package into a TeX distribution. - -### Source files (TDS) - -All files included in the `zref-check/source` directory. - -* zref-check.dtx -* zref-check.ins - -### TeX files (TDS) - -All files included in the `zref-check/tex` directory. - -* zref-check.sty - -### Doc files (TDS) - -All files included in the `zref-check/doc` directory. - -* CHANGELOG.md -* DEPENDS.txt -* MANIFEST.md -* README.md -* zref-check-code.pdf -* zref-check-code.tex -* zref-check.pdf -* zref-check.tex - - -## CTAN manifest - -The following group lists the files included in the CTAN package. - -### CTAN files - -* CHANGELOG.md -* DEPENDS.txt -* MANIFEST.md -* README.md -* zref-check-code.pdf -* zref-check-code.tex -* zref-check.dtx -* zref-check.ins -* zref-check.pdf -* zref-check.tex diff --git a/Master/texmf-dist/doc/latex/zref-check/zref-check-code.pdf b/Master/texmf-dist/doc/latex/zref-check/zref-check-code.pdf index 71e442e6317..a1a9a62ba06 100644 Binary files a/Master/texmf-dist/doc/latex/zref-check/zref-check-code.pdf and b/Master/texmf-dist/doc/latex/zref-check/zref-check-code.pdf differ diff --git a/Master/texmf-dist/doc/latex/zref-check/zref-check-code.tex b/Master/texmf-dist/doc/latex/zref-check/zref-check-code.tex index 81efd7f4ec5..56454302955 100644 --- a/Master/texmf-dist/doc/latex/zref-check/zref-check-code.tex +++ b/Master/texmf-dist/doc/latex/zref-check/zref-check-code.tex @@ -24,7 +24,7 @@ % zref-check.ins, % zref-check.tex, % zref-check-code.tex, -% and the files listed in MANIFEST.md. +% and the files generated from them. % % The released version of this package is available from CTAN. % diff --git a/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf b/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf index ecfd8ee3faa..fb0e239f4a6 100644 Binary files a/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf and b/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf differ diff --git a/Master/texmf-dist/doc/latex/zref-check/zref-check.tex b/Master/texmf-dist/doc/latex/zref-check/zref-check.tex index 140d22bfd45..bed532befcc 100644 --- a/Master/texmf-dist/doc/latex/zref-check/zref-check.tex +++ b/Master/texmf-dist/doc/latex/zref-check/zref-check.tex @@ -24,7 +24,7 @@ % zref-check.ins, % zref-check.tex, % zref-check-code.tex, -% and the files listed in MANIFEST.md. +% and the files generated from them. % % The released version of this package is available from CTAN. % diff --git a/Master/texmf-dist/source/latex/zref-check/zref-check.dtx b/Master/texmf-dist/source/latex/zref-check/zref-check.dtx index 186173b35ce..9647be95fe7 100644 --- a/Master/texmf-dist/source/latex/zref-check/zref-check.dtx +++ b/Master/texmf-dist/source/latex/zref-check/zref-check.dtx @@ -24,7 +24,7 @@ % zref-check.ins, % zref-check.tex, % zref-check-code.tex, -% and the files listed in MANIFEST.md. +% and the files generated from them. % % The released version of this package is available from CTAN. % @@ -124,12 +124,14 @@ % \section{Loading the package} % \label{sec:loading-package} % -% As usual: +% \pkg{zref-check} can be loaded with the usual: % % \begin{syntax} -% \cs{usepackage}\oarg{options}|{zref-check}| +% \cs{usepackage}|{zref-check}| % \end{syntax} % +% The package does not accept load-time options, package options must be set +% using \cs{zrefchecksetup} (see Section~\ref{sec:user-interface}). % % % \section{Dependencies} @@ -469,7 +471,11 @@ % A change log with relevant changes for each version, eventual upgrade % instructions, and upcoming changes, is maintained in the package's % repository, at -% \url{https://github.com/gusbrs/zref-check/blob/main/CHANGELOG.md}. +% \url{https://github.com/gusbrs/zref-check/blob/main/CHANGELOG.md}. The +% change log is also distributed with the package's documentation through CTAN +% upon release so, most likely, \texttt{texdoc zref-check/changelog} should +% provide easy local access to it. An archive of historical versions of the +% package is also kept at \url{https://github.com/gusbrs/zref-check/releases}. % % % @@ -510,7 +516,7 @@ % % Identify the package. % \begin{macrocode} -\ProvidesExplPackage {zref-check} {2022-02-11} {0.2.5} +\ProvidesExplPackage {zref-check} {2022-04-22} {0.3.0} {Flexible cross-references with contextual checks based on zref} % \end{macrocode} % @@ -660,6 +666,11 @@ } \msg_new:nnn { zref-check } { option-deprecated } { Option~'#1'~has~been~deprecated~\msg_line_context:. } +\msg_new:nnn { zref-check } { load-time-options } + { + 'zref-check'~does~not~accept~load-time~options.~ + To~configure~package~options,~use~'\iow_char:N\\zrefchecksetup'. + } % \end{macrocode} % % @@ -918,11 +929,17 @@ % % \subsubsection*{Package options} % -% Process load-time package options -% (\url{https://tex.stackexchange.com/a/15840}). -% \begin{macrocode} -\RequirePackage { l3keys2e } -\ProcessKeysOptions { zref-check } +% \pkg{zref-check} does not accept load-time options. Despite the tradition +% of so doing, Joseph Wright has a point in recommending otherwise at +% \url{https://chat.stackexchange.com/transcript/message/60360822#60360822}: +% separating ``loading the package'' from ``configuring the package'' grants +% less trouble with ``option clashes'' and with expansion of options at +% load-time. +% \begin{macrocode} +\bool_lazy_and:nnT + { \tl_if_exist_p:c { opt@ zref-check.sty } } + { ! \tl_if_empty_p:c { opt@ zref-check.sty } } + { \msg_warning:nn { zref-check } { load-time-options } } % \end{macrocode} % % diff --git a/Master/texmf-dist/source/latex/zref-check/zref-check.ins b/Master/texmf-dist/source/latex/zref-check/zref-check.ins index 312a34c124a..fe58b39e694 100644 --- a/Master/texmf-dist/source/latex/zref-check/zref-check.ins +++ b/Master/texmf-dist/source/latex/zref-check/zref-check.ins @@ -24,7 +24,7 @@ % zref-check.ins, % zref-check.tex, % zref-check-code.tex, -% and the files listed in MANIFEST.md. +% and the files generated from them. % % The released version of this package is available from CTAN. % @@ -70,7 +70,7 @@ This work consists of the files zref-check.dtx, zref-check.ins, zref-check.tex, zref-check-code.tex, - and the files listed in MANIFEST.md. + and the files generated from them. The released version of this package is available from CTAN. diff --git a/Master/texmf-dist/tex/latex/zref-check/zref-check.sty b/Master/texmf-dist/tex/latex/zref-check/zref-check.sty index 58ae260ae2c..e4e709313f9 100644 --- a/Master/texmf-dist/tex/latex/zref-check/zref-check.sty +++ b/Master/texmf-dist/tex/latex/zref-check/zref-check.sty @@ -28,7 +28,7 @@ %% zref-check.ins, %% zref-check.tex, %% zref-check-code.tex, -%% and the files listed in MANIFEST.md. +%% and the files generated from them. %% %% The released version of this package is available from CTAN. %% @@ -53,7 +53,7 @@ }% \endinput }% -\ProvidesExplPackage {zref-check} {2022-02-11} {0.2.5} +\ProvidesExplPackage {zref-check} {2022-04-22} {0.3.0} {Flexible cross-references with contextual checks based on zref} \RequirePackage { zref-user } \RequirePackage { zref-abspage } @@ -141,6 +141,11 @@ } \msg_new:nnn { zref-check } { option-deprecated } { Option~'#1'~has~been~deprecated~\msg_line_context:. } +\msg_new:nnn { zref-check } { load-time-options } + { + 'zref-check'~does~not~accept~load-time~options.~ + To~configure~package~options,~use~'\iow_char:N\\zrefchecksetup'. + } \cs_new_eq:NN \__zrefcheck_int_to_roman:w \__int_to_roman:w \prg_new_conditional:Npnn \__zrefcheck_is_integer:n #1 { p, T , F , TF } { @@ -307,8 +312,10 @@ { labelcmd } } , } -\RequirePackage { l3keys2e } -\ProcessKeysOptions { zref-check } +\bool_lazy_and:nnT + { \tl_if_exist_p:c { opt@ zref-check.sty } } + { ! \tl_if_empty_p:c { opt@ zref-check.sty } } + { \msg_warning:nn { zref-check } { load-time-options } } \NewDocumentCommand \zrefchecksetup { m } { \keys_set:nn { zref-check } {#1} } \prop_new:N \g__zrefcheck_auxfile_lblseq_prop -- cgit v1.2.3