Tidied up the gem requirements and fixed the use of Bundler
[porter2stemmer.git] / rdoc / Porter2.html
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5 <head>
6 <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
7
8 <title>Module: Porter2</title>
9
10 <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
11
12 <script src="./js/jquery.js" type="text/javascript"
13 charset="utf-8"></script>
14 <script src="./js/thickbox-compressed.js" type="text/javascript"
15 charset="utf-8"></script>
16 <script src="./js/quicksearch.js" type="text/javascript"
17 charset="utf-8"></script>
18 <script src="./js/darkfish.js" type="text/javascript"
19 charset="utf-8"></script>
20
21 </head>
22 <body class="module">
23
24 <div id="metadata">
25 <div id="home-metadata">
26 <div id="home-section" class="section">
27 <h3 class="section-header">
28 <a href="./index.html">Home</a>
29 <a href="./index.html#classes">Classes</a>
30 <a href="./index.html#methods">Methods</a>
31 </h3>
32 </div>
33 </div>
34
35 <div id="file-metadata">
36 <div id="file-list-section" class="section">
37 <h3 class="section-header">In Files</h3>
38 <div class="section-body">
39 <ul>
40
41 <li><a href="./lib/porter2stemmer/constants_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
42 class="thickbox" title="lib/porter2stemmer/constants.rb">lib/porter2stemmer/constants.rb</a></li>
43
44 </ul>
45 </div>
46 </div>
47
48
49 </div>
50
51 <div id="class-metadata">
52
53 <!-- Parent Class -->
54
55
56 <!-- Namespace Contents -->
57
58
59 <!-- Method Quickref -->
60
61
62 <!-- Included Modules -->
63
64 </div>
65
66 <div id="project-metadata">
67
68
69 <div id="fileindex-section" class="section project-section">
70 <h3 class="section-header">Files</h3>
71 <ul>
72
73 <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
74
75 </ul>
76 </div>
77
78
79 <div id="classindex-section" class="section project-section">
80 <h3 class="section-header">Class Index
81 <span class="search-toggle"><img src="./images/find.png"
82 height="16" width="16" alt="[+]"
83 title="show/hide quicksearch" /></span></h3>
84 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
85 <fieldset>
86 <legend>Quicksearch</legend>
87 <input type="text" name="quicksearch" value=""
88 class="quicksearch-field" />
89 </fieldset>
90 </form>
91
92 <ul class="link-list">
93
94 <li><a href="./Porter2.html">Porter2</a></li>
95
96 <li><a href="./String.html">String</a></li>
97
98 </ul>
99 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
100 </div>
101
102
103 </div>
104 </div>
105
106 <div id="documentation">
107 <h1 class="module">Porter2</h1>
108
109 <div id="description">
110 <p>
111 Constants for the Porter 2 stemmer
112 </p>
113
114 </div>
115
116 <!-- Constants -->
117
118 <div id="constants-list" class="section">
119 <h3 class="section-header">Constants</h3>
120 <dl>
121
122 <dt><a name="C">C</a></dt>
123
124 <dd class="description"><p>
125 A non-vowel
126 </p></dd>
127
128
129 <dt><a name="V">V</a></dt>
130
131 <dd class="description"><p>
132 A vowel: a e i o u y
133 </p></dd>
134
135
136 <dt><a name="CW">CW</a></dt>
137
138 <dd class="description"><p>
139 A non-vowel other than w, x, or Y
140 </p></dd>
141
142
143 <dt><a name="Double">Double</a></dt>
144
145 <dd class="description"><p>
146 Doubles created when adding a suffix: these are undoubled when stemmed
147 </p></dd>
148
149
150 <dt><a name="Valid_LI">Valid_LI</a></dt>
151
152 <dd class="description"><p>
153 A valid letter that can come before &#8216;li&#8217; (or &#8216;ly&#8217;)
154 </p></dd>
155
156
157 <dt><a name="SHORT_SYLLABLE">SHORT_SYLLABLE</a></dt>
158
159 <dd class="description"><p>
160 A specification for a short syllable.
161 </p>
162 <p>
163 A short syllable in a word is either:
164 </p>
165 <ol>
166 <li><p>
167 a vowel followed by a non-vowel other than w, x or Y and preceded by a
168 non-vowel, or
169 </p>
170 </li>
171 <li><p>
172 a vowel at the beginning of the word followed by a non-vowel.
173 </p>
174 </li>
175 </ol>
176 <p>
177 (The original document is silent on whether sequences of two or more
178 non-vowels make a syllable long. But as this specification is only used to
179 find sequences of non-vowel - vowel - non-vowel - end-of-word, this
180 ambiguity does not have an effect.)
181 </p></dd>
182
183
184 <dt><a name="STEP_2_MAPS">STEP_2_MAPS</a></dt>
185
186 <dd class="description"><p>
187 Suffix transformations used in porter2_step2. (ogi, li endings dealt with
188 in procedure)
189 </p></dd>
190
191
192 <dt><a name="STEP_3_MAPS">STEP_3_MAPS</a></dt>
193
194 <dd class="description"><p>
195 Suffix transformations used in porter2_step3. (ative ending dealt with in
196 procedure)
197 </p></dd>
198
199
200 <dt><a name="STEP_4_MAPS">STEP_4_MAPS</a></dt>
201
202 <dd class="description"><p>
203 Suffix transformations used in porter2_step4. (ion ending dealt with in
204 procedure)
205 </p></dd>
206
207
208 <dt><a name="SPECIAL_CASES">SPECIAL_CASES</a></dt>
209
210 <dd class="description"><p>
211 Special-case stemmings
212 </p></dd>
213
214
215 <dt><a name="STEP_1A_SPECIAL_CASES">STEP_1A_SPECIAL_CASES</a></dt>
216
217 <dd class="description"><p>
218 Special case words to stop processing after step 1a.
219 </p></dd>
220
221
222 </dl>
223 </div>
224
225
226 <!-- Attributes -->
227
228
229 <!-- Methods -->
230
231
232 </div>
233
234
235 <div id="rdoc-debugging-section-dump" class="debugging-section">
236
237 <p>Disabled; run with --debug to generate this.</p>
238
239 </div>
240
241 <div id="validator-badges">
242 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
243 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
244 Rdoc Generator</a> 1.1.6</small>.</p>
245 </div>
246
247 </body>
248 </html>
249