docgenerator 2.1.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/examples/creole_example.rb +0 -1
- data/examples/creole_example_new_plugin.rb +51 -0
- data/examples/creole_example_tabular.rb +3 -1
- data/examples/wiki2docgenerator_example.rb +2 -2
- data/lib/creole/creole2doc.rb +697 -680
- data/lib/creole/creole_characters.rb +90 -26
- data/lib/creole/creole_inclusion_and_plugins.rb +25 -43
- data/lib/creole/creole_inclusions.rb +87 -75
- data/lib/creole/creole_placeholder.rb +87 -89
- data/lib/creole/creole_plugins.rb +149 -117
- data/lib/creole/creole_tabular.rb +247 -141
- data/lib/creole/plugins/todonotes.rb +48 -48
- data/lib/docgenerator/characters.rb +106 -8
- data/lib/docgenerator/compatibility_v1.rb +7 -1
- data/lib/docgenerator/document.rb +34 -19
- data/lib/docgenerator/element.rb +1 -0
- data/lib/docgenerator/element_meta.rb +1 -1
- data/lib/docgenerator/elements.rb +594 -535
- data/lib/docgenerator/environments.rb +131 -99
- data/lib/docgenerator/index.rb +110 -0
- data/lib/docgenerator/lists.rb +2 -1
- data/lib/docgenerator/packages/caption.rb +32 -34
- data/lib/docgenerator/packages/hyperref.rb +1 -0
- data/lib/docgenerator/packages/multicol.rb +3 -2
- data/lib/docgenerator/packages/pdfpages.rb +71 -20
- data/lib/docgenerator/packages/scrpage2.rb +99 -142
- data/lib/docgenerator/packages/url.rb +75 -81
- data/lib/docgenerator/sections.rb +98 -98
- data/lib/docgenerator/standard.rb +8 -1
- data/lib/docgenerator/tabular.rb +44 -25
- data/lib/docgenerator/templates/docgenerator_template.yaml +28 -0
- data/lib/docgenerator/version.rb +146 -0
- data/lib/docgenerator.rb +20 -15
- data/meta_test_and_doc/build_doc.rb +39 -10
- data/meta_test_and_doc/build_test.rb +34 -12
- data/meta_test_and_doc/manpages/characters.rb +452 -20
- data/meta_test_and_doc/manpages/elementlist.rb +304 -0
- data/meta_test_and_doc/manpages/elements.rb +305 -42
- data/meta_test_and_doc/manpages/others.rb +403 -0
- data/meta_test_and_doc/manpages/pdfpages.rb +117 -18
- data/meta_test_and_doc/manpages/readme.rdoc +3 -1
- data/meta_test_and_doc/manpages/scrpage2.rb +0 -80
- data/meta_test_and_doc/manpages/tables.rb +6 -6
- data/readme.rdoc +11 -120
- data/unittest/expected/test_comment.html +1 -0
- data/unittest/expected/test_comment.latex +5 -0
- data/unittest/expected/test_comment_complex.html +3 -0
- data/unittest/expected/test_comment_complex.latex +15 -0
- data/unittest/expected_creole/test_creole_characters_all.html +6 -5
- data/unittest/expected_creole/test_creole_characters_all.latex +10 -8
- data/unittest/expected_creole/test_creole_creole1.0test.latex +5 -5
- data/unittest/expected_creole/test_creole_input.normsource +11 -9
- data/unittest/expected_creole/test_creole_list_ul.normsource +57 -51
- data/unittest/expected_creole/test_creole_list_ulul_without_ul.html +6 -0
- data/unittest/expected_creole/test_creole_list_ulul_without_ul.latex +12 -0
- data/unittest/expected_creole/test_creole_paragraphs.normsource +12 -10
- data/unittest/expected_creole/test_creole_pictures.latex +2 -2
- data/unittest/expected_creole/test_creole_pictures_css.latex +2 -2
- data/unittest/expected_creole/test_creole_pictures_imgclass.latex +2 -2
- data/unittest/expected_creole/test_creole_pictures_width.latex +1 -1
- data/unittest/expected_creole/test_creole_tabular.latex +3 -3
- data/unittest/expected_creole/test_creole_tabular_creole.latex +2 -2
- data/unittest/expected_creole/test_creole_tabular_css.latex +3 -3
- data/unittest/expected_creole/test_creole_tabular_row_parameters.latex +22 -0
- data/unittest/expected_templates/test_standalone.tex +34 -0
- data/unittest/expected_wikimedia/test_wiki_picture.latex +12 -12
- data/unittest/unittest_creole.rb +22 -3
- data/unittest/unittest_creole_tabular.rb +34 -1
- data/unittest/unittest_docgenerator.rb +46 -3
- data/unittest/unittest_docgenerator_characters.rb +527 -82
- data/unittest/unittest_templates.rb +1 -1
- metadata +149 -108
@@ -9,6 +9,11 @@ This document is the source for a manpage for usage of Docgenerator elements.
|
|
9
9
|
The following Element are documented in this document:
|
10
10
|
|
11
11
|
* Docgenerator::Style
|
12
|
+
* Docgenerator::Index::Index
|
13
|
+
* Docgenerator::Index::Makeindex
|
14
|
+
* Docgenerator::Index::Printindex
|
15
|
+
* Docgenerator::Index::Newindex
|
16
|
+
* Docgenerator::Index::Sindex
|
12
17
|
=end
|
13
18
|
|
14
19
|
#
|
@@ -126,4 +131,402 @@ Default:
|
|
126
131
|
class Style << Docgenerator::Element
|
127
132
|
#This coding is empty - this is the manpage definition, not the implementation
|
128
133
|
end #class Style
|
134
|
+
end #module Docgenerator
|
135
|
+
module Docgenerator
|
136
|
+
module Index
|
137
|
+
=begin rdoc
|
138
|
+
=Docgenerator::Index::Index
|
139
|
+
|
140
|
+
Docgenerator::Index::Index does not contain attributes
|
141
|
+
|
142
|
+
|
143
|
+
Docgenerator::Index::Index can contain content.
|
144
|
+
|
145
|
+
==Generate an object
|
146
|
+
test = Docgenerator::Index::Index.new( {}, 'content')
|
147
|
+
|
148
|
+
Alternative generation
|
149
|
+
test = element(:index, {}, 'content' )
|
150
|
+
|
151
|
+
|
152
|
+
==Outputs
|
153
|
+
===Docgenerator::Index::Index#to_latex
|
154
|
+
\index{content}
|
155
|
+
|
156
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Index::Index#.to_latex
|
157
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
158
|
+
|
159
|
+
Default:
|
160
|
+
<<START>>\index{content}<<END>>
|
161
|
+
|
162
|
+
* Result after Docgenerator::Index::Index#cr:
|
163
|
+
|
164
|
+
<<START>>\index{content}
|
165
|
+
<<END>>
|
166
|
+
|
167
|
+
* Result after Docgenerator::Index::Index#cR:
|
168
|
+
|
169
|
+
<<START>>\index{content}
|
170
|
+
<<END>>
|
171
|
+
|
172
|
+
* Result after Docgenerator::Index::Index#Cr:
|
173
|
+
|
174
|
+
<<START>>
|
175
|
+
\index{content}
|
176
|
+
<<END>>
|
177
|
+
|
178
|
+
* Result after Docgenerator::Index::Index#CR:
|
179
|
+
|
180
|
+
<<START>>
|
181
|
+
\index{content}
|
182
|
+
<<END>>
|
183
|
+
|
184
|
+
===Docgenerator::Index::Index#to_html
|
185
|
+
<span >content</span>
|
186
|
+
|
187
|
+
* No output routine defined for html - use a dummy
|
188
|
+
===Docgenerator::Index::Index#to_context
|
189
|
+
\index{content}
|
190
|
+
|
191
|
+
* No output routine defined for context - use a dummy
|
192
|
+
===Docgenerator::Index::Index#to_text
|
193
|
+
content
|
194
|
+
|
195
|
+
* No output routine defined for text - use a dummy
|
196
|
+
===Docgenerator::Index::Index#to_wiki
|
197
|
+
content
|
198
|
+
|
199
|
+
|
200
|
+
* No output routine defined for wiki - use a dummy
|
201
|
+
===Docgenerator::Index::Index#to_creole
|
202
|
+
content
|
203
|
+
|
204
|
+
|
205
|
+
* No output routine defined for creole - use a dummy
|
206
|
+
=end
|
207
|
+
class Index << Docgenerator::Element
|
208
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
209
|
+
end #class Index
|
210
|
+
end #module Index
|
211
|
+
end #module Docgenerator
|
212
|
+
module Docgenerator
|
213
|
+
module Index
|
214
|
+
=begin rdoc
|
215
|
+
=Docgenerator::Index::Makeindex
|
216
|
+
|
217
|
+
Docgenerator::Index::Makeindex does not contain attributes
|
218
|
+
|
219
|
+
|
220
|
+
Docgenerator::Index::Makeindex allows no content.
|
221
|
+
|
222
|
+
==Generate an object
|
223
|
+
test = Docgenerator::Index::Makeindex.new( )
|
224
|
+
|
225
|
+
Alternative generation
|
226
|
+
test = element(:makeindex)
|
227
|
+
|
228
|
+
|
229
|
+
==Outputs
|
230
|
+
===Docgenerator::Index::Makeindex#to_latex
|
231
|
+
\makeindex
|
232
|
+
|
233
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Index::Makeindex#.to_latex
|
234
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
235
|
+
|
236
|
+
Default:
|
237
|
+
<<START>>\makeindex <<END>>
|
238
|
+
|
239
|
+
* Result after Docgenerator::Index::Makeindex#cr:
|
240
|
+
|
241
|
+
<<START>>\makeindex
|
242
|
+
<<END>>
|
243
|
+
|
244
|
+
* Result after Docgenerator::Index::Makeindex#cR:
|
245
|
+
|
246
|
+
<<START>>\makeindex
|
247
|
+
<<END>>
|
248
|
+
|
249
|
+
* Result after Docgenerator::Index::Makeindex#Cr:
|
250
|
+
|
251
|
+
<<START>>
|
252
|
+
\makeindex
|
253
|
+
<<END>>
|
254
|
+
|
255
|
+
* Result after Docgenerator::Index::Makeindex#CR:
|
256
|
+
|
257
|
+
<<START>>
|
258
|
+
\makeindex
|
259
|
+
<<END>>
|
260
|
+
|
261
|
+
===Docgenerator::Index::Makeindex#to_html
|
262
|
+
<span />
|
263
|
+
|
264
|
+
* No output routine defined for html - use a dummy
|
265
|
+
===Docgenerator::Index::Makeindex#to_context
|
266
|
+
\makeindex{}
|
267
|
+
|
268
|
+
* No output routine defined for context - use a dummy
|
269
|
+
===Docgenerator::Index::Makeindex#to_text
|
270
|
+
|
271
|
+
|
272
|
+
* No output routine defined for text - use a dummy
|
273
|
+
===Docgenerator::Index::Makeindex#to_wiki
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
* No output routine defined for wiki - use a dummy
|
278
|
+
===Docgenerator::Index::Makeindex#to_creole
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
* No output routine defined for creole - use a dummy
|
283
|
+
=end
|
284
|
+
class Makeindex << Docgenerator::Element
|
285
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
286
|
+
end #class Makeindex
|
287
|
+
end #module Index
|
288
|
+
end #module Docgenerator
|
289
|
+
module Docgenerator
|
290
|
+
module Index
|
291
|
+
=begin rdoc
|
292
|
+
=Docgenerator::Index::Printindex
|
293
|
+
|
294
|
+
==Attributes
|
295
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
296
|
+
====================================================================================================
|
297
|
+
subindex : - - X - - - - -
|
298
|
+
|
299
|
+
|
300
|
+
Docgenerator::Index::Printindex allows no content.
|
301
|
+
|
302
|
+
==Generate an object
|
303
|
+
test = Docgenerator::Index::Printindex.new( {
|
304
|
+
#:subindex => <<value>>, % optional
|
305
|
+
})
|
306
|
+
|
307
|
+
Alternative generation
|
308
|
+
test = element(:printindex, {...Attributes...})
|
309
|
+
|
310
|
+
|
311
|
+
==Outputs
|
312
|
+
===Docgenerator::Index::Printindex#to_latex
|
313
|
+
|
314
|
+
|
315
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Index::Printindex#.to_latex
|
316
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
317
|
+
|
318
|
+
Default:
|
319
|
+
<<START>><<END>>
|
320
|
+
|
321
|
+
* Result after Docgenerator::Index::Printindex#cr:
|
322
|
+
|
323
|
+
<<START>>
|
324
|
+
<<END>>
|
325
|
+
|
326
|
+
* Result after Docgenerator::Index::Printindex#cR:
|
327
|
+
|
328
|
+
<<START>>
|
329
|
+
<<END>>
|
330
|
+
|
331
|
+
* Result after Docgenerator::Index::Printindex#Cr:
|
332
|
+
|
333
|
+
<<START>>
|
334
|
+
<<END>>
|
335
|
+
|
336
|
+
* Result after Docgenerator::Index::Printindex#CR:
|
337
|
+
|
338
|
+
<<START>>
|
339
|
+
<<END>>
|
340
|
+
|
341
|
+
===Docgenerator::Index::Printindex#to_html
|
342
|
+
<span />
|
343
|
+
|
344
|
+
* No output routine defined for html - use a dummy
|
345
|
+
===Docgenerator::Index::Printindex#to_context
|
346
|
+
\printindex{}
|
347
|
+
|
348
|
+
* No output routine defined for context - use a dummy
|
349
|
+
===Docgenerator::Index::Printindex#to_text
|
350
|
+
|
351
|
+
|
352
|
+
* No output routine defined for text - use a dummy
|
353
|
+
===Docgenerator::Index::Printindex#to_wiki
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
* No output routine defined for wiki - use a dummy
|
358
|
+
===Docgenerator::Index::Printindex#to_creole
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
* No output routine defined for creole - use a dummy
|
363
|
+
=end
|
364
|
+
class Printindex << Docgenerator::Element
|
365
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
366
|
+
end #class Printindex
|
367
|
+
end #module Index
|
368
|
+
end #module Docgenerator
|
369
|
+
module Docgenerator
|
370
|
+
module Index
|
371
|
+
=begin rdoc
|
372
|
+
=Docgenerator::Index::Newindex
|
373
|
+
|
374
|
+
==Attributes
|
375
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
376
|
+
====================================================================================================
|
377
|
+
subname : X - X - - - - -
|
378
|
+
|
379
|
+
|
380
|
+
Docgenerator::Index::Newindex can contain content.
|
381
|
+
|
382
|
+
==Generate an object
|
383
|
+
test = Docgenerator::Index::Newindex.new( {
|
384
|
+
:subname => <<value>>, % required
|
385
|
+
}, 'content')
|
386
|
+
|
387
|
+
Alternative generation
|
388
|
+
test = element(:newindex, {...Attributes...}, 'content' )
|
389
|
+
|
390
|
+
|
391
|
+
==Outputs
|
392
|
+
===Docgenerator::Index::Newindex#to_latex
|
393
|
+
\newindex[Value for subname]{content}
|
394
|
+
|
395
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Index::Newindex#.to_latex
|
396
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
397
|
+
|
398
|
+
Default:
|
399
|
+
<<START>>\newindex[Value for subname]{content}<<END>>
|
400
|
+
|
401
|
+
* Result after Docgenerator::Index::Newindex#cr:
|
402
|
+
|
403
|
+
<<START>>\newindex[Value for subname]{content}
|
404
|
+
<<END>>
|
405
|
+
|
406
|
+
* Result after Docgenerator::Index::Newindex#cR:
|
407
|
+
|
408
|
+
<<START>>\newindex[Value for subname]{content}
|
409
|
+
<<END>>
|
410
|
+
|
411
|
+
* Result after Docgenerator::Index::Newindex#Cr:
|
412
|
+
|
413
|
+
<<START>>
|
414
|
+
\newindex[Value for subname]{content}
|
415
|
+
<<END>>
|
416
|
+
|
417
|
+
* Result after Docgenerator::Index::Newindex#CR:
|
418
|
+
|
419
|
+
<<START>>
|
420
|
+
\newindex[Value for subname]{content}
|
421
|
+
<<END>>
|
422
|
+
|
423
|
+
===Docgenerator::Index::Newindex#to_html
|
424
|
+
<span >content</span>
|
425
|
+
|
426
|
+
* No output routine defined for html - use a dummy
|
427
|
+
===Docgenerator::Index::Newindex#to_context
|
428
|
+
\newindex{content}
|
429
|
+
|
430
|
+
* No output routine defined for context - use a dummy
|
431
|
+
===Docgenerator::Index::Newindex#to_text
|
432
|
+
content
|
433
|
+
|
434
|
+
* No output routine defined for text - use a dummy
|
435
|
+
===Docgenerator::Index::Newindex#to_wiki
|
436
|
+
content
|
437
|
+
|
438
|
+
|
439
|
+
* No output routine defined for wiki - use a dummy
|
440
|
+
===Docgenerator::Index::Newindex#to_creole
|
441
|
+
content
|
442
|
+
|
443
|
+
|
444
|
+
* No output routine defined for creole - use a dummy
|
445
|
+
=end
|
446
|
+
class Newindex << Docgenerator::Element
|
447
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
448
|
+
end #class Newindex
|
449
|
+
end #module Index
|
450
|
+
end #module Docgenerator
|
451
|
+
module Docgenerator
|
452
|
+
module Index
|
453
|
+
=begin rdoc
|
454
|
+
=Docgenerator::Index::Sindex
|
455
|
+
|
456
|
+
==Attributes
|
457
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
458
|
+
====================================================================================================
|
459
|
+
subindex : X - X - - - - -
|
460
|
+
|
461
|
+
|
462
|
+
Docgenerator::Index::Sindex can contain content.
|
463
|
+
|
464
|
+
==Generate an object
|
465
|
+
test = Docgenerator::Index::Sindex.new( {
|
466
|
+
:subindex => <<value>>, % required
|
467
|
+
}, 'content')
|
468
|
+
|
469
|
+
Alternative generation
|
470
|
+
test = element(:sindex, {...Attributes...}, 'content' )
|
471
|
+
|
472
|
+
|
473
|
+
==Outputs
|
474
|
+
===Docgenerator::Index::Sindex#to_latex
|
475
|
+
\sindex[Value for subindex]{content}
|
476
|
+
|
477
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Index::Sindex#.to_latex
|
478
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
479
|
+
|
480
|
+
Default:
|
481
|
+
<<START>>\sindex[Value for subindex]{content}<<END>>
|
482
|
+
|
483
|
+
* Result after Docgenerator::Index::Sindex#cr:
|
484
|
+
|
485
|
+
<<START>>\sindex[Value for subindex]{content}
|
486
|
+
<<END>>
|
487
|
+
|
488
|
+
* Result after Docgenerator::Index::Sindex#cR:
|
489
|
+
|
490
|
+
<<START>>\sindex[Value for subindex]{content}
|
491
|
+
<<END>>
|
492
|
+
|
493
|
+
* Result after Docgenerator::Index::Sindex#Cr:
|
494
|
+
|
495
|
+
<<START>>
|
496
|
+
\sindex[Value for subindex]{content}
|
497
|
+
<<END>>
|
498
|
+
|
499
|
+
* Result after Docgenerator::Index::Sindex#CR:
|
500
|
+
|
501
|
+
<<START>>
|
502
|
+
\sindex[Value for subindex]{content}
|
503
|
+
<<END>>
|
504
|
+
|
505
|
+
===Docgenerator::Index::Sindex#to_html
|
506
|
+
<span >content</span>
|
507
|
+
|
508
|
+
* No output routine defined for html - use a dummy
|
509
|
+
===Docgenerator::Index::Sindex#to_context
|
510
|
+
\sindex{content}
|
511
|
+
|
512
|
+
* No output routine defined for context - use a dummy
|
513
|
+
===Docgenerator::Index::Sindex#to_text
|
514
|
+
content
|
515
|
+
|
516
|
+
* No output routine defined for text - use a dummy
|
517
|
+
===Docgenerator::Index::Sindex#to_wiki
|
518
|
+
content
|
519
|
+
|
520
|
+
|
521
|
+
* No output routine defined for wiki - use a dummy
|
522
|
+
===Docgenerator::Index::Sindex#to_creole
|
523
|
+
content
|
524
|
+
|
525
|
+
|
526
|
+
* No output routine defined for creole - use a dummy
|
527
|
+
=end
|
528
|
+
class Sindex << Docgenerator::Element
|
529
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
530
|
+
end #class Sindex
|
531
|
+
end #module Index
|
129
532
|
end #module Docgenerator
|
@@ -8,14 +8,16 @@ This document is the source for a manpage for usage of Docgenerator elements.
|
|
8
8
|
|
9
9
|
The following Element are documented in this document:
|
10
10
|
|
11
|
-
* Docgenerator::Packages::IncludePDF
|
11
|
+
* Docgenerator::Packages::PDFPages::IncludePDF
|
12
|
+
* Docgenerator::Packages::PDFPages::IncludePDFmerge
|
12
13
|
=end
|
13
14
|
|
14
15
|
#
|
15
16
|
module Docgenerator
|
16
17
|
module Packages
|
18
|
+
module PDFPages
|
17
19
|
=begin rdoc
|
18
|
-
=Docgenerator::Packages::IncludePDF
|
20
|
+
=Docgenerator::Packages::PDFPages::IncludePDF
|
19
21
|
|
20
22
|
==Attributes
|
21
23
|
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
@@ -29,10 +31,10 @@ module Docgenerator
|
|
29
31
|
linktodoc : - - - X - - - -
|
30
32
|
|
31
33
|
|
32
|
-
Docgenerator::Packages::IncludePDF can contain content.
|
34
|
+
Docgenerator::Packages::PDFPages::IncludePDF can contain content.
|
33
35
|
|
34
36
|
==Generate an object
|
35
|
-
test = Docgenerator::Packages::IncludePDF.new( {
|
37
|
+
test = Docgenerator::Packages::PDFPages::IncludePDF.new( {
|
36
38
|
#:pages => <<value>>, % optional, values: [String]
|
37
39
|
#:nup => <<value>>, % optional, values: [/\d+x\d+/]
|
38
40
|
#:landscape => <<value>>, % optional, values: [true, false]
|
@@ -47,62 +49,159 @@ Alternative generation
|
|
47
49
|
|
48
50
|
|
49
51
|
==Outputs
|
50
|
-
===Docgenerator::Packages::IncludePDF#to_latex
|
52
|
+
===Docgenerator::Packages::PDFPages::IncludePDF#to_latex
|
51
53
|
\includepdf[]{content}
|
52
54
|
|
53
|
-
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::IncludePDF#.to_latex
|
55
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::PDFPages::IncludePDF#.to_latex
|
54
56
|
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
55
57
|
|
56
58
|
Default:
|
57
59
|
<<START>>\includepdf[]{content}<<END>>
|
58
60
|
|
59
|
-
* Result after Docgenerator::Packages::IncludePDF#cr:
|
61
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDF#cr:
|
60
62
|
|
61
63
|
<<START>>\includepdf[]{content}
|
62
64
|
<<END>>
|
63
65
|
|
64
|
-
* Result after Docgenerator::Packages::IncludePDF#cR:
|
66
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDF#cR:
|
65
67
|
|
66
68
|
<<START>>\includepdf[]{content}
|
67
69
|
<<END>>
|
68
70
|
|
69
|
-
* Result after Docgenerator::Packages::IncludePDF#Cr:
|
71
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDF#Cr:
|
70
72
|
|
71
73
|
<<START>>
|
72
74
|
\includepdf[]{content}
|
73
75
|
<<END>>
|
74
76
|
|
75
|
-
* Result after Docgenerator::Packages::IncludePDF#CR:
|
77
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDF#CR:
|
76
78
|
|
77
79
|
<<START>>
|
78
80
|
\includepdf[]{content}
|
79
81
|
<<END>>
|
80
82
|
|
81
|
-
===Docgenerator::Packages::IncludePDF#to_html
|
83
|
+
===Docgenerator::Packages::PDFPages::IncludePDF#to_html
|
82
84
|
<span >content</span>
|
83
85
|
|
84
86
|
* No output routine defined for html - use a dummy
|
85
|
-
===Docgenerator::Packages::IncludePDF#to_context
|
87
|
+
===Docgenerator::Packages::PDFPages::IncludePDF#to_context
|
86
88
|
\includepdf{content}
|
87
89
|
|
88
90
|
* No output routine defined for context - use a dummy
|
89
|
-
===Docgenerator::Packages::IncludePDF#to_text
|
91
|
+
===Docgenerator::Packages::PDFPages::IncludePDF#to_text
|
90
92
|
content
|
91
93
|
|
92
94
|
* No output routine defined for text - use a dummy
|
93
|
-
===Docgenerator::Packages::IncludePDF#to_wiki
|
95
|
+
===Docgenerator::Packages::PDFPages::IncludePDF#to_wiki
|
94
96
|
content
|
95
97
|
|
96
98
|
|
97
99
|
* No output routine defined for wiki - use a dummy
|
98
|
-
===Docgenerator::Packages::IncludePDF#to_creole
|
100
|
+
===Docgenerator::Packages::PDFPages::IncludePDF#to_creole
|
99
101
|
content
|
100
102
|
|
101
103
|
|
102
104
|
* No output routine defined for creole - use a dummy
|
103
105
|
=end
|
104
|
-
|
105
|
-
|
106
|
-
|
106
|
+
class IncludePDF << Docgenerator::Element
|
107
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
108
|
+
end #class IncludePDF
|
109
|
+
end #module PDFPages
|
110
|
+
end #module Packages
|
111
|
+
end #module Docgenerator
|
112
|
+
module Docgenerator
|
113
|
+
module Packages
|
114
|
+
module PDFPages
|
115
|
+
=begin rdoc
|
116
|
+
=Docgenerator::Packages::PDFPages::IncludePDFmerge
|
117
|
+
|
118
|
+
==Attributes
|
119
|
+
Attribute required? HTML LaTeX ~keyval ConTeXt Text Wiki Creole Values
|
120
|
+
====================================================================================================
|
121
|
+
pages : - - - X - - - -
|
122
|
+
nup : - - - X - - - -
|
123
|
+
landscape : - - - X - - - -
|
124
|
+
pagecommand : - - - X - - - -
|
125
|
+
link : - - - X - - - -
|
126
|
+
linkname : - - - X - - - -
|
127
|
+
linktodoc : - - - X - - - -
|
128
|
+
|
129
|
+
|
130
|
+
Docgenerator::Packages::PDFPages::IncludePDFmerge can contain content.
|
131
|
+
|
132
|
+
==Generate an object
|
133
|
+
test = Docgenerator::Packages::PDFPages::IncludePDFmerge.new( {
|
134
|
+
#:pages => <<value>>, % optional, values: [String]
|
135
|
+
#:nup => <<value>>, % optional, values: [/\d+x\d+/]
|
136
|
+
#:landscape => <<value>>, % optional, values: [true, false]
|
137
|
+
#:pagecommand => <<value>>, % optional, values: [String]
|
138
|
+
#:link => <<value>>, % optional, values: [true, false]
|
139
|
+
#:linkname => <<value>>, % optional, values: [String]
|
140
|
+
#:linktodoc => <<value>>, % optional, values: [true, false]
|
141
|
+
}, 'content')
|
142
|
+
|
143
|
+
Alternative generation
|
144
|
+
test = element(:includepdfmerge, {...Attributes...}, 'content' )
|
145
|
+
|
146
|
+
|
147
|
+
==Outputs
|
148
|
+
===Docgenerator::Packages::PDFPages::IncludePDFmerge#to_latex
|
149
|
+
\includepdfmerge[]{content}
|
150
|
+
|
151
|
+
====:cr, :cR, :Cr, :CR for Docgenerator::Packages::PDFPages::IncludePDFmerge#.to_latex
|
152
|
+
<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
|
153
|
+
|
154
|
+
Default:
|
155
|
+
<<START>>\includepdfmerge[]{content}<<END>>
|
156
|
+
|
157
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDFmerge#cr:
|
158
|
+
|
159
|
+
<<START>>\includepdfmerge[]{content}
|
160
|
+
<<END>>
|
161
|
+
|
162
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDFmerge#cR:
|
163
|
+
|
164
|
+
<<START>>\includepdfmerge[]{content}
|
165
|
+
<<END>>
|
166
|
+
|
167
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDFmerge#Cr:
|
168
|
+
|
169
|
+
<<START>>
|
170
|
+
\includepdfmerge[]{content}
|
171
|
+
<<END>>
|
172
|
+
|
173
|
+
* Result after Docgenerator::Packages::PDFPages::IncludePDFmerge#CR:
|
174
|
+
|
175
|
+
<<START>>
|
176
|
+
\includepdfmerge[]{content}
|
177
|
+
<<END>>
|
178
|
+
|
179
|
+
===Docgenerator::Packages::PDFPages::IncludePDFmerge#to_html
|
180
|
+
<span >content</span>
|
181
|
+
|
182
|
+
* No output routine defined for html - use a dummy
|
183
|
+
===Docgenerator::Packages::PDFPages::IncludePDFmerge#to_context
|
184
|
+
\includepdfmerge{content}
|
185
|
+
|
186
|
+
* No output routine defined for context - use a dummy
|
187
|
+
===Docgenerator::Packages::PDFPages::IncludePDFmerge#to_text
|
188
|
+
content
|
189
|
+
|
190
|
+
* No output routine defined for text - use a dummy
|
191
|
+
===Docgenerator::Packages::PDFPages::IncludePDFmerge#to_wiki
|
192
|
+
content
|
193
|
+
|
194
|
+
|
195
|
+
* No output routine defined for wiki - use a dummy
|
196
|
+
===Docgenerator::Packages::PDFPages::IncludePDFmerge#to_creole
|
197
|
+
content
|
198
|
+
|
199
|
+
|
200
|
+
* No output routine defined for creole - use a dummy
|
201
|
+
=end
|
202
|
+
class IncludePDFmerge << Docgenerator::Packages::PDFPages::IncludePDF
|
203
|
+
#This coding is empty - this is the manpage definition, not the implementation
|
204
|
+
end #class IncludePDFmerge
|
205
|
+
end #module PDFPages
|
107
206
|
end #module Packages
|
108
207
|
end #module Docgenerator
|
@@ -1,8 +1,10 @@
|
|
1
|
+
=Generated Manpages
|
2
|
+
|
1
3
|
This is a generated manpage collection for docgenerator.
|
2
4
|
|
3
5
|
Each *Element*-class of Docgenerator is analyzed for attributes and output.
|
4
6
|
|
5
|
-
|
7
|
+
===:cr, :cR, :Cr, :CR for elements
|
6
8
|
With Element#cr, Element#cR, Element#Cr, Element#CR you may influence
|
7
9
|
the code layout.
|
8
10
|
|