rrtf 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +31 -7
- data/documentation/RRTF/CharacterFormatting.html +1002 -0
- data/documentation/RRTF/CharacterStyle.html +1058 -0
- data/documentation/RRTF/Colour.html +813 -0
- data/documentation/RRTF/ColourTable.html +770 -0
- data/documentation/RRTF/CommandNode.html +2372 -0
- data/documentation/RRTF/ContainerNode.html +826 -0
- data/documentation/RRTF/Converters/HTML/Helpers.html +272 -0
- data/documentation/RRTF/Converters/HTML/Node.html +364 -0
- data/documentation/RRTF/Converters/HTML/NodeSet.html +265 -0
- data/documentation/RRTF/Converters/HTML.html +337 -0
- data/documentation/RRTF/Converters.html +117 -0
- data/documentation/RRTF/Document.html +2405 -0
- data/documentation/RRTF/DocumentStyle.html +1367 -0
- data/documentation/RRTF/Font.html +790 -0
- data/documentation/RRTF/FontTable.html +763 -0
- data/documentation/RRTF/FooterNode.html +515 -0
- data/documentation/RRTF/HeaderNode.html +515 -0
- data/documentation/RRTF/ImageNode.html +1374 -0
- data/documentation/RRTF/Information.html +809 -0
- data/documentation/RRTF/LinkNode.html +264 -0
- data/documentation/RRTF/ListLevel.html +799 -0
- data/documentation/RRTF/ListLevelNode.html +612 -0
- data/documentation/RRTF/ListMarker.html +595 -0
- data/documentation/RRTF/ListNode.html +368 -0
- data/documentation/RRTF/ListTable.html +343 -0
- data/documentation/RRTF/ListTemplate.html +433 -0
- data/documentation/RRTF/ListTextNode.html +285 -0
- data/documentation/RRTF/Node.html +616 -0
- data/documentation/RRTF/Paper.html +624 -0
- data/documentation/RRTF/ParagraphFormatting.html +749 -0
- data/documentation/RRTF/ParagraphNode.html +275 -0
- data/documentation/RRTF/ParagraphStyle.html +1319 -0
- data/documentation/RRTF/RTFError.html +295 -0
- data/documentation/RRTF/Style.html +1767 -0
- data/documentation/RRTF/Stylesheet.html +1768 -0
- data/documentation/RRTF/TableCellNode.html +1704 -0
- data/documentation/RRTF/TableNode.html +1025 -0
- data/documentation/RRTF/TableRowNode.html +675 -0
- data/documentation/RRTF/TextNode.html +600 -0
- data/documentation/RRTF/Utilities.html +201 -0
- data/documentation/RRTF.html +129 -0
- data/documentation/_index.html +478 -0
- data/documentation/class_list.html +51 -0
- data/documentation/css/common.css +1 -0
- data/documentation/css/full_list.css +58 -0
- data/documentation/css/style.css +492 -0
- data/documentation/file.README.html +223 -0
- data/documentation/file_list.html +56 -0
- data/documentation/frames.html +17 -0
- data/documentation/index.html +223 -0
- data/documentation/js/app.js +248 -0
- data/documentation/js/full_list.js +216 -0
- data/documentation/js/jquery.js +4 -0
- data/documentation/method_list.html +2203 -0
- data/documentation/top-level-namespace.html +110 -0
- data/examples/01.rtf +14 -17
- data/examples/01_mac_word15_36.png +0 -0
- data/examples/01_styles_and_paragraphs.rb +3 -4
- data/examples/resources/json/redshirt_styles.json +4 -2
- data/lib/rrtf/node.rb +86 -167
- data/lib/rrtf/style/character_style.rb +4 -3
- data/lib/rrtf/style/formatting.rb +55 -11
- data/lib/rrtf/style/paragraph_style.rb +19 -4
- data/lib/rrtf/style/style.rb +15 -15
- data/lib/rrtf/stylesheet.rb +57 -16
- data/lib/rrtf/version.rb +1 -1
- data/rrtf.gemspec +1 -0
- metadata +70 -1
|
@@ -0,0 +1,809 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: RRTF::Information
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.9
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "RRTF::Information";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (I)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Information</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: RRTF::Information
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">RRTF::Information</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/rrtf/information.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>This class represents an information group for a RTF document.</p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
118
|
+
<ul class="summary">
|
|
119
|
+
|
|
120
|
+
<li class="public ">
|
|
121
|
+
<span class="summary_signature">
|
|
122
|
+
|
|
123
|
+
<a href="#author-instance_method" title="#author (instance method)">#<strong>author</strong> ⇒ Object </a>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
</span>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<span class="summary_desc"><div class='inline'>
|
|
141
|
+
<p>Attribute accessor.</p>
|
|
142
|
+
</div></span>
|
|
143
|
+
|
|
144
|
+
</li>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
<li class="public ">
|
|
148
|
+
<span class="summary_signature">
|
|
149
|
+
|
|
150
|
+
<a href="#comments-instance_method" title="#comments (instance method)">#<strong>comments</strong> ⇒ Object </a>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
</span>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<span class="summary_desc"><div class='inline'>
|
|
168
|
+
<p>Attribute accessor.</p>
|
|
169
|
+
</div></span>
|
|
170
|
+
|
|
171
|
+
</li>
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<li class="public ">
|
|
175
|
+
<span class="summary_signature">
|
|
176
|
+
|
|
177
|
+
<a href="#company-instance_method" title="#company (instance method)">#<strong>company</strong> ⇒ Object </a>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</span>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
<span class="summary_desc"><div class='inline'>
|
|
195
|
+
<p>Attribute accessor.</p>
|
|
196
|
+
</div></span>
|
|
197
|
+
|
|
198
|
+
</li>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
<li class="public ">
|
|
202
|
+
<span class="summary_signature">
|
|
203
|
+
|
|
204
|
+
<a href="#created-instance_method" title="#created (instance method)">#<strong>created</strong> ⇒ Object </a>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
</span>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
<span class="summary_desc"><div class='inline'>
|
|
222
|
+
<p>Attribute accessor.</p>
|
|
223
|
+
</div></span>
|
|
224
|
+
|
|
225
|
+
</li>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
<li class="public ">
|
|
229
|
+
<span class="summary_signature">
|
|
230
|
+
|
|
231
|
+
<a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> ⇒ Object </a>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
</span>
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Attribute accessor.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
</ul>
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<h2>
|
|
262
|
+
Instance Method Summary
|
|
263
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
264
|
+
</h2>
|
|
265
|
+
|
|
266
|
+
<ul class="summary">
|
|
267
|
+
|
|
268
|
+
<li class="public ">
|
|
269
|
+
<span class="summary_signature">
|
|
270
|
+
|
|
271
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(title = nil, author = nil, company = nil, comments = nil, creation = nil) ⇒ Information </a>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
</span>
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<span class="note title constructor">constructor</span>
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
<span class="summary_desc"><div class='inline'>
|
|
288
|
+
<p>This is the constructor for the Information class.</p>
|
|
289
|
+
</div></span>
|
|
290
|
+
|
|
291
|
+
</li>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<li class="public ">
|
|
295
|
+
<span class="summary_signature">
|
|
296
|
+
|
|
297
|
+
<a href="#to_rtf-instance_method" title="#to_rtf (instance method)">#<strong>to_rtf</strong>(indent = 0) ⇒ Object </a>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
</span>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<span class="summary_desc"><div class='inline'>
|
|
312
|
+
<p>This method generates the RTF text for an Information object.</p>
|
|
313
|
+
</div></span>
|
|
314
|
+
|
|
315
|
+
</li>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<li class="public ">
|
|
319
|
+
<span class="summary_signature">
|
|
320
|
+
|
|
321
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong>(indent = 0) ⇒ Object </a>
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</span>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<span class="summary_desc"><div class='inline'>
|
|
336
|
+
<p>This method creates a textual description for an Information object.</p>
|
|
337
|
+
</div></span>
|
|
338
|
+
|
|
339
|
+
</li>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
</ul>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
<div id="constructor_details" class="method_details_list">
|
|
346
|
+
<h2>Constructor Details</h2>
|
|
347
|
+
|
|
348
|
+
<div class="method_details first">
|
|
349
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
350
|
+
|
|
351
|
+
#<strong>initialize</strong>(title = nil, author = nil, company = nil, comments = nil, creation = nil) ⇒ <tt><span class='object_link'><a href="" title="RRTF::Information (class)">Information</a></span></tt>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
</h3><div class="docstring">
|
|
358
|
+
<div class="discussion">
|
|
359
|
+
|
|
360
|
+
<p>This is the constructor for the Information class.</p>
|
|
361
|
+
|
|
362
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
363
|
+
<dl class="rdoc-list note-list"><dt>title
|
|
364
|
+
<dd>
|
|
365
|
+
<p>A string containing the document title information. Defaults to nil.</p>
|
|
366
|
+
</dd><dt>author
|
|
367
|
+
<dd>
|
|
368
|
+
<p>A string containing the document author information. Defaults to nil.</p>
|
|
369
|
+
</dd><dt>company
|
|
370
|
+
<dd>
|
|
371
|
+
<p>A string containing the company name information. Defaults to nil.</p>
|
|
372
|
+
</dd><dt>comments
|
|
373
|
+
<dd>
|
|
374
|
+
<p>A string containing the information comments. Defaults to nil to indicate
|
|
375
|
+
no comments.</p>
|
|
376
|
+
</dd><dt>creation
|
|
377
|
+
<dd>
|
|
378
|
+
<p>A Time object or a String that can be parsed into a Time object (using
|
|
379
|
+
ParseDate) indicating the document creation date and time. Defaults to nil
|
|
380
|
+
to indicate the current date and time.</p>
|
|
381
|
+
</dd></dl>
|
|
382
|
+
|
|
383
|
+
<h4 id="label-Exceptions">Exceptions</h4>
|
|
384
|
+
<dl class="rdoc-list note-list"><dt>RTFError
|
|
385
|
+
<dd>
|
|
386
|
+
<p>Generated whenever invalid creation date/time details are specified.</p>
|
|
387
|
+
</dd></dl>
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</div>
|
|
391
|
+
</div>
|
|
392
|
+
<div class="tags">
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
</div><table class="source_code">
|
|
396
|
+
<tr>
|
|
397
|
+
<td>
|
|
398
|
+
<pre class="lines">
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
33
|
|
402
|
+
34
|
|
403
|
+
35
|
|
404
|
+
36
|
|
405
|
+
37
|
|
406
|
+
38
|
|
407
|
+
39</pre>
|
|
408
|
+
</td>
|
|
409
|
+
<td>
|
|
410
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 33</span>
|
|
411
|
+
|
|
412
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_title'>title</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_author'>author</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_company'>company</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_comments'>comments</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_creation'>creation</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
|
|
413
|
+
<span class='ivar'>@title</span> <span class='op'>=</span> <span class='id identifier rubyid_title'>title</span>
|
|
414
|
+
<span class='ivar'>@author</span> <span class='op'>=</span> <span class='id identifier rubyid_author'>author</span>
|
|
415
|
+
<span class='ivar'>@company</span> <span class='op'>=</span> <span class='id identifier rubyid_company'>company</span>
|
|
416
|
+
<span class='ivar'>@comments</span> <span class='op'>=</span> <span class='id identifier rubyid_comments'>comments</span>
|
|
417
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_created'>created</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='id identifier rubyid_creation'>creation</span> <span class='op'>==</span> <span class='kw'>nil</span> <span class='op'>?</span> <span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='op'>:</span> <span class='id identifier rubyid_creation'>creation</span><span class='rparen'>)</span>
|
|
418
|
+
<span class='kw'>end</span></pre>
|
|
419
|
+
</td>
|
|
420
|
+
</tr>
|
|
421
|
+
</table>
|
|
422
|
+
</div>
|
|
423
|
+
|
|
424
|
+
</div>
|
|
425
|
+
|
|
426
|
+
<div id="instance_attr_details" class="attr_details">
|
|
427
|
+
<h2>Instance Attribute Details</h2>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
<span id="author=-instance_method"></span>
|
|
431
|
+
<div class="method_details first">
|
|
432
|
+
<h3 class="signature first" id="author-instance_method">
|
|
433
|
+
|
|
434
|
+
#<strong>author</strong> ⇒ <tt>Object</tt>
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
</h3><div class="docstring">
|
|
441
|
+
<div class="discussion">
|
|
442
|
+
|
|
443
|
+
<p>Attribute accessor.</p>
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</div>
|
|
447
|
+
</div>
|
|
448
|
+
<div class="tags">
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</div><table class="source_code">
|
|
452
|
+
<tr>
|
|
453
|
+
<td>
|
|
454
|
+
<pre class="lines">
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
8
|
|
458
|
+
9
|
|
459
|
+
10</pre>
|
|
460
|
+
</td>
|
|
461
|
+
<td>
|
|
462
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 8</span>
|
|
463
|
+
|
|
464
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_author'>author</span>
|
|
465
|
+
<span class='ivar'>@author</span>
|
|
466
|
+
<span class='kw'>end</span></pre>
|
|
467
|
+
</td>
|
|
468
|
+
</tr>
|
|
469
|
+
</table>
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
<span id="comments=-instance_method"></span>
|
|
474
|
+
<div class="method_details ">
|
|
475
|
+
<h3 class="signature " id="comments-instance_method">
|
|
476
|
+
|
|
477
|
+
#<strong>comments</strong> ⇒ <tt>Object</tt>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
</h3><div class="docstring">
|
|
484
|
+
<div class="discussion">
|
|
485
|
+
|
|
486
|
+
<p>Attribute accessor.</p>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
</div>
|
|
490
|
+
</div>
|
|
491
|
+
<div class="tags">
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
</div><table class="source_code">
|
|
495
|
+
<tr>
|
|
496
|
+
<td>
|
|
497
|
+
<pre class="lines">
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
8
|
|
501
|
+
9
|
|
502
|
+
10</pre>
|
|
503
|
+
</td>
|
|
504
|
+
<td>
|
|
505
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 8</span>
|
|
506
|
+
|
|
507
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_comments'>comments</span>
|
|
508
|
+
<span class='ivar'>@comments</span>
|
|
509
|
+
<span class='kw'>end</span></pre>
|
|
510
|
+
</td>
|
|
511
|
+
</tr>
|
|
512
|
+
</table>
|
|
513
|
+
</div>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
<span id="company=-instance_method"></span>
|
|
517
|
+
<div class="method_details ">
|
|
518
|
+
<h3 class="signature " id="company-instance_method">
|
|
519
|
+
|
|
520
|
+
#<strong>company</strong> ⇒ <tt>Object</tt>
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
</h3><div class="docstring">
|
|
527
|
+
<div class="discussion">
|
|
528
|
+
|
|
529
|
+
<p>Attribute accessor.</p>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
</div>
|
|
533
|
+
</div>
|
|
534
|
+
<div class="tags">
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
</div><table class="source_code">
|
|
538
|
+
<tr>
|
|
539
|
+
<td>
|
|
540
|
+
<pre class="lines">
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
8
|
|
544
|
+
9
|
|
545
|
+
10</pre>
|
|
546
|
+
</td>
|
|
547
|
+
<td>
|
|
548
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 8</span>
|
|
549
|
+
|
|
550
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_company'>company</span>
|
|
551
|
+
<span class='ivar'>@company</span>
|
|
552
|
+
<span class='kw'>end</span></pre>
|
|
553
|
+
</td>
|
|
554
|
+
</tr>
|
|
555
|
+
</table>
|
|
556
|
+
</div>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<span id="created=-instance_method"></span>
|
|
560
|
+
<div class="method_details ">
|
|
561
|
+
<h3 class="signature " id="created-instance_method">
|
|
562
|
+
|
|
563
|
+
#<strong>created</strong> ⇒ <tt>Object</tt>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
</h3><div class="docstring">
|
|
570
|
+
<div class="discussion">
|
|
571
|
+
|
|
572
|
+
<p>Attribute accessor.</p>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
</div>
|
|
576
|
+
</div>
|
|
577
|
+
<div class="tags">
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
</div><table class="source_code">
|
|
581
|
+
<tr>
|
|
582
|
+
<td>
|
|
583
|
+
<pre class="lines">
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
8
|
|
587
|
+
9
|
|
588
|
+
10</pre>
|
|
589
|
+
</td>
|
|
590
|
+
<td>
|
|
591
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 8</span>
|
|
592
|
+
|
|
593
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_created'>created</span>
|
|
594
|
+
<span class='ivar'>@created</span>
|
|
595
|
+
<span class='kw'>end</span></pre>
|
|
596
|
+
</td>
|
|
597
|
+
</tr>
|
|
598
|
+
</table>
|
|
599
|
+
</div>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
<span id="title=-instance_method"></span>
|
|
603
|
+
<div class="method_details ">
|
|
604
|
+
<h3 class="signature " id="title-instance_method">
|
|
605
|
+
|
|
606
|
+
#<strong>title</strong> ⇒ <tt>Object</tt>
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</h3><div class="docstring">
|
|
613
|
+
<div class="discussion">
|
|
614
|
+
|
|
615
|
+
<p>Attribute accessor.</p>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
</div>
|
|
619
|
+
</div>
|
|
620
|
+
<div class="tags">
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
</div><table class="source_code">
|
|
624
|
+
<tr>
|
|
625
|
+
<td>
|
|
626
|
+
<pre class="lines">
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
8
|
|
630
|
+
9
|
|
631
|
+
10</pre>
|
|
632
|
+
</td>
|
|
633
|
+
<td>
|
|
634
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 8</span>
|
|
635
|
+
|
|
636
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
|
|
637
|
+
<span class='ivar'>@title</span>
|
|
638
|
+
<span class='kw'>end</span></pre>
|
|
639
|
+
</td>
|
|
640
|
+
</tr>
|
|
641
|
+
</table>
|
|
642
|
+
</div>
|
|
643
|
+
|
|
644
|
+
</div>
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
<div id="instance_method_details" class="method_details_list">
|
|
648
|
+
<h2>Instance Method Details</h2>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
<div class="method_details first">
|
|
652
|
+
<h3 class="signature first" id="to_rtf-instance_method">
|
|
653
|
+
|
|
654
|
+
#<strong>to_rtf</strong>(indent = 0) ⇒ <tt>Object</tt>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
</h3><div class="docstring">
|
|
661
|
+
<div class="discussion">
|
|
662
|
+
|
|
663
|
+
<p>This method generates the RTF text for an Information object.</p>
|
|
664
|
+
|
|
665
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
666
|
+
<dl class="rdoc-list note-list"><dt>indent
|
|
667
|
+
<dd>
|
|
668
|
+
<p>The number of spaces to prefix to the lines generated by the method.
|
|
669
|
+
Defaults to zero.</p>
|
|
670
|
+
</dd></dl>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
</div>
|
|
674
|
+
</div>
|
|
675
|
+
<div class="tags">
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</div><table class="source_code">
|
|
679
|
+
<tr>
|
|
680
|
+
<td>
|
|
681
|
+
<pre class="lines">
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
91
|
|
685
|
+
92
|
|
686
|
+
93
|
|
687
|
+
94
|
|
688
|
+
95
|
|
689
|
+
96
|
|
690
|
+
97
|
|
691
|
+
98
|
|
692
|
+
99
|
|
693
|
+
100
|
|
694
|
+
101
|
|
695
|
+
102
|
|
696
|
+
103
|
|
697
|
+
104
|
|
698
|
+
105
|
|
699
|
+
106
|
|
700
|
+
107
|
|
701
|
+
108</pre>
|
|
702
|
+
</td>
|
|
703
|
+
<td>
|
|
704
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 91</span>
|
|
705
|
+
|
|
706
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_rtf'>to_rtf</span><span class='lparen'>(</span><span class='id identifier rubyid_indent'>indent</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span>
|
|
707
|
+
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span> <span class='op'>*</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
708
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
709
|
+
|
|
710
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>{\\info</span><span class='tstring_end'>"</span></span>
|
|
711
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>{\\title </span><span class='embexpr_beg'>#{</span><span class='ivar'>@title</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@title</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
712
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>{\\author </span><span class='embexpr_beg'>#{</span><span class='ivar'>@author</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@author</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
713
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>{\\company </span><span class='embexpr_beg'>#{</span><span class='ivar'>@company</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@company</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
714
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>{\\doccomm </span><span class='embexpr_beg'>#{</span><span class='ivar'>@comments</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
715
|
+
<span class='kw'>unless</span> <span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
716
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>{\\createim\\yr</span><span class='embexpr_beg'>#{</span><span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_year'>year</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
717
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\mo</span><span class='embexpr_beg'>#{</span><span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_month'>month</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\dy</span><span class='embexpr_beg'>#{</span><span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_day'>day</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
718
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\\hr</span><span class='embexpr_beg'>#{</span><span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_hour'>hour</span><span class='embexpr_end'>}</span><span class='tstring_content'>\\min</span><span class='embexpr_beg'>#{</span><span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_min'>min</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='tstring_end'>"</span></span>
|
|
719
|
+
<span class='kw'>end</span>
|
|
720
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='tstring_end'>"</span></span>
|
|
721
|
+
|
|
722
|
+
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
|
|
723
|
+
<span class='kw'>end</span></pre>
|
|
724
|
+
</td>
|
|
725
|
+
</tr>
|
|
726
|
+
</table>
|
|
727
|
+
</div>
|
|
728
|
+
|
|
729
|
+
<div class="method_details ">
|
|
730
|
+
<h3 class="signature " id="to_s-instance_method">
|
|
731
|
+
|
|
732
|
+
#<strong>to_s</strong>(indent = 0) ⇒ <tt>Object</tt>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
</h3><div class="docstring">
|
|
739
|
+
<div class="discussion">
|
|
740
|
+
|
|
741
|
+
<p>This method creates a textual description for an Information object.</p>
|
|
742
|
+
|
|
743
|
+
<h4 id="label-Parameters">Parameters</h4>
|
|
744
|
+
<dl class="rdoc-list note-list"><dt>indent
|
|
745
|
+
<dd>
|
|
746
|
+
<p>The number of spaces to prefix to the lines generated by the method.
|
|
747
|
+
Defaults to zero.</p>
|
|
748
|
+
</dd></dl>
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
</div>
|
|
752
|
+
</div>
|
|
753
|
+
<div class="tags">
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
</div><table class="source_code">
|
|
757
|
+
<tr>
|
|
758
|
+
<td>
|
|
759
|
+
<pre class="lines">
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
72
|
|
763
|
+
73
|
|
764
|
+
74
|
|
765
|
+
75
|
|
766
|
+
76
|
|
767
|
+
77
|
|
768
|
+
78
|
|
769
|
+
79
|
|
770
|
+
80
|
|
771
|
+
81
|
|
772
|
+
82
|
|
773
|
+
83
|
|
774
|
+
84</pre>
|
|
775
|
+
</td>
|
|
776
|
+
<td>
|
|
777
|
+
<pre class="code"><span class="info file"># File 'lib/rrtf/information.rb', line 72</span>
|
|
778
|
+
|
|
779
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='id identifier rubyid_indent'>indent</span><span class='op'>=</span><span class='int'>0</span><span class='rparen'>)</span>
|
|
780
|
+
<span class='id identifier rubyid_prefix'>prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>></span> <span class='int'>0</span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'> </span><span class='tstring_end'>'</span></span> <span class='op'>*</span> <span class='id identifier rubyid_indent'>indent</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span>
|
|
781
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
782
|
+
|
|
783
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>Information</span><span class='tstring_end'>"</span></span>
|
|
784
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'> Title: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@title</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@title</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
785
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'> Author: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@author</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@author</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
786
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'> Company: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@company</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@company</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
787
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'> Comments: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@comments</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
788
|
+
<span class='id identifier rubyid_text'>text</span> <span class='op'><<</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_prefix'>prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'> Created: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@created</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='ivar'>@created</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
789
|
+
|
|
790
|
+
<span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_string'>string</span>
|
|
791
|
+
<span class='kw'>end</span></pre>
|
|
792
|
+
</td>
|
|
793
|
+
</tr>
|
|
794
|
+
</table>
|
|
795
|
+
</div>
|
|
796
|
+
|
|
797
|
+
</div>
|
|
798
|
+
|
|
799
|
+
</div>
|
|
800
|
+
|
|
801
|
+
<div id="footer">
|
|
802
|
+
Generated on Mon Jul 24 15:49:02 2017 by
|
|
803
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
804
|
+
0.9.9 (ruby-2.3.3).
|
|
805
|
+
</div>
|
|
806
|
+
|
|
807
|
+
</div>
|
|
808
|
+
</body>
|
|
809
|
+
</html>
|