-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathhunspell.html
163 lines (156 loc) · 5.5 KB
/
hunspell.html
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<title> hunspell - spell checking </title>
<script src="jquery.js"></script>
<script src="jquery-cookie.js"></script>
<script src="jquery-tablesorter.js"></script>
<script src="strftime.js"></script>
<script src="mustache.js"></script>
<script src="config.js"></script>
<script src="main.js"></script>
<link rel="stylesheet" type="text/css" href="templates/reset.css" />
<link rel="stylesheet" type="text/css" href="templates/hack.css" />
<link rel="stylesheet" type="text/css" id="lights_css" />
<script>
var DOCNAME = 'hunspell'
var PROJECT = 'hunspell'
//set the lights before rendering starts
set_lights()
</script>
</head>
<body>
<header>
<div class="container">
<div class="btn-container btn-lights-container">
<a href="#" class="btn btn-lights" id="lights">lights</a>
</div>
<div class="btn-container btn-home-container">
<a href="/" class="btn btn-home">luapower</a>
</div>
<table id="header_table">
<tr>
<td style="vertical-align: middle;" width="100%">
<h1> hunspell </h1>
<h2> spell checking </h2>
</td>
<td style="vertical-align: middle;" align="right" style="height: 150px">
<table><tr><td>
<div class="doc" id="package_info_container">
<div id="package_info"> </div>
<div id="commit_log"> </div>
</div>
<a href="https://github.com/luapower/hunspell" class="btn btn-rightside btn-github"><span class="icon"></span>View on GitHub</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/hunspell/tarball/master" class="btn btn-rightside">Download as .tar.gz</a>
</td></tr><tr><td>
<a href="https://github.com/luapower/hunspell/zipball/master" class="btn btn-rightside">Download as .zip</a>
</td></tr></table>
</td>
</tr>
</table>
<div class="btn-container btn-discuss-container">
<a href="https://github.com/luapower/hunspell/issues/new" target="_blank"
class="btn btn-rightside btn-discuss"><span class="icon"></span>Discuss</a>
</div>
</div>
</header>
<div class="bg-container">
<div class="bg-center-container">
<div class="bg bg-hunspell" style="background-image: url('bg/hunspell.png');"></div>
</div>
</div>
<div class="under-header">
<div class="container">
<div id="toc_container" class="toc_container doc"></div>
<button id=tab1_button class="tab_button hidden">Documentation</button>
<button id=tab2_button class="tab_button hidden">Package Info</button>
<div id="tabs_cointainer">
<div id="tab1_container">
<section class="doc">
<span id="module_info"></span>
<h2 id="local-hunspell-requirehunspell"><code>local hunspell = require'hunspell'</code></h2>
<p>A ffi binding of the popular spell checking library <a href="http://hunspell.sourceforge.net/">hunspell</a>.</p>
<table>
<tbody>
<tr class="odd">
<td align="left"><code>hunspell.new(aff_filepath, dic_filepath[, key]) -> h</code></td>
<td align="left">create a hunspell instance</td>
</tr>
<tr class="even">
<td align="left"><code>h:free()</code></td>
<td align="left">free the hunspell instance</td>
</tr>
<tr class="odd">
<td align="left"><code>h:spell(word) -> true[, 'warn'] | false</code></td>
<td align="left">spell-check a word (the 'warn' flag indicates a rare word, which often is a spelling mistake)</td>
</tr>
<tr class="even">
<td align="left"><code>h:suggest(word) -> words_t</code></td>
<td align="left">suggest correct words for a possibly bad word</td>
</tr>
<tr class="odd">
<td align="left"><strong>advanced use</strong></td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left"><code>h:analyze(word) -> words_t</code></td>
<td align="left">morphological analysis of a word</td>
</tr>
<tr class="odd">
<td align="left"><code>h:stem(word) -> words_t</code></td>
<td align="left">stems of a word</td>
</tr>
<tr class="even">
<td align="left"><code>h:generate(word, example) -> words_t</code></td>
<td align="left">generate word(s) by example</td>
</tr>
<tr class="odd">
<td align="left"><code>h:generate(word, desc_t) -> words_t</code></td>
<td align="left">generate word(s) by description (dictionary dependent)</td>
</tr>
<tr class="even">
<td align="left"><code>h:add_word(word)</code></td>
<td align="left">add a word to the dictionary (in memory)</td>
</tr>
<tr class="odd">
<td align="left"><code>h:remove_word(word)</code></td>
<td align="left">remove a word from the dictionary (in memory)</td>
</tr>
<tr class="even">
<td align="left"><code>h:get_dic_encoding() -> string</code></td>
<td align="left">return the current encoding (dictionary dependent)</td>
</tr>
<tr class="odd">
<td align="left"><strong>extras</strong> (available with the included <code>hunspell.dll</code>)</td>
<td align="left"></td>
</tr>
<tr class="even">
<td align="left"><code>h:add_dic(dic_filepath[, key])</code></td>
<td align="left">add a dictionary file to the hunspell instance</td>
</tr>
</tbody>
</table>
</section>
</div>
<div id="tab2_container" class="doc"></div>
</div>
</div>
<div class="container">
<footer>
<div id="disqus_thread"></div>
<div class="faint">cosmin.apreutesei@gmail.com | <a href="http://unlicense.org/">public domain</a></div>
</footer>
</div>
</div>
<script type="text/x-mustache" id=info_tab_template>
<h3>Modules</h3>
<ul>
{{#module_array}}
<li>{{name}}</li>
{{/module_array}}
</ul>
</script>
</body>
</html>