rdoc_html_templates 2.3.0
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.
- data.tar.gz.sig +1 -0
- data/History.txt +6 -0
- data/Manifest.txt +9 -0
- data/README.txt +34 -0
- data/Rakefile +18 -0
- data/lib/rdoc/discover.rb +1 -0
- data/lib/rdoc/generator/html/frameless.rb +93 -0
- data/lib/rdoc/generator/html/hefss.rb +151 -0
- data/lib/rdoc/generator/html/kilmer.rb +152 -0
- data/lib/rdoc/generator/html/kilmerfactory.rb +428 -0
- metadata +119 -0
- metadata.gz.sig +0 -0
data.tar.gz.sig
ADDED
data/History.txt
ADDED
data/Manifest.txt
ADDED
data/README.txt
ADDED
@@ -0,0 +1,34 @@
|
|
1
|
+
= rdoc_html_templates
|
2
|
+
|
3
|
+
* Project Page: http://rubyforge.org/projects/rdoc
|
4
|
+
* Documentation: http://rdoc.rubyforge.org/rdoc_html_templates
|
5
|
+
|
6
|
+
== DESCRIPTION:
|
7
|
+
|
8
|
+
Unmaintained templates for RDoc's HTML generator.
|
9
|
+
|
10
|
+
== FEATURES/PROBLEMS:
|
11
|
+
|
12
|
+
* Unmaintained, only known to work with RDoc 2.3.0
|
13
|
+
|
14
|
+
== SYNOPSIS:
|
15
|
+
|
16
|
+
gem 'rdoc'
|
17
|
+
require 'rdoc/rdoc'
|
18
|
+
|
19
|
+
RDoc::RDoc.new.document "-f html", "-T kilmer", # ... see RDoc
|
20
|
+
|
21
|
+
== REQUIREMENTS:
|
22
|
+
|
23
|
+
* RDoc 2.3 (probably works with newer RDoc 2.x versions)
|
24
|
+
|
25
|
+
== INSTALL:
|
26
|
+
|
27
|
+
* sudo gem install rdoc_html_templates
|
28
|
+
|
29
|
+
== LICENSE:
|
30
|
+
|
31
|
+
RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers. It is
|
32
|
+
free software, and may be redistributed under the terms specified in the
|
33
|
+
README file of the Ruby distribution.
|
34
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# -*- ruby -*-
|
2
|
+
|
3
|
+
require 'rubygems'
|
4
|
+
require 'hoe'
|
5
|
+
|
6
|
+
Hoe.new('rdoc_html_templates', '2.3.0') do |p|
|
7
|
+
p.rubyforge_name = 'rdoc'
|
8
|
+
|
9
|
+
p.developer 'Eric Hodel', 'drbrain@segment7.net'
|
10
|
+
p.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
|
11
|
+
p.developer 'Dave Thomas', ''
|
12
|
+
|
13
|
+
p.extra_deps << ['rdoc', '~> 2.3']
|
14
|
+
p.extra_dev_deps << ['minitest', '~> 1.3']
|
15
|
+
p.spec_extras['required_rubygems_version'] = '>= 1.3'
|
16
|
+
end
|
17
|
+
|
18
|
+
# vim: syntax=Ruby
|
@@ -0,0 +1 @@
|
|
1
|
+
# no-op, only for auto-gem by RDoc
|
@@ -0,0 +1,93 @@
|
|
1
|
+
gem 'rdoc', '~> 2.3'
|
2
|
+
require 'rdoc/generator/html/html'
|
3
|
+
|
4
|
+
##
|
5
|
+
# = CSS2 RDoc HTML template
|
6
|
+
#
|
7
|
+
# This is a template for RDoc that uses XHTML 1.0 Strict and dictates a
|
8
|
+
# bit more of the appearance of the output to cascading stylesheets than the
|
9
|
+
# default. It was designed for clean inline code display, and uses DHTMl to
|
10
|
+
# toggle the visbility of each method's source with each click on the '[source]'
|
11
|
+
# link.
|
12
|
+
#
|
13
|
+
# Frameless basically is the html template without frames.
|
14
|
+
#
|
15
|
+
# == Authors
|
16
|
+
#
|
17
|
+
# * Michael Granger <ged@FaerieMUD.org>
|
18
|
+
#
|
19
|
+
# Copyright (c) 2002, 2003 The FaerieMUD Consortium. Some rights reserved.
|
20
|
+
#
|
21
|
+
# This work is licensed under the Creative Commons Attribution License. To view
|
22
|
+
# a copy of this license, visit http://creativecommons.org/licenses/by/1.0/ or
|
23
|
+
# send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California
|
24
|
+
# 94305, USA.
|
25
|
+
|
26
|
+
module RDoc::Generator::HTML::FRAMELESS
|
27
|
+
|
28
|
+
FRAMELESS = true
|
29
|
+
|
30
|
+
FONTS = RDoc::Generator::HTML::HTML::FONTS
|
31
|
+
|
32
|
+
STYLE = RDoc::Generator::HTML::HTML::STYLE
|
33
|
+
|
34
|
+
HEADER = RDoc::Generator::HTML::HTML::HEADER
|
35
|
+
|
36
|
+
FOOTER = <<-EOF
|
37
|
+
<div id="popupmenu" class="index">
|
38
|
+
<br />
|
39
|
+
<h1 class="index-entries section-bar">Files</h1>
|
40
|
+
<ul>
|
41
|
+
<% values[:file_list].each do |file| %>
|
42
|
+
<li><a href="<%= file[:href] %>"><%= file[:name] %></a></li>
|
43
|
+
<% end %>
|
44
|
+
</ul>
|
45
|
+
|
46
|
+
<br />
|
47
|
+
<h1 class="index-entries section-bar">Classes</h1>
|
48
|
+
<ul>
|
49
|
+
<% values[:class_list].each do |klass| %>
|
50
|
+
<li><a href="<%= klass[:href] %>"><%= klass[:name] %></a></li>
|
51
|
+
<% end %>
|
52
|
+
</ul>
|
53
|
+
|
54
|
+
<br />
|
55
|
+
<h1 class="index-entries section-bar">Methods</h1>
|
56
|
+
<ul>
|
57
|
+
<% values[:method_list].each do |method| %>
|
58
|
+
<li><a href="<%= method[:href] %>"><%= method[:name] %></a></li>
|
59
|
+
<% end %>
|
60
|
+
</ul>
|
61
|
+
</div>
|
62
|
+
</body>
|
63
|
+
</html>
|
64
|
+
EOF
|
65
|
+
|
66
|
+
FILE_PAGE = RDoc::Generator::HTML::HTML::FILE_PAGE
|
67
|
+
|
68
|
+
CLASS_PAGE = RDoc::Generator::HTML::HTML::CLASS_PAGE
|
69
|
+
|
70
|
+
METHOD_LIST = RDoc::Generator::HTML::HTML::METHOD_LIST
|
71
|
+
|
72
|
+
BODY = HEADER + %{
|
73
|
+
|
74
|
+
<%= template_include %> <!-- banner header -->
|
75
|
+
|
76
|
+
<div id="bodyContent">
|
77
|
+
|
78
|
+
} + METHOD_LIST + %{
|
79
|
+
|
80
|
+
</div>
|
81
|
+
|
82
|
+
} + FOOTER
|
83
|
+
|
84
|
+
SRC_PAGE = RDoc::Generator::HTML::HTML::SRC_PAGE
|
85
|
+
|
86
|
+
FR_INDEX_BODY = RDoc::Generator::HTML::HTML::FR_INDEX_BODY
|
87
|
+
|
88
|
+
FILE_INDEX = RDoc::Generator::HTML::HTML::FILE_INDEX
|
89
|
+
|
90
|
+
CLASS_INDEX = RDoc::Generator::HTML::HTML::CLASS_INDEX
|
91
|
+
|
92
|
+
METHOD_INDEX = RDoc::Generator::HTML::HTML::METHOD_INDEX
|
93
|
+
end
|
@@ -0,0 +1,151 @@
|
|
1
|
+
gem 'rdoc', '~> 2.3'
|
2
|
+
require 'rdoc/generator/html'
|
3
|
+
require 'rdoc/generator/html/kilmerfactory'
|
4
|
+
|
5
|
+
module RDoc::Generator::HTML::HEFSS
|
6
|
+
|
7
|
+
FONTS = "Verdana, Arial, Helvetica, sans-serif"
|
8
|
+
|
9
|
+
CENTRAL_STYLE = <<-EOF
|
10
|
+
body,p { font-family: <%= values[:fonts] %>;
|
11
|
+
color: #000040; background: #BBBBBB;
|
12
|
+
}
|
13
|
+
|
14
|
+
td { font-family: <%= values[:fonts] %>;
|
15
|
+
color: #000040;
|
16
|
+
}
|
17
|
+
|
18
|
+
.attr-rw { font-size: small; color: #444488 }
|
19
|
+
|
20
|
+
.title-row {color: #eeeeff;
|
21
|
+
background: #BBBBDD;
|
22
|
+
}
|
23
|
+
|
24
|
+
.big-title-font { color: white;
|
25
|
+
font-family: <%= values[:fonts] %>;
|
26
|
+
font-size: large;
|
27
|
+
height: 50px}
|
28
|
+
|
29
|
+
.small-title-font { color: purple;
|
30
|
+
font-family: <%= values[:fonts] %>;
|
31
|
+
font-size: small; }
|
32
|
+
|
33
|
+
.aqua { color: purple }
|
34
|
+
|
35
|
+
#diagram img {
|
36
|
+
border: 0;
|
37
|
+
}
|
38
|
+
|
39
|
+
.method-name, attr-name {
|
40
|
+
font-family: monospace; font-weight: bold;
|
41
|
+
}
|
42
|
+
|
43
|
+
.tablesubtitle {
|
44
|
+
width: 100%;
|
45
|
+
margin-top: 1ex;
|
46
|
+
margin-bottom: .5ex;
|
47
|
+
padding: 5px 0px 5px 20px;
|
48
|
+
font-size: large;
|
49
|
+
color: purple;
|
50
|
+
background: #BBBBCC;
|
51
|
+
}
|
52
|
+
|
53
|
+
.tablesubsubtitle {
|
54
|
+
width: 100%;
|
55
|
+
margin-top: 1ex;
|
56
|
+
margin-bottom: .5ex;
|
57
|
+
padding: 5px 0px 5px 20px;
|
58
|
+
font-size: medium;
|
59
|
+
color: white;
|
60
|
+
background: #BBBBCC;
|
61
|
+
}
|
62
|
+
|
63
|
+
.name-list {
|
64
|
+
font-family: monospace;
|
65
|
+
margin-left: 40px;
|
66
|
+
margin-bottom: 2ex;
|
67
|
+
line-height: 140%;
|
68
|
+
}
|
69
|
+
|
70
|
+
.description {
|
71
|
+
margin-left: 40px;
|
72
|
+
margin-bottom: 2ex;
|
73
|
+
line-height: 140%;
|
74
|
+
}
|
75
|
+
|
76
|
+
.methodtitle {
|
77
|
+
font-size: medium;
|
78
|
+
text_decoration: none;
|
79
|
+
padding: 3px 3px 3px 20px;
|
80
|
+
color: #0000AA;
|
81
|
+
}
|
82
|
+
|
83
|
+
.ruby-comment { color: green; font-style: italic }
|
84
|
+
.ruby-constant { color: #4433aa; font-weight: bold; }
|
85
|
+
.ruby-identifier { color: #222222; }
|
86
|
+
.ruby-ivar { color: #2233dd; }
|
87
|
+
.ruby-keyword { color: #3333FF; font-weight: bold }
|
88
|
+
.ruby-node { color: #777777; }
|
89
|
+
.ruby-operator { color: #111111; }
|
90
|
+
.ruby-regexp { color: #662222; }
|
91
|
+
.ruby-value { color: #662222; font-style: italic }
|
92
|
+
|
93
|
+
.srcbut { float: right }
|
94
|
+
EOF
|
95
|
+
|
96
|
+
INDEX_STYLE = <<-EOF
|
97
|
+
body {
|
98
|
+
background-color: #bbbbbb;
|
99
|
+
font-family: #{FONTS};
|
100
|
+
font-size: 11px;
|
101
|
+
font-style: normal;
|
102
|
+
line-height: 14px;
|
103
|
+
color: #000040;
|
104
|
+
}
|
105
|
+
|
106
|
+
div.banner {
|
107
|
+
background: #bbbbcc;
|
108
|
+
color: white;
|
109
|
+
padding: 1;
|
110
|
+
margin: 0;
|
111
|
+
font-size: 90%;
|
112
|
+
font-weight: bold;
|
113
|
+
line-height: 1.1;
|
114
|
+
text-align: center;
|
115
|
+
width: 100%;
|
116
|
+
}
|
117
|
+
EOF
|
118
|
+
|
119
|
+
FACTORY = RDoc::Generator::HTML::
|
120
|
+
KilmerFactory.new(:central_css => CENTRAL_STYLE,
|
121
|
+
:index_css => INDEX_STYLE,
|
122
|
+
:method_list_heading => "Subroutines and Functions",
|
123
|
+
:class_and_module_list_heading => "Classes and Modules",
|
124
|
+
:attribute_list_heading => "Arguments")
|
125
|
+
|
126
|
+
STYLE = FACTORY.get_STYLE()
|
127
|
+
|
128
|
+
METHOD_LIST = FACTORY.get_METHOD_LIST()
|
129
|
+
|
130
|
+
BODY = FACTORY.get_BODY()
|
131
|
+
|
132
|
+
FILE_PAGE = FACTORY.get_FILE_PAGE()
|
133
|
+
|
134
|
+
CLASS_PAGE = FACTORY.get_CLASS_PAGE()
|
135
|
+
|
136
|
+
SRC_PAGE = FACTORY.get_SRC_PAGE()
|
137
|
+
|
138
|
+
FR_INDEX_BODY = FACTORY.get_FR_INDEX_BODY()
|
139
|
+
|
140
|
+
FILE_INDEX = FACTORY.get_FILE_INDEX()
|
141
|
+
|
142
|
+
CLASS_INDEX = FACTORY.get_CLASS_INDEX()
|
143
|
+
|
144
|
+
METHOD_INDEX = FACTORY.get_METHOD_INDEX()
|
145
|
+
|
146
|
+
INDEX = FACTORY.get_INDEX()
|
147
|
+
|
148
|
+
def self.write_extra_pages(values)
|
149
|
+
FACTORY.write_extra_pages(values)
|
150
|
+
end
|
151
|
+
end
|
@@ -0,0 +1,152 @@
|
|
1
|
+
gem 'rdoc', '~> 2.3'
|
2
|
+
require 'rdoc/generator/html'
|
3
|
+
require 'rdoc/generator/html/kilmerfactory'
|
4
|
+
|
5
|
+
module RDoc::Generator::HTML::KILMER
|
6
|
+
|
7
|
+
FONTS = "Verdana, Arial, Helvetica, sans-serif"
|
8
|
+
|
9
|
+
CENTRAL_STYLE = <<-EOF
|
10
|
+
body,td,p { font-family: <%= values[:fonts] %>;
|
11
|
+
color: #000040;
|
12
|
+
}
|
13
|
+
|
14
|
+
.attr-rw { font-size: xx-small; color: #444488 }
|
15
|
+
|
16
|
+
.title-row { background-color: #CCCCFF;
|
17
|
+
color: #000010;
|
18
|
+
}
|
19
|
+
|
20
|
+
.big-title-font {
|
21
|
+
color: black;
|
22
|
+
font-weight: bold;
|
23
|
+
font-family: <%= values[:fonts] %>;
|
24
|
+
font-size: large;
|
25
|
+
height: 60px;
|
26
|
+
padding: 10px 3px 10px 3px;
|
27
|
+
}
|
28
|
+
|
29
|
+
.small-title-font { color: black;
|
30
|
+
font-family: <%= values[:fonts] %>;
|
31
|
+
font-size:10; }
|
32
|
+
|
33
|
+
.aqua { color: black }
|
34
|
+
|
35
|
+
#diagram img {
|
36
|
+
border: 0;
|
37
|
+
}
|
38
|
+
|
39
|
+
.method-name, .attr-name {
|
40
|
+
font-family: font-family: <%= values[:fonts] %>;
|
41
|
+
font-weight: bold;
|
42
|
+
font-size: small;
|
43
|
+
margin-left: 20px;
|
44
|
+
color: #000033;
|
45
|
+
}
|
46
|
+
|
47
|
+
.tablesubtitle, .tablesubsubtitle {
|
48
|
+
width: 100%;
|
49
|
+
margin-top: 1ex;
|
50
|
+
margin-bottom: .5ex;
|
51
|
+
padding: 5px 0px 5px 3px;
|
52
|
+
font-size: large;
|
53
|
+
color: black;
|
54
|
+
background-color: #CCCCFF;
|
55
|
+
border: thin;
|
56
|
+
}
|
57
|
+
|
58
|
+
.name-list {
|
59
|
+
margin-left: 5px;
|
60
|
+
margin-bottom: 2ex;
|
61
|
+
line-height: 105%;
|
62
|
+
}
|
63
|
+
|
64
|
+
.description {
|
65
|
+
margin-left: 5px;
|
66
|
+
margin-bottom: 2ex;
|
67
|
+
line-height: 105%;
|
68
|
+
font-size: small;
|
69
|
+
}
|
70
|
+
|
71
|
+
.methodtitle {
|
72
|
+
font-size: small;
|
73
|
+
font-weight: bold;
|
74
|
+
text-decoration: none;
|
75
|
+
color: #000033;
|
76
|
+
background: #ccc;
|
77
|
+
}
|
78
|
+
|
79
|
+
.srclink {
|
80
|
+
font-size: small;
|
81
|
+
font-weight: bold;
|
82
|
+
text-decoration: none;
|
83
|
+
color: #0000DD;
|
84
|
+
background-color: white;
|
85
|
+
}
|
86
|
+
|
87
|
+
.srcbut { float: right }
|
88
|
+
|
89
|
+
.ruby-comment { color: green; font-style: italic }
|
90
|
+
.ruby-constant { color: #4433aa; font-weight: bold; }
|
91
|
+
.ruby-identifier { color: #222222; }
|
92
|
+
.ruby-ivar { color: #2233dd; }
|
93
|
+
.ruby-keyword { color: #3333FF; font-weight: bold }
|
94
|
+
.ruby-node { color: #777777; }
|
95
|
+
.ruby-operator { color: #111111; }
|
96
|
+
.ruby-regexp { color: #662222; }
|
97
|
+
.ruby-value { color: #662222; font-style: italic }
|
98
|
+
EOF
|
99
|
+
|
100
|
+
INDEX_STYLE = <<-EOF
|
101
|
+
body {
|
102
|
+
background-color: #ddddff;
|
103
|
+
font-family: #{FONTS};
|
104
|
+
font-size: 11px;
|
105
|
+
font-style: normal;
|
106
|
+
line-height: 14px;
|
107
|
+
color: #000040;
|
108
|
+
}
|
109
|
+
|
110
|
+
div.banner {
|
111
|
+
background: #0000aa;
|
112
|
+
color: white;
|
113
|
+
padding: 1;
|
114
|
+
margin: 0;
|
115
|
+
font-size: 90%;
|
116
|
+
font-weight: bold;
|
117
|
+
line-height: 1.1;
|
118
|
+
text-align: center;
|
119
|
+
width: 100%;
|
120
|
+
}
|
121
|
+
EOF
|
122
|
+
|
123
|
+
FACTORY = RDoc::Generator::HTML::
|
124
|
+
KilmerFactory.new(:central_css => CENTRAL_STYLE,
|
125
|
+
:index_css => INDEX_STYLE)
|
126
|
+
|
127
|
+
STYLE = FACTORY.get_STYLE()
|
128
|
+
|
129
|
+
METHOD_LIST = FACTORY.get_METHOD_LIST()
|
130
|
+
|
131
|
+
BODY = FACTORY.get_BODY()
|
132
|
+
|
133
|
+
FILE_PAGE = FACTORY.get_FILE_PAGE()
|
134
|
+
|
135
|
+
CLASS_PAGE = FACTORY.get_CLASS_PAGE()
|
136
|
+
|
137
|
+
SRC_PAGE = FACTORY.get_SRC_PAGE()
|
138
|
+
|
139
|
+
FR_INDEX_BODY = FACTORY.get_FR_INDEX_BODY()
|
140
|
+
|
141
|
+
FILE_INDEX = FACTORY.get_FILE_INDEX()
|
142
|
+
|
143
|
+
CLASS_INDEX = FACTORY.get_CLASS_INDEX()
|
144
|
+
|
145
|
+
METHOD_INDEX = FACTORY.get_METHOD_INDEX()
|
146
|
+
|
147
|
+
INDEX = FACTORY.get_INDEX()
|
148
|
+
|
149
|
+
def self.write_extra_pages(values)
|
150
|
+
FACTORY.write_extra_pages(values)
|
151
|
+
end
|
152
|
+
end
|
@@ -0,0 +1,428 @@
|
|
1
|
+
gem 'rdoc', '~> 2.3'
|
2
|
+
require 'rdoc/generator/html'
|
3
|
+
require 'rdoc/generator/html/common'
|
4
|
+
|
5
|
+
#
|
6
|
+
# This class generates Kilmer-style templates. Right now,
|
7
|
+
# rdoc is shipped with two such templates:
|
8
|
+
# * kilmer
|
9
|
+
# * hefss
|
10
|
+
#
|
11
|
+
# Kilmer-style templates use frames. The left side of the page has
|
12
|
+
# three frames stacked on top of each other: one lists
|
13
|
+
# files, one lists classes, and one lists methods. If source code
|
14
|
+
# is not inlined, an additional frame runs across the bottom of
|
15
|
+
# the page and will be used to display method source code.
|
16
|
+
# The central (and largest frame) display class and file
|
17
|
+
# pages.
|
18
|
+
#
|
19
|
+
# The constructor of this class accepts a Hash containing stylistic
|
20
|
+
# attributes. Then, a get_BLAH instance method of this class returns a
|
21
|
+
# value for the template's BLAH constant. get_BODY, for instance, returns
|
22
|
+
# the value of the template's BODY constant.
|
23
|
+
#
|
24
|
+
class RDoc::Generator::HTML::KilmerFactory
|
25
|
+
|
26
|
+
include RDoc::Generator::HTML::Common
|
27
|
+
|
28
|
+
#
|
29
|
+
# The contents of the stylesheet that should be used for the
|
30
|
+
# central frame (for the class and file pages).
|
31
|
+
#
|
32
|
+
# This must be specified in the Hash passed to the constructor.
|
33
|
+
#
|
34
|
+
attr_reader :central_css
|
35
|
+
|
36
|
+
#
|
37
|
+
# The contents of the stylesheet that should be used for the
|
38
|
+
# index pages.
|
39
|
+
#
|
40
|
+
# This must be specified in the Hash passed to the constructor.
|
41
|
+
#
|
42
|
+
attr_reader :index_css
|
43
|
+
|
44
|
+
#
|
45
|
+
# The heading that should be displayed before listing methods.
|
46
|
+
#
|
47
|
+
# If not supplied, this defaults to "Methods".
|
48
|
+
#
|
49
|
+
attr_reader :method_list_heading
|
50
|
+
|
51
|
+
#
|
52
|
+
# The heading that should be displayed before listing classes and
|
53
|
+
# modules.
|
54
|
+
#
|
55
|
+
# If not supplied, this defaults to "Classes and Modules".
|
56
|
+
#
|
57
|
+
attr_reader :class_and_module_list_heading
|
58
|
+
|
59
|
+
#
|
60
|
+
# The heading that should be displayed before listing attributes.
|
61
|
+
#
|
62
|
+
# If not supplied, this defaults to "Attributes".
|
63
|
+
#
|
64
|
+
attr_reader :attribute_list_heading
|
65
|
+
|
66
|
+
#
|
67
|
+
# ====Description:
|
68
|
+
# This method constructs a KilmerFactory instance, which
|
69
|
+
# can be used to build Kilmer-style template classes.
|
70
|
+
# The +style_attributes+ argument is a Hash that contains the
|
71
|
+
# values of the classes attributes (Symbols mapped to Strings).
|
72
|
+
#
|
73
|
+
# ====Parameters:
|
74
|
+
# [style_attributes]
|
75
|
+
# A Hash describing the appearance of the Kilmer-style.
|
76
|
+
#
|
77
|
+
def initialize(style_attributes)
|
78
|
+
@central_css = style_attributes[:central_css]
|
79
|
+
if(!@central_css)
|
80
|
+
raise ArgumentError, "did not specify a value for :central_css"
|
81
|
+
end
|
82
|
+
|
83
|
+
@index_css = style_attributes[:index_css]
|
84
|
+
if(!@index_css)
|
85
|
+
raise ArgumentError, "did not specify a value for :index_css"
|
86
|
+
end
|
87
|
+
|
88
|
+
@method_list_heading = style_attributes[:method_list_heading]
|
89
|
+
if(!@method_list_heading)
|
90
|
+
@method_list_heading = "Methods"
|
91
|
+
end
|
92
|
+
|
93
|
+
@class_and_module_list_heading = style_attributes[:class_and_module_list_heading]
|
94
|
+
if(!@class_and_module_list_heading)
|
95
|
+
@class_and_module_list_heading = "Classes and Modules"
|
96
|
+
end
|
97
|
+
|
98
|
+
@attribute_list_heading = style_attributes[:attribute_list_heading]
|
99
|
+
if(!@attribute_list_heading)
|
100
|
+
@attribute_list_heading = "Attributes"
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
def get_STYLE
|
105
|
+
return @central_css
|
106
|
+
end
|
107
|
+
|
108
|
+
def get_METHOD_LIST
|
109
|
+
return %{
|
110
|
+
<% if values[:diagram] then %>
|
111
|
+
<div id="diagram">
|
112
|
+
<table width="100%"><tr><td align="center">
|
113
|
+
<%= values[:diagram] %>
|
114
|
+
</td></tr></table>
|
115
|
+
</div>
|
116
|
+
<% end %>
|
117
|
+
|
118
|
+
<% if values[:description] then %>
|
119
|
+
<div class="description"><%= values[:description] %></div>
|
120
|
+
<% end %>
|
121
|
+
|
122
|
+
<% if values[:requires] then %>
|
123
|
+
<table cellpadding="5" width="100%">
|
124
|
+
<tr><td class="tablesubtitle">Required files</td></tr>
|
125
|
+
</table><br />
|
126
|
+
<div class="name-list">
|
127
|
+
<% values[:requires].each do |requires| %>
|
128
|
+
<%= href requires[:aref], requires[:name] %>
|
129
|
+
<% end %><%# values[:requires] %>
|
130
|
+
</div>
|
131
|
+
<% end %>
|
132
|
+
|
133
|
+
<% if values[:methods] then %>
|
134
|
+
<table cellpadding="5" width="100%">
|
135
|
+
<tr><td class="tablesubtitle">#{@method_list_heading}</td></tr>
|
136
|
+
</table><br />
|
137
|
+
<div class="name-list">
|
138
|
+
<% values[:methods].each do |methods| %>
|
139
|
+
<%= href methods[:aref], methods[:name] %>,
|
140
|
+
<% end %><%# values[:methods] %>
|
141
|
+
</div>
|
142
|
+
<% end %>
|
143
|
+
|
144
|
+
<% if values[:includes] then %>
|
145
|
+
<div class="tablesubsubtitle">Included modules</div><br />
|
146
|
+
<div class="name-list">
|
147
|
+
<% values[:includes].each do |includes| %>
|
148
|
+
<span class="method-name"><%= href includes[:aref], includes[:name] %></span>
|
149
|
+
<% end %><%# values[:includes] %>
|
150
|
+
</div>
|
151
|
+
<% end %>
|
152
|
+
|
153
|
+
<% values[:sections].each do |sections| %>
|
154
|
+
<div id="section">
|
155
|
+
<% if sections[:sectitle] then %>
|
156
|
+
<h2 class="section-title"><a name="<%= sections[:secsequence] %>"><%= sections[:sectitle] %></a></h2>
|
157
|
+
<% if sections[:seccomment] then %>
|
158
|
+
<div class="section-comment">
|
159
|
+
<%= sections[:seccomment] %>
|
160
|
+
</div>
|
161
|
+
<% end %>
|
162
|
+
<% end %>
|
163
|
+
<% if sections[:attributes] then %>
|
164
|
+
<table cellpadding="5" width="100%">
|
165
|
+
<tr><td class="tablesubtitle">#{@attribute_list_heading}</td></tr>
|
166
|
+
</table><br />
|
167
|
+
<table cellspacing="5">
|
168
|
+
<% sections[:attributes].each do |attributes| %>
|
169
|
+
<tr valign="top">
|
170
|
+
<% if attributes[:rw] then %>
|
171
|
+
<td align="center" class="attr-rw"> [<%= attributes[:rw] %>] </td>
|
172
|
+
<% end %>
|
173
|
+
<% unless attributes[:rw] then %>
|
174
|
+
<td></td>
|
175
|
+
<% end %>
|
176
|
+
<td class="attr-name"><%= attributes[:name] %></td>
|
177
|
+
<td><%= attributes[:a_desc] %></td>
|
178
|
+
</tr>
|
179
|
+
<% end %><%# sections[:attributes] %>
|
180
|
+
</table>
|
181
|
+
<% end %>
|
182
|
+
|
183
|
+
<% if sections[:classlist] then %>
|
184
|
+
<table cellpadding="5" width="100%">
|
185
|
+
<tr><td class="tablesubtitle">#{@class_and_module_list_heading}</td></tr>
|
186
|
+
</table><br />
|
187
|
+
<%= sections[:classlist] %><br />
|
188
|
+
<% end %>
|
189
|
+
|
190
|
+
<% if sections[:method_list] then %>
|
191
|
+
<% sections[:method_list].each do |method_list| %>
|
192
|
+
<% if method_list[:methods] then %>
|
193
|
+
<table cellpadding="5" width="100%">
|
194
|
+
<tr><td class="tablesubtitle"><%= method_list[:type] %> <%= method_list[:category] %> methods</td></tr>
|
195
|
+
</table>
|
196
|
+
<% method_list[:methods].each do |methods| %>
|
197
|
+
<table width="100%" cellspacing="0" cellpadding="5" border="0">
|
198
|
+
<tr><td class="methodtitle">
|
199
|
+
<a name="<%= methods[:aref] %>">
|
200
|
+
<% if methods[:callseq] then %>
|
201
|
+
<b><%= methods[:callseq] %></b>
|
202
|
+
<% end %>
|
203
|
+
<% unless methods[:callseq] then %>
|
204
|
+
<b><%= methods[:name] %></b><%= methods[:params] %>
|
205
|
+
<% end %>
|
206
|
+
</a>
|
207
|
+
<% if methods[:codeurl] then %>
|
208
|
+
<a href="<%= methods[:codeurl] %>" target="source" class="srclink">src</a>
|
209
|
+
<% end %>
|
210
|
+
</td></tr>
|
211
|
+
</table>
|
212
|
+
<% if methods[:m_desc] then %>
|
213
|
+
<div class="description">
|
214
|
+
<%= methods[:m_desc] %>
|
215
|
+
</div>
|
216
|
+
<% end %>
|
217
|
+
<% if methods[:aka] then %>
|
218
|
+
<div class="aka">
|
219
|
+
This method is also aliased as
|
220
|
+
<% methods[:aka].each do |aka| %>
|
221
|
+
<a href="<%= methods[:aref] %>"><%= methods[:name] %></a>
|
222
|
+
<% end %><%# methods[:aka] %>
|
223
|
+
</div>
|
224
|
+
<% end %>
|
225
|
+
<% if methods[:sourcecode] then %>
|
226
|
+
<pre class="source">
|
227
|
+
<%= methods[:sourcecode] %>
|
228
|
+
</pre>
|
229
|
+
<% end %>
|
230
|
+
<% end %><%# method_list[:methods] %>
|
231
|
+
<% end %>
|
232
|
+
<% end %><%# sections[:method_list] %>
|
233
|
+
<% end %>
|
234
|
+
|
235
|
+
<% end %><%# values[:sections] %>
|
236
|
+
</div>
|
237
|
+
}
|
238
|
+
end
|
239
|
+
|
240
|
+
def get_BODY
|
241
|
+
return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{
|
242
|
+
<head>
|
243
|
+
<title><%= values[:title] %></title>
|
244
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
|
245
|
+
<link rel="stylesheet" href="<%= values[:style_url] %>" type="text/css" media="screen" />
|
246
|
+
<script type="text/javascript">
|
247
|
+
<!--
|
248
|
+
function popCode(url) {
|
249
|
+
parent.frames.source.location = url
|
250
|
+
}
|
251
|
+
//-->
|
252
|
+
</script>
|
253
|
+
</head>
|
254
|
+
<body>
|
255
|
+
<div class="bodyContent">
|
256
|
+
<%= template_include %> <!-- banner header -->
|
257
|
+
|
258
|
+
#{get_METHOD_LIST()}
|
259
|
+
</div>
|
260
|
+
</body>
|
261
|
+
</html>
|
262
|
+
}
|
263
|
+
end
|
264
|
+
|
265
|
+
def get_FILE_PAGE
|
266
|
+
return %{
|
267
|
+
<table width="100%">
|
268
|
+
<tr class="title-row">
|
269
|
+
<td><table width="100%"><tr>
|
270
|
+
<td class="big-title-font" colspan="2">File<br /><%= values[:short_name] %></td>
|
271
|
+
<td align="right"><table cellspacing="0" cellpadding="2">
|
272
|
+
<tr>
|
273
|
+
<td class="small-title-font">Path:</td>
|
274
|
+
<td class="small-title-font"><%= values[:full_path] %>
|
275
|
+
<% if values[:cvsurl] then %>
|
276
|
+
(<a href="<%= values[:cvsurl] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
|
277
|
+
<% end %>
|
278
|
+
</td>
|
279
|
+
</tr>
|
280
|
+
<tr>
|
281
|
+
<td class="small-title-font">Modified:</td>
|
282
|
+
<td class="small-title-font"><%= values[:dtm_modified] %></td>
|
283
|
+
</tr>
|
284
|
+
</table>
|
285
|
+
</td></tr></table></td>
|
286
|
+
</tr>
|
287
|
+
</table><br />
|
288
|
+
}
|
289
|
+
end
|
290
|
+
|
291
|
+
def get_CLASS_PAGE
|
292
|
+
return %{
|
293
|
+
<table width="100%" border="0" cellspacing="0">
|
294
|
+
<tr class="title-row">
|
295
|
+
<td class="big-title-font">
|
296
|
+
<%= values[:classmod] %><br /><%= values[:full_name] %>
|
297
|
+
</td>
|
298
|
+
<td align="right">
|
299
|
+
<table cellspacing="0" cellpadding="2">
|
300
|
+
<tr valign="top">
|
301
|
+
<td class="small-title-font">In:</td>
|
302
|
+
<td class="small-title-font">
|
303
|
+
<% values[:infiles].each do |infiles| %>
|
304
|
+
<%= href infiles[:full_path_url], infiles[:full_path] %>
|
305
|
+
<% if infiles[:cvsurl] then %>
|
306
|
+
(<a href="<%= infiles[:cvsurl] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
|
307
|
+
<% end %>
|
308
|
+
<% end %><%# values[:infiles] %>
|
309
|
+
</td>
|
310
|
+
</tr>
|
311
|
+
<% if values[:parent] then %>
|
312
|
+
<tr>
|
313
|
+
<td class="small-title-font">Parent:</td>
|
314
|
+
<td class="small-title-font">
|
315
|
+
<% if values[:par_url] then %>
|
316
|
+
<a href="<%= values[:par_url] %>" class="cyan">
|
317
|
+
<% end %>
|
318
|
+
<%= values[:parent] %>
|
319
|
+
<% if values[:par_url] then %>
|
320
|
+
</a>
|
321
|
+
<% end %>
|
322
|
+
</td>
|
323
|
+
</tr>
|
324
|
+
<% end %>
|
325
|
+
</table>
|
326
|
+
</td>
|
327
|
+
</tr>
|
328
|
+
</table><br />
|
329
|
+
}
|
330
|
+
end
|
331
|
+
|
332
|
+
def get_SRC_PAGE
|
333
|
+
return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{
|
334
|
+
<head><title><%= values[:title] %></title>
|
335
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
|
336
|
+
<link rel="stylesheet" href="<%= values[:style_url] %>" type="text/css" media="screen" />
|
337
|
+
</head>
|
338
|
+
<body>
|
339
|
+
<pre><%= values[:code] %></pre>
|
340
|
+
</body>
|
341
|
+
</html>
|
342
|
+
}
|
343
|
+
end
|
344
|
+
|
345
|
+
def get_FR_INDEX_BODY
|
346
|
+
return %{<%= template_include %>}
|
347
|
+
end
|
348
|
+
|
349
|
+
def get_FILE_INDEX
|
350
|
+
return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{
|
351
|
+
<head>
|
352
|
+
<title><%= values[:title] %></title>
|
353
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
|
354
|
+
<style type="text/css">
|
355
|
+
<!--
|
356
|
+
#{@index_css}
|
357
|
+
-->
|
358
|
+
</style>
|
359
|
+
<base target="docwin" />
|
360
|
+
</head>
|
361
|
+
<body>
|
362
|
+
<div class="index">
|
363
|
+
<div class="banner"><%= values[:list_title] %></div>
|
364
|
+
<% values[:entries].each do |entries| %>
|
365
|
+
<a href="<%= entries[:href] %>"><%= entries[:name] %></a><br />
|
366
|
+
<% end %><%# values[:entries] %>
|
367
|
+
</div>
|
368
|
+
</body></html>
|
369
|
+
}
|
370
|
+
end
|
371
|
+
|
372
|
+
def get_CLASS_INDEX
|
373
|
+
return get_FILE_INDEX
|
374
|
+
end
|
375
|
+
|
376
|
+
def get_METHOD_INDEX
|
377
|
+
return get_FILE_INDEX
|
378
|
+
end
|
379
|
+
|
380
|
+
def get_INDEX
|
381
|
+
return XHTML_FRAME_PREAMBLE + HTML_ELEMENT + %{
|
382
|
+
<head>
|
383
|
+
<title><%= values[:title] %></title>
|
384
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
|
385
|
+
</head>
|
386
|
+
|
387
|
+
<frameset cols="20%,*">
|
388
|
+
<frameset rows="15%,35%,50%">
|
389
|
+
<frame src="fr_file_index.html" title="Files" name="Files" />
|
390
|
+
<frame src="fr_class_index.html" name="Classes" />
|
391
|
+
<frame src="fr_method_index.html" name="Methods" />
|
392
|
+
</frameset>
|
393
|
+
<% if values[:inline_source] then %>
|
394
|
+
<frame src="<%= values[:initial_page] %>" name="docwin" />
|
395
|
+
<% end %>
|
396
|
+
<% unless values[:inline_source] then %>
|
397
|
+
<frameset rows="80%,20%">
|
398
|
+
<frame src="<%= values[:initial_page] %>" name="docwin" />
|
399
|
+
<frame src="blank.html" name="source" />
|
400
|
+
</frameset>
|
401
|
+
<% end %>
|
402
|
+
</frameset>
|
403
|
+
|
404
|
+
</html>
|
405
|
+
}
|
406
|
+
end
|
407
|
+
|
408
|
+
def get_BLANK
|
409
|
+
# This will be displayed in the source code frame before
|
410
|
+
# any source code has been selected.
|
411
|
+
return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{
|
412
|
+
<head>
|
413
|
+
<title>Source Code Frame <%= values[:title_suffix] %></title>
|
414
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= values[:charset] %>" />
|
415
|
+
<link rel="stylesheet" href="<%= values[:style_url] %>" type="text/css" media="screen" />
|
416
|
+
</head>
|
417
|
+
<body>
|
418
|
+
</body>
|
419
|
+
</html>
|
420
|
+
}
|
421
|
+
end
|
422
|
+
|
423
|
+
def write_extra_pages(values)
|
424
|
+
template = RDoc::TemplatePage.new(get_BLANK())
|
425
|
+
File.open("blank.html", "w") { |f| template.write_html_on(f, values) }
|
426
|
+
end
|
427
|
+
|
428
|
+
end
|
metadata
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rdoc_html_templates
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 2.3.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Eric Hodel
|
8
|
+
- Tony Strauss
|
9
|
+
- Dave Thomas
|
10
|
+
autorequire:
|
11
|
+
bindir: bin
|
12
|
+
cert_chain:
|
13
|
+
- |
|
14
|
+
-----BEGIN CERTIFICATE-----
|
15
|
+
MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
|
16
|
+
YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
|
17
|
+
ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
|
18
|
+
cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
|
19
|
+
FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
|
20
|
+
LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
|
21
|
+
U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
|
22
|
+
Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
|
23
|
+
mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
|
24
|
+
g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
|
25
|
+
sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
|
26
|
+
BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
|
27
|
+
kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
|
28
|
+
bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
|
29
|
+
DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
|
30
|
+
UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
|
31
|
+
14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
|
32
|
+
x52qPcexcYZR7w==
|
33
|
+
-----END CERTIFICATE-----
|
34
|
+
|
35
|
+
date: 2009-01-28 00:00:00 -08:00
|
36
|
+
default_executable:
|
37
|
+
dependencies:
|
38
|
+
- !ruby/object:Gem::Dependency
|
39
|
+
name: rdoc
|
40
|
+
type: :runtime
|
41
|
+
version_requirement:
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - ~>
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: "2.3"
|
47
|
+
version:
|
48
|
+
- !ruby/object:Gem::Dependency
|
49
|
+
name: minitest
|
50
|
+
type: :development
|
51
|
+
version_requirement:
|
52
|
+
version_requirements: !ruby/object:Gem::Requirement
|
53
|
+
requirements:
|
54
|
+
- - ~>
|
55
|
+
- !ruby/object:Gem::Version
|
56
|
+
version: "1.3"
|
57
|
+
version:
|
58
|
+
- !ruby/object:Gem::Dependency
|
59
|
+
name: hoe
|
60
|
+
type: :development
|
61
|
+
version_requirement:
|
62
|
+
version_requirements: !ruby/object:Gem::Requirement
|
63
|
+
requirements:
|
64
|
+
- - ">="
|
65
|
+
- !ruby/object:Gem::Version
|
66
|
+
version: 1.8.2
|
67
|
+
version:
|
68
|
+
description: Unmaintained templates for RDoc's HTML generator.
|
69
|
+
email:
|
70
|
+
- drbrain@segment7.net
|
71
|
+
- tony.strauss@designingpatterns.com
|
72
|
+
- ""
|
73
|
+
executables: []
|
74
|
+
|
75
|
+
extensions: []
|
76
|
+
|
77
|
+
extra_rdoc_files:
|
78
|
+
- History.txt
|
79
|
+
- Manifest.txt
|
80
|
+
- README.txt
|
81
|
+
files:
|
82
|
+
- History.txt
|
83
|
+
- Manifest.txt
|
84
|
+
- README.txt
|
85
|
+
- Rakefile
|
86
|
+
- lib/rdoc/discover.rb
|
87
|
+
- lib/rdoc/generator/html/frameless.rb
|
88
|
+
- lib/rdoc/generator/html/hefss.rb
|
89
|
+
- lib/rdoc/generator/html/kilmer.rb
|
90
|
+
- lib/rdoc/generator/html/kilmerfactory.rb
|
91
|
+
has_rdoc: true
|
92
|
+
homepage: "Project Page: http://rubyforge.org/projects/rdoc"
|
93
|
+
post_install_message:
|
94
|
+
rdoc_options:
|
95
|
+
- --main
|
96
|
+
- README.txt
|
97
|
+
require_paths:
|
98
|
+
- lib
|
99
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: "0"
|
104
|
+
version:
|
105
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: "1.3"
|
110
|
+
version:
|
111
|
+
requirements: []
|
112
|
+
|
113
|
+
rubyforge_project: rdoc
|
114
|
+
rubygems_version: 1.3.1.1939
|
115
|
+
signing_key:
|
116
|
+
specification_version: 2
|
117
|
+
summary: Unmaintained templates for RDoc's HTML generator.
|
118
|
+
test_files: []
|
119
|
+
|
metadata.gz.sig
ADDED
Binary file
|