diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/luatex/latex/lua-check-hyphen/doc/README.md |
Initial commit
Diffstat (limited to 'macros/luatex/latex/lua-check-hyphen/doc/README.md')
-rw-r--r-- | macros/luatex/latex/lua-check-hyphen/doc/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/macros/luatex/latex/lua-check-hyphen/doc/README.md b/macros/luatex/latex/lua-check-hyphen/doc/README.md new file mode 100644 index 0000000000..24384114ef --- /dev/null +++ b/macros/luatex/latex/lua-check-hyphen/doc/README.md @@ -0,0 +1,27 @@ +# lua-check-hyphen + +## Usage + + \usepackage{lua-check-hyphen} + ... + \LuaCheckHyphen{mark,whitelist={filea.txt,fileb.txt}} + +## What it does + +It lists all hyphenated words in the log file as well as in the file with the extension `.uhy` + +## How to use + +A typical workflow is: + +* run final document +* put the correctly hyphenated words into a text file (format: each word separated with space or on a single line, only whitespace matters as a separator) +* add that file to the whitelist (as given above) +* optionally use the option `mark` to make the unknown hyphenated words visible in the PDF file + + +Copyright 2012–2018 Patrick Gundlach (patrick@gundla.ch) and other contributors (see github)<br> +Package version: 0.7a +Public repository: https://github.com/pgundlach/lua-check-hyphen<br> +Licensed under the MIT license. See the file 'mit-license.txt' for exact terms.<br> +Status: works fine, slightly unmaintained.<br> |