summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/zref-check/CHANGELOG.md
blob: f812c8b76cde3737b8cddd4b4a3981045b08d49f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# Changelog

## [Unreleased](https://github.com/gusbrs/zref-check/compare/v0.3.2...HEAD)

## [v0.3.2](https://github.com/gusbrs/zref-check/compare/v0.3.1...v0.3.2) (2022-07-07)

### Fixed
- Recompiled documentation with workaround for upstream `l3doc` bug.

## [v0.3.1](https://github.com/gusbrs/zref-check/compare/v0.3.0...v0.3.1) (2022-07-05)

### Changed
- Adjust some warning messages to try to improve machine-readability, and thus
  editor parsing, of the log (see https://tex.stackexchange.com/q/649548).
- (Internal) Use standard counters to keep track of sections and chapters.

## [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)

### Changed
- (Internal) Option variables setting was reviewed, ensuring proper scope is
  in use and that they are always properly declared.  `expl3` debugging
  enabled in regression tests.

## [v0.2.4](https://github.com/gusbrs/zref-check/compare/v0.2.3...v0.2.4) (2022-02-08)

### Added
- New `otherpage` check.
- Infrastructure support provided for integration with `zref-vario`.

### Deprecated
- Option `labelcmd` has been deprecated with no replacement.  The originally
  intended use for this option has been made obsolete by package
  `zref-clever`.

## [v0.2.3](https://github.com/gusbrs/zref-check/compare/v0.2.2...v0.2.3) (2021-12-20)

### Fixed
- Use `main` property list for user facing labels in `\zctarget` and
  `zcregion` environment, so that references made to them with `zref-clever`
  contain all required properties.

## [v0.2.2](https://github.com/gusbrs/zref-check/compare/v0.2.1...v0.2.2) (2021-12-07)

### Changed
- Option values `msglevel=obeydraft`, `msglevel=obeyfinal`,
  `onpage=obeydraft`, and `onpage=obeyfinal` have been respectively renamed to
  `msglevel=infoifdraft`, `msglevel=warniffinal`, `onpage=labelseqifdraft`,
  and `onpage=msgiffinal`.  Previous values have been deprecated.
- Spare setting end label for `\zctarget` with empty text argument.

## [v0.2.1](https://github.com/gusbrs/zref-check/compare/v0.2.0...v0.2.1) (2021-09-16)

### Changed
- Use `\msg_line_context:` instead of `\msg_line_number:` for messages.
- Use more efficient way to set checks as option keys in `\zcheck`.
- Spare setting end label in `\zcheck` for checks which don't need it.
- Separate `zref` property lists for checks and targets, so that only the
  minimum set of required properties for each are used.

### Added
- New `pagegap` check.
- Provide infrastructure for integration with `zref-clever`.

## [v0.2.0](https://github.com/gusbrs/zref-check/compare/v0.1.0...v0.2.0) (2021-08-17)

### Changed
- The syntax of user command `\zcheck` has changed.  Previously, it received
  the `<checks>` as a second optional argument, now both `<checks>` and
  `<options>` can be passed together in the single optional argument to
  `\zcheck`.
- (Internal) Use new hook management system syntax for begindocument hooks.
- (Internal) Use prefix for internal zref properties.
- Small adjustments in User manual.

### Added
- CTAN upload automation with l3build.
- Regression tests for labels with `babel` active characters.
- Dedicated Readme for CTAN.

## [v0.1.0](https://github.com/gusbrs/zref-check/releases/tag/v0.1.0) (2021-08-04)

### Added
- Initial release.