summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/spelling/README
blob: a5f2ee415838ca5de0ee1d105dd6762ffeb159aa (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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
This material is subject to the LaTeX Project Public License. See
<http://www.latex-project.org/lppl/> for the details of that license.



### Package information

Package name: spelling  
Summary description: support for spell-checking of LuaTeX documents  
Version: v0.41  
Date: 2013-05-25  
License: [LPPL v1.3c](http://www.latex-project.org/lppl/lppl-1-3c.html)  
Maintenance status: maintained  
Current maintainer: Stephan Hennig, <sh2d@arcor.de>  



### Description

This package supports spell-checking of TeX documents compiled with the
LuaTeX engine.  It can give visual feedback in PDF output similar to
WYSIWYG word processors.  The package relies on an external
spell-checker application that can check a plain text file and output a
list of bad spellings.  The package should work with most
spell-checkers, even dumb, TeX-unaware ones.



### Development

The development repository is currently hosted at
[GitHub](https://github.com/sh2d/spelling/).  Code documentation is in
[LuaDoc](http://keplerproject.github.com/luadoc/) format and can be
generated via

    luadoc -d API *.lua

Bugs and a wish list can be found in the
[issue tracker](https://github.com/sh2d/spelling/issues/).  Patches
welcome!


_Happy TeXing!_



### File list

    CHANGES
    LICENSE
    README
    spelling.sty
    spelling-doc.bad
    spelling-doc.tex
    spelling-doc-lst-lua.tex
    spelling-main.lua
    spelling-recurse.lua
    spelling-stage-1.lua
    spelling-stage-2.lua
    spelling-stage-3.lua
    spelling-stage-4.lua



<!--
%%% Local Variables: 
%%% coding: utf-8
%%% mode: markdown
%%% End: 
-->