doc/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/porter2_constants_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  42                                                         class="thickbox" title="lib/porter2_constants.rb">lib/porter2_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                                         <li><a href="./TestPorter2.html">TestPorter2</a></li>
  99
 100                                 </ul>
 101                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 102                         </div>
 103
 104
 105                 </div>
 106         </div>
 107
 108         <div id="documentation">
 109                 <h1 class="module">Porter2</h1>
 110
 111                 <div id="description">
 112                         <p>
 113 Constants for the Porter 2 stemmer
 114 </p>
 115
 116                 </div>
 117
 118                 <!-- Constants -->
 119
 120                 <div id="constants-list" class="section">
 121                         <h3 class="section-header">Constants</h3>
 122                         <dl>
 123
 124                                 <dt><a name="C">C</a></dt>
 125
 126                                 <dd class="description"><p>
 127 A non-vowel
 128 </p></dd>
 129
 130
 131                                 <dt><a name="V">V</a></dt>
 132
 133                                 <dd class="description"><p>
 134 A vowel: a e i o u y
 135 </p></dd>
 136
 137
 138                                 <dt><a name="CW">CW</a></dt>
 139
 140                                 <dd class="description"><p>
 141 A non-vowel other than w, x, or Y
 142 </p></dd>
 143
 144
 145                                 <dt><a name="Double">Double</a></dt>
 146
 147                                 <dd class="description"><p>
 148 Doubles created when adding a suffix: these are undoubled when stemmed
 149 </p></dd>
 150
 151
 152                                 <dt><a name="Valid_LI">Valid_LI</a></dt>
 153
 154                                 <dd class="description"><p>
 155 A valid letter that can come before &#8216;li&#8217; (or &#8216;ly&#8217;)
 156 </p></dd>
 157
 158
 159                                 <dt><a name="SHORT_SYLLABLE">SHORT_SYLLABLE</a></dt>
 160
 161                                 <dd class="description"><p>
 162 A specification for a short syllable.
 163 </p>
 164 <p>
 165 A short syllable in a word is either:
 166 </p>
 167 <ol>
 168 <li><p>
 169 a vowel followed by a non-vowel other than w, x or Y and preceded by a
 170 non-vowel, or
 171 </p>
 172 </li>
 173 <li><p>
 174 a vowel at the beginning of the word followed by a non-vowel.
 175 </p>
 176 </li>
 177 </ol>
 178 <p>
 179 (The original document is silent on whether sequences of two or more
 180 non-vowels make a
 syllable long. But as this specification is only used to
 181 find sequences of non-vowel -
 vowel - non-vowel - end-of-word, this
 182 ambiguity does not have an effect.)
 183 </p></dd>
 184
 185
 186                                 <dt><a name="STEP_2_MAPS">STEP_2_MAPS</a></dt>
 187
 188                                 <dd class="description"><p>
 189 Suffix transformations used in porter2_step2.
 (ogi, li endings dealt with
 190 in procedure)
 191 </p></dd>
 192
 193
 194                                 <dt><a name="STEP_3_MAPS">STEP_3_MAPS</a></dt>
 195
 196                                 <dd class="description"><p>
 197 Suffix transformations used in porter2_step3.
 (ative ending dealt with in
 198 procedure)
 199 </p></dd>
 200
 201
 202                                 <dt><a name="STEP_4_MAPS">STEP_4_MAPS</a></dt>
 203
 204                                 <dd class="description"><p>
 205 Suffix transformations used in porter2_step4.
 (ion ending dealt with in
 206 procedure)
 207 </p></dd>
 208
 209
 210                                 <dt><a name="SPECIAL_CASES">SPECIAL_CASES</a></dt>
 211
 212                                 <dd class="description"><p>
 213 Special-case stemmings
 214 </p></dd>
 215
 216
 217                                 <dt><a name="STEP_1A_SPECIAL_CASES">STEP_1A_SPECIAL_CASES</a></dt>
 218
 219                                 <dd class="description"><p>
 220 Special case words to stop processing after step 1a.
 221 </p></dd>
 222
 223
 224                         </dl>
 225                 </div>
 226
 227
 228                 <!-- Attributes -->
 229
 230
 231                 <!-- Methods -->
 232
 233
 234         </div>
 235
 236
 237         <div id="rdoc-debugging-section-dump" class="debugging-section">
 238
 239                 <p>Disabled; run with --debug to generate this.</p>
 240
 241         </div>
 242
 243         <div id="validator-badges">
 244                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 245                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 246                         Rdoc Generator</a> 1.1.6</small>.</p>
 247         </div>
 248
 249 </body>
 250 </html>
 251