summaryrefslogtreecommitdiff
path: root/macros/luatex/latex/lua-check-hyphen/doc/README.md
blob: 24384114ef1ed9720b01336bb0e82c9ac7aded3c (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
# 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>