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