docgenerator 2.1.0 → 2.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. checksums.yaml +7 -0
  2. data/examples/creole_example.rb +0 -1
  3. data/examples/creole_example_new_plugin.rb +51 -0
  4. data/examples/creole_example_tabular.rb +3 -1
  5. data/examples/wiki2docgenerator_example.rb +2 -2
  6. data/lib/creole/creole2doc.rb +697 -680
  7. data/lib/creole/creole_characters.rb +90 -26
  8. data/lib/creole/creole_inclusion_and_plugins.rb +25 -43
  9. data/lib/creole/creole_inclusions.rb +87 -75
  10. data/lib/creole/creole_placeholder.rb +87 -89
  11. data/lib/creole/creole_plugins.rb +149 -117
  12. data/lib/creole/creole_tabular.rb +247 -141
  13. data/lib/creole/plugins/todonotes.rb +48 -48
  14. data/lib/docgenerator/characters.rb +106 -8
  15. data/lib/docgenerator/compatibility_v1.rb +7 -1
  16. data/lib/docgenerator/document.rb +34 -19
  17. data/lib/docgenerator/element.rb +1 -0
  18. data/lib/docgenerator/element_meta.rb +1 -1
  19. data/lib/docgenerator/elements.rb +594 -535
  20. data/lib/docgenerator/environments.rb +131 -99
  21. data/lib/docgenerator/index.rb +110 -0
  22. data/lib/docgenerator/lists.rb +2 -1
  23. data/lib/docgenerator/packages/caption.rb +32 -34
  24. data/lib/docgenerator/packages/hyperref.rb +1 -0
  25. data/lib/docgenerator/packages/multicol.rb +3 -2
  26. data/lib/docgenerator/packages/pdfpages.rb +71 -20
  27. data/lib/docgenerator/packages/scrpage2.rb +99 -142
  28. data/lib/docgenerator/packages/url.rb +75 -81
  29. data/lib/docgenerator/sections.rb +98 -98
  30. data/lib/docgenerator/standard.rb +8 -1
  31. data/lib/docgenerator/tabular.rb +44 -25
  32. data/lib/docgenerator/templates/docgenerator_template.yaml +28 -0
  33. data/lib/docgenerator/version.rb +146 -0
  34. data/lib/docgenerator.rb +20 -15
  35. data/meta_test_and_doc/build_doc.rb +39 -10
  36. data/meta_test_and_doc/build_test.rb +34 -12
  37. data/meta_test_and_doc/manpages/characters.rb +452 -20
  38. data/meta_test_and_doc/manpages/elementlist.rb +304 -0
  39. data/meta_test_and_doc/manpages/elements.rb +305 -42
  40. data/meta_test_and_doc/manpages/others.rb +403 -0
  41. data/meta_test_and_doc/manpages/pdfpages.rb +117 -18
  42. data/meta_test_and_doc/manpages/readme.rdoc +3 -1
  43. data/meta_test_and_doc/manpages/scrpage2.rb +0 -80
  44. data/meta_test_and_doc/manpages/tables.rb +6 -6
  45. data/readme.rdoc +11 -120
  46. data/unittest/expected/test_comment.html +1 -0
  47. data/unittest/expected/test_comment.latex +5 -0
  48. data/unittest/expected/test_comment_complex.html +3 -0
  49. data/unittest/expected/test_comment_complex.latex +15 -0
  50. data/unittest/expected_creole/test_creole_characters_all.html +6 -5
  51. data/unittest/expected_creole/test_creole_characters_all.latex +10 -8
  52. data/unittest/expected_creole/test_creole_creole1.0test.latex +5 -5
  53. data/unittest/expected_creole/test_creole_input.normsource +11 -9
  54. data/unittest/expected_creole/test_creole_list_ul.normsource +57 -51
  55. data/unittest/expected_creole/test_creole_list_ulul_without_ul.html +6 -0
  56. data/unittest/expected_creole/test_creole_list_ulul_without_ul.latex +12 -0
  57. data/unittest/expected_creole/test_creole_paragraphs.normsource +12 -10
  58. data/unittest/expected_creole/test_creole_pictures.latex +2 -2
  59. data/unittest/expected_creole/test_creole_pictures_css.latex +2 -2
  60. data/unittest/expected_creole/test_creole_pictures_imgclass.latex +2 -2
  61. data/unittest/expected_creole/test_creole_pictures_width.latex +1 -1
  62. data/unittest/expected_creole/test_creole_tabular.latex +3 -3
  63. data/unittest/expected_creole/test_creole_tabular_creole.latex +2 -2
  64. data/unittest/expected_creole/test_creole_tabular_css.latex +3 -3
  65. data/unittest/expected_creole/test_creole_tabular_row_parameters.latex +22 -0
  66. data/unittest/expected_templates/test_standalone.tex +34 -0
  67. data/unittest/expected_wikimedia/test_wiki_picture.latex +12 -12
  68. data/unittest/unittest_creole.rb +22 -3
  69. data/unittest/unittest_creole_tabular.rb +34 -1
  70. data/unittest/unittest_docgenerator.rb +46 -3
  71. data/unittest/unittest_docgenerator_characters.rb +527 -82
  72. data/unittest/unittest_templates.rb +1 -1
  73. metadata +149 -108
