summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/zref-check
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2021-08-05 20:47:40 +0000
committerKarl Berry <karl@freefriends.org>2021-08-05 20:47:40 +0000
commiteda08b76ad9d0ad91675a9e563c8c478df9af77a (patch)
treee86e02f996fe19e803fbb484b029dfc53cbb7912 /Master/texmf-dist/doc/latex/zref-check
parentd728f6878800a22105df3da9d37de7d1cc0f0bcb (diff)
zref-check (5aug21)
git-svn-id: svn://tug.org/texlive/trunk@60171 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/zref-check')
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md8
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/DEPENDS.txt3
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/README.md17
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/zref-check-code.pdfbin0 -> 702150 bytes
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/zref-check-code.tex87
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/zref-check.pdfbin0 -> 454988 bytes
-rw-r--r--Master/texmf-dist/doc/latex/zref-check/zref-check.tex89
7 files changed, 204 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md b/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md
new file mode 100644
index 00000000000..debf07cafcb
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/CHANGELOG.md
@@ -0,0 +1,8 @@
+# Changelog
+
+## [Unreleased](https://github.com/gusbrs/zref-check/compare/v0.1.0...HEAD)
+
+## [v0.1.0](https://github.com/gusbrs/zref-check/releases/tag/v0.1.0) (2021-08-04)
+
+### Added
+- Initial release.
diff --git a/Master/texmf-dist/doc/latex/zref-check/DEPENDS.txt b/Master/texmf-dist/doc/latex/zref-check/DEPENDS.txt
new file mode 100644
index 00000000000..bd9b1e21c48
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/DEPENDS.txt
@@ -0,0 +1,3 @@
+hard zref
+hard oberdiek
+soft hyperref
diff --git a/Master/texmf-dist/doc/latex/zref-check/README.md b/Master/texmf-dist/doc/latex/zref-check/README.md
new file mode 100644
index 00000000000..c5726af278e
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/README.md
@@ -0,0 +1,17 @@
+# zref-check
+
+**Flexible LaTeX cross-references with contextual checks based on zref**
+
+`zref-check` provides an user interface for making LaTeX cross-references
+flexibly, while allowing to have them checked for consistency with the
+document structure as typeset. Statements such as “above”, “on the next
+page”, “previously”, “as will be discussed”, “on the previous chapter” and so
+on can be given to `\zcheck` in free-form, and a set of “checks” can be
+specified to be run against a given `label`, which will result in a warning at
+compilation time if any of these checks fail. `\zctarget` and the `zcregion`
+environment are also defined as a means to easily set label targets to
+arbitrary places in the text which can be referred to by `\zcheck`.
+
+The released version of this package is available from CTAN.
+
+For more details, check the Documentation.
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
new file mode 100644
index 00000000000..52682fbc5e5
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/zref-check-code.pdf
Binary files 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
new file mode 100644
index 00000000000..d9ee1c58d0a
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/zref-check-code.tex
@@ -0,0 +1,87 @@
+% \iffalse meta-comment
+%
+% File: zref-check-code.tex
+%
+% This file is part of the LaTeX package "zref-check".
+%
+% Copyright (C) 2021 Gustavo Barros
+%
+% It may be distributed and/or modified under the conditions of the
+% LaTeX Project Public License (LPPL), either version 1.3c of this
+% license or (at your option) any later version. The latest version
+% of this license is in the file:
+%
+% https://www.latex-project.org/lppl.txt
+%
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+%
+% This work is "maintained" (as per LPPL maintenance status) by
+% Gustavo Barros.
+%
+% This work consists of the files zref-check.dtx,
+% zref-check.ins,
+% zref-check.tex,
+% zref-check-code.tex,
+% and the derived files zref-check.sty and
+% zref-check.pdf,
+% zref-check-code.pdf.
+%
+% The released version of this package is available from CTAN.
+%
+% -----------------------------------------------------------------------
+%
+% The development version of the package can be found at
+%
+% https://github.com/gusbrs/zref-check
+%
+% for those people who are interested.
+%
+% -----------------------------------------------------------------------
+%
+% \fi
+
+\documentclass{l3doc}
+
+% Have \GetFileInfo pick up date and version data
+\usepackage{zref-check}
+
+\NewDocumentCommand\opt{m}{\texttt{#1}}
+
+% Have the Index at 'section' level rather than 'part'. Otherwise it is just
+% the same definition from 'l3doc.cls'.
+\IndexPrologue{%
+ \section*{Index}
+ \markboth{Index}{Index}
+ \addcontentsline{toc}{section}{Index}
+ The italic numbers denote the pages where the corresponding entry is
+ described, numbers underlined point to the definition, all others indicate
+ the places where it is used.%
+}
+
+\begin{document}
+
+\GetFileInfo{zref-check.sty}
+
+\title{%
+ The \pkg{zref-check} package implementation%
+ \thanks{This file describes \fileversion, last revised \filedate.}%
+}
+
+\author{%
+ Gustavo Barros%
+ \thanks{\url{https://github.com/gusbrs/zref-check}}%
+}
+
+\date{\filedate}
+
+\maketitle
+
+\tableofcontents
+
+\DisableDocumentation
+
+\DocInput{zref-check.dtx}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf b/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf
new file mode 100644
index 00000000000..ffdf3330371
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/zref-check.pdf
Binary files 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
new file mode 100644
index 00000000000..0edf9557f85
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/zref-check/zref-check.tex
@@ -0,0 +1,89 @@
+% \iffalse meta-comment
+%
+% File: zref-check.tex
+%
+% This file is part of the LaTeX package "zref-check".
+%
+% Copyright (C) 2021 Gustavo Barros
+%
+% It may be distributed and/or modified under the conditions of the
+% LaTeX Project Public License (LPPL), either version 1.3c of this
+% license or (at your option) any later version. The latest version
+% of this license is in the file:
+%
+% https://www.latex-project.org/lppl.txt
+%
+% and version 1.3 or later is part of all distributions of LaTeX
+% version 2005/12/01 or later.
+%
+%
+% This work is "maintained" (as per LPPL maintenance status) by
+% Gustavo Barros.
+%
+% This work consists of the files zref-check.dtx,
+% zref-check.ins,
+% zref-check.tex,
+% zref-check-code.tex,
+% and the derived files zref-check.sty and
+% zref-check.pdf,
+% zref-check-code.pdf.
+%
+% The released version of this package is available from CTAN.
+%
+% -----------------------------------------------------------------------
+%
+% The development version of the package can be found at
+%
+% https://github.com/gusbrs/zref-check
+%
+% for those people who are interested.
+%
+% -----------------------------------------------------------------------
+%
+% \fi
+
+\documentclass{l3doc}
+
+% Have \GetFileInfo pick up date and version data
+\usepackage{zref-check}
+
+\NewDocumentCommand\opt{m}{\texttt{#1}}
+
+\begin{document}
+
+\GetFileInfo{zref-check.sty}
+
+\title{%
+ The \pkg{zref-check} package%
+ \thanks{This file describes \fileversion, last revised \filedate.}%
+}
+
+\author{%
+ Gustavo Barros%
+ \thanks{\url{https://github.com/gusbrs/zref-check}}%
+}
+
+\date{\filedate}
+
+\maketitle
+
+\begin{abstract}
+ \pkg{zref-check} provides an user interface for making \LaTeX{}
+ cross-references flexibly, while allowing to have them checked for
+ consistency with the document structure as typeset. Statements such as
+ ``above'', ``on the next page'', ``previously'', ``as will be discussed'',
+ ``on the previous chapter'' and so on can be given to \cs{zcheck} in
+ free-form, and a set of ``checks'' can be specified to be run against a
+ given \texttt{label}, which will result in a warning at compilation time if
+ any of these checks fail. \cs{zctarget} and the \texttt{zcregion}
+ environment are also defined as a means to easily set label targets to
+ arbitrary places in the text which can be referred to by \cs{zcheck}.
+\end{abstract}
+
+\tableofcontents
+
+\DisableImplementation
+
+\DocInput{zref-check.dtx}
+
+\end{document}