rrtf 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (70) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -7
  3. data/documentation/RRTF/CharacterFormatting.html +1002 -0
  4. data/documentation/RRTF/CharacterStyle.html +1058 -0
  5. data/documentation/RRTF/Colour.html +813 -0
  6. data/documentation/RRTF/ColourTable.html +770 -0
  7. data/documentation/RRTF/CommandNode.html +2372 -0
  8. data/documentation/RRTF/ContainerNode.html +826 -0
  9. data/documentation/RRTF/Converters/HTML/Helpers.html +272 -0
  10. data/documentation/RRTF/Converters/HTML/Node.html +364 -0
  11. data/documentation/RRTF/Converters/HTML/NodeSet.html +265 -0
  12. data/documentation/RRTF/Converters/HTML.html +337 -0
  13. data/documentation/RRTF/Converters.html +117 -0
  14. data/documentation/RRTF/Document.html +2405 -0
  15. data/documentation/RRTF/DocumentStyle.html +1367 -0
  16. data/documentation/RRTF/Font.html +790 -0
  17. data/documentation/RRTF/FontTable.html +763 -0
  18. data/documentation/RRTF/FooterNode.html +515 -0
  19. data/documentation/RRTF/HeaderNode.html +515 -0
  20. data/documentation/RRTF/ImageNode.html +1374 -0
  21. data/documentation/RRTF/Information.html +809 -0
  22. data/documentation/RRTF/LinkNode.html +264 -0
  23. data/documentation/RRTF/ListLevel.html +799 -0
  24. data/documentation/RRTF/ListLevelNode.html +612 -0
  25. data/documentation/RRTF/ListMarker.html +595 -0
  26. data/documentation/RRTF/ListNode.html +368 -0
  27. data/documentation/RRTF/ListTable.html +343 -0
  28. data/documentation/RRTF/ListTemplate.html +433 -0
  29. data/documentation/RRTF/ListTextNode.html +285 -0
  30. data/documentation/RRTF/Node.html +616 -0
  31. data/documentation/RRTF/Paper.html +624 -0
  32. data/documentation/RRTF/ParagraphFormatting.html +749 -0
  33. data/documentation/RRTF/ParagraphNode.html +275 -0
  34. data/documentation/RRTF/ParagraphStyle.html +1319 -0
  35. data/documentation/RRTF/RTFError.html +295 -0
  36. data/documentation/RRTF/Style.html +1767 -0
  37. data/documentation/RRTF/Stylesheet.html +1768 -0
  38. data/documentation/RRTF/TableCellNode.html +1704 -0
  39. data/documentation/RRTF/TableNode.html +1025 -0
  40. data/documentation/RRTF/TableRowNode.html +675 -0
  41. data/documentation/RRTF/TextNode.html +600 -0
  42. data/documentation/RRTF/Utilities.html +201 -0
  43. data/documentation/RRTF.html +129 -0
  44. data/documentation/_index.html +478 -0
  45. data/documentation/class_list.html +51 -0
  46. data/documentation/css/common.css +1 -0
  47. data/documentation/css/full_list.css +58 -0
  48. data/documentation/css/style.css +492 -0
  49. data/documentation/file.README.html +223 -0
  50. data/documentation/file_list.html +56 -0
  51. data/documentation/frames.html +17 -0
  52. data/documentation/index.html +223 -0
  53. data/documentation/js/app.js +248 -0
  54. data/documentation/js/full_list.js +216 -0
  55. data/documentation/js/jquery.js +4 -0
  56. data/documentation/method_list.html +2203 -0
  57. data/documentation/top-level-namespace.html +110 -0
  58. data/examples/01.rtf +14 -17
  59. data/examples/01_mac_word15_36.png +0 -0
  60. data/examples/01_styles_and_paragraphs.rb +3 -4
  61. data/examples/resources/json/redshirt_styles.json +4 -2
  62. data/lib/rrtf/node.rb +86 -167
  63. data/lib/rrtf/style/character_style.rb +4 -3
  64. data/lib/rrtf/style/formatting.rb +55 -11
  65. data/lib/rrtf/style/paragraph_style.rb +19 -4
  66. data/lib/rrtf/style/style.rb +15 -15
  67. data/lib/rrtf/stylesheet.rb +57 -16
  68. data/lib/rrtf/version.rb +1 -1
  69. data/rrtf.gemspec +1 -0
  70. metadata +70 -1