@@ -13,6 +13,7 @@ The following Element are documented in this document:
13
13
  * Docgenerator::Elements::Latexdummy
14
14
  * Docgenerator::Elements::Htmldummy
15
15
  * Docgenerator::Elements::Title
16
+ * Docgenerator::Elements::Title::Subtitle
16
17
  * Docgenerator::Elements::Meta
17
18
  * Docgenerator::Elements::Meta2
18
19
  * Docgenerator::Elements::Author
@@ -29,6 +30,8 @@ The following Element are documented in this document:
29
30
  * Docgenerator::Elements::Nobr
30
31
  * Docgenerator::Elements::Newline
31
32
  * Docgenerator::Elements::Hrulefill
33
+ * Docgenerator::Elements::Pagestyle
34
+ * Docgenerator::Elements::Thispagestyle
32
35
  * Docgenerator::Elements::Vspace
33
36
  * Docgenerator::Elements::Hspace
34
37
  * Docgenerator::Elements::Vfill
@@ -807,6 +810,128 @@ Default:
807
810
  end #class Title
808
811
  end #module Elements
809
812
  end #module Docgenerator
813
+ module Docgenerator
814
+ module Elements
815
+ module Title
816
+ =begin rdoc
817
+ =Docgenerator::Elements::Title::Subtitle
818
+
819
+ Docgenerator::Elements::Title::Subtitle does not contain attributes
820
+
821
+
822
+ Docgenerator::Elements::Title::Subtitle can contain content.
823
+
824
+ ==Generate an object
825
+ test = Docgenerator::Elements::Title::Subtitle.new( {}, 'content')
826
+
827
+ Alternative generation
828
+ test = element(:subtitle, {}, 'content' )
829
+
830
+
831
+ ==Outputs
832
+ ===Docgenerator::Elements::Title::Subtitle#to_latex
833
+ \subtitle{content}
834
+
835
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Title::Subtitle#.to_latex
836
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
837
+
838
+ Default:
839
+ <<START>>\subtitle{content}<<END>>
840
+
841
+ * Result after Docgenerator::Elements::Title::Subtitle#cr:
842
+
843
+ <<START>>\subtitle{content}
844
+ <<END>>
845
+
846
+ * Result after Docgenerator::Elements::Title::Subtitle#cR:
847
+
848
+ <<START>>\subtitle{content}
849
+ <<END>>
850
+
851
+ * Result after Docgenerator::Elements::Title::Subtitle#Cr:
852
+
853
+ <<START>>
854
+ \subtitle{content}
855
+ <<END>>
856
+
857
+ * Result after Docgenerator::Elements::Title::Subtitle#CR:
858
+
859
+ <<START>>
860
+ \subtitle{content}
861
+ <<END>>
862
+
863
+ ===Docgenerator::Elements::Title::Subtitle#to_html
864
+
865
+
866
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Title::Subtitle#.to_html
867
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
868
+
869
+ Default:
870
+ <<START>><<END>>
871
+
872
+ * Docgenerator::Elements::Title::Subtitle#cr has no effect, same result as default
873
+ * Docgenerator::Elements::Title::Subtitle#cR has no effect, same result as default
874
+ * Docgenerator::Elements::Title::Subtitle#Cr has no effect, same result as default
875
+ * Docgenerator::Elements::Title::Subtitle#CR has no effect, same result as default
876
+ ===Docgenerator::Elements::Title::Subtitle#to_context
877
+
878
+
879
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Title::Subtitle#.to_context
880
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
881
+
882
+ Default:
883
+ <<START>><<END>>
884
+
885
+ * Docgenerator::Elements::Title::Subtitle#cr has no effect, same result as default
886
+ * Docgenerator::Elements::Title::Subtitle#cR has no effect, same result as default
887
+ * Docgenerator::Elements::Title::Subtitle#Cr has no effect, same result as default
888
+ * Docgenerator::Elements::Title::Subtitle#CR has no effect, same result as default
889
+ ===Docgenerator::Elements::Title::Subtitle#to_text
890
+
891
+
892
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Title::Subtitle#.to_text
893
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
894
+
895
+ Default:
896
+ <<START>><<END>>
897
+
898
+ * Docgenerator::Elements::Title::Subtitle#cr has no effect, same result as default
899
+ * Docgenerator::Elements::Title::Subtitle#cR has no effect, same result as default
900
+ * Docgenerator::Elements::Title::Subtitle#Cr has no effect, same result as default
901
+ * Docgenerator::Elements::Title::Subtitle#CR has no effect, same result as default
902
+ ===Docgenerator::Elements::Title::Subtitle#to_wiki
903
+
904
+
905
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Title::Subtitle#.to_wiki
906
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
907
+
908
+ Default:
909
+ <<START>><<END>>
910
+
911
+ * Docgenerator::Elements::Title::Subtitle#cr has no effect, same result as default
912
+ * Docgenerator::Elements::Title::Subtitle#cR has no effect, same result as default
913
+ * Docgenerator::Elements::Title::Subtitle#Cr has no effect, same result as default
914
+ * Docgenerator::Elements::Title::Subtitle#CR has no effect, same result as default
915
+ ===Docgenerator::Elements::Title::Subtitle#to_creole
916
+
917
+
918
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Title::Subtitle#.to_creole
919
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
920
+
921
+ Default:
922
+ <<START>><<END>>
923
+
924
+ * Docgenerator::Elements::Title::Subtitle#cr has no effect, same result as default
925
+ * Docgenerator::Elements::Title::Subtitle#cR has no effect, same result as default
926
+ * Docgenerator::Elements::Title::Subtitle#Cr has no effect, same result as default
927
+ * Docgenerator::Elements::Title::Subtitle#CR has no effect, same result as default
928
+ =end
929
+ class Subtitle << Docgenerator::Element
930
+ #This coding is empty - this is the manpage definition, not the implementation
931
+ end #class Subtitle
932
+ end #module Title
933
+ end #module Elements
934
+ end #module Docgenerator
810
935
  module Docgenerator
