docgenerator 2.0.0 → 2.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/examples/creole_example_tabular.rb +95 -0
- data/examples/docgenerator_example.rb +5 -5
- data/lib/creole/creole2doc.rb +28 -18
- data/lib/creole/creole_inclusions.rb +4 -4
- data/lib/creole/creole_placeholder.rb +4 -1
- data/lib/creole/creole_tabular.rb +173 -155
- data/lib/creole/plugins/rail.rb +118 -119
- data/lib/creole/plugins/struktex.rb +35 -35
- data/lib/creole/plugins/todonotes.rb +8 -1
- data/lib/docgenerator/attribute.rb +160 -160
- data/lib/docgenerator/characters.rb +343 -311
- data/lib/docgenerator/css.rb +167 -167
- data/lib/docgenerator/document.rb +525 -511
- data/lib/docgenerator/element.rb +316 -316
- data/lib/docgenerator/element_meta.rb +114 -114
- data/lib/docgenerator/elements.rb +19 -9
- data/lib/docgenerator/environments.rb +3 -1
- data/lib/docgenerator/lists.rb +177 -174
- data/lib/docgenerator/packages/hyperref.rb +74 -70
- data/lib/docgenerator/packages/multicol.rb +33 -0
- data/lib/docgenerator/packages/scrlettr2.rb +152 -151
- data/lib/docgenerator/packages/todonotes.rb +1 -1
- data/lib/docgenerator/tabular.rb +463 -400
- data/lib/docgenerator/templates/docgenerator_template.rb +94 -84
- data/lib/docgenerator/templates/docgenerator_template.yaml +75 -15
- data/lib/docgenerator.rb +1 -1
- data/lib/wiki2doc/wiki2docgenerator.rb +1 -1
- data/meta_test_and_doc/build__meta.rb +125 -0
- data/meta_test_and_doc/build_doc.rb +333 -0
- data/meta_test_and_doc/build_test.rb +251 -0
- data/meta_test_and_doc/manpages/attachfile.rb +389 -0
- data/meta_test_and_doc/manpages/caption.rb +133 -0
- data/meta_test_and_doc/manpages/characters.rb +3738 -0
- data/meta_test_and_doc/manpages/elements.rb +6851 -0
- data/meta_test_and_doc/manpages/environments.rb +985 -0
- data/meta_test_and_doc/manpages/footnote.rb +439 -0
- data/meta_test_and_doc/manpages/hyperref.rb +605 -0
- data/meta_test_and_doc/manpages/listings.rb +988 -0
- data/meta_test_and_doc/manpages/lists.rb +1463 -0
- data/meta_test_and_doc/manpages/others.rb +129 -0
- data/meta_test_and_doc/manpages/packages.rb +13 -0
- data/meta_test_and_doc/manpages/pdfpages.rb +108 -0
- data/meta_test_and_doc/manpages/readme.rdoc +9 -0
- data/meta_test_and_doc/manpages/scrlettr2.rb +362 -0
- data/meta_test_and_doc/manpages/scrpage2.rb +2028 -0
- data/meta_test_and_doc/manpages/sectioning.rb +2467 -0
- data/meta_test_and_doc/manpages/tables.rb +2088 -0
- data/meta_test_and_doc/manpages/todonotes.rb +235 -0
- data/meta_test_and_doc/manpages/wiki2docgenerator.rb +64 -0
- data/{readme.rd → readme.rdoc} +18 -1
- data/unittest/expected/test_tabular.creole +33 -0
- data/unittest/expected_creole/test_creole_creole1.0test.html +3 -3
- data/unittest/expected_creole/test_creole_creole1.0test.latex +3 -3
- data/unittest/expected_creole/test_creole_creole1.0test.text +3 -3
- data/unittest/expected_creole/test_creole_inline_apostroph.html +6 -0
- data/unittest/expected_creole/test_creole_inline_apostroph.latex +8 -0
- data/unittest/expected_creole/test_creole_inline_apostroph.text +4 -0
- data/unittest/expected_creole/test_creole_input.normsource +12 -12
- data/unittest/expected_creole/test_creole_input.normsource_1.8 +23 -0
- data/unittest/expected_creole/test_creole_links_external_implicit.html +2 -2
- data/unittest/expected_creole/test_creole_links_external_implicit.latex +2 -2
- data/unittest/expected_creole/test_creole_links_external_implicit.text +2 -2
- data/unittest/expected_creole/test_creole_links_implicit_end.html +1 -1
- data/unittest/expected_creole/test_creole_links_implicit_end.latex +1 -1
- data/unittest/expected_creole/test_creole_list_ul.normsource +42 -42
- data/unittest/expected_creole/test_creole_list_ul.normsource_1.8 +83 -0
- data/unittest/expected_creole/test_creole_paragraphs.normsource +15 -15
- data/unittest/expected_creole/test_creole_paragraphs.normsource_1.8 +27 -0
- data/unittest/expected_creole/test_creole_tabular.creole +22 -0
- data/unittest/expected_creole/test_creole_tabular_creole.creole +19 -0
- data/unittest/expected_creole/test_creole_tabular_css.creole +24 -0
- data/unittest/expected_creole/test_creole_tabular_multicols.creole +16 -0
- data/unittest/expected_creole/test_creole_tabular_multicols.html +14 -0
- data/unittest/expected_creole/test_creole_tabular_multicols.latex +16 -0
- data/unittest/expected_creole/test_creole_tabular_with_cell_option.creole +21 -0
- data/unittest/expected_creole/test_creole_toc_level_text.html +2 -2
- data/unittest/expected_creole/test_creole_toc_level_text.latex +2 -2
- data/unittest/expected_packages/test_multicol_3.tex +2 -0
- data/unittest/expected_packages/test_multicol_3_titleline.tex +2 -0
- data/unittest/expected_templates/test_article.tex +23 -0
- data/unittest/expected_templates/test_article_utf8.tex +34 -0
- data/unittest/expected_templates/test_context.miv +18 -0
- data/unittest/expected_templates/test_creole.creole +8 -0
- data/unittest/expected_templates/test_html.html +12 -0
- data/unittest/expected_templates/test_html401_strict.html +14 -0
- data/unittest/expected_templates/test_html401_trans.html +14 -0
- data/unittest/expected_templates/test_html_utf8.html +14 -0
- data/unittest/expected_templates/test_include.tex +17 -0
- data/unittest/expected_templates/test_include_utf8.tex +17 -0
- data/unittest/expected_templates/test_text.txt +6 -0
- data/unittest/expected_templates/test_wiki.wiki +6 -0
- data/unittest/expected_templates/test_xhtml_strict.html +14 -0
- data/unittest/expected_templates/test_xhtml_trans.html +14 -0
- data/unittest/unittest_creole.rb +27 -6
- data/unittest/unittest_creole_placeholders.rb +1 -123
- data/unittest/unittest_creole_tabular.rb +174 -0
- data/unittest/unittest_docgenerator.rb +4 -3
- data/unittest/unittest_docgenerator_characters.rb +4769 -615
- data/unittest/unittest_packages_multicol.rb +84 -0
- data/unittest/unittest_rubycode4doc.rb +0 -1
- data/unittest/unittest_templates.rb +64 -0
- metadata +163 -77
- data/build_test_and_doc.rb +0 -505
- data/manpage_elements.rb +0 -10411
@@ -0,0 +1,389 @@
|
|
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::Packages::Attachfile::Attachfile
|
12
|
+
* Docgenerator::Packages::Attachfile::Noattachfile
|
13
|
+
* Docgenerator::Packages::Attachfile::Textattachfile
|
14
|
+
* Docgenerator::Packages::Attachfile::Notextattachfile
|
15
|
+
=end
|
16
|
+
|
17
|
+
#
|
18
|
+
module Docgenerator
|
19
|
+
module Packages
|
20
|
+
module Attachfile
|
21
|
+
=begin rdoc
|
22
|
+
=Docgenerator::Packages::Attachfile::Attachfile
|
23
|
+
|
24
|
+
==Attributes
|
25
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
26
|
+
====================================================================================================
|
27
|
+
author : - - - X - - - -
|
28
|
+
description : - - - X - - - -
|
29
|
+
subject : - - - X - - - -
|
30
|
+
icon : - - - X - - - -
|
31
|
+
mimetype : - - - X - - - -
|
32
|
+
|
33
|
+
|
34
|
+
Docgenerator::Packages::Attachfile::Attachfile can contain content.
|
35
|
+
|
36
|
+
==Generate an object
|
37
|
+
test = Docgenerator::Packages::Attachfile::Attachfile.new( {
|
38
|
+
#:author => <<value>>, % optional, values: [String]
|
39
|
+
#:description => <<value>>, % optional, values: [String]
|
40
|
+
#:subject => <<value>>, % optional, values: [String]
|
41
|
+
#:icon => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
|
42
|
+
#:mimetype => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
|
43
|
+
}, 'content')
|
44
|
+
|
45
|
+
Alternative generation
|
46
|
+
test = element(:attachfile, {...Attributes...}, 'content' )
|
47
|
+
|
48
|
+
|
49
|
+
==Outputs
|
50
|
+
===Docgenerator::Packages::Attachfile::Attachfile#to_latex
|
51
|
+
\attachfile[]{content}
|
52
|
+
|
53
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Attachfile#.to_latex
|
54
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
55
|
+
|
56
|
+
Default:
|
57
|
+
<<START>>\attachfile[]{content}<<END>>
|
58
|
+
|
59
|
+
* Result after Docgenerator::Packages::Attachfile::Attachfile#cr:
|
60
|
+
|
61
|
+
<<START>>\attachfile[]{content}
|
62
|
+
<<END>>
|
63
|
+
|
64
|
+
* Result after Docgenerator::Packages::Attachfile::Attachfile#cR:
|
65
|
+
|
66
|
+
<<START>>\attachfile[]{content}
|
67
|
+
<<END>>
|
68
|
+
|
69
|
+
* Result after Docgenerator::Packages::Attachfile::Attachfile#Cr:
|
70
|
+
|
71
|
+
<<START>>
|
72
|
+
\attachfile[]{content}
|
73
|
+
<<END>>
|
74
|
+
|
75
|
+
* Result after Docgenerator::Packages::Attachfile::Attachfile#CR:
|
76
|
+
|
77
|
+
<<START>>
|
78
|
+
\attachfile[]{content}
|
79
|
+
<<END>>
|
80
|
+
|
81
|
+
===Docgenerator::Packages::Attachfile::Attachfile#to_html
|
82
|
+
<span >content</span>
|
83
|
+
|
84
|
+
* No output routine defined for html - use a dummy
|
85
|
+
===Docgenerator::Packages::Attachfile::Attachfile#to_context
|
86
|
+
\attachfile{content}
|
87
|
+
|
88
|
+
* No output routine defined for context - use a dummy
|
89
|
+
===Docgenerator::Packages::Attachfile::Attachfile#to_text
|
90
|
+
content
|
91
|
+
|
92
|
+
* No output routine defined for text - use a dummy
|
93
|
+
===Docgenerator::Packages::Attachfile::Attachfile#to_wiki
|
94
|
+
content
|
95
|
+
|
96
|
+
|
97
|
+
* No output routine defined for wiki - use a dummy
|
98
|
+
===Docgenerator::Packages::Attachfile::Attachfile#to_creole
|
99
|
+
content
|
100
|
+
|
101
|
+
|
102
|
+
* No output routine defined for creole - use a dummy
|
103
|
+
=end
|
104
|
+
class Attachfile << Docgenerator::Element
|
105
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
106
|
+
end #class Attachfile
|
107
|
+
end #module Attachfile
|
108
|
+
end #module Packages
|
109
|
+
end #module Docgenerator
|
110
|
+
module Docgenerator
|
111
|
+
module Packages
|
112
|
+
module Attachfile
|
113
|
+
=begin rdoc
|
114
|
+
=Docgenerator::Packages::Attachfile::Noattachfile
|
115
|
+
|
116
|
+
==Attributes
|
117
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
118
|
+
====================================================================================================
|
119
|
+
author : - - - X - - - -
|
120
|
+
description : - - - X - - - -
|
121
|
+
subject : - - - X - - - -
|
122
|
+
icon : - - - X - - - -
|
123
|
+
mimetype : - - - X - - - -
|
124
|
+
|
125
|
+
|
126
|
+
Docgenerator::Packages::Attachfile::Noattachfile allows no content.
|
127
|
+
|
128
|
+
==Generate an object
|
129
|
+
test = Docgenerator::Packages::Attachfile::Noattachfile.new( {
|
130
|
+
#:author => <<value>>, % optional, values: [String]
|
131
|
+
#:description => <<value>>, % optional, values: [String]
|
132
|
+
#:subject => <<value>>, % optional, values: [String]
|
133
|
+
#:icon => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
|
134
|
+
#:mimetype => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
|
135
|
+
})
|
136
|
+
|
137
|
+
Alternative generation
|
138
|
+
test = element(:noattachfile, {...Attributes...})
|
139
|
+
|
140
|
+
|
141
|
+
==Outputs
|
142
|
+
===Docgenerator::Packages::Attachfile::Noattachfile#to_latex
|
143
|
+
\noattachfile[]
|
144
|
+
|
145
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Noattachfile#.to_latex
|
146
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
147
|
+
|
148
|
+
Default:
|
149
|
+
<<START>>\noattachfile[]<<END>>
|
150
|
+
|
151
|
+
* Result after Docgenerator::Packages::Attachfile::Noattachfile#cr:
|
152
|
+
|
153
|
+
<<START>>\noattachfile[]
|
154
|
+
<<END>>
|
155
|
+
|
156
|
+
* Result after Docgenerator::Packages::Attachfile::Noattachfile#cR:
|
157
|
+
|
158
|
+
<<START>>\noattachfile[]
|
159
|
+
<<END>>
|
160
|
+
|
161
|
+
* Result after Docgenerator::Packages::Attachfile::Noattachfile#Cr:
|
162
|
+
|
163
|
+
<<START>>
|
164
|
+
\noattachfile[]
|
165
|
+
<<END>>
|
166
|
+
|
167
|
+
* Result after Docgenerator::Packages::Attachfile::Noattachfile#CR:
|
168
|
+
|
169
|
+
<<START>>
|
170
|
+
\noattachfile[]
|
171
|
+
<<END>>
|
172
|
+
|
173
|
+
===Docgenerator::Packages::Attachfile::Noattachfile#to_html
|
174
|
+
<span />
|
175
|
+
|
176
|
+
* No output routine defined for html - use a dummy
|
177
|
+
===Docgenerator::Packages::Attachfile::Noattachfile#to_context
|
178
|
+
\noattachfile{}
|
179
|
+
|
180
|
+
* No output routine defined for context - use a dummy
|
181
|
+
===Docgenerator::Packages::Attachfile::Noattachfile#to_text
|
182
|
+
|
183
|
+
|
184
|
+
* No output routine defined for text - use a dummy
|
185
|
+
===Docgenerator::Packages::Attachfile::Noattachfile#to_wiki
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
* No output routine defined for wiki - use a dummy
|
190
|
+
===Docgenerator::Packages::Attachfile::Noattachfile#to_creole
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
* No output routine defined for creole - use a dummy
|
195
|
+
=end
|
196
|
+
class Noattachfile << Docgenerator::Element
|
197
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
198
|
+
end #class Noattachfile
|
199
|
+
end #module Attachfile
|
200
|
+
end #module Packages
|
201
|
+
end #module Docgenerator
|
202
|
+
module Docgenerator
|
203
|
+
module Packages
|
204
|
+
module Attachfile
|
205
|
+
=begin rdoc
|
206
|
+
=Docgenerator::Packages::Attachfile::Textattachfile
|
207
|
+
|
208
|
+
==Attributes
|
209
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
210
|
+
====================================================================================================
|
211
|
+
author : - - - X - - - -
|
212
|
+
description : - - - X - - - -
|
213
|
+
subject : - - - X - - - -
|
214
|
+
icon : - - - X - - - -
|
215
|
+
mimetype : - - - X - - - -
|
216
|
+
text : - - - - - - - -
|
217
|
+
|
218
|
+
|
219
|
+
Docgenerator::Packages::Attachfile::Textattachfile can contain content.
|
220
|
+
|
221
|
+
==Generate an object
|
222
|
+
test = Docgenerator::Packages::Attachfile::Textattachfile.new( {
|
223
|
+
#:author => <<value>>, % optional, values: [String]
|
224
|
+
#:description => <<value>>, % optional, values: [String]
|
225
|
+
#:subject => <<value>>, % optional, values: [String]
|
226
|
+
#:icon => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
|
227
|
+
#:mimetype => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
|
228
|
+
#:text => <<value>>, % optional, values: [String]
|
229
|
+
}, 'content')
|
230
|
+
|
231
|
+
Alternative generation
|
232
|
+
test = element(:textattachfile, {...Attributes...}, 'content' )
|
233
|
+
|
234
|
+
|
235
|
+
==Outputs
|
236
|
+
===Docgenerator::Packages::Attachfile::Textattachfile#to_latex
|
237
|
+
\textattachfile[]{content}{}
|
238
|
+
|
239
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Textattachfile#.to_latex
|
240
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
241
|
+
|
242
|
+
Default:
|
243
|
+
<<START>>\textattachfile[]{content}{}<<END>>
|
244
|
+
|
245
|
+
* Result after Docgenerator::Packages::Attachfile::Textattachfile#cr:
|
246
|
+
|
247
|
+
<<START>>\textattachfile[]{content}{}
|
248
|
+
<<END>>
|
249
|
+
|
250
|
+
* Result after Docgenerator::Packages::Attachfile::Textattachfile#cR:
|
251
|
+
|
252
|
+
<<START>>\textattachfile[]{content}{}
|
253
|
+
<<END>>
|
254
|
+
|
255
|
+
* Result after Docgenerator::Packages::Attachfile::Textattachfile#Cr:
|
256
|
+
|
257
|
+
<<START>>
|
258
|
+
\textattachfile[]{content}{}
|
259
|
+
<<END>>
|
260
|
+
|
261
|
+
* Result after Docgenerator::Packages::Attachfile::Textattachfile#CR:
|
262
|
+
|
263
|
+
<<START>>
|
264
|
+
\textattachfile[]{content}{}
|
265
|
+
<<END>>
|
266
|
+
|
267
|
+
===Docgenerator::Packages::Attachfile::Textattachfile#to_html
|
268
|
+
<span >content</span>
|
269
|
+
|
270
|
+
* No output routine defined for html - use a dummy
|
271
|
+
===Docgenerator::Packages::Attachfile::Textattachfile#to_context
|
272
|
+
\textattachfile{content}
|
273
|
+
|
274
|
+
* No output routine defined for context - use a dummy
|
275
|
+
===Docgenerator::Packages::Attachfile::Textattachfile#to_text
|
276
|
+
content
|
277
|
+
|
278
|
+
* No output routine defined for text - use a dummy
|
279
|
+
===Docgenerator::Packages::Attachfile::Textattachfile#to_wiki
|
280
|
+
content
|
281
|
+
|
282
|
+
|
283
|
+
* No output routine defined for wiki - use a dummy
|
284
|
+
===Docgenerator::Packages::Attachfile::Textattachfile#to_creole
|
285
|
+
content
|
286
|
+
|
287
|
+
|
288
|
+
* No output routine defined for creole - use a dummy
|
289
|
+
=end
|
290
|
+
class Textattachfile << Docgenerator::Element
|
291
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
292
|
+
end #class Textattachfile
|
293
|
+
end #module Attachfile
|
294
|
+
end #module Packages
|
295
|
+
end #module Docgenerator
|
296
|
+
module Docgenerator
|
297
|
+
module Packages
|
298
|
+
module Attachfile
|
299
|
+
=begin rdoc
|
300
|
+
=Docgenerator::Packages::Attachfile::Notextattachfile
|
301
|
+
|
302
|
+
==Attributes
|
303
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
304
|
+
====================================================================================================
|
305
|
+
author : - - - X - - - -
|
306
|
+
description : - - - X - - - -
|
307
|
+
subject : - - - X - - - -
|
308
|
+
icon : - - - X - - - -
|
309
|
+
mimetype : - - - X - - - -
|
310
|
+
text : - - - - - - - -
|
311
|
+
|
312
|
+
|
313
|
+
Docgenerator::Packages::Attachfile::Notextattachfile allows no content.
|
314
|
+
|
315
|
+
==Generate an object
|
316
|
+
test = Docgenerator::Packages::Attachfile::Notextattachfile.new( {
|
317
|
+
#:author => <<value>>, % optional, values: [String]
|
318
|
+
#:description => <<value>>, % optional, values: [String]
|
319
|
+
#:subject => <<value>>, % optional, values: [String]
|
320
|
+
#:icon => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
|
321
|
+
#:mimetype => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
|
322
|
+
#:text => <<value>>, % optional, values: [String]
|
323
|
+
})
|
324
|
+
|
325
|
+
Alternative generation
|
326
|
+
test = element(:notextattachfile, {...Attributes...})
|
327
|
+
|
328
|
+
|
329
|
+
==Outputs
|
330
|
+
===Docgenerator::Packages::Attachfile::Notextattachfile#to_latex
|
331
|
+
\notextattachfile[]{}
|
332
|
+
|
333
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Notextattachfile#.to_latex
|
334
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
335
|
+
|
336
|
+
Default:
|
337
|
+
<<START>>\notextattachfile[]{}<<END>>
|
338
|
+
|
339
|
+
* Result after Docgenerator::Packages::Attachfile::Notextattachfile#cr:
|
340
|
+
|
341
|
+
<<START>>\notextattachfile[]{}
|
342
|
+
<<END>>
|
343
|
+
|
344
|
+
* Result after Docgenerator::Packages::Attachfile::Notextattachfile#cR:
|
345
|
+
|
346
|
+
<<START>>\notextattachfile[]{}
|
347
|
+
<<END>>
|
348
|
+
|
349
|
+
* Result after Docgenerator::Packages::Attachfile::Notextattachfile#Cr:
|
350
|
+
|
351
|
+
<<START>>
|
352
|
+
\notextattachfile[]{}
|
353
|
+
<<END>>
|
354
|
+
|
355
|
+
* Result after Docgenerator::Packages::Attachfile::Notextattachfile#CR:
|
356
|
+
|
357
|
+
<<START>>
|
358
|
+
\notextattachfile[]{}
|
359
|
+
<<END>>
|
360
|
+
|
361
|
+
===Docgenerator::Packages::Attachfile::Notextattachfile#to_html
|
362
|
+
<span />
|
363
|
+
|
364
|
+
* No output routine defined for html - use a dummy
|
365
|
+
===Docgenerator::Packages::Attachfile::Notextattachfile#to_context
|
366
|
+
\notextattachfile{}
|
367
|
+
|
368
|
+
* No output routine defined for context - use a dummy
|
369
|
+
===Docgenerator::Packages::Attachfile::Notextattachfile#to_text
|
370
|
+
|
371
|
+
|
372
|
+
* No output routine defined for text - use a dummy
|
373
|
+
===Docgenerator::Packages::Attachfile::Notextattachfile#to_wiki
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
* No output routine defined for wiki - use a dummy
|
378
|
+
===Docgenerator::Packages::Attachfile::Notextattachfile#to_creole
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
* No output routine defined for creole - use a dummy
|
383
|
+
=end
|
384
|
+
class Notextattachfile << Docgenerator::Element
|
385
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
386
|
+
end #class Notextattachfile
|
387
|
+
end #module Attachfile
|
388
|
+
end #module Packages
|
389
|
+
end #module Docgenerator
|
@@ -0,0 +1,133 @@
|
|
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::Packages::Caption::Captionof
|
12
|
+
=end
|
13
|
+
|
14
|
+
#
|
15
|
+
module Docgenerator
|
16
|
+
module Packages
|
17
|
+
module Caption
|
18
|
+
=begin rdoc
|
19
|
+
=Docgenerator::Packages::Caption::Captionof
|
20
|
+
|
21
|
+
==Attributes
|
22
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
23
|
+
====================================================================================================
|
24
|
+
float_type : X - X - - - - -
|
25
|
+
lst_entry : - - - - - - - -
|
26
|
+
|
27
|
+
|
28
|
+
Docgenerator::Packages::Caption::Captionof can contain content.
|
29
|
+
|
30
|
+
==Generate an object
|
31
|
+
test = Docgenerator::Packages::Caption::Captionof.new( {
|
32
|
+
:float_type => <<value>>, % required, values: ["figure", "table"]
|
33
|
+
#:lst_entry => <<value>>, % optional, values: [String]
|
34
|
+
}, 'content')
|
35
|
+
|
36
|
+
Alternative generation
|
37
|
+
test = element(:captionof, {...Attributes...}, 'content' )
|
38
|
+
|
39
|
+
|
40
|
+
==Outputs
|
41
|
+
===Docgenerator::Packages::Caption::Captionof#to_latex
|
42
|
+
\captionof{Value for float_type}{["content"]}
|
43
|
+
|
44
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Caption::Captionof#.to_latex
|
45
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
46
|
+
|
47
|
+
Default:
|
48
|
+
<<START>>\captionof{Value for float_type}{["content"]}<<END>>
|
49
|
+
|
50
|
+
* Result after Docgenerator::Packages::Caption::Captionof#cr:
|
51
|
+
|
52
|
+
<<START>>\captionof{Value for float_type}{["content"]}
|
53
|
+
<<END>>
|
54
|
+
|
55
|
+
* Result after Docgenerator::Packages::Caption::Captionof#cR:
|
56
|
+
|
57
|
+
<<START>>\captionof{Value for float_type}{["content"]}
|
58
|
+
<<END>>
|
59
|
+
|
60
|
+
* Result after Docgenerator::Packages::Caption::Captionof#Cr:
|
61
|
+
|
62
|
+
<<START>>
|
63
|
+
\captionof{Value for float_type}{["content"]}
|
64
|
+
<<END>>
|
65
|
+
|
66
|
+
* Result after Docgenerator::Packages::Caption::Captionof#CR:
|
67
|
+
|
68
|
+
<<START>>
|
69
|
+
\captionof{Value for float_type}{["content"]}
|
70
|
+
<<END>>
|
71
|
+
|
72
|
+
===Docgenerator::Packages::Caption::Captionof#to_html
|
73
|
+
<span >content</span>
|
74
|
+
|
75
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Caption::Captionof#.to_html
|
76
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
77
|
+
|
78
|
+
Default:
|
79
|
+
<<START>><span >content</span><<END>>
|
80
|
+
|
81
|
+
* Result after Docgenerator::Packages::Caption::Captionof#cr:
|
82
|
+
|
83
|
+
<<START>><span >content</span>
|
84
|
+
<<END>>
|
85
|
+
|
86
|
+
* Result after Docgenerator::Packages::Caption::Captionof#cR:
|
87
|
+
|
88
|
+
<<START>><span >
|
89
|
+
content
|
90
|
+
</span>
|
91
|
+
<<END>>
|
92
|
+
|
93
|
+
* Result after Docgenerator::Packages::Caption::Captionof#Cr:
|
94
|
+
|
95
|
+
<<START>>
|
96
|
+
<span >
|
97
|
+
content
|
98
|
+
</span>
|
99
|
+
<<END>>
|
100
|
+
|
101
|
+
* Result after Docgenerator::Packages::Caption::Captionof#CR:
|
102
|
+
|
103
|
+
<<START>>
|
104
|
+
<span >
|
105
|
+
content
|
106
|
+
</span>
|
107
|
+
<<END>>
|
108
|
+
|
109
|
+
===Docgenerator::Packages::Caption::Captionof#to_context
|
110
|
+
\captionof{content}
|
111
|
+
|
112
|
+
* No output routine defined for context - use a dummy
|
113
|
+
===Docgenerator::Packages::Caption::Captionof#to_text
|
114
|
+
content
|
115
|
+
|
116
|
+
* No output routine defined for text - use a dummy
|
117
|
+
===Docgenerator::Packages::Caption::Captionof#to_wiki
|
118
|
+
content
|
119
|
+
|
120
|
+
|
121
|
+
* No output routine defined for wiki - use a dummy
|
122
|
+
===Docgenerator::Packages::Caption::Captionof#to_creole
|
123
|
+
content
|
124
|
+
|
125
|
+
|
126
|
+
* No output routine defined for creole - use a dummy
|
127
|
+
=end
|
128
|
+
class Captionof << Docgenerator::Element
|
129
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
130
|
+
end #class Captionof
|
131
|
+
end #module Caption
|
132
|
+
end #module Packages
|
133
|
+
end #module Docgenerator
|