docgenerator 2.0.0 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (104) hide show
  1. data/examples/creole_example_tabular.rb +95 -0
  2. data/examples/docgenerator_example.rb +5 -5
  3. data/lib/creole/creole2doc.rb +28 -18
  4. data/lib/creole/creole_inclusions.rb +4 -4
  5. data/lib/creole/creole_placeholder.rb +4 -1
  6. data/lib/creole/creole_tabular.rb +173 -155
  7. data/lib/creole/plugins/rail.rb +118 -119
  8. data/lib/creole/plugins/struktex.rb +35 -35
  9. data/lib/creole/plugins/todonotes.rb +8 -1
  10. data/lib/docgenerator/attribute.rb +160 -160
  11. data/lib/docgenerator/characters.rb +343 -311
  12. data/lib/docgenerator/css.rb +167 -167
  13. data/lib/docgenerator/document.rb +525 -511
  14. data/lib/docgenerator/element.rb +316 -316
  15. data/lib/docgenerator/element_meta.rb +114 -114
  16. data/lib/docgenerator/elements.rb +19 -9
  17. data/lib/docgenerator/environments.rb +3 -1
  18. data/lib/docgenerator/lists.rb +177 -174
  19. data/lib/docgenerator/packages/hyperref.rb +74 -70
  20. data/lib/docgenerator/packages/multicol.rb +33 -0
  21. data/lib/docgenerator/packages/scrlettr2.rb +152 -151
  22. data/lib/docgenerator/packages/todonotes.rb +1 -1
  23. data/lib/docgenerator/tabular.rb +463 -400
  24. data/lib/docgenerator/templates/docgenerator_template.rb +94 -84
  25. data/lib/docgenerator/templates/docgenerator_template.yaml +75 -15
  26. data/lib/docgenerator.rb +1 -1
  27. data/lib/wiki2doc/wiki2docgenerator.rb +1 -1
  28. data/meta_test_and_doc/build__meta.rb +125 -0
  29. data/meta_test_and_doc/build_doc.rb +333 -0
  30. data/meta_test_and_doc/build_test.rb +251 -0
  31. data/meta_test_and_doc/manpages/attachfile.rb +389 -0
  32. data/meta_test_and_doc/manpages/caption.rb +133 -0
  33. data/meta_test_and_doc/manpages/characters.rb +3738 -0
  34. data/meta_test_and_doc/manpages/elements.rb +6851 -0
  35. data/meta_test_and_doc/manpages/environments.rb +985 -0
  36. data/meta_test_and_doc/manpages/footnote.rb +439 -0
  37. data/meta_test_and_doc/manpages/hyperref.rb +605 -0
  38. data/meta_test_and_doc/manpages/listings.rb +988 -0
  39. data/meta_test_and_doc/manpages/lists.rb +1463 -0
  40. data/meta_test_and_doc/manpages/others.rb +129 -0
  41. data/meta_test_and_doc/manpages/packages.rb +13 -0
  42. data/meta_test_and_doc/manpages/pdfpages.rb +108 -0
  43. data/meta_test_and_doc/manpages/readme.rdoc +9 -0
  44. data/meta_test_and_doc/manpages/scrlettr2.rb +362 -0
  45. data/meta_test_and_doc/manpages/scrpage2.rb +2028 -0
  46. data/meta_test_and_doc/manpages/sectioning.rb +2467 -0
  47. data/meta_test_and_doc/manpages/tables.rb +2088 -0
  48. data/meta_test_and_doc/manpages/todonotes.rb +235 -0
  49. data/meta_test_and_doc/manpages/wiki2docgenerator.rb +64 -0
  50. data/{readme.rd → readme.rdoc} +18 -1
  51. data/unittest/expected/test_tabular.creole +33 -0
  52. data/unittest/expected_creole/test_creole_creole1.0test.html +3 -3
  53. data/unittest/expected_creole/test_creole_creole1.0test.latex +3 -3
  54. data/unittest/expected_creole/test_creole_creole1.0test.text +3 -3
  55. data/unittest/expected_creole/test_creole_inline_apostroph.html +6 -0
  56. data/unittest/expected_creole/test_creole_inline_apostroph.latex +8 -0
  57. data/unittest/expected_creole/test_creole_inline_apostroph.text +4 -0
  58. data/unittest/expected_creole/test_creole_input.normsource +12 -12
  59. data/unittest/expected_creole/test_creole_input.normsource_1.8 +23 -0
  60. data/unittest/expected_creole/test_creole_links_external_implicit.html +2 -2
  61. data/unittest/expected_creole/test_creole_links_external_implicit.latex +2 -2
  62. data/unittest/expected_creole/test_creole_links_external_implicit.text +2 -2
  63. data/unittest/expected_creole/test_creole_links_implicit_end.html +1 -1
  64. data/unittest/expected_creole/test_creole_links_implicit_end.latex +1 -1
  65. data/unittest/expected_creole/test_creole_list_ul.normsource +42 -42
  66. data/unittest/expected_creole/test_creole_list_ul.normsource_1.8 +83 -0
  67. data/unittest/expected_creole/test_creole_paragraphs.normsource +15 -15
  68. data/unittest/expected_creole/test_creole_paragraphs.normsource_1.8 +27 -0
  69. data/unittest/expected_creole/test_creole_tabular.creole +22 -0
  70. data/unittest/expected_creole/test_creole_tabular_creole.creole +19 -0
  71. data/unittest/expected_creole/test_creole_tabular_css.creole +24 -0
  72. data/unittest/expected_creole/test_creole_tabular_multicols.creole +16 -0
  73. data/unittest/expected_creole/test_creole_tabular_multicols.html +14 -0
  74. data/unittest/expected_creole/test_creole_tabular_multicols.latex +16 -0
  75. data/unittest/expected_creole/test_creole_tabular_with_cell_option.creole +21 -0
  76. data/unittest/expected_creole/test_creole_toc_level_text.html +2 -2
  77. data/unittest/expected_creole/test_creole_toc_level_text.latex +2 -2
  78. data/unittest/expected_packages/test_multicol_3.tex +2 -0
  79. data/unittest/expected_packages/test_multicol_3_titleline.tex +2 -0
  80. data/unittest/expected_templates/test_article.tex +23 -0
  81. data/unittest/expected_templates/test_article_utf8.tex +34 -0
  82. data/unittest/expected_templates/test_context.miv +18 -0
  83. data/unittest/expected_templates/test_creole.creole +8 -0
  84. data/unittest/expected_templates/test_html.html +12 -0
  85. data/unittest/expected_templates/test_html401_strict.html +14 -0
  86. data/unittest/expected_templates/test_html401_trans.html +14 -0
  87. data/unittest/expected_templates/test_html_utf8.html +14 -0
  88. data/unittest/expected_templates/test_include.tex +17 -0
  89. data/unittest/expected_templates/test_include_utf8.tex +17 -0
  90. data/unittest/expected_templates/test_text.txt +6 -0
  91. data/unittest/expected_templates/test_wiki.wiki +6 -0
  92. data/unittest/expected_templates/test_xhtml_strict.html +14 -0
  93. data/unittest/expected_templates/test_xhtml_trans.html +14 -0
  94. data/unittest/unittest_creole.rb +27 -6
  95. data/unittest/unittest_creole_placeholders.rb +1 -123
  96. data/unittest/unittest_creole_tabular.rb +174 -0
  97. data/unittest/unittest_docgenerator.rb +4 -3
  98. data/unittest/unittest_docgenerator_characters.rb +4769 -615
  99. data/unittest/unittest_packages_multicol.rb +84 -0
  100. data/unittest/unittest_rubycode4doc.rb +0 -1
  101. data/unittest/unittest_templates.rb +64 -0
  102. metadata +163 -77
  103. data/build_test_and_doc.rb +0 -505
  104. data/manpage_elements.rb +0 -10411