811
936
  module Elements
812
937
  =begin rdoc
@@ -2631,6 +2756,160 @@ end #module Docgenerator
2631
2756
  module Docgenerator
2632
2757
  module Elements
2633
2758
  =begin rdoc
2759
+ =Docgenerator::Elements::Pagestyle
2760
+
2761
+ Docgenerator::Elements::Pagestyle does not contain attributes
2762
+
2763
+
2764
+ Docgenerator::Elements::Pagestyle can contain content.
2765
+
2766
+ ==Generate an object
2767
+ test = Docgenerator::Elements::Pagestyle.new( {}, 'content')
2768
+
2769
+ Alternative generation
2770
+ test = element(:pagestyle, {}, 'content' )
2771
+
2772
+
2773
+ ==Outputs
2774
+ ===Docgenerator::Elements::Pagestyle#to_latex
2775
+ \pagestyle{content}
2776
+
2777
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Pagestyle#.to_latex
2778
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
2779
+
2780
+ Default:
2781
+ <<START>>\pagestyle{content}<<END>>
2782
+
2783
+ * Result after Docgenerator::Elements::Pagestyle#cr:
2784
+
2785
+ <<START>>\pagestyle{content}
2786
+ <<END>>
2787
+
2788
+ * Result after Docgenerator::Elements::Pagestyle#cR:
2789
+
2790
+ <<START>>\pagestyle{content}
2791
+ <<END>>
2792
+
2793
+ * Result after Docgenerator::Elements::Pagestyle#Cr:
2794
+
2795
+ <<START>>
2796
+ \pagestyle{content}
2797
+ <<END>>
2798
+
2799
+ * Result after Docgenerator::Elements::Pagestyle#CR:
2800
+
2801
+ <<START>>
2802
+ \pagestyle{content}
2803
+ <<END>>
2804
+
2805
+ ===Docgenerator::Elements::Pagestyle#to_html
2806
+ <span >content</span>
2807
+
2808
+ * No output routine defined for html - use a dummy
2809
+ ===Docgenerator::Elements::Pagestyle#to_context
2810
+ \pagestyle{content}
2811
+
2812
+ * No output routine defined for context - use a dummy
2813
+ ===Docgenerator::Elements::Pagestyle#to_text
2814
+ content
2815
+
2816
+ * No output routine defined for text - use a dummy
2817
+ ===Docgenerator::Elements::Pagestyle#to_wiki
2818
+ content
2819
+
2820
+
2821
+ * No output routine defined for wiki - use a dummy
2822
+ ===Docgenerator::Elements::Pagestyle#to_creole
2823
+ content
2824
+
2825
+
2826
+ * No output routine defined for creole - use a dummy
2827
+ =end
2828
+ class Pagestyle << Docgenerator::Element
2829
+ #This coding is empty - this is the manpage definition, not the implementation
2830
+ end #class Pagestyle
2831
+ end #module Elements
2832
+ end #module Docgenerator
2833
+ module Docgenerator
2834
+ module Elements
2835
+ =begin rdoc
2836
+ =Docgenerator::Elements::Thispagestyle
2837
+
2838
+ Docgenerator::Elements::Thispagestyle does not contain attributes
2839
+
2840
+
2841
+ Docgenerator::Elements::Thispagestyle can contain content.
2842
+
2843
+ ==Generate an object
2844
+ test = Docgenerator::Elements::Thispagestyle.new( {}, 'content')
2845
+
2846
+ Alternative generation
2847
+ test = element(:thispagestyle, {}, 'content' )
2848
+
2849
+
2850
+ ==Outputs
2851
+ ===Docgenerator::Elements::Thispagestyle#to_latex
2852
+ \thispagestyle{content}
2853
+
2854
+ ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Thispagestyle#.to_latex
2855
+ <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
2856
+
2857
+ Default:
2858
+ <<START>>\thispagestyle{content}<<END>>
2859
+
2860
+ * Result after Docgenerator::Elements::Thispagestyle#cr:
2861
+
2862
+ <<START>>\thispagestyle{content}
2863
+ <<END>>
2864
+
2865
+ * Result after Docgenerator::Elements::Thispagestyle#cR:
2866
+
2867
+ <<START>>\thispagestyle{content}
2868
+ <<END>>
2869
+
2870
+ * Result after Docgenerator::Elements::Thispagestyle#Cr:
2871
+
2872
+ <<START>>
2873
+ \thispagestyle{content}
2874
+ <<END>>
2875
+
2876
+ * Result after Docgenerator::Elements::Thispagestyle#CR:
2877
+
2878
+ <<START>>
2879
+ \thispagestyle{content}
2880
+ <<END>>
2881
+
2882
+ ===Docgenerator::Elements::Thispagestyle#to_html
2883
+ <span >content</span>
2884
+
2885
+ * No output routine defined for html - use a dummy
2886
+ ===Docgenerator::Elements::Thispagestyle#to_context
2887
+ \thispagestyle{content}
2888
+
2889
+ * No output routine defined for context - use a dummy
2890
+ ===Docgenerator::Elements::Thispagestyle#to_text
2891
+ content
2892
+
2893
+ * No output routine defined for text - use a dummy
2894
+ ===Docgenerator::Elements::Thispagestyle#to_wiki
2895
+ content
2896
+
2897
+
2898
+ * No output routine defined for wiki - use a dummy
2899
+ ===Docgenerator::Elements::Thispagestyle#to_creole
2900
+ content
2901
+
2902
+
2903
+ * No output routine defined for creole - use a dummy
2904
+ =end
2905
+ class Thispagestyle << Docgenerator::Element
2906
+ #This coding is empty - this is the manpage definition, not the implementation
2907
+ end #class Thispagestyle
2908
+ end #module Elements
2909
+ end #module Docgenerator
2910
+ module Docgenerator
2911
+ module Elements
2912
+ =begin rdoc
2634
2913
  =Docgenerator::Elements::Vspace