@@ -0,0 +1,595 @@
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::ListMarker
8
+
9
+ &mdash; 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::ListMarker";
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 (L)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../RRTF.html" title="RRTF (module)">RRTF</a></span></span>
41
+ &raquo;
42
+ <span class="title">ListMarker</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::ListMarker
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::ListMarker</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/list.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+ <h2>
111
+ Instance Method Summary
112
+ <small><a href="#" class="summary_toggle">collapse</a></small>
113
+ </h2>
114
+
115
+ <ul class="summary">
116
+
117
+ <li class="public ">
118
+ <span class="summary_signature">
119
+
120
+ <a href="#bullet%3F-instance_method" title="#bullet? (instance method)">#<strong>bullet?</strong> &#x21d2; Boolean </a>
121
+
122
+
123
+
124
+ </span>
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ <span class="summary_desc"><div class='inline'></div></span>
135
+
136
+ </li>
137
+
138
+
139
+ <li class="public ">
140
+ <span class="summary_signature">
141
+
142
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, codepoint = nil) &#x21d2; ListMarker </a>
143
+
144
+
145
+
146
+ </span>
147
+
148
+
149
+ <span class="note title constructor">constructor</span>
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>A new instance of ListMarker.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> &#x21d2; Object </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ <span class="summary_desc"><div class='inline'></div></span>
183
+
184
+ </li>
185
+
186
+
187
+ <li class="public ">
188
+ <span class="summary_signature">
189
+
190
+ <a href="#number_type-instance_method" title="#number_type (instance method)">#<strong>number_type</strong> &#x21d2; Object </a>
191
+
192
+
193
+
194
+ </span>
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+ <span class="summary_desc"><div class='inline'></div></span>
205
+
206
+ </li>
207
+
208
+
209
+ <li class="public ">
210
+ <span class="summary_signature">
211
+
212
+ <a href="#template_format-instance_method" title="#template_format (instance method)">#<strong>template_format</strong> &#x21d2; Object </a>
213
+
214
+
215
+
216
+ </span>
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <span class="summary_desc"><div class='inline'></div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#text_format-instance_method" title="#text_format (instance method)">#<strong>text_format</strong>(n = nil) &#x21d2; Object </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'></div></span>
249
+
250
+ </li>
251
+
252
+
253
+ <li class="public ">
254
+ <span class="summary_signature">
255
+
256
+ <a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; Object </a>
257
+
258
+
259
+
260
+ </span>
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+ <span class="summary_desc"><div class='inline'></div></span>
271
+
272
+ </li>
273
+
274
+
275
+ </ul>
276
+
277
+
278
+ <div id="constructor_details" class="method_details_list">
279
+ <h2>Constructor Details</h2>
280
+
281
+ <div class="method_details first">
282
+ <h3 class="signature first" id="initialize-instance_method">
283
+
284
+ #<strong>initialize</strong>(name, codepoint = nil) &#x21d2; <tt><span class='object_link'><a href="" title="RRTF::ListMarker (class)">ListMarker</a></span></tt>
285
+
286
+
287
+
288
+
289
+
290
+ </h3><div class="docstring">
291
+ <div class="discussion">
292
+
293
+ <p>Returns a new instance of ListMarker</p>
294
+
295
+
296
+ </div>
297
+ </div>
298
+ <div class="tags">
299
+
300
+
301
+ </div><table class="source_code">
302
+ <tr>
303
+ <td>
304
+ <pre class="lines">
305
+
306
+
307
+ 38
308
+ 39
309
+ 40
310
+ 41</pre>
311
+ </td>
312
+ <td>
313
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 38</span>
314
+
315
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_codepoint'>codepoint</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
316
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span>
317
+ <span class='ivar'>@codepoint</span> <span class='op'>=</span> <span class='id identifier rubyid_codepoint'>codepoint</span>
318
+ <span class='kw'>end</span></pre>
319
+ </td>
320
+ </tr>
321
+ </table>
322
+ </div>
323
+
324
+ </div>
325
+
326
+
327
+ <div id="instance_method_details" class="method_details_list">
328
+ <h2>Instance Method Details</h2>
329
+
330
+
331
+ <div class="method_details first">
332
+ <h3 class="signature first" id="bullet?-instance_method">
333
+
334
+ #<strong>bullet?</strong> &#x21d2; <tt>Boolean</tt>
335
+
336
+
337
+
338
+
339
+
340
+ </h3><div class="docstring">
341
+ <div class="discussion">
342
+
343
+
344
+ </div>
345
+ </div>
346
+ <div class="tags">
347
+
348
+ <p class="tag_title">Returns:</p>
349
+ <ul class="return">
350
+
351
+ <li>
352
+
353
+
354
+ <span class='type'>(<tt>Boolean</tt>)</span>
355
+
356
+
357
+
358
+ </li>
359
+
360
+ </ul>
361
+
362
+ </div><table class="source_code">
363
+ <tr>
364
+ <td>
365
+ <pre class="lines">
366
+
367
+
368
+ 43
369
+ 44
370
+ 45</pre>
371
+ </td>
372
+ <td>
373
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 43</span>
374
+
375
+ <span class='kw'>def</span> <span class='id identifier rubyid_bullet?'>bullet?</span>
376
+ <span class='op'>!</span><span class='ivar'>@codepoint</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
377
+ <span class='kw'>end</span></pre>
378
+ </td>
379
+ </tr>
380
+ </table>
381
+ </div>
382
+
383
+ <div class="method_details ">
384
+ <h3 class="signature " id="name-instance_method">
385
+
386
+ #<strong>name</strong> &#x21d2; <tt>Object</tt>
387
+
388
+
389
+
390
+
391
+
392
+ </h3><table class="source_code">
393
+ <tr>
394
+ <td>
395
+ <pre class="lines">
396
+
397
+
398
+ 58
399
+ 59
400
+ 60
401
+ 61
402
+ 62</pre>
403
+ </td>
404
+ <td>
405
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 58</span>
406
+
407
+ <span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
408
+ <span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\{</span><span class='embvar'>#</span><span class='ivar'>@name</span><span class='tstring_content'>\\}</span><span class='tstring_end'>&quot;</span></span>
409
+ <span class='id identifier rubyid_name'>name</span> <span class='op'>&lt;&lt;</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>.</span><span class='tstring_end'>&#39;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_bullet?'>bullet?</span>
410
+ <span class='id identifier rubyid_name'>name</span>
411
+ <span class='kw'>end</span></pre>
412
+ </td>
413
+ </tr>
414
+ </table>
415
+ </div>
416
+
417
+ <div class="method_details ">
418
+ <h3 class="signature " id="number_type-instance_method">
419
+
420
+ #<strong>number_type</strong> &#x21d2; <tt>Object</tt>
421
+
422
+
423
+
424
+
425
+
426
+ </h3><table class="source_code">
427
+ <tr>
428
+ <td>
429
+ <pre class="lines">
430
+
431
+
432
+ 51
433
+ 52
434
+ 53
435
+ 54
436
+ 55
437
+ 56</pre>
438
+ </td>
439
+ <td>
440
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 51</span>
441
+
442
+ <span class='kw'>def</span> <span class='id identifier rubyid_number_type'>number_type</span>
443
+ <span class='comment'># 23: bullet, 0: arabic
444
+ </span> <span class='comment'># applies to the \levelnfcN macro
445
+ </span> <span class='comment'>#
446
+ </span> <span class='id identifier rubyid_bullet?'>bullet?</span> <span class='op'>?</span> <span class='int'>23</span> <span class='op'>:</span> <span class='int'>0</span>
447
+ <span class='kw'>end</span></pre>
448
+ </td>
449
+ </tr>
450
+ </table>
451
+ </div>
452
+
453
+ <div class="method_details ">
454
+ <h3 class="signature " id="template_format-instance_method">
455
+
456
+ #<strong>template_format</strong> &#x21d2; <tt>Object</tt>
457
+
458
+
459
+
460
+
461
+
462
+ </h3><table class="source_code">
463
+ <tr>
464
+ <td>
465
+ <pre class="lines">
466
+
467
+
468
+ 64
469
+ 65
470
+ 66
471
+ 67
472
+ 68
473
+ 69
474
+ 70
475
+ 71
476
+ 72
477
+ 73
478
+ 74
479
+ 75
480
+ 76
481
+ 77
482
+ 78
483
+ 79</pre>
484
+ </td>
485
+ <td>
486
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 64</span>
487
+
488
+ <span class='kw'>def</span> <span class='id identifier rubyid_template_format'>template_format</span>
489
+ <span class='comment'># The first char is the string size, the next ones are
490
+ </span> <span class='comment'># either placeholders (\&#39;0X) or actual characters to
491
+ </span> <span class='comment'># include in the format. In the bullet case, \uc0 is
492
+ </span> <span class='comment'># used to get rid of the multibyte translation: we want
493
+ </span> <span class='comment'># an Unicode character.
494
+ </span> <span class='comment'>#
495
+ </span> <span class='comment'># In the decimal case, we have a fixed format, with a
496
+ </span> <span class='comment'># dot following the actual number.
497
+ </span> <span class='comment'>#
498
+ </span> <span class='kw'>if</span> <span class='id identifier rubyid_bullet?'>bullet?</span>
499
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\&#39;01\\uc0\\u</span><span class='embvar'>#</span><span class='ivar'>@codepoint</span><span class='tstring_end'>&quot;</span></span>
500
+ <span class='kw'>else</span>
501
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\&#39;02\\&#39;00. </span><span class='tstring_end'>&quot;</span></span>
502
+ <span class='kw'>end</span>
503
+ <span class='kw'>end</span></pre>
504
+ </td>
505
+ </tr>
506
+ </table>
507
+ </div>
508
+
509
+ <div class="method_details ">
510
+ <h3 class="signature " id="text_format-instance_method">
511
+
512
+ #<strong>text_format</strong>(n = nil) &#x21d2; <tt>Object</tt>
513
+
514
+
515
+
516
+
517
+
518
+ </h3><table class="source_code">
519
+ <tr>
520
+ <td>
521
+ <pre class="lines">
522
+
523
+
524
+ 81
525
+ 82
526
+ 83
527
+ 84
528
+ 85
529
+ 86
530
+ 87
531
+ 88
532
+ 89
533
+ 90</pre>
534
+ </td>
535
+ <td>
536
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 81</span>
537
+
538
+ <span class='kw'>def</span> <span class='id identifier rubyid_text_format'>text_format</span><span class='lparen'>(</span><span class='id identifier rubyid_n'>n</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
539
+ <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span>
540
+ <span class='kw'>if</span> <span class='id identifier rubyid_bullet?'>bullet?</span>
541
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\uc0\\u</span><span class='embvar'>#</span><span class='ivar'>@codepoint</span><span class='tstring_end'>&quot;</span></span>
542
+ <span class='kw'>else</span>
543
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_n'>n</span><span class='embexpr_end'>}</span><span class='tstring_content'>.</span><span class='tstring_end'>&quot;</span></span>
544
+ <span class='kw'>end</span>
545
+
546
+ <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\t</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_text'>text</span><span class='embexpr_end'>}</span><span class='tstring_content'>\t</span><span class='tstring_end'>&quot;</span></span>
547
+ <span class='kw'>end</span></pre>
548
+ </td>
549
+ </tr>
550
+ </table>
551
+ </div>
552
+
553
+ <div class="method_details ">
554
+ <h3 class="signature " id="type-instance_method">
555
+
556
+ #<strong>type</strong> &#x21d2; <tt>Object</tt>
557
+
558
+
559
+
560
+
561
+
562
+ </h3><table class="source_code">
563
+ <tr>
564
+ <td>
565
+ <pre class="lines">
566
+
567
+
568
+ 47
569
+ 48
570
+ 49</pre>
571
+ </td>
572
+ <td>
573
+ <pre class="code"><span class="info file"># File 'lib/rrtf/list.rb', line 47</span>
574
+
575
+ <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
576
+ <span class='id identifier rubyid_bullet?'>bullet?</span> <span class='op'>?</span> <span class='symbol'>:bullet</span> <span class='op'>:</span> <span class='symbol'>:decimal</span>
577
+ <span class='kw'>end</span></pre>
578
+ </td>
579
+ </tr>
580
+ </table>
581
+ </div>
582
+
583
+ </div>
584
+
585
+ </div>
586
+
587
+ <div id="footer">
588
+ Generated on Mon Jul 24 15:48:59 2017 by
589
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
590
+ 0.9.9 (ruby-2.3.3).
591
+ </div>
592
+
593
+ </div>
594
+ </body>
595
+ </html>