rdoc_chm 3.0.0 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- data/History.txt +4 -0
- data/Manifest.txt +10 -5
- data/lib/rdoc/generator/chm.rb +19 -44
- data/lib/rdoc/generator/template/chm/_class_metadata.rhtml +45 -0
- data/lib/rdoc/generator/template/chm/_footer.rhtml +4 -0
- data/lib/rdoc/generator/template/chm/_head.rhtml +12 -0
- data/lib/rdoc/generator/template/chm/_hidden_images.rhtml +20 -0
- data/lib/rdoc/generator/template/chm/_index_modules_and_files.rhtml +16 -0
- data/lib/rdoc/generator/template/chm/{chm_index.rhtml → chm_index.hhk.rhtml} +3 -3
- data/lib/rdoc/generator/template/chm/class.rhtml +145 -0
- data/lib/rdoc/generator/template/chm/classindex.rhtml +0 -15
- data/lib/rdoc/generator/template/chm/{contents.rhtml → contents.hhc.rhtml} +2 -2
- data/lib/rdoc/generator/template/chm/fileindex.rhtml +2 -18
- data/lib/rdoc/generator/template/chm/{hpp_file.rhtml → hhp_file.hhp.rhtml} +0 -0
- data/lib/rdoc/generator/template/chm/index.rhtml +2 -63
- data/lib/rdoc/generator/template/chm/page.rhtml +4 -0
- metadata +12 -7
- data/lib/rdoc/generator/template/chm/classpage.rhtml +0 -180
- data/lib/rdoc/generator/template/chm/filepage.rhtml +0 -74
data/History.txt
CHANGED
data/Manifest.txt
CHANGED
@@ -5,13 +5,18 @@ Rakefile
|
|
5
5
|
lib/rdoc/discover.rb
|
6
6
|
lib/rdoc/generator/chm.rb
|
7
7
|
lib/rdoc/generator/template/chm/.document
|
8
|
-
lib/rdoc/generator/template/chm/
|
8
|
+
lib/rdoc/generator/template/chm/_class_metadata.rhtml
|
9
|
+
lib/rdoc/generator/template/chm/_index_modules_and_files.rhtml
|
10
|
+
lib/rdoc/generator/template/chm/_hidden_images.rhtml
|
11
|
+
lib/rdoc/generator/template/chm/_head.rhtml
|
12
|
+
lib/rdoc/generator/template/chm/_footer.rhtml
|
13
|
+
lib/rdoc/generator/template/chm/chm_index.hhk.rhtml
|
9
14
|
lib/rdoc/generator/template/chm/classindex.rhtml
|
10
|
-
lib/rdoc/generator/template/chm/
|
11
|
-
lib/rdoc/generator/template/chm/contents.rhtml
|
15
|
+
lib/rdoc/generator/template/chm/class.rhtml
|
16
|
+
lib/rdoc/generator/template/chm/contents.hhc.rhtml
|
12
17
|
lib/rdoc/generator/template/chm/fileindex.rhtml
|
13
|
-
lib/rdoc/generator/template/chm/
|
14
|
-
lib/rdoc/generator/template/chm/
|
18
|
+
lib/rdoc/generator/template/chm/page.rhtml
|
19
|
+
lib/rdoc/generator/template/chm/hhp_file.hhp.rhtml
|
15
20
|
lib/rdoc/generator/template/chm/images/brick.png
|
16
21
|
lib/rdoc/generator/template/chm/images/brick_link.png
|
17
22
|
lib/rdoc/generator/template/chm/images/bug.png
|
data/lib/rdoc/generator/chm.rb
CHANGED
@@ -16,7 +16,7 @@ end
|
|
16
16
|
|
17
17
|
class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
18
18
|
|
19
|
-
VERSION = '3.
|
19
|
+
VERSION = '3.1.0'
|
20
20
|
|
21
21
|
DESCRIPTION = 'Microsoft Compiled HTML Help (chm) generator'
|
22
22
|
|
@@ -55,6 +55,9 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
55
55
|
# The project contains the project file, a table of contents and an index
|
56
56
|
|
57
57
|
def generate_help_project
|
58
|
+
# Set which files should actually be generated
|
59
|
+
@generated_files = @files.select { |f| f.text? }
|
60
|
+
|
58
61
|
debug_msg "Generating the help project files"
|
59
62
|
generate_file_index
|
60
63
|
generate_class_index
|
@@ -68,6 +71,9 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
68
71
|
template_file = @template_dir + 'fileindex.rhtml'
|
69
72
|
|
70
73
|
out_file = @outputdir + "fileindex.html"
|
74
|
+
# suppress 1.9.3 warning
|
75
|
+
rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
|
76
|
+
|
71
77
|
debug_msg " rendering #{out_file}"
|
72
78
|
render_template template_file, out_file do |io| binding end
|
73
79
|
end
|
@@ -77,6 +83,9 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
77
83
|
|
78
84
|
out_file = @outputdir + "classindex.html"
|
79
85
|
debug_msg " rendering #{out_file}"
|
86
|
+
# suppress 1.9.3 warning
|
87
|
+
rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
|
88
|
+
|
80
89
|
render_template template_file, out_file do |io| binding end
|
81
90
|
end
|
82
91
|
|
@@ -84,12 +93,12 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
84
93
|
# The project file links together all the various
|
85
94
|
# files that go to make up the help.
|
86
95
|
def generate_project_file
|
87
|
-
template_file = @template_dir + '
|
96
|
+
template_file = @template_dir + 'hhp_file.hhp.rhtml'
|
88
97
|
|
89
98
|
@values = { :title => @options.title, :opname => @outputdir.basename }
|
90
99
|
|
91
100
|
static_files = ['index.html', 'classindex.html', 'fileindex.html']
|
92
|
-
@values[:html_files] = static_files + (@
|
101
|
+
@values[:html_files] = static_files + (@generated_files+@classes).map{|f| f.path}.uniq
|
93
102
|
|
94
103
|
out_file = @outputdir + @project_name
|
95
104
|
debug_msg " rendering #{out_file}"
|
@@ -99,7 +108,7 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
99
108
|
##
|
100
109
|
# generate the CHM contents (contents.hhc)
|
101
110
|
def generate_contents
|
102
|
-
template_file = @template_dir + 'contents.rhtml'
|
111
|
+
template_file = @template_dir + 'contents.hhc.rhtml'
|
103
112
|
|
104
113
|
out_file = @outputdir + "contents.hhc"
|
105
114
|
debug_msg " rendering #{out_file}"
|
@@ -109,7 +118,7 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
109
118
|
##
|
110
119
|
# generate the CHM index (index.hhk)
|
111
120
|
def generate_chm_index
|
112
|
-
template_file = @template_dir + 'chm_index.rhtml'
|
121
|
+
template_file = @template_dir + 'chm_index.hhk.rhtml'
|
113
122
|
|
114
123
|
out_file = @outputdir + "index.hhk"
|
115
124
|
debug_msg " rendering #{out_file}"
|
@@ -126,47 +135,13 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
|
|
126
135
|
##
|
127
136
|
# This is an override to make sure that the new Darkfish template
|
128
137
|
# doesn't try to parse the CHM files as html partials
|
129
|
-
#
|
130
|
-
# TODO: If you want to refactor the html used in the template
|
131
|
-
# this should probably be a regex or something that checks to see
|
132
|
-
# if the file extension is html.
|
133
138
|
def assemble_template body_file
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
# The generate_file_files method in RDoc 3.12 is broken for 'legacy'
|
140
|
-
# template support. So this overrides that method so it works.
|
141
|
-
def generate_file_files
|
142
|
-
filepage_file = @template_dir + 'filepage.rhtml'
|
143
|
-
|
144
|
-
return unless filepage_file.exist?
|
145
|
-
|
146
|
-
debug_msg "Generating file documentation in #{@outputdir}"
|
147
|
-
|
148
|
-
out_file = nil
|
149
|
-
current = nil
|
150
|
-
|
151
|
-
@files.each do |file|
|
152
|
-
current = file
|
153
|
-
template_file = nil
|
154
|
-
out_file = @outputdir + file.path
|
155
|
-
debug_msg " working on %s (%s)" % [file.full_name, out_file]
|
156
|
-
# suppress 1.9.3 warning
|
157
|
-
rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
|
158
|
-
|
159
|
-
@title += " - #{@options.title}"
|
160
|
-
template_file = filepage_file
|
161
|
-
|
162
|
-
render_template template_file, out_file do |io| binding end
|
139
|
+
if body_file.basename.to_s =~ /\.hh(k|c|p)/
|
140
|
+
body = body_file.read
|
141
|
+
return body if body
|
142
|
+
else
|
143
|
+
super
|
163
144
|
end
|
164
|
-
rescue => e
|
165
|
-
error =
|
166
|
-
RDoc::Error.new "error generating #{out_file}: #{e.message} (#{e.class})"
|
167
|
-
error.set_backtrace e.backtrace
|
168
|
-
|
169
|
-
raise error
|
170
145
|
end
|
171
146
|
end
|
172
147
|
|
@@ -0,0 +1,45 @@
|
|
1
|
+
<!--<div id="metadata"> -->
|
2
|
+
<div id="file-metadata">
|
3
|
+
<div id="file-list-section" class="section">
|
4
|
+
<h3 class="section-header">In Files</h3>
|
5
|
+
<div class="section-body">
|
6
|
+
<ul>
|
7
|
+
<% klass.in_files.each do |tl| %>
|
8
|
+
<li><%= h tl.absolute_name %></li>
|
9
|
+
<% end %>
|
10
|
+
</ul>
|
11
|
+
</div>
|
12
|
+
</div>
|
13
|
+
|
14
|
+
<div id="class-metadata">
|
15
|
+
|
16
|
+
<!-- Parent Class -->
|
17
|
+
<% if klass.type == 'class' %>
|
18
|
+
<div id="parent-class-section" class="section">
|
19
|
+
<h3 class="section-header">Parent</h3>
|
20
|
+
<% unless String === klass.superclass or klass.superclass.nil? %>
|
21
|
+
<p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a></p>
|
22
|
+
<% else %>
|
23
|
+
<p class="link"><%= klass.superclass %></p>
|
24
|
+
<% end %>
|
25
|
+
</div>
|
26
|
+
<% end %>
|
27
|
+
|
28
|
+
<!-- Included Modules -->
|
29
|
+
<% unless klass.includes.empty? %>
|
30
|
+
<div id="includes-section" class="section">
|
31
|
+
<h3 class="section-header">Included Modules</h3>
|
32
|
+
<ul class="link-list">
|
33
|
+
<% klass.each_include do |inc| %>
|
34
|
+
<% unless String === inc.module %>
|
35
|
+
<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
|
36
|
+
<% else %>
|
37
|
+
<li><span class="include"><%= inc.name %></span></li>
|
38
|
+
<% end %>
|
39
|
+
<% end %>
|
40
|
+
</ul>
|
41
|
+
</div>
|
42
|
+
<% end %>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<!-- </div> -->
|
@@ -0,0 +1,4 @@
|
|
1
|
+
<footer id="validator-badges">
|
2
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> <%= RDoc::VERSION %>.
|
3
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %>.
|
4
|
+
</footer>
|
@@ -0,0 +1,12 @@
|
|
1
|
+
<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type">
|
2
|
+
|
3
|
+
<title><%= h @title %></title>
|
4
|
+
|
5
|
+
<link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet">
|
6
|
+
|
7
|
+
<script type="text/javascript">
|
8
|
+
var rdoc_rel_prefix = "<%= rel_prefix %>/";
|
9
|
+
</script>
|
10
|
+
|
11
|
+
<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/jquery.js"></script>
|
12
|
+
<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/darkfish.js"></script>
|
@@ -0,0 +1,20 @@
|
|
1
|
+
<img class="initially-hidden" src="images/brick.png"/>
|
2
|
+
<img class="initially-hidden" src="images/brick_link.png"/>
|
3
|
+
<img class="initially-hidden" src="images/bug.png"/>
|
4
|
+
<img class="initially-hidden" src="images/bullet_black.png"/>
|
5
|
+
<img class="initially-hidden" src="images/bullet_toggle_minus.png"/>
|
6
|
+
<img class="initially-hidden" src="images/bullet_toggle_plus.png"/>
|
7
|
+
<img class="initially-hidden" src="images/date.png"/>
|
8
|
+
<img class="initially-hidden" src="images/find.png"/>
|
9
|
+
<img class="initially-hidden" src="images/loadingAnimation.gif"/>
|
10
|
+
<img class="initially-hidden" src="images/macFFBgHack.png"/>
|
11
|
+
<img class="initially-hidden" src="images/package.png"/>
|
12
|
+
<img class="initially-hidden" src="images/page_green.png"/>
|
13
|
+
<img class="initially-hidden" src="images/page_white_text.png"/>
|
14
|
+
<img class="initially-hidden" src="images/page_white_width.png"/>
|
15
|
+
<img class="initially-hidden" src="images/plugin.png"/>
|
16
|
+
<img class="initially-hidden" src="images/ruby.png"/>
|
17
|
+
<img class="initially-hidden" src="images/tag_green.png"/>
|
18
|
+
<img class="initially-hidden" src="images/wrench.png"/>
|
19
|
+
<img class="initially-hidden" src="images/wrench_orange.png"/>
|
20
|
+
<img class="initially-hidden" src="images/zoom.png"/>
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<% simple_files = @files.select { |f| f.text? } %>
|
2
|
+
<% unless simple_files.empty? then %>
|
3
|
+
<h2>Files</h2>
|
4
|
+
<ul>
|
5
|
+
<% simple_files.sort.each do |file| %>
|
6
|
+
<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
|
7
|
+
<% end %>
|
8
|
+
</ul>
|
9
|
+
<% end %>
|
10
|
+
|
11
|
+
<h2>Classes/Modules</h2>
|
12
|
+
<ul>
|
13
|
+
<% @modsort.each do |klass| %>
|
14
|
+
<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
|
15
|
+
<% end %>
|
16
|
+
</ul>
|
@@ -10,7 +10,7 @@
|
|
10
10
|
<param name="ImageType" value="Folder">
|
11
11
|
</OBJECT>
|
12
12
|
<UL>
|
13
|
-
<% (@
|
13
|
+
<% (@generated_files+@classes).sort.each do |index| %>
|
14
14
|
<LI> <OBJECT type="text/sitemap">
|
15
15
|
<param name="Name" value="<%= index.full_name %>">
|
16
16
|
<param name="Local" value="<%= index.path %>">
|
@@ -22,6 +22,6 @@
|
|
22
22
|
<param name="Local" value="<%= method.path %>">
|
23
23
|
</OBJECT>
|
24
24
|
<% end # index.method_list.sort %>
|
25
|
-
<% end # (@
|
25
|
+
<% end # (@generated_files+@classes).sort %>
|
26
26
|
</UL>
|
27
|
-
</BODY></HTML>
|
27
|
+
</BODY></HTML>
|
@@ -0,0 +1,145 @@
|
|
1
|
+
<body id="top" class="<%= klass.type %>">
|
2
|
+
<div id="documentation">
|
3
|
+
<h1 class="<%= klass.type %>"><%= klass.type %> <%= klass.full_name %></h1>
|
4
|
+
|
5
|
+
<div id="description" class="description">
|
6
|
+
<%= klass.description %>
|
7
|
+
</div><!-- description -->
|
8
|
+
|
9
|
+
<!-- Metadata -->
|
10
|
+
<%= render '_class_metadata.rhtml' %>
|
11
|
+
|
12
|
+
<% klass.each_section do |section, constants, attributes| %>
|
13
|
+
<% constants = constants.select { |const| const.display? } %>
|
14
|
+
<% attributes = attributes.select { |attr| attr.display? } %>
|
15
|
+
<section id="<%= section.aref %>" class="documentation-section">
|
16
|
+
<% if section.title then %>
|
17
|
+
<div class="documentation-section-title">
|
18
|
+
<h2 class="section-header">
|
19
|
+
<%= section.title %>
|
20
|
+
</h2>
|
21
|
+
<span class="section-click-top">
|
22
|
+
<a href="#top">↑ top</a>
|
23
|
+
</span>
|
24
|
+
</div>
|
25
|
+
<% end %>
|
26
|
+
|
27
|
+
<% if section.comment then %>
|
28
|
+
<div class="description">
|
29
|
+
<%= section.description %>
|
30
|
+
</div>
|
31
|
+
<% end %>
|
32
|
+
|
33
|
+
<% unless constants.empty? then %>
|
34
|
+
<!-- Constants -->
|
35
|
+
<section id="constants-list" class="section">
|
36
|
+
<h3 class="section-header">Constants</h3>
|
37
|
+
<dl>
|
38
|
+
<% constants.each do |const| %>
|
39
|
+
<dt id="<%= const.name %>"><%= const.name %>
|
40
|
+
<% if const.comment then %>
|
41
|
+
<dd class="description"><%= const.description.strip %>
|
42
|
+
<% else %>
|
43
|
+
<dd class="description missing-docs">(Not documented)
|
44
|
+
<% end %>
|
45
|
+
<% end %>
|
46
|
+
</dl>
|
47
|
+
</section>
|
48
|
+
<% end %>
|
49
|
+
|
50
|
+
<% unless attributes.empty? then %>
|
51
|
+
<!-- Attributes -->
|
52
|
+
<section id="attribute-method-details" class="method-section section">
|
53
|
+
<h3 class="section-header">Attributes</h3>
|
54
|
+
|
55
|
+
<% attributes.each do |attrib| %>
|
56
|
+
<div id="<%= attrib.aref %>" class="method-detail">
|
57
|
+
<div class="method-heading attribute-method-heading">
|
58
|
+
<span class="method-name"><%= h attrib.name %></span><span
|
59
|
+
class="attribute-access-type">[<%= attrib.rw %>]</span>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div class="method-description">
|
63
|
+
<% if attrib.comment then %>
|
64
|
+
<%= attrib.description.strip %>
|
65
|
+
<% else %>
|
66
|
+
<p class="missing-docs">(Not documented)
|
67
|
+
<% end %>
|
68
|
+
</div>
|
69
|
+
</div>
|
70
|
+
<% end %>
|
71
|
+
</section><!-- attribute-method-details -->
|
72
|
+
<% end %>
|
73
|
+
|
74
|
+
<!-- Methods -->
|
75
|
+
<% klass.methods_by_type(section).each do |type, visibilities|
|
76
|
+
next if visibilities.empty?
|
77
|
+
visibilities.each do |visibility, methods|
|
78
|
+
next if methods.empty? %>
|
79
|
+
<section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section section">
|
80
|
+
<h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
|
81
|
+
|
82
|
+
<% methods.each do |method| %>
|
83
|
+
<div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
|
84
|
+
<% if method.call_seq then %>
|
85
|
+
<% method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
|
86
|
+
<div class="method-heading">
|
87
|
+
<span class="method-callseq">
|
88
|
+
<%= h(call_seq.strip.
|
89
|
+
gsub( /^\w+\./m, '')).
|
90
|
+
gsub(/(.*)[-=]>/, '\1→') %>
|
91
|
+
</span>
|
92
|
+
<% if i == 0 then %>
|
93
|
+
<span class="method-click-advice">click to toggle source</span>
|
94
|
+
<% end %>
|
95
|
+
</div>
|
96
|
+
<% end %>
|
97
|
+
<% else %>
|
98
|
+
<div class="method-heading">
|
99
|
+
<span class="method-name"><%= h method.name %></span><span
|
100
|
+
class="method-args"><%= method.param_seq %></span>
|
101
|
+
<span class="method-click-advice">click to toggle source</span>
|
102
|
+
</div>
|
103
|
+
<% end %>
|
104
|
+
|
105
|
+
<div class="method-description">
|
106
|
+
<% if method.comment then %>
|
107
|
+
<%= method.description.strip %>
|
108
|
+
<% else %>
|
109
|
+
<p class="missing-docs">(Not documented)
|
110
|
+
<% end %>
|
111
|
+
|
112
|
+
<% if method.token_stream then %>
|
113
|
+
<div class="method-source-code" id="<%= method.html_name %>-source">
|
114
|
+
<pre><%= method.markup_code %></pre>
|
115
|
+
</div><!-- <%= method.html_name %>-source -->
|
116
|
+
<% end %>
|
117
|
+
</div>
|
118
|
+
|
119
|
+
<% unless method.aliases.empty? then %>
|
120
|
+
<div class="aliases">
|
121
|
+
Also aliased as: <%= method.aliases.map do |aka|
|
122
|
+
if aka.parent then # HACK lib/rexml/encodings
|
123
|
+
%{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
|
124
|
+
else
|
125
|
+
h aka.name
|
126
|
+
end
|
127
|
+
end.join ", " %>
|
128
|
+
</div>
|
129
|
+
<% end %>
|
130
|
+
|
131
|
+
<% if method.is_alias_for then %>
|
132
|
+
<div class="aliases">
|
133
|
+
Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
|
134
|
+
</div>
|
135
|
+
<% end %>
|
136
|
+
</div><!-- <%= method.html_name %>-method -->
|
137
|
+
|
138
|
+
<% end %>
|
139
|
+
</section><!-- <%= visibility %>-<%= type %>-method-details -->
|
140
|
+
<% end
|
141
|
+
end %>
|
142
|
+
</section><!-- <%= section.aref %> -->
|
143
|
+
<% end %>
|
144
|
+
|
145
|
+
</div><!-- documentation -->
|
@@ -1,15 +1,3 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
5
|
-
<head>
|
6
|
-
<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
|
7
|
-
|
8
|
-
<title>Classes/Modules</title>
|
9
|
-
|
10
|
-
<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
|
11
|
-
|
12
|
-
</head>
|
13
1
|
<body class="indexpage">
|
14
2
|
|
15
3
|
<h1><%= h @options.title %></h1>
|
@@ -22,6 +10,3 @@
|
|
22
10
|
<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
|
23
11
|
<% end %>
|
24
12
|
</ul>
|
25
|
-
|
26
|
-
</body>
|
27
|
-
</html>
|
@@ -41,7 +41,7 @@
|
|
41
41
|
<param name="Local" value="fileindex.html">
|
42
42
|
</OBJECT>
|
43
43
|
<UL>
|
44
|
-
<% @
|
44
|
+
<% @generated_files.sort.each do |klass| %>
|
45
45
|
<LI><OBJECT type="text/sitemap">
|
46
46
|
<param name="Name" value="<%= klass.full_name %>">
|
47
47
|
<param name="Local" value="<%= klass.path %>">
|
@@ -50,4 +50,4 @@
|
|
50
50
|
</UL>
|
51
51
|
</UL>
|
52
52
|
</BODY>
|
53
|
-
</HTML>
|
53
|
+
</HTML>
|
@@ -1,30 +1,14 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
5
|
-
<head>
|
6
|
-
<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
|
7
|
-
|
8
|
-
<title>Files</title>
|
9
|
-
|
10
|
-
<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
|
11
|
-
|
12
|
-
</head>
|
13
1
|
<body class="indexpage">
|
14
2
|
|
15
3
|
<h1><%= h @options.title %></h1>
|
16
4
|
|
17
5
|
<p>This is the API documentation for '<%= @options.title %>'.</p>
|
18
6
|
|
19
|
-
|
20
|
-
<% unless simple_files.empty? then %>
|
7
|
+
<% unless @generated_files.empty? %>
|
21
8
|
<h2>Files</h2>
|
22
9
|
<ul>
|
23
|
-
<%
|
10
|
+
<% @generated_files.sort.each do |file| %>
|
24
11
|
<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
|
25
12
|
<% end %>
|
26
13
|
</ul>
|
27
14
|
<% end %>
|
28
|
-
|
29
|
-
</body>
|
30
|
-
</html>
|
File without changes
|
@@ -1,22 +1,4 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
5
|
-
<head>
|
6
|
-
<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
|
7
|
-
|
8
|
-
<title><%= h @options.title %></title>
|
9
|
-
|
10
|
-
<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
|
11
|
-
|
12
|
-
<script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
|
13
|
-
<script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
|
14
|
-
<script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
|
15
|
-
<script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>
|
16
|
-
|
17
|
-
</head>
|
18
1
|
<body class="indexpage">
|
19
|
-
|
20
2
|
<h1><%= h @options.title %></h1>
|
21
3
|
|
22
4
|
<% if @options.main_page && main_page = @files.find { |f| f.full_name == @options.main_page } %>
|
@@ -27,49 +9,6 @@
|
|
27
9
|
<p>This is the API documentation for '<%= @options.title %>'.</p>
|
28
10
|
<% end %>
|
29
11
|
|
30
|
-
|
31
|
-
<% unless simple_files.empty? then %>
|
32
|
-
<h2>Files</h2>
|
33
|
-
<ul>
|
34
|
-
<% simple_files.sort.each do |file| %>
|
35
|
-
<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
|
36
|
-
<% end %>
|
37
|
-
</ul>
|
38
|
-
<% end %>
|
39
|
-
|
40
|
-
<h2>Classes/Modules</h2>
|
41
|
-
<ul>
|
42
|
-
<% @modsort.each do |klass| %>
|
43
|
-
<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
|
44
|
-
<% end %>
|
45
|
-
</ul>
|
46
|
-
|
47
|
-
<div id="validator-badges">
|
48
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
49
|
-
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
50
|
-
Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
|
51
|
-
</div>
|
52
|
-
|
53
|
-
<img class="initially-hidden" src="images/brick.png"/>
|
54
|
-
<img class="initially-hidden" src="images/brick_link.png"/>
|
55
|
-
<img class="initially-hidden" src="images/bug.png"/>
|
56
|
-
<img class="initially-hidden" src="images/bullet_black.png"/>
|
57
|
-
<img class="initially-hidden" src="images/bullet_toggle_minus.png"/>
|
58
|
-
<img class="initially-hidden" src="images/bullet_toggle_plus.png"/>
|
59
|
-
<img class="initially-hidden" src="images/date.png"/>
|
60
|
-
<img class="initially-hidden" src="images/find.png"/>
|
61
|
-
<img class="initially-hidden" src="images/loadingAnimation.gif"/>
|
62
|
-
<img class="initially-hidden" src="images/macFFBgHack.png"/>
|
63
|
-
<img class="initially-hidden" src="images/package.png"/>
|
64
|
-
<img class="initially-hidden" src="images/page_green.png"/>
|
65
|
-
<img class="initially-hidden" src="images/page_white_text.png"/>
|
66
|
-
<img class="initially-hidden" src="images/page_white_width.png"/>
|
67
|
-
<img class="initially-hidden" src="images/plugin.png"/>
|
68
|
-
<img class="initially-hidden" src="images/ruby.png"/>
|
69
|
-
<img class="initially-hidden" src="images/tag_green.png"/>
|
70
|
-
<img class="initially-hidden" src="images/wrench.png"/>
|
71
|
-
<img class="initially-hidden" src="images/wrench_orange.png"/>
|
72
|
-
<img class="initially-hidden" src="images/zoom.png"/>
|
12
|
+
<%= render '_index_modules_and_files.rhtml' %>
|
73
13
|
|
74
|
-
|
75
|
-
</html>
|
14
|
+
<%= render '_hidden_images.rhtml' %>
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rdoc_chm
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.
|
4
|
+
version: 3.1.0
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -12,7 +12,7 @@ authors:
|
|
12
12
|
autorequire:
|
13
13
|
bindir: bin
|
14
14
|
cert_chain: []
|
15
|
-
date: 2012-
|
15
|
+
date: 2012-06-23 00:00:00.000000000 Z
|
16
16
|
dependencies:
|
17
17
|
- !ruby/object:Gem::Dependency
|
18
18
|
name: rdoc
|
@@ -66,13 +66,18 @@ files:
|
|
66
66
|
- lib/rdoc/discover.rb
|
67
67
|
- lib/rdoc/generator/chm.rb
|
68
68
|
- lib/rdoc/generator/template/chm/.document
|
69
|
-
- lib/rdoc/generator/template/chm/
|
69
|
+
- lib/rdoc/generator/template/chm/_class_metadata.rhtml
|
70
|
+
- lib/rdoc/generator/template/chm/_index_modules_and_files.rhtml
|
71
|
+
- lib/rdoc/generator/template/chm/_hidden_images.rhtml
|
72
|
+
- lib/rdoc/generator/template/chm/_head.rhtml
|
73
|
+
- lib/rdoc/generator/template/chm/_footer.rhtml
|
74
|
+
- lib/rdoc/generator/template/chm/chm_index.hhk.rhtml
|
70
75
|
- lib/rdoc/generator/template/chm/classindex.rhtml
|
71
|
-
- lib/rdoc/generator/template/chm/
|
72
|
-
- lib/rdoc/generator/template/chm/contents.rhtml
|
76
|
+
- lib/rdoc/generator/template/chm/class.rhtml
|
77
|
+
- lib/rdoc/generator/template/chm/contents.hhc.rhtml
|
73
78
|
- lib/rdoc/generator/template/chm/fileindex.rhtml
|
74
|
-
- lib/rdoc/generator/template/chm/
|
75
|
-
- lib/rdoc/generator/template/chm/
|
79
|
+
- lib/rdoc/generator/template/chm/page.rhtml
|
80
|
+
- lib/rdoc/generator/template/chm/hhp_file.hhp.rhtml
|
76
81
|
- lib/rdoc/generator/template/chm/images/brick.png
|
77
82
|
- lib/rdoc/generator/template/chm/images/brick_link.png
|
78
83
|
- lib/rdoc/generator/template/chm/images/bug.png
|
@@ -1,180 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
-
<head>
|
5
|
-
<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
|
6
|
-
|
7
|
-
<title><%= klass.type.capitalize %>: <%= klass.full_name %></title>
|
8
|
-
|
9
|
-
<link rel="stylesheet" href="<%= rel_prefix %>/rdoc.css" type="text/css" media="screen" />
|
10
|
-
|
11
|
-
<script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
|
12
|
-
charset="utf-8"></script>
|
13
|
-
<script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
|
14
|
-
charset="utf-8"></script>
|
15
|
-
<script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
|
16
|
-
charset="utf-8"></script>
|
17
|
-
<script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
|
18
|
-
charset="utf-8"></script>
|
19
|
-
|
20
|
-
</head>
|
21
|
-
<body class="<%= klass.type %>">
|
22
|
-
|
23
|
-
<div id="documentation">
|
24
|
-
|
25
|
-
<h1 class="<%= klass.type %>"><%= klass.full_name %></h1>
|
26
|
-
|
27
|
-
|
28
|
-
<!--<div id="metadata"> -->
|
29
|
-
<div id="file-metadata">
|
30
|
-
<div id="file-list-section" class="section">
|
31
|
-
<h3 class="section-header">In Files</h3>
|
32
|
-
<div class="section-body">
|
33
|
-
<ul>
|
34
|
-
<% klass.in_files.each do |tl| %>
|
35
|
-
<li><a href="<%= rel_prefix %>/<%= h tl.path %>"
|
36
|
-
title="<%= h tl.absolute_name %>"><%= h tl.absolute_name %></a></li>
|
37
|
-
<% end %>
|
38
|
-
</ul>
|
39
|
-
</div>
|
40
|
-
</div>
|
41
|
-
|
42
|
-
<div id="class-metadata">
|
43
|
-
|
44
|
-
<!-- Parent Class -->
|
45
|
-
<% if klass.type == 'class' %>
|
46
|
-
<div id="parent-class-section" class="section">
|
47
|
-
<h3 class="section-header">Parent</h3>
|
48
|
-
<% unless String === klass.superclass or klass.superclass.nil? %>
|
49
|
-
<p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a></p>
|
50
|
-
<% else %>
|
51
|
-
<p class="link"><%= klass.superclass %></p>
|
52
|
-
<% end %>
|
53
|
-
</div>
|
54
|
-
<% end %>
|
55
|
-
|
56
|
-
<!-- Included Modules -->
|
57
|
-
<% unless klass.includes.empty? %>
|
58
|
-
<div id="includes-section" class="section">
|
59
|
-
<h3 class="section-header">Included Modules</h3>
|
60
|
-
<ul class="link-list">
|
61
|
-
<% klass.each_include do |inc| %>
|
62
|
-
<% unless String === inc.module %>
|
63
|
-
<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
|
64
|
-
<% else %>
|
65
|
-
<li><span class="include"><%= inc.name %></span></li>
|
66
|
-
<% end %>
|
67
|
-
<% end %>
|
68
|
-
</ul>
|
69
|
-
</div>
|
70
|
-
<% end %>
|
71
|
-
</div>
|
72
|
-
|
73
|
-
<!-- </div> -->
|
74
|
-
|
75
|
-
<div id="description">
|
76
|
-
<%= klass.description %>
|
77
|
-
</div>
|
78
|
-
|
79
|
-
<!-- Constants -->
|
80
|
-
<% unless klass.constants.empty? %>
|
81
|
-
<div id="constants-list" class="section">
|
82
|
-
<h3 class="section-header">Constants</h3>
|
83
|
-
<dl>
|
84
|
-
<% klass.each_constant do |const| %>
|
85
|
-
<dt><a name="<%= const.name %>"><%= const.name %></a></dt>
|
86
|
-
<% if const.comment %>
|
87
|
-
<dd class="description"><%= const.description.strip %></dd>
|
88
|
-
<% else %>
|
89
|
-
<dd class="description missing-docs">(Not documented)</dd>
|
90
|
-
<% end %>
|
91
|
-
<% end %>
|
92
|
-
</dl>
|
93
|
-
</div>
|
94
|
-
<% end %>
|
95
|
-
|
96
|
-
<!-- Attributes -->
|
97
|
-
<% unless klass.attributes.empty? %>
|
98
|
-
<div id="attribute-method-details" class="method-section section">
|
99
|
-
<h3 class="section-header">Attributes</h3>
|
100
|
-
|
101
|
-
<% klass.each_attribute do |attrib| %>
|
102
|
-
<div id="<%= attrib.html_name %>-attribute-method" class="method-detail">
|
103
|
-
<a name="<%= h attrib.name %>"></a>
|
104
|
-
<% if attrib.rw =~ /w/i %>
|
105
|
-
<a name="<%= h attrib.name %>="></a>
|
106
|
-
<% end %>
|
107
|
-
<div class="method-heading attribute-method-heading">
|
108
|
-
<span class="method-name"><%= h attrib.name %></span><span
|
109
|
-
class="attribute-access-type">[<%= attrib.rw %>]</span>
|
110
|
-
</div>
|
111
|
-
|
112
|
-
<div class="method-description">
|
113
|
-
<% if attrib.comment %>
|
114
|
-
<%= attrib.description.strip %>
|
115
|
-
<% else %>
|
116
|
-
<p class="missing-docs">(Not documented)</p>
|
117
|
-
<% end %>
|
118
|
-
</div>
|
119
|
-
</div>
|
120
|
-
<% end %>
|
121
|
-
</div>
|
122
|
-
<% end %>
|
123
|
-
|
124
|
-
<!-- Methods -->
|
125
|
-
<% klass.methods_by_type.each do |type, visibilities|
|
126
|
-
next if visibilities.empty?
|
127
|
-
visibilities.each do |visibility, methods|
|
128
|
-
next if methods.empty? %>
|
129
|
-
<div id="<%= visibility %>-<%= type %>-method-details" class="method-section section">
|
130
|
-
<h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
|
131
|
-
|
132
|
-
<% methods.each do |method| %>
|
133
|
-
<div id="<%= method.html_name %>-method" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
|
134
|
-
<a name="<%= h method.aref %>"></a>
|
135
|
-
|
136
|
-
<div class="method-heading">
|
137
|
-
<% if method.call_seq %>
|
138
|
-
<span class="method-callseq"><%= method.call_seq.strip.gsub(/->/, '→').gsub( /^\w+\./m, '') %></span>
|
139
|
-
<span class="method-click-advice">click to toggle source</span>
|
140
|
-
<% else %>
|
141
|
-
<span class="method-name"><%= h method.name %></span><span
|
142
|
-
class="method-args"><%= method.params %></span>
|
143
|
-
<span class="method-click-advice">click to toggle source</span>
|
144
|
-
<% end %>
|
145
|
-
</div>
|
146
|
-
|
147
|
-
<div class="method-description">
|
148
|
-
<% if method.comment %>
|
149
|
-
<%= method.description.strip %>
|
150
|
-
<% else %>
|
151
|
-
<p class="missing-docs">(Not documented)</p>
|
152
|
-
<% end %>
|
153
|
-
|
154
|
-
<% if method.token_stream %>
|
155
|
-
<div class="method-source-code"
|
156
|
-
id="<%= method.html_name %>-source">
|
157
|
-
<pre>
|
158
|
-
<%= method.markup_code %>
|
159
|
-
</pre>
|
160
|
-
</div>
|
161
|
-
<% end %>
|
162
|
-
</div>
|
163
|
-
|
164
|
-
<% unless method.aliases.empty? %>
|
165
|
-
<div class="aliases">
|
166
|
-
Also aliased as: <%= method.aliases.map do |aka|
|
167
|
-
%{<a href="#{ klass.aref_to aka.path}">#{h aka.name}</a>}
|
168
|
-
end.join(", ") %>
|
169
|
-
</div>
|
170
|
-
<% end %>
|
171
|
-
</div>
|
172
|
-
|
173
|
-
<% end %>
|
174
|
-
</div>
|
175
|
-
<% end
|
176
|
-
end %>
|
177
|
-
|
178
|
-
</div>
|
179
|
-
</body>
|
180
|
-
</html>
|
@@ -1,74 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
-
<head>
|
6
|
-
<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
|
7
|
-
|
8
|
-
<title>File: <%= file.base_name %> [<%= @options.title %>]</title>
|
9
|
-
|
10
|
-
<link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet" />
|
11
|
-
|
12
|
-
<script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
|
13
|
-
charset="utf-8"></script>
|
14
|
-
<script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
|
15
|
-
charset="utf-8"></script>
|
16
|
-
<script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
|
17
|
-
charset="utf-8"></script>
|
18
|
-
<script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
|
19
|
-
charset="utf-8"></script>
|
20
|
-
</head>
|
21
|
-
|
22
|
-
<% if file.parser == RDoc::Parser::Simple %>
|
23
|
-
<body class="file">
|
24
|
-
|
25
|
-
<div id="documentation">
|
26
|
-
<%= file.description %>
|
27
|
-
</div>
|
28
|
-
|
29
|
-
<div id="validator-badges">
|
30
|
-
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
|
31
|
-
<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
|
32
|
-
Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
|
33
|
-
</div>
|
34
|
-
</body>
|
35
|
-
<% else %>
|
36
|
-
<body class="file file-popup">
|
37
|
-
|
38
|
-
<div id="documentation">
|
39
|
-
|
40
|
-
<!-- <div id="metadata"> -->
|
41
|
-
<dl>
|
42
|
-
<dt class="modified-date">Last Modified</dt>
|
43
|
-
<dd class="modified-date"><%= file.last_modified %></dd>
|
44
|
-
|
45
|
-
<% if file.requires %>
|
46
|
-
<dt class="requires">Requires</dt>
|
47
|
-
<dd class="requires">
|
48
|
-
<ul>
|
49
|
-
<% file.requires.each do |require| %>
|
50
|
-
<li><%= require.name %></li>
|
51
|
-
<% end %>
|
52
|
-
</ul>
|
53
|
-
</dd>
|
54
|
-
<% end %>
|
55
|
-
|
56
|
-
<% if @options.webcvs %>
|
57
|
-
<dt class="scs-url">Trac URL</dt>
|
58
|
-
<dd class="scs-url"><a target="_top"
|
59
|
-
href="<%= file.cvs_url %>"><%= file.cvs_url %></a></dd>
|
60
|
-
<% end %>
|
61
|
-
</dl>
|
62
|
-
<!-- </div> -->
|
63
|
-
|
64
|
-
<% if file.comment %>
|
65
|
-
<div class="description">
|
66
|
-
<h2>Description</h2>
|
67
|
-
<%= file.description %>
|
68
|
-
</div>
|
69
|
-
<% end %>
|
70
|
-
</div>
|
71
|
-
</body>
|
72
|
-
<% end %>
|
73
|
-
</html>
|
74
|
-
|