@@ -0,0 +1,985 @@
1
+ #encoding utf-8
2
+ =begin rdoc
3
+ Generated manpages for elements.
4
+
5
+ This document does not contain the implementation or code documentation.
6
+
7
+ This document is the source for a manpage for usage of Docgenerator elements.
8
+
9
+ The following Element are documented in this document:
10
+
11
+ * Docgenerator::Environments::Environment
12
+ * Docgenerator::Environments::Minipage
13
+ * Docgenerator::Environments::Center
14
+ * Docgenerator::Environments::Quote
15
+ * Docgenerator::Environments::Landscape
16
+ * Docgenerator::Environments::Verbatim
17
+ * Docgenerator::Environments::Figure
18
+ * Docgenerator::Environments::Abstract
19
+ =end
20
+
21
+ #
22
+ module Docgenerator
23
+ module Environments
24
+ =begin rdoc
25
+ =Docgenerator::Environments::Environment
26
+
27
+ Docgenerator::Environments::Environment does not contain attributes
28
+
29
+
30
+ Docgenerator::Environments::Environment can contain content.
31
+
32
+ ==Generate an object
33
+ test = Docgenerator::Environments::Environment.new( {}, 'content')
34
+
35
+ Alternative generation
36
+ test = element(:environment, {}, 'content' )
37
+
38
+
39
+ ==Outputs
40
+ ===Docgenerator::Environments::Environment#to_latex
41
+ \environment{content}
42
+
43
+ * No output routine defined for latex - use a dummy
44
+ ===Docgenerator::Environments::Environment#to_html
45
+ <span >content</span>
46
+
47
+ * No output routine defined for html - use a dummy
48
+ ===Docgenerator::Environments::Environment#to_context
49
+ \environment{content}
50
+
51
+ * No output routine defined for context - use a dummy
52
+ ===Docgenerator::Environments::Environment#to_text
53
+ content
54
+
55
+ * No output routine defined for text - use a dummy
56
+ ===Docgenerator::Environments::Environment#to_wiki
57
+ content
58
+
59
+
60
+ * No output routine defined for wiki - use a dummy
61
+ ===Docgenerator::Environments::Environment#to_creole
62
+ content
63
+
64
+
65
+ * No output routine defined for creole - use a dummy
66
+ =end
67
+ class Environment << Docgenerator::Element
68
+ #This coding is empty - this is the manpage definition, not the implementation
69
+ end #class Environment
70
+ end #module Environments
71
+ end #module Docgenerator
72
+ module Docgenerator
73
+ module Environments
74
+ =begin rdoc
75
+ =Docgenerator::Environments::Minipage
76
+
77
+ ==Attributes
78
+ Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
79
+ ====================================================================================================
80
+ width : - X X - - - - -
81
+ pos : - - X - - - - -
82
+
83
+
84
+ Docgenerator::Environments::Minipage can contain content.
85
+
86
+ ==Generate an object
87
+ test = Docgenerator::Environments::Minipage.new( {
88
+ #:width => <<value>>, % optional, values: [String]
89
+ #:pos => <<value>>, % optional, values: ["b", "t"]
90
+ }, 'content')
91
+
92
+ Alternative generation
93
+ test = element(:minipage, {...Attributes...}, 'content' )
94
+
95
+
96
+ ==Outputs
97
+ ===Docgenerator::Environments::Minipage#to_latex
98
+ \begin{minipage}[]{}content\end{minipage}
99
+
100
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Minipage#.to_latex
101
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
102
+
103
+ Default:
104
+ <<START>>\begin{minipage}[]{}content\end{minipage}<<END>>
105
+
106
+ * Result after Docgenerator::Environments::Minipage#cr:
107
+
108
+ <<START>>\begin{minipage}[]{}content\end{minipage}
109
+ <<END>>
110
+
111
+ * Result after Docgenerator::Environments::Minipage#cR:
112
+
113
+ <<START>>\begin{minipage}[]{}
114
+ content
115
+ \end{minipage}
116
+ <<END>>
117
+
118
+ * Result after Docgenerator::Environments::Minipage#Cr:
119
+
120
+ <<START>>
121
+ \begin{minipage}[]{}
122
+ content
123
+ \end{minipage}
124
+ <<END>>
125
+
126
+ * Result after Docgenerator::Environments::Minipage#CR:
127
+
128
+ <<START>>
129
+ \begin{minipage}[]{}
130
+ content
131
+ \end{minipage}
132
+ <<END>>
133
+
134
+ ===Docgenerator::Environments::Minipage#to_html
135
+ <div >content</div>
136
+
137
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Minipage#.to_html
138
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
139
+
140
+ Default:
141
+ <<START>><div >content</div><<END>>
142
+
143
+ * Result after Docgenerator::Environments::Minipage#cr:
144
+
145
+ <<START>><div >content</div>
146
+ <<END>>
147
+
148
+ * Result after Docgenerator::Environments::Minipage#cR:
149
+
150
+ <<START>><div >
151
+ content
152
+ </div>
153
+ <<END>>
154
+
155
+ * Result after Docgenerator::Environments::Minipage#Cr:
156
+
157
+ <<START>>
158
+ <div >
159
+ content
160
+ </div>
161
+ <<END>>
162
+
163
+ * Result after Docgenerator::Environments::Minipage#CR:
164
+
165
+ <<START>>
166
+ <div >
167
+ content
168
+ </div>
169
+ <<END>>
170
+
171
+ ===Docgenerator::Environments::Minipage#to_context
172
+ \minipage{content}
173
+
174
+ * No output routine defined for context - use a dummy
175
+ ===Docgenerator::Environments::Minipage#to_text
176
+ content
177
+
178
+ * No output routine defined for text - use a dummy
179
+ ===Docgenerator::Environments::Minipage#to_wiki
180
+ content
181
+
182
+
183
+ * No output routine defined for wiki - use a dummy
184
+ ===Docgenerator::Environments::Minipage#to_creole
185
+ content
186
+
187
+
188
+ * No output routine defined for creole - use a dummy
189
+ =end
190
+ class Minipage << Docgenerator::Element
191
+ #This coding is empty - this is the manpage definition, not the implementation
192
+ end #class Minipage
193
+ end #module Environments
194
+ end #module Docgenerator
195
+ module Docgenerator
196
+ module Environments
197
+ =begin rdoc
198
+ =Docgenerator::Environments::Center
199
+
200
+ ==Attributes
201
+ Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
202
+ ====================================================================================================
203
+ id : - X - - - - - -
204
+ class : - X - - - - - -
205
+ style : - X - - - - - -
206
+ title : - X - - - - - -
207
+
208
+
209
+ Docgenerator::Environments::Center can contain content.
210
+
211
+ ==Generate an object
212
+ test = Docgenerator::Environments::Center.new( {
213
+ #:id => <<value>>, % optional
214
+ #:class => <<value>>, % optional
215
+ #:style => <<value>>, % optional, values: [Docgenerator::CSS, String]
216
+ #:title => <<value>>, % optional
217
+ }, 'content')
218
+
219
+ Alternative generation
220
+ test = element(:center, {...Attributes...}, 'content' )
221
+
222
+
223
+ ==Outputs
224
+ ===Docgenerator::Environments::Center#to_latex
225
+ \begin{center}content\end{center}
226
+
227
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Center#.to_latex
228
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
229
+
230
+ Default:
231
+ <<START>>\begin{center}content\end{center}<<END>>
232
+
233
+ * Result after Docgenerator::Environments::Center#cr:
234
+
235
+ <<START>>\begin{center}content\end{center}
236
+ <<END>>
237
+
238
+ * Result after Docgenerator::Environments::Center#cR:
239
+
240
+ <<START>>\begin{center}
241
+ content
242
+ \end{center}
243
+ <<END>>
244
+
245
+ * Result after Docgenerator::Environments::Center#Cr:
246
+
247
+ <<START>>
248
+ \begin{center}
249
+ content
250
+ \end{center}
251
+ <<END>>
252
+
253
+ * Result after Docgenerator::Environments::Center#CR:
254
+
255
+ <<START>>
256
+ \begin{center}
257
+ content
258
+ \end{center}
259
+ <<END>>
260
+
261
+ ===Docgenerator::Environments::Center#to_html
262
+ <center >content</center>
263
+
264
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Center#.to_html
265
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
266
+
267
+ Default:
268
+ <<START>><center >content</center><<END>>
269
+
270
+ * Result after Docgenerator::Environments::Center#cr:
271
+
272
+ <<START>><center >content</center>
273
+ <<END>>
274
+
275
+ * Result after Docgenerator::Environments::Center#cR:
276
+
277
+ <<START>><center >
278
+ content
279
+ </center>
280
+ <<END>>
281
+
282
+ * Result after Docgenerator::Environments::Center#Cr:
283
+
284
+ <<START>>
285
+ <center >
286
+ content
287
+ </center>
288
+ <<END>>
289
+
290
+ * Result after Docgenerator::Environments::Center#CR:
291
+
292
+ <<START>>
293
+ <center >
294
+ content
295
+ </center>
296
+ <<END>>
297
+
298
+ ===Docgenerator::Environments::Center#to_context
299
+ \center{content}
300
+
301
+ * No output routine defined for context - use a dummy
302
+ ===Docgenerator::Environments::Center#to_text
303
+ content
304
+
305
+ * No output routine defined for text - use a dummy
306
+ ===Docgenerator::Environments::Center#to_wiki
307
+ content
308
+
309
+
310
+ * No output routine defined for wiki - use a dummy
311
+ ===Docgenerator::Environments::Center#to_creole
312
+ content
313
+
314
+
315
+ * No output routine defined for creole - use a dummy
316
+ =end
317
+ class Center << Docgenerator::Element
318
+ #This coding is empty - this is the manpage definition, not the implementation
319
+ end #class Center
320
+ end #module Environments
321
+ end #module Docgenerator
322
+ module Docgenerator
323
+ module Environments
324
+ =begin rdoc
325
+ =Docgenerator::Environments::Quote
326
+
327
+ ==Attributes
328
+ Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
329
+ ====================================================================================================
330
+ id : - X - - - - - -
331
+ class : - X - - - - - -
332
+ style : - X - - - - - -
333
+ title : - X - - - - - -
334
+
335
+
336
+ Docgenerator::Environments::Quote can contain content.
337
+
338
+ ==Generate an object
339
+ test = Docgenerator::Environments::Quote.new( {
340
+ #:id => <<value>>, % optional
341
+ #:class => <<value>>, % optional
342
+ #:style => <<value>>, % optional, values: [Docgenerator::CSS, String]
343
+ #:title => <<value>>, % optional
344
+ }, 'content')
345
+
346
+ Alternative generation
347
+ test = element(:quote, {...Attributes...}, 'content' )
348
+ test = element(:blockquote, {...Attributes...}, 'content' )
349
+
350
+
351
+ ==Outputs
352
+ ===Docgenerator::Environments::Quote#to_latex
353
+ \begin{quote}content\end{quote}
354
+
355
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Quote#.to_latex
356
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
357
+
358
+ Default:
359
+ <<START>>\begin{quote}content\end{quote}<<END>>
360
+
361
+ * Result after Docgenerator::Environments::Quote#cr:
362
+
363
+ <<START>>\begin{quote}content\end{quote}
364
+ <<END>>
365
+
366
+ * Result after Docgenerator::Environments::Quote#cR:
367
+
368
+ <<START>>\begin{quote}
369
+ content
370
+ \end{quote}
371
+ <<END>>
372
+
373
+ * Result after Docgenerator::Environments::Quote#Cr:
374
+
375
+ <<START>>
376
+ \begin{quote}
377
+ content
378
+ \end{quote}
379
+ <<END>>
380
+
381
+ * Result after Docgenerator::Environments::Quote#CR:
382
+
383
+ <<START>>
384
+ \begin{quote}
385
+ content
386
+ \end{quote}
387
+ <<END>>
388
+
389
+ ===Docgenerator::Environments::Quote#to_html
390
+ <blockquote >content</blockquote>
391
+
392
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Quote#.to_html
393
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
394
+
395
+ Default:
396
+ <<START>><blockquote >content</blockquote><<END>>
397
+
398
+ * Result after Docgenerator::Environments::Quote#cr:
399
+
400
+ <<START>><blockquote >content</blockquote>
401
+ <<END>>
402
+
403
+ * Result after Docgenerator::Environments::Quote#cR:
404
+
405
+ <<START>><blockquote >
406
+ content
407
+ </blockquote>
408
+ <<END>>
409
+
410
+ * Result after Docgenerator::Environments::Quote#Cr:
411
+
412
+ <<START>>
413
+ <blockquote >
414
+ content
415
+ </blockquote>
416
+ <<END>>
417
+
418
+ * Result after Docgenerator::Environments::Quote#CR:
419
+
420
+ <<START>>
421
+ <blockquote >
422
+ content
423
+ </blockquote>
424
+ <<END>>
425
+
426
+ ===Docgenerator::Environments::Quote#to_context
427
+ \blockquote{content}
428
+
429
+ * No output routine defined for context - use a dummy
430
+ ===Docgenerator::Environments::Quote#to_text
431
+ content
432
+
433
+ * No output routine defined for text - use a dummy
434
+ ===Docgenerator::Environments::Quote#to_wiki
435
+ content
436
+
437
+
438
+ * No output routine defined for wiki - use a dummy
439
+ ===Docgenerator::Environments::Quote#to_creole
440
+ content
441
+
442
+
443
+ * No output routine defined for creole - use a dummy
444
+ =end
445
+ class Quote << Docgenerator::Element
446
+ #This coding is empty - this is the manpage definition, not the implementation
447
+ end #class Quote
448
+ end #module Environments
449
+ end #module Docgenerator
450
+ module Docgenerator
451
+ module Environments
452
+ =begin rdoc
453
+ =Docgenerator::Environments::Landscape
454
+
455
+ Docgenerator::Environments::Landscape does not contain attributes
456
+
457
+
458
+ Docgenerator::Environments::Landscape can contain content.
459
+
460
+ ==Generate an object
461
+ test = Docgenerator::Environments::Landscape.new( {}, 'content')
462
+
463
+ Alternative generation
464
+ test = element(:landscape, {}, 'content' )
465
+
466
+
467
+ ==Outputs
468
+ ===Docgenerator::Environments::Landscape#to_latex
469
+ \begin{landscape}content\end{landscape}
470
+
471
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Landscape#.to_latex
472
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
473
+
474
+ Default:
475
+ <<START>>\begin{landscape}content\end{landscape}<<END>>
476
+
477
+ * Result after Docgenerator::Environments::Landscape#cr:
478
+
479
+ <<START>>\begin{landscape}content\end{landscape}
480
+ <<END>>
481
+
482
+ * Result after Docgenerator::Environments::Landscape#cR:
483
+
484
+ <<START>>\begin{landscape}
485
+ content
486
+ \end{landscape}
487
+ <<END>>
488
+
489
+ * Result after Docgenerator::Environments::Landscape#Cr:
490
+
491
+ <<START>>
492
+ \begin{landscape}
493
+ content
494
+ \end{landscape}
495
+ <<END>>
496
+
497
+ * Result after Docgenerator::Environments::Landscape#CR:
498
+
499
+ <<START>>
500
+ \begin{landscape}
501
+ content
502
+ \end{landscape}
503
+ <<END>>
504
+
505
+ ===Docgenerator::Environments::Landscape#to_html
506
+ <span >content</span>
507
+
508
+ * No output routine defined for html - use a dummy
509
+ ===Docgenerator::Environments::Landscape#to_context
510
+ \landscape{content}
511
+
512
+ * No output routine defined for context - use a dummy
513
+ ===Docgenerator::Environments::Landscape#to_text
514
+ content
515
+
516
+ * No output routine defined for text - use a dummy
517
+ ===Docgenerator::Environments::Landscape#to_wiki
518
+ content
519
+
520
+
521
+ * No output routine defined for wiki - use a dummy
522
+ ===Docgenerator::Environments::Landscape#to_creole
523
+ content
524
+
525
+
526
+ * No output routine defined for creole - use a dummy
527
+ =end
528
+ class Landscape << Docgenerator::Element
529
+ #This coding is empty - this is the manpage definition, not the implementation
530
+ end #class Landscape
531
+ end #module Environments
532
+ end #module Docgenerator
533
+ module Docgenerator
534
+ module Environments
535
+ =begin rdoc
536
+ =Docgenerator::Environments::Verbatim
537
+
538
+ ==Attributes
539
+ Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
540
+ ====================================================================================================
541
+ width : - X - - - - - -
542
+ lang : - X - - - - - -
543
+ id : - X - - - - - -
544
+ class : - X - - - - - -
545
+ style : - X - - - - - -
546
+ title : - X - - - - - -
547
+ dir : - X - - - - - -
548
+ onclick : - X - - - - - -
549
+ ondblclick : - X - - - - - -
550
+ onmousedown : - X - - - - - -
551
+ onmouseup : - X - - - - - -
552
+ onmouseover : - X - - - - - -
553
+ onmousemove : - X - - - - - -
554
+ onmouseout : - X - - - - - -
555
+ onkeypress : - X - - - - - -
556
+ onkeyup : - X - - - - - -
557
+ onkeydown : - X - - - - - -
558
+
559
+
560
+ Docgenerator::Environments::Verbatim can contain content.
561
+
562
+ ==Generate an object
563
+ test = Docgenerator::Environments::Verbatim.new( {
564
+ #:width => <<value>>, % optional, values: [Integer]
565
+ #:lang => <<value>>, % optional, values: ["en", "de"]
566
+ #:id => <<value>>, % optional
567
+ #:class => <<value>>, % optional
568
+ #:style => <<value>>, % optional, values: [Docgenerator::CSS, String]
569
+ #:title => <<value>>, % optional
570
+ #:dir => <<value>>, % optional, values: ["ltr", "rtl"]
571
+ #:onclick => <<value>>, % optional
572
+ #:ondblclick => <<value>>, % optional
573
+ #:onmousedown => <<value>>, % optional
574
+ #:onmouseup => <<value>>, % optional
575
+ #:onmouseover => <<value>>, % optional
576
+ #:onmousemove => <<value>>, % optional
577
+ #:onmouseout => <<value>>, % optional
578
+ #:onkeypress => <<value>>, % optional
579
+ #:onkeyup => <<value>>, % optional
580
+ #:onkeydown => <<value>>, % optional
581
+ }, 'content')
582
+
583
+ Alternative generation
584
+ test = element(:verbatim, {...Attributes...}, 'content' )
585
+ test = element(:pre, {...Attributes...}, 'content' )
586
+
587
+
588
+ ==Outputs
589
+ ===Docgenerator::Environments::Verbatim#to_latex
590
+
591
+ \begin{verbatim}content\end{verbatim}
592
+
593
+
594
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Verbatim#.to_latex
595
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
596
+
597
+ Default:
598
+ <<START>>
599
+ \begin{verbatim}content\end{verbatim}
600
+ <<END>>
601
+
602
+ * Result after Docgenerator::Environments::Verbatim#cr:
603
+
604
+ <<START>>
605
+ \begin{verbatim}content\end{verbatim}
606
+
607
+ <<END>>
608
+
609
+ * Result after Docgenerator::Environments::Verbatim#cR:
610
+
611
+ <<START>>
612
+ \begin{verbatim}
613
+ content
614
+ \end{verbatim}
615
+
616
+ <<END>>
617
+
618
+ * Result after Docgenerator::Environments::Verbatim#Cr:
619
+
620
+ <<START>>
621
+
622
+ \begin{verbatim}
623
+ content
624
+ \end{verbatim}
625
+
626
+ <<END>>
627
+
628
+ * Result after Docgenerator::Environments::Verbatim#CR:
629
+
630
+ <<START>>
631
+
632
+ \begin{verbatim}
633
+ content
634
+ \end{verbatim}
635
+
636
+ <<END>>
637
+
638
+ ===Docgenerator::Environments::Verbatim#to_html
639
+ <pre>content</pre>
640
+
641
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Verbatim#.to_html
642
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
643
+
644
+ Default:
645
+ <<START>><pre>content</pre><<END>>
646
+
647
+ * Result after Docgenerator::Environments::Verbatim#cr:
648
+
649
+ <<START>><pre>content</pre>
650
+ <<END>>
651
+
652
+ * Result after Docgenerator::Environments::Verbatim#cR:
653
+
654
+ <<START>><pre>
655
+ content
656
+ </pre>
657
+ <<END>>
658
+
659
+ * Result after Docgenerator::Environments::Verbatim#Cr:
660
+
661
+ <<START>>
662
+ <pre>
663
+ content
664
+ </pre>
665
+ <<END>>
666
+
667
+ * Result after Docgenerator::Environments::Verbatim#CR:
668
+
669
+ <<START>>
670
+ <pre>
671
+ content
672
+ </pre>
673
+ <<END>>
674
+
675
+ ===Docgenerator::Environments::Verbatim#to_context
676
+ \pre{content}
677
+
678
+ * No output routine defined for context - use a dummy
679
+ ===Docgenerator::Environments::Verbatim#to_text
680
+ content
681
+
682
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Verbatim#.to_text
683
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
684
+
685
+ Default:
686
+ <<START>>content<<END>>
687
+
688
+ * Docgenerator::Environments::Verbatim#cr has no effect, same result as default
689
+ * Docgenerator::Environments::Verbatim#cR has no effect, same result as default
690
+ * Docgenerator::Environments::Verbatim#Cr has no effect, same result as default
691
+ * Docgenerator::Environments::Verbatim#CR has no effect, same result as default
692
+ ===Docgenerator::Environments::Verbatim#to_wiki
693
+ content
694
+
695
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Verbatim#.to_wiki
696
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
697
+
698
+ Default:
699
+ <<START>> content<<END>>
700
+
701
+ * Docgenerator::Environments::Verbatim#cr has no effect, same result as default
702
+ * Docgenerator::Environments::Verbatim#cR has no effect, same result as default
703
+ * Docgenerator::Environments::Verbatim#Cr has no effect, same result as default
704
+ * Docgenerator::Environments::Verbatim#CR has no effect, same result as default
705
+ ===Docgenerator::Environments::Verbatim#to_creole
706
+ {{{
707
+ content
708
+ }}}
709
+
710
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Verbatim#.to_creole
711
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
712
+
713
+ Default:
714
+ <<START>>{{{
715
+ content
716
+ }}}<<END>>
717
+
718
+ * Docgenerator::Environments::Verbatim#cr has no effect, same result as default
719
+ * Docgenerator::Environments::Verbatim#cR has no effect, same result as default
720
+ * Docgenerator::Environments::Verbatim#Cr has no effect, same result as default
721
+ * Docgenerator::Environments::Verbatim#CR has no effect, same result as default
722
+ =end
723
+ class Verbatim << Docgenerator::Environments::Environment
724
+ #This coding is empty - this is the manpage definition, not the implementation
725
+ end #class Verbatim
726
+ end #module Environments
727
+ end #module Docgenerator
728
+ module Docgenerator
729
+ module Environments
730
+ =begin rdoc
731
+ =Docgenerator::Environments::Figure
732
+
733
+ ==Attributes
734
+ Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
735
+ ====================================================================================================
736
+ lang : - X - - - - - -
737
+ id : - X - - - - - -
738
+ class : - X - - - - - -
739
+ style : - X - - - - - -
740
+ title : - X - - - - - -
741
+ dir : - X - - - - - -
742
+ onclick : - X - - - - - -
743
+ ondblclick : - X - - - - - -
744
+ onmousedown : - X - - - - - -
745
+ onmouseup : - X - - - - - -
746
+ onmouseover : - X - - - - - -
747
+ onmousemove : - X - - - - - -
748
+ onmouseout : - X - - - - - -
749
+ onkeypress : - X - - - - - -
750
+ onkeyup : - X - - - - - -
751
+ onkeydown : - X - - - - - -
752
+
753
+
754
+ Docgenerator::Environments::Figure can contain content.
755
+
756
+ ==Generate an object
757
+ test = Docgenerator::Environments::Figure.new( {
758
+ #:lang => <<value>>, % optional, values: ["en", "de"]
759
+ #:id => <<value>>, % optional
760
+ #:class => <<value>>, % optional
761
+ #:style => <<value>>, % optional, values: [Docgenerator::CSS, String]
762
+ #:title => <<value>>, % optional
763
+ #:dir => <<value>>, % optional, values: ["ltr", "rtl"]
764
+ #:onclick => <<value>>, % optional
765
+ #:ondblclick => <<value>>, % optional
766
+ #:onmousedown => <<value>>, % optional
767
+ #:onmouseup => <<value>>, % optional
768
+ #:onmouseover => <<value>>, % optional
769
+ #:onmousemove => <<value>>, % optional
770
+ #:onmouseout => <<value>>, % optional
771
+ #:onkeypress => <<value>>, % optional
772
+ #:onkeyup => <<value>>, % optional
773
+ #:onkeydown => <<value>>, % optional
774
+ }, 'content')
775
+
776
+ Alternative generation
777
+ test = element(:figure, {...Attributes...}, 'content' )
778
+
779
+
780
+ ==Outputs
781
+ ===Docgenerator::Environments::Figure#to_latex
782
+
783
+ \begin{figure}content\end{figure}
784
+
785
+
786
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Figure#.to_latex
787
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
788
+
789
+ Default:
790
+ <<START>>
791
+ \begin{figure}content\end{figure}
792
+ <<END>>
793
+
794
+ * Result after Docgenerator::Environments::Figure#cr:
795
+
796
+ <<START>>
797
+ \begin{figure}content\end{figure}
798
+
799
+ <<END>>
800
+
801
+ * Result after Docgenerator::Environments::Figure#cR:
802
+
803
+ <<START>>
804
+ \begin{figure}
805
+ content
806
+ \end{figure}
807
+
808
+ <<END>>
809
+
810
+ * Result after Docgenerator::Environments::Figure#Cr:
811
+
812
+ <<START>>
813
+
814
+ \begin{figure}
815
+ content
816
+ \end{figure}
817
+
818
+ <<END>>
819
+
820
+ * Result after Docgenerator::Environments::Figure#CR:
821
+
822
+ <<START>>
823
+
824
+ \begin{figure}
825
+ content
826
+ \end{figure}
827
+
828
+ <<END>>
829
+
830
+ ===Docgenerator::Environments::Figure#to_html
831
+ <div >content</div>
832
+
833
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Figure#.to_html
834
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
835
+
836
+ Default:
837
+ <<START>><div >content</div><<END>>
838
+
839
+ * Result after Docgenerator::Environments::Figure#cr:
840
+
841
+ <<START>><div >content</div>
842
+ <<END>>
843
+
844
+ * Result after Docgenerator::Environments::Figure#cR:
845
+
846
+ <<START>><div >
847
+ content
848
+ </div>
849
+ <<END>>
850
+
851
+ * Result after Docgenerator::Environments::Figure#Cr:
852
+
853
+ <<START>>
854
+ <div >
855
+ content
856
+ </div>
857
+ <<END>>
858
+
859
+ * Result after Docgenerator::Environments::Figure#CR:
860
+
861
+ <<START>>
862
+ <div >
863
+ content
864
+ </div>
865
+ <<END>>
866
+
867
+ ===Docgenerator::Environments::Figure#to_context
868
+ \figure{content}
869
+
870
+ * No output routine defined for context - use a dummy
871
+ ===Docgenerator::Environments::Figure#to_text
872
+ content
873
+
874
+ * No output routine defined for text - use a dummy
875
+ ===Docgenerator::Environments::Figure#to_wiki
876
+ content
877
+
878
+
879
+ * No output routine defined for wiki - use a dummy
880
+ ===Docgenerator::Environments::Figure#to_creole
881
+ content
882
+
883
+
884
+ * No output routine defined for creole - use a dummy
885
+ =end
886
+ class Figure << Docgenerator::Environments::Environment
887
+ #This coding is empty - this is the manpage definition, not the implementation
888
+ end #class Figure
889
+ end #module Environments
890
+ end #module Docgenerator
891
+ module Docgenerator
892
+ module Environments
893
+ =begin rdoc
894
+ =Docgenerator::Environments::Abstract
895
+
896
+ Docgenerator::Environments::Abstract does not contain attributes
897
+
898
+
899
+ Docgenerator::Environments::Abstract can contain content.
900
+
901
+ ==Generate an object
902
+ test = Docgenerator::Environments::Abstract.new( {}, 'content')
903
+
904
+ Alternative generation
905
+ test = element(:abstract, {}, 'content' )
906
+
907
+
908
+ ==Outputs
909
+ ===Docgenerator::Environments::Abstract#to_latex
910
+
911
+ \begin{abstract}content\end{abstract}
912
+
913
+
914
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Environments::Abstract#.to_latex
915
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
916
+
917
+ Default:
918
+ <<START>>
919
+ \begin{abstract}content\end{abstract}
920
+ <<END>>
921
+
922
+ * Result after Docgenerator::Environments::Abstract#cr:
923
+
924
+ <<START>>
925
+ \begin{abstract}content\end{abstract}
926
+
927
+ <<END>>
928
+
929
+ * Result after Docgenerator::Environments::Abstract#cR:
930
+
931
+ <<START>>
932
+ \begin{abstract}
933
+ content
934
+ \end{abstract}
935
+
936
+ <<END>>
937
+
938
+ * Result after Docgenerator::Environments::Abstract#Cr:
939
+
940
+ <<START>>
941
+
942
+ \begin{abstract}
943
+ content
944
+ \end{abstract}
945
+
946
+ <<END>>
947
+
948
+ * Result after Docgenerator::Environments::Abstract#CR:
949
+
950
+ <<START>>
951
+
952
+ \begin{abstract}
953
+ content
954
+ \end{abstract}
955
+
956
+ <<END>>
957
+
958
+ ===Docgenerator::Environments::Abstract#to_html
959
+ <span >content</span>
960
+
961
+ * No output routine defined for html - use a dummy
962
+ ===Docgenerator::Environments::Abstract#to_context
963
+ \abstract{content}
964
+
965
+ * No output routine defined for context - use a dummy
966
+ ===Docgenerator::Environments::Abstract#to_text
967
+ content
968
+
969
+ * No output routine defined for text - use a dummy
970
+ ===Docgenerator::Environments::Abstract#to_wiki
971
+ content
972
+
973
+
974
+ * No output routine defined for wiki - use a dummy
975
+ ===Docgenerator::Environments::Abstract#to_creole
976
+ content
977
+
978
+
979
+ * No output routine defined for creole - use a dummy
980
+ =end
981
+ class Abstract << Docgenerator::Environments::Environment
982
+ #This coding is empty - this is the manpage definition, not the implementation
983
+ end #class Abstract
984
+ end #module Environments
985
+ end #module Docgenerator