2635
2914
 
2636
2915
  Docgenerator::Elements::Vspace does not contain attributes
@@ -3391,73 +3670,55 @@ Alternative generation
3391
3670
 
3392
3671
  ==Outputs
3393
3672
  ===Docgenerator::Elements::Comment#to_latex
3394
- % ------- content -------
3673
+ %content
3674
+
3395
3675
 
3396
3676
  ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Comment#.to_latex
3397
3677
  <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
3398
3678
 
3399
3679
  Default:
3400
- <<START>>% ------- content ------- <<END>>
3680
+ <<START>>%content
3681
+ <<END>>
3401
3682
 
3402
3683
  * Result after Docgenerator::Elements::Comment#cr:
3403
3684
 
3404
- <<START>>% ------- content -------
3685
+ <<START>>%content
3686
+
3405
3687
  <<END>>
3406
3688
 
3407
3689
  * Result after Docgenerator::Elements::Comment#cR:
3408
3690
 
3409
- <<START>>% ------- content -------
3691
+ <<START>>%content
3692
+
3410
3693
  <<END>>
3411
3694
 
3412
3695
  * Result after Docgenerator::Elements::Comment#Cr:
3413
3696
 
3414
3697
  <<START>>
3415
- % ------- content -------
3698
+ %content
3699
+
3416
3700
  <<END>>
