summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex/lua-check-hyphen/doc/README.md
blob: 20d8244dc83120c5c9bd19936ae26a5db9cde86c (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
# 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.