summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/zref-vario
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-02-08 21:52:17 +0000
committerKarl Berry <karl@freefriends.org>2022-02-08 21:52:17 +0000
commit52f867b578332875678567cd90f15d2a9e9420b7 (patch)
tree6445cb17b9a37ecc4d4a9b008e8393c4f84ba727 /Master/texmf-dist/doc/latex/zref-vario
parent35e83165817085cc1bdbbf9d5b7ba8e05a1bb8da (diff)
zref-vario (8feb22)
git-svn-id: svn://tug.org/texlive/trunk@61951 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/zref-vario')
-rw-r--r--Master/texmf-dist/doc/latex/zref-vario/CHANGELOG.md7
-rw-r--r--Master/texmf-dist/doc/latex/zref-vario/MANIFEST.md2
-rw-r--r--Master/texmf-dist/doc/latex/zref-vario/zref-vario-code.pdfbin538943 -> 569775 bytes
-rw-r--r--Master/texmf-dist/doc/latex/zref-vario/zref-vario.pdfbin121131 -> 144096 bytes
-rw-r--r--Master/texmf-dist/doc/latex/zref-vario/zref-vario.tex31
5 files changed, 38 insertions, 2 deletions
diff --git a/Master/texmf-dist/doc/latex/zref-vario/CHANGELOG.md b/Master/texmf-dist/doc/latex/zref-vario/CHANGELOG.md
index 968785ecbf9..256cf2d24ab 100644
--- a/Master/texmf-dist/doc/latex/zref-vario/CHANGELOG.md
+++ b/Master/texmf-dist/doc/latex/zref-vario/CHANGELOG.md
@@ -1,6 +1,11 @@
# Changelog
-## [Unreleased](https://github.com/gusbrs/zref-vario/compare/v0.1.1-alpha...HEAD)
+## [Unreleased](https://github.com/gusbrs/zref-vario/compare/v0.1.2-alpha...HEAD)
+
+## [v0.1.2-alpha](https://github.com/gusbrs/zref-vario/compare/v0.1.1-alpha...v0.1.2-alpha) (2022-02-08)
+
+### Added
+- Integration with `zref-check` and new corresponding option `vcheck`.
## [v0.1.1-alpha](https://github.com/gusbrs/zref-vario/compare/v0.1.0-alpha...v0.1.1-alpha) (2022-02-01)
diff --git a/Master/texmf-dist/doc/latex/zref-vario/MANIFEST.md b/Master/texmf-dist/doc/latex/zref-vario/MANIFEST.md
index 050277efd7b..f615ce334ee 100644
--- a/Master/texmf-dist/doc/latex/zref-vario/MANIFEST.md
+++ b/Master/texmf-dist/doc/latex/zref-vario/MANIFEST.md
@@ -64,6 +64,7 @@ different engines (pdfTeX, XeTeX, LuaTeX, etc.).
* zv-basic04.lvt
* zv-hyperref01.lvt
* zv-languages01.lvt
+* zv-vcheck01.lvt
* zv-zcref-options01.lvt
* zv-basic01.luatex.tlg
* zv-basic01.luatexdev.tlg
@@ -91,6 +92,7 @@ different engines (pdfTeX, XeTeX, LuaTeX, etc.).
* zv-hyperref01.xetex.tlg
* zv-hyperref01.xetexdev.tlg
* zv-languages01.tlg
+* zv-vcheck01.tlg
* zv-zcref-options01.luatex.tlg
* zv-zcref-options01.luatexdev.tlg
* zv-zcref-options01.tlg
diff --git a/Master/texmf-dist/doc/latex/zref-vario/zref-vario-code.pdf b/Master/texmf-dist/doc/latex/zref-vario/zref-vario-code.pdf
index 88f16366360..64dcae01659 100644
--- a/Master/texmf-dist/doc/latex/zref-vario/zref-vario-code.pdf
+++ b/Master/texmf-dist/doc/latex/zref-vario/zref-vario-code.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/zref-vario/zref-vario.pdf b/Master/texmf-dist/doc/latex/zref-vario/zref-vario.pdf
index 8a37e41a8d2..df3d54ed309 100644
--- a/Master/texmf-dist/doc/latex/zref-vario/zref-vario.pdf
+++ b/Master/texmf-dist/doc/latex/zref-vario/zref-vario.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/zref-vario/zref-vario.tex b/Master/texmf-dist/doc/latex/zref-vario/zref-vario.tex
index 7801d52f5d6..a4ef3708376 100644
--- a/Master/texmf-dist/doc/latex/zref-vario/zref-vario.tex
+++ b/Master/texmf-dist/doc/latex/zref-vario/zref-vario.tex
@@ -236,7 +236,7 @@ macros to the values given to the corresponding options in
support, you should set at least the whole set of ``\texttt{reftext}\dots{}''
options. Language independent default values are provided for the
``\dots{}\texttt{format}'' options (equivalent to the ones from
-\pkg{varioref}, which are adequate to most use cases), so you may omit them.
+\pkg{varioref}, which are adequate for most use cases), so you may omit them.
But, if you need to adjust them, the default values can be overridden by
setting the corresponding options in \cs{zvLanguageSetup}.
@@ -249,6 +249,35 @@ though they do affect \pkg{zref-vario}'s commands, just as they do with
\pkg{varioref}'s.
+\section{Integration with \pkg{zref-check}}
+
+When package \pkg{zref-check} is loaded, \pkg{zref-vario} provides one further
+option to its user commands: \opt{vcheck}. The purpose of this option is to
+check the relative position of label and reference within the same page. It
+can receive two values: \texttt{above} and \texttt{below}, being those the
+names of the \pkg{zref-check}'s checks which are meaningful for the use case
+at hand. Of course, these could also be performed with \cs{zcref}'s
+\opt{check} option, which is available for \pkg{zref-vario}'s commands as
+well. The difference here is that the check specified in \opt{vcheck} is only
+performed when the referenced label -- or labels, in the case of a range --
+fall on the same page as the reference itself.\footnote{There's another
+ technical difference between them. \pkg{zref-check}'s checks, and hence
+ those of the \opt{check} option, make sure the whole reference passes each
+ check by setting labels both at the start and the end of the reference, and
+ verifying if each one of them passes the checks. But, since \pkg{varioref}
+ already has it's own mechanism to handle references which cross page
+ boundaries, \opt{vcheck}'s checks set only one label, at the end of the
+ reference, the same position \pkg{varioref} uses to check whether label and
+ reference are on the same page.} In other words, when \opt{vcurrent} would
+be used (if provided). For this reason, only the commands which support
+\opt{vcurrent} offer \pkg{vcheck}. Also, \opt{vcheck} cannot receive
+\pkg{zref-check}'s options, as \opt{check} is able to, but the latter can be
+used for the purpose of locally controlling the behavior of the checks
+performed by \opt{vcheck}. Consult \pkg{zref-check}'s documentation for
+details and limitations of these checks and envisaged workflows for their
+reliable use.
+
+
% \section{Acknowledgments}
%
% A number of people have contributed to \pkg{zref-vario}. Suggestions,