3417
3701
 
3418
3702
  * Result after Docgenerator::Elements::Comment#CR:
3419
3703
 
3420
3704
  <<START>>
3421
- % ------- content -------
3705
+ %content
3706
+
3422
3707
  <<END>>
3423
3708
 
3424
3709
  ===Docgenerator::Elements::Comment#to_html
3425
- <<!-- #{@content} --> >content</<!-- #{@content} -->>
3710
+ <!-- content -->
3426
3711
 
3427
3712
  ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Comment#.to_html
3428
3713
  <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
3429
3714
 
3430
3715
  Default:
3431
- <<START>><<!-- #{@content} --> >content</<!-- #{@content} -->><<END>>
3432
-
3433
- * Result after Docgenerator::Elements::Comment#cr:
3434
-
3435
- <<START>><<!-- #{@content} --> >content</<!-- #{@content} -->>
3436
- <<END>>
3437
-
3438
- * Result after Docgenerator::Elements::Comment#cR:
3439
-
3440
- <<START>><<!-- #{@content} --> >
3441
- content
3442
- </<!-- #{@content} -->>
3443
- <<END>>
3444
-
3445
- * Result after Docgenerator::Elements::Comment#Cr:
3446
-
3447
- <<START>>
3448
- <<!-- #{@content} --> >
3449
- content
3450
- </<!-- #{@content} -->>
3451
- <<END>>
3452
-
3453
- * Result after Docgenerator::Elements::Comment#CR:
3454
-
3455
- <<START>>
3456
- <<!-- #{@content} --> >
3457
- content
3458
- </<!-- #{@content} -->>
3459
- <<END>>
3716
+ <<START>><!-- content --><<END>>
3460
3717
 
