1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
2 |
<!DOCTYPE html |
3 |
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
4 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
5 |
|
6 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
7 |
<head> |
8 |
<title>Class: Estraier::Document</title> |
9 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
10 |
<meta http-equiv="Content-Script-Type" content="text/javascript" /> |
11 |
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" /> |
12 |
<script type="text/javascript"> |
13 |
// <![CDATA[ |
14 |
|
15 |
function popupCode( url ) { |
16 |
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") |
17 |
} |
18 |
|
19 |
function toggleCode( id ) { |
20 |
if ( document.getElementById ) |
21 |
elem = document.getElementById( id ); |
22 |
else if ( document.all ) |
23 |
elem = eval( "document.all." + id ); |
24 |
else |
25 |
return false; |
26 |
|
27 |
elemStyle = elem.style; |
28 |
|
29 |
if ( elemStyle.display != "block" ) { |
30 |
elemStyle.display = "block" |
31 |
} else { |
32 |
elemStyle.display = "none" |
33 |
} |
34 |
|
35 |
return true; |
36 |
} |
37 |
|
38 |
// Make codeblocks hidden by default |
39 |
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) |
40 |
|
41 |
// ]]> |
42 |
</script> |
43 |
|
44 |
</head> |
45 |
<body> |
46 |
|
47 |
|
48 |
|
49 |
<div id="classHeader"> |
50 |
<table class="header-table"> |
51 |
<tr class="top-aligned-row"> |
52 |
<td><strong>Class</strong></td> |
53 |
<td class="class-name-in-header">Estraier::Document</td> |
54 |
</tr> |
55 |
<tr class="top-aligned-row"> |
56 |
<td><strong>In:</strong></td> |
57 |
<td> |
58 |
<a href="../../files/estraier_rb.html"> |
59 |
estraier.rb |
60 |
</a> |
61 |
<br /> |
62 |
</td> |
63 |
</tr> |
64 |
|
65 |
<tr class="top-aligned-row"> |
66 |
<td><strong>Parent:</strong></td> |
67 |
<td> |
68 |
Object |
69 |
</td> |
70 |
</tr> |
71 |
</table> |
72 |
</div> |
73 |
<!-- banner header --> |
74 |
|
75 |
<div id="bodyContent"> |
76 |
|
77 |
|
78 |
|
79 |
<div id="contextContent"> |
80 |
|
81 |
<div id="description"> |
82 |
<p> |
83 |
Abstraction of document. |
84 |
</p> |
85 |
|
86 |
</div> |
87 |
|
88 |
|
89 |
</div> |
90 |
|
91 |
<div id="method-list"> |
92 |
<h3 class="section-bar">Methods</h3> |
93 |
|
94 |
<div class="name-list"> |
95 |
<a href="#M000043">add_attr</a> |
96 |
<a href="#M000045">add_hidden_text</a> |
97 |
<a href="#M000044">add_text</a> |
98 |
<a href="#M000048">attr</a> |
99 |
<a href="#M000047">attr_names</a> |
100 |
<a href="#M000050">cat_texts</a> |
101 |
<a href="#M000051">dump_draft</a> |
102 |
<a href="#M000046">id</a> |
103 |
<a href="#M000052">make_snippet</a> |
104 |
<a href="#M000054">new</a> |
105 |
<a href="#M000053">scan_words</a> |
106 |
<a href="#M000049">texts</a> |
107 |
</div> |
108 |
</div> |
109 |
|
110 |
</div> |
111 |
|
112 |
|
113 |
<!-- if includes --> |
114 |
|
115 |
<div id="section"> |
116 |
|
117 |
|
118 |
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
<!-- if method_list --> |
125 |
<div id="methods"> |
126 |
<h3 class="section-bar">Public Class methods</h3> |
127 |
|
128 |
<div id="method-M000054" class="method-detail"> |
129 |
<a name="M000054"></a> |
130 |
|
131 |
<div class="method-heading"> |
132 |
<a href="Document.src/M000054.html" target="Code" class="method-signature" |
133 |
onclick="popupCode('Document.src/M000054.html');return false;"> |
134 |
<span class="method-name">new</span><span class="method-args">(draft = "")</span> |
135 |
</a> |
136 |
</div> |
137 |
|
138 |
<div class="method-description"> |
139 |
<p> |
140 |
Create a document object. `draft’ specifies a string of draft data. |
141 |
</p> |
142 |
</div> |
143 |
</div> |
144 |
|
145 |
<h3 class="section-bar">Public Instance methods</h3> |
146 |
|
147 |
<div id="method-M000043" class="method-detail"> |
148 |
<a name="M000043"></a> |
149 |
|
150 |
<div class="method-heading"> |
151 |
<a href="Document.src/M000043.html" target="Code" class="method-signature" |
152 |
onclick="popupCode('Document.src/M000043.html');return false;"> |
153 |
<span class="method-name">add_attr</span><span class="method-args">(name, value)</span> |
154 |
</a> |
155 |
</div> |
156 |
|
157 |
<div class="method-description"> |
158 |
<p> |
159 |
Add an attribute. `name’ specifies the name of an attribute. |
160 |
`value’ specifies the value of the attribute. If it is nil, the |
161 |
attribute is removed. |
162 |
</p> |
163 |
</div> |
164 |
</div> |
165 |
|
166 |
<div id="method-M000045" class="method-detail"> |
167 |
<a name="M000045"></a> |
168 |
|
169 |
<div class="method-heading"> |
170 |
<a href="Document.src/M000045.html" target="Code" class="method-signature" |
171 |
onclick="popupCode('Document.src/M000045.html');return false;"> |
172 |
<span class="method-name">add_hidden_text</span><span class="method-args">(text)</span> |
173 |
</a> |
174 |
</div> |
175 |
|
176 |
<div class="method-description"> |
177 |
<p> |
178 |
Add a hidden sentence. `text’ specifies a hidden sentence. |
179 |
</p> |
180 |
</div> |
181 |
</div> |
182 |
|
183 |
<div id="method-M000044" class="method-detail"> |
184 |
<a name="M000044"></a> |
185 |
|
186 |
<div class="method-heading"> |
187 |
<a href="Document.src/M000044.html" target="Code" class="method-signature" |
188 |
onclick="popupCode('Document.src/M000044.html');return false;"> |
189 |
<span class="method-name">add_text</span><span class="method-args">(text)</span> |
190 |
</a> |
191 |
</div> |
192 |
|
193 |
<div class="method-description"> |
194 |
<p> |
195 |
Add a sentence of text. `text’ specifies a sentence of text. |
196 |
</p> |
197 |
</div> |
198 |
</div> |
199 |
|
200 |
<div id="method-M000048" class="method-detail"> |
201 |
<a name="M000048"></a> |
202 |
|
203 |
<div class="method-heading"> |
204 |
<a href="Document.src/M000048.html" target="Code" class="method-signature" |
205 |
onclick="popupCode('Document.src/M000048.html');return false;"> |
206 |
<span class="method-name">attr</span><span class="method-args">(name)</span> |
207 |
</a> |
208 |
</div> |
209 |
|
210 |
<div class="method-description"> |
211 |
<p> |
212 |
Get the value of an attribute. `name’ specifies the name of an |
213 |
attribute. The return value is the value of the attribute or nil if it does |
214 |
not exist. |
215 |
</p> |
216 |
</div> |
217 |
</div> |
218 |
|
219 |
<div id="method-M000047" class="method-detail"> |
220 |
<a name="M000047"></a> |
221 |
|
222 |
<div class="method-heading"> |
223 |
<a href="Document.src/M000047.html" target="Code" class="method-signature" |
224 |
onclick="popupCode('Document.src/M000047.html');return false;"> |
225 |
<span class="method-name">attr_names</span><span class="method-args">()</span> |
226 |
</a> |
227 |
</div> |
228 |
|
229 |
<div class="method-description"> |
230 |
<p> |
231 |
Get a list of attribute names of a document object. The return value is a |
232 |
list object of attribute names. |
233 |
</p> |
234 |
</div> |
235 |
</div> |
236 |
|
237 |
<div id="method-M000050" class="method-detail"> |
238 |
<a name="M000050"></a> |
239 |
|
240 |
<div class="method-heading"> |
241 |
<a href="Document.src/M000050.html" target="Code" class="method-signature" |
242 |
onclick="popupCode('Document.src/M000050.html');return false;"> |
243 |
<span class="method-name">cat_texts</span><span class="method-args">()</span> |
244 |
</a> |
245 |
</div> |
246 |
|
247 |
<div class="method-description"> |
248 |
<p> |
249 |
Concatenate sentences of the text of a document object. The return value is |
250 |
concatenated sentences. |
251 |
</p> |
252 |
</div> |
253 |
</div> |
254 |
|
255 |
<div id="method-M000051" class="method-detail"> |
256 |
<a name="M000051"></a> |
257 |
|
258 |
<div class="method-heading"> |
259 |
<a href="Document.src/M000051.html" target="Code" class="method-signature" |
260 |
onclick="popupCode('Document.src/M000051.html');return false;"> |
261 |
<span class="method-name">dump_draft</span><span class="method-args">()</span> |
262 |
</a> |
263 |
</div> |
264 |
|
265 |
<div class="method-description"> |
266 |
<p> |
267 |
Dump draft data of a document object. The return value is draft data. |
268 |
</p> |
269 |
</div> |
270 |
</div> |
271 |
|
272 |
<div id="method-M000046" class="method-detail"> |
273 |
<a name="M000046"></a> |
274 |
|
275 |
<div class="method-heading"> |
276 |
<a href="Document.src/M000046.html" target="Code" class="method-signature" |
277 |
onclick="popupCode('Document.src/M000046.html');return false;"> |
278 |
<span class="method-name">id</span><span class="method-args">()</span> |
279 |
</a> |
280 |
</div> |
281 |
|
282 |
<div class="method-description"> |
283 |
<p> |
284 |
Get the ID number. The return value is the ID number of the document |
285 |
object. If the object has never been registered, -1 is returned. |
286 |
</p> |
287 |
</div> |
288 |
</div> |
289 |
|
290 |
<div id="method-M000052" class="method-detail"> |
291 |
<a name="M000052"></a> |
292 |
|
293 |
<div class="method-heading"> |
294 |
<a href="Document.src/M000052.html" target="Code" class="method-signature" |
295 |
onclick="popupCode('Document.src/M000052.html');return false;"> |
296 |
<span class="method-name">make_snippet</span><span class="method-args">(words, wwidth, hwidth, awidth)</span> |
297 |
</a> |
298 |
</div> |
299 |
|
300 |
<div class="method-description"> |
301 |
<p> |
302 |
Make a snippet of the body text of a document object. `word’ |
303 |
specifies a list object of words to be highlight. `wwitdh’ specifies |
304 |
whole width of the result. `hwitdh’ specifies width of strings picked |
305 |
up from the beginning of the text. `awitdh’ specifies width of |
306 |
strings picked up around each highlighted word. The return value is a |
307 |
snippet string of the body text. There are tab separated values. Each line |
308 |
is a string to be shown. Though most lines have only one field, some lines |
309 |
have two fields. If the second field exists, the first field is to be shown |
310 |
with highlighted, and the second field means its normalized form. |
311 |
</p> |
312 |
</div> |
313 |
</div> |
314 |
|
315 |
<div id="method-M000053" class="method-detail"> |
316 |
<a name="M000053"></a> |
317 |
|
318 |
<div class="method-heading"> |
319 |
<a href="Document.src/M000053.html" target="Code" class="method-signature" |
320 |
onclick="popupCode('Document.src/M000053.html');return false;"> |
321 |
<span class="method-name">scan_words</span><span class="method-args">(words)</span> |
322 |
</a> |
323 |
</div> |
324 |
|
325 |
<div class="method-description"> |
326 |
<p> |
327 |
Check whether the text of a document object includes every specified words. |
328 |
`word’ specifies a list object of words to be checked. The return |
329 |
value is true if every specified words is found, else it is false. |
330 |
</p> |
331 |
</div> |
332 |
</div> |
333 |
|
334 |
<div id="method-M000049" class="method-detail"> |
335 |
<a name="M000049"></a> |
336 |
|
337 |
<div class="method-heading"> |
338 |
<a href="Document.src/M000049.html" target="Code" class="method-signature" |
339 |
onclick="popupCode('Document.src/M000049.html');return false;"> |
340 |
<span class="method-name">texts</span><span class="method-args">()</span> |
341 |
</a> |
342 |
</div> |
343 |
|
344 |
<div class="method-description"> |
345 |
<p> |
346 |
Get a list of sentences of the text. The return value is a list object of |
347 |
sentences of the text. |
348 |
</p> |
349 |
</div> |
350 |
</div> |
351 |
|
352 |
|
353 |
</div> |
354 |
|
355 |
|
356 |
</div> |
357 |
|
358 |
|
359 |
<div id="validator-badges"> |
360 |
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> |
361 |
</div> |
362 |
|
363 |
</body> |
364 |
</html> |