diff options
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md')
-rw-r--r-- | Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md new file mode 100644 index 00000000000..20d8244dc83 --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md @@ -0,0 +1,26 @@ +# 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 Patrick Gundlach (patrick@gundla.ch) +Package version: 0.1 +Public repository: https://github.com/pgundlach/lua-check-hyphen +Licensed under the MIT license. |