3718
+ * Docgenerator::Elements::Comment#cr has no effect, same result as default
3719
+ * Docgenerator::Elements::Comment#cR has no effect, same result as default
3720
+ * Docgenerator::Elements::Comment#Cr has no effect, same result as default
3721
+ * Docgenerator::Elements::Comment#CR has no effect, same result as default
3461
3722
  ===Docgenerator::Elements::Comment#to_context
3462
3723
  \comment{content}
3463
3724
 
@@ -6593,6 +6854,7 @@ module Docgenerator
6593
6854
  usemap : - X - - - - - -
6594
6855
  name : - X - - - - - -
6595
6856
  angle : - - - X - - - -
6857
+ texoption : - - X - - - - -
6596
6858
 
6597
6859
 
6598
6860
  Docgenerator::Elements::Img allows no content.
@@ -6613,6 +6875,7 @@ Docgenerator::Elements::Img allows no content.
6613
6875
  #:usemap => <<value>>, % optional, values: [String]
6614
6876
  #:name => <<value>>, % optional, values: [String]
6615
6877
  #:angle => <<value>>, % optional, values: [Integer]
6878
+ #:texoption => <<value>>, % optional, values: [String]
6616
6879
  })
6617
6880
 
6618
6881
  Alternative generation
@@ -6622,34 +6885,34 @@ Alternative generation
6622
6885
 
6623
6886
  ==Outputs
6624
6887
  ===Docgenerator::Elements::Img#to_latex
6625
- \includegraphics[]{Value for src}
6888
+ \includegraphics[,]{Value for src}
6626
6889
 
6627
6890
  ====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Img#.to_latex
6628
6891
  <<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
6629
6892
 
6630
6893
  Default:
6631
- <<START>>\includegraphics[]{Value for src}<<END>>
6894
+ <<START>>\includegraphics[,]{Value for src}<<END>>
6632
6895
 
6633
6896
  * Result after Docgenerator::Elements::Img#cr:
6634
6897
 
6635
- <<START>>\includegraphics[]{Value for src}
6898
+ <<START>>\includegraphics[,]{Value for src}
6636
6899
  <<END>>
6637
6900
 
6638
6901
  * Result after Docgenerator::Elements::Img#cR:
6639
6902
 
6640
- <<START>>\includegraphics[]{Value for src}
6903
+ <<START>>\includegraphics[,]{Value for src}
6641
6904
  <<END>>
6642
6905
 
6643
6906
  * Result after Docgenerator::Elements::Img#Cr:
6644
6907
 
6645
6908
  <<START>>
6646
- \includegraphics[]{Value for src}
6909
+ \includegraphics[,]{Value for src}
6647
6910
  <<END>>
6648
6911
 
6649
6912
  * Result after Docgenerator::Elements::Img#CR:
6650
6913
 
6651
6914
  <<START>>
6652
- \includegraphics[]{Value for src}
6915
+ \includegraphics[,]{Value for src}
6653
6916
  <<END>>
6654
6917
 
6655
6918
  ===Docgenerator::Elements::Img#to_html