diff options
Diffstat (limited to 'macros/latex/contrib/cleveref-forward/README.md')
-rw-r--r-- | macros/latex/contrib/cleveref-forward/README.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/macros/latex/contrib/cleveref-forward/README.md b/macros/latex/contrib/cleveref-forward/README.md index 4a67b0cdd3..aab25e04a5 100644 --- a/macros/latex/contrib/cleveref-forward/README.md +++ b/macros/latex/contrib/cleveref-forward/README.md @@ -2,24 +2,26 @@ # `cleveref-forward` — Forward-referencing functionality for cleveref -`cleveref-forward` aims at providing the forward-referencing functionality to `cleveref`. +`cleveref-forward` aims at providing the forward-referencing functionality for the package `cleveref`. -This package is derived from the package [`cleveref-usedon`](https://ctan.org/pkg/cleveref-usedon), with several fixes and enhancements. +> This package is derived from the package [`cleveref-usedon`](https://ctan.org/pkg/cleveref-usedon), with several fixes and enhancements. + +> Package dependencies: [`cleveref`](https://ctan.org/pkg/cleveref), [*`crefthe`*](https://ctan.org/pkg/crefthe), [`iflang`](https://ctan.org/pkg/iflang), [`regexpatch`](https://ctan.org/pkg/regexpatch). ## Regarding the usage It might be a good idea to start with the [demo documents](https://github.com/Jinwen-XU/cleveref-forward/tree/main/demo). -> The documentation and examples written by Sven Pistre for the original package [`cleveref-usedon`](https://ctan.org/pkg/cleveref-usedon) are also very inspiring (but be aware that the usage has changed a lot, so some of the code there may no longer work here). +> The [documentation](http://mirrors.ctan.org/macros/latex/contrib/cleveref-usedon/cleveref-usedon.pdf) and [examples](https://github.com/SvenPistre/cleveref-usedon/tree/main/examples) written by Sven Pistre for the original package `cleveref-usedon` are also very inspiring (but be aware that the usage has changed a lot, so some of the code there may no longer work here). ## Known issues / what to do next -- The multilingual support is not yet perfect. -- The code is somewhat messy for now, and the naming of many macros should be made better. -- The support for displayed maths is still not perfect. -- Not all configuration yields nice result, more examples are needed. +- This package currently works for English, French, German, Italian and Spanish — certainly more languages would be added to this list in the future. +- The code is somewhat messy for now, and the naming of many macros could be improved. +- The support for displayed maths is still not perfect: currently, if you choose to print the forward-referencing message outside the math environment, then for `equation`, `multline` and `dmath`, it works nicely (you may need to configure `cleveref` to make it work with `dmath`); but for `align`, `flalign`, `alignat` and `gather`, it would only show the message for the last labeled line. The inside-math mode has no such limitation, but it would require sufficient margin width. +- Not all configuration yields nice result, more appealing examples are needed. -The original package [`cleveref-usedon`](https://ctan.org/pkg/cleveref-usedon) is better in terms of documentation, while the current package is slightly more advanced in terms of code. It is hoped that one day they can be combined into a better version. +The original package [`cleveref-usedon`](https://ctan.org/pkg/cleveref-usedon) is nicer in terms of documentation, while the current package is slightly more advanced in terms of code. It is hoped that one day they can be combined into a better version. ## Acknowledgement |