summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/zref-check/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/zref-check/README.md')
-rw-r--r--macros/latex/contrib/zref-check/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/macros/latex/contrib/zref-check/README.md b/macros/latex/contrib/zref-check/README.md
new file mode 100644
index 0000000000..c5726af278
--- /dev/null
+++ b/macros/latex/contrib/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.