rdoc_chm 3.0.0 → 3.1.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 3.1.0 / 2012-06-23
+
+* Updated Darkfish template to match RDoc 3.12 ones [Azolo]
+
 === 3.0.0 / 2012-05-11
 
 * Updated to for RDoc 3.12 Capatibility

data/Manifest.txt

@@ -5,13 +5,18 @@ Rakefile
 lib/rdoc/discover.rb
 lib/rdoc/generator/chm.rb
 lib/rdoc/generator/template/chm/.document
-lib/rdoc/generator/template/chm/chm_index.rhtml
+lib/rdoc/generator/template/chm/_class_metadata.rhtml
+lib/rdoc/generator/template/chm/_index_modules_and_files.rhtml
+lib/rdoc/generator/template/chm/_hidden_images.rhtml
+lib/rdoc/generator/template/chm/_head.rhtml
+lib/rdoc/generator/template/chm/_footer.rhtml
+lib/rdoc/generator/template/chm/chm_index.hhk.rhtml
 lib/rdoc/generator/template/chm/classindex.rhtml
-lib/rdoc/generator/template/chm/classpage.rhtml
-lib/rdoc/generator/template/chm/contents.rhtml
+lib/rdoc/generator/template/chm/class.rhtml
+lib/rdoc/generator/template/chm/contents.hhc.rhtml
 lib/rdoc/generator/template/chm/fileindex.rhtml
-lib/rdoc/generator/template/chm/filepage.rhtml
-lib/rdoc/generator/template/chm/hpp_file.rhtml
+lib/rdoc/generator/template/chm/page.rhtml
+lib/rdoc/generator/template/chm/hhp_file.hhp.rhtml
 lib/rdoc/generator/template/chm/images/brick.png
 lib/rdoc/generator/template/chm/images/brick_link.png
 lib/rdoc/generator/template/chm/images/bug.png

data/lib/rdoc/generator/chm.rb

@@ -16,7 +16,7 @@ end
 
 class RDoc::Generator::CHM < RDoc::Generator::Darkfish
 
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 
   DESCRIPTION = 'Microsoft Compiled HTML Help (chm) generator'
 
@@ -55,6 +55,9 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
   # The project contains the project file, a table of contents and an index
 
   def generate_help_project
+    # Set which files should actually be generated
+    @generated_files = @files.select { |f| f.text? }
+
     debug_msg "Generating the help project files"
     generate_file_index
     generate_class_index
@@ -68,6 +71,9 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
     template_file = @template_dir + 'fileindex.rhtml'
 
     out_file = @outputdir + "fileindex.html"
+    # suppress 1.9.3 warning
+    rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
+
     debug_msg "  rendering #{out_file}"
     render_template template_file, out_file do |io| binding end
   end
@@ -77,6 +83,9 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
 
     out_file = @outputdir + "classindex.html"
     debug_msg "  rendering #{out_file}"
+    # suppress 1.9.3 warning
+    rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
+
     render_template template_file, out_file do |io| binding end
   end
 
@@ -84,12 +93,12 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
   # The project file links together all the various
   # files that go to make up the help.
   def generate_project_file
-    template_file = @template_dir + 'hpp_file.rhtml'
+    template_file = @template_dir + 'hhp_file.hhp.rhtml'
 
     @values = { :title => @options.title, :opname => @outputdir.basename }
     
     static_files = ['index.html', 'classindex.html', 'fileindex.html']
-    @values[:html_files] = static_files + (@files+@classes).map{|f| f.path }
+    @values[:html_files] = static_files + (@generated_files+@classes).map{|f| f.path}.uniq
     
     out_file = @outputdir + @project_name
     debug_msg "  rendering #{out_file}"
@@ -99,7 +108,7 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
   ##
   # generate the CHM contents (contents.hhc)
   def generate_contents
-    template_file = @template_dir + 'contents.rhtml'
+    template_file = @template_dir + 'contents.hhc.rhtml'
 
     out_file = @outputdir + "contents.hhc"
     debug_msg "  rendering #{out_file}"
@@ -109,7 +118,7 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
   ##
   # generate the CHM index (index.hhk)
   def generate_chm_index
-    template_file = @template_dir + 'chm_index.rhtml'
+    template_file = @template_dir + 'chm_index.hhk.rhtml'
     
     out_file = @outputdir + "index.hhk"
     debug_msg "  rendering #{out_file}"
@@ -126,47 +135,13 @@ class RDoc::Generator::CHM < RDoc::Generator::Darkfish
   ##
   # This is an override to make sure that the new Darkfish template
   # doesn't try to parse the CHM files as html partials
-  #
-  # TODO: If you want to refactor the html used in the template
-  # this should probably be a regex or something that checks to see
-  # if the file extension is html.
   def assemble_template body_file
-    body = body_file.read
-    return body if body
-  end
-
-  ##
-  # The generate_file_files method in RDoc 3.12 is broken for 'legacy'
-  # template support. So this overrides that method so it works.
-  def generate_file_files
-    filepage_file = @template_dir + 'filepage.rhtml' 
-
-    return unless filepage_file.exist?
-
-    debug_msg "Generating file documentation in #{@outputdir}"
-
-    out_file = nil
-    current = nil
-
-    @files.each do |file|
-      current = file
-      template_file = nil
-      out_file = @outputdir + file.path
-      debug_msg "  working on %s (%s)" % [file.full_name, out_file]
-      # suppress 1.9.3 warning
-      rel_prefix = rel_prefix = @outputdir.relative_path_from(out_file.dirname)
-
-      @title += " - #{@options.title}"
-      template_file = filepage_file
-
-      render_template template_file, out_file do |io| binding end
+    if body_file.basename.to_s =~ /\.hh(k|c|p)/
+      body = body_file.read
+      return body if body
+    else
+      super
     end
-  rescue => e
-    error =
-      RDoc::Error.new "error generating #{out_file}: #{e.message} (#{e.class})"
-    error.set_backtrace e.backtrace
-
-    raise error
   end
 end
 

data/lib/rdoc/generator/template/chm/_class_metadata.rhtml

@@ -0,0 +1,45 @@
+	<!--<div id="metadata"> -->
+		<div id="file-metadata">
+			<div id="file-list-section" class="section">
+				<h3 class="section-header">In Files</h3>
+				<div class="section-body">
+					<ul>
+					<% klass.in_files.each do |tl| %>
+						<li><%= h tl.absolute_name %></li>
+					<% end %>
+					</ul>
+				</div>
+			</div>
+
+		<div id="class-metadata">
+
+			<!-- Parent Class -->
+			<% if klass.type == 'class' %>
+			<div id="parent-class-section" class="section">
+				<h3 class="section-header">Parent</h3>
+				<% unless String === klass.superclass or klass.superclass.nil? %>
+				<p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a></p>
+				<% else %>
+				<p class="link"><%= klass.superclass %></p>
+				<% end %>
+			</div>
+			<% end %>
+
+			<!-- Included Modules -->
+			<% unless klass.includes.empty? %>
+			<div id="includes-section" class="section">
+				<h3 class="section-header">Included Modules</h3>
+				<ul class="link-list">
+				<% klass.each_include do |inc| %>
+				<% unless String === inc.module %>
+					<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
+				<% else %>
+					<li><span class="include"><%= inc.name %></span></li>
+				<% end %>
+				<% end %>
+				</ul>
+			</div>
+			<% end %>
+		</div>
+
+	<!-- </div> -->

data/lib/rdoc/generator/template/chm/_footer.rhtml

@@ -0,0 +1,4 @@
+<footer id="validator-badges">
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> <%= RDoc::VERSION %>.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %>.
+</footer>

data/lib/rdoc/generator/template/chm/_head.rhtml

@@ -0,0 +1,12 @@
+<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type">
+
+<title><%= h @title %></title>
+
+<link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "<%= rel_prefix %>/";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/darkfish.js"></script>

data/lib/rdoc/generator/template/chm/_hidden_images.rhtml

@@ -0,0 +1,20 @@
+  <img class="initially-hidden" src="images/brick.png"/>
+  <img class="initially-hidden" src="images/brick_link.png"/>
+  <img class="initially-hidden" src="images/bug.png"/>
+  <img class="initially-hidden" src="images/bullet_black.png"/>
+  <img class="initially-hidden" src="images/bullet_toggle_minus.png"/>
+  <img class="initially-hidden" src="images/bullet_toggle_plus.png"/>
+  <img class="initially-hidden" src="images/date.png"/>
+  <img class="initially-hidden" src="images/find.png"/>
+  <img class="initially-hidden" src="images/loadingAnimation.gif"/>
+  <img class="initially-hidden" src="images/macFFBgHack.png"/>
+  <img class="initially-hidden" src="images/package.png"/>
+  <img class="initially-hidden" src="images/page_green.png"/>
+  <img class="initially-hidden" src="images/page_white_text.png"/>
+  <img class="initially-hidden" src="images/page_white_width.png"/>
+  <img class="initially-hidden" src="images/plugin.png"/>
+  <img class="initially-hidden" src="images/ruby.png"/>
+  <img class="initially-hidden" src="images/tag_green.png"/>
+  <img class="initially-hidden" src="images/wrench.png"/>
+  <img class="initially-hidden" src="images/wrench_orange.png"/>
+  <img class="initially-hidden" src="images/zoom.png"/>

data/lib/rdoc/generator/template/chm/_index_modules_and_files.rhtml

@@ -0,0 +1,16 @@
+	<% simple_files = @files.select { |f| f.text? } %>
+	<% unless simple_files.empty? then %>
+	<h2>Files</h2>
+	<ul>
+		<% simple_files.sort.each do |file| %>
+			<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
+		<% end %>
+	</ul>
+	<% end %>
+
+	<h2>Classes/Modules</h2>
+	<ul>
+		<% @modsort.each do |klass| %>
+		<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
+		<% end %>
+	</ul>

data/lib/rdoc/generator/template/chm/{chm_index.rhtml → chm_index.hhk.rhtml}

@@ -10,7 +10,7 @@
 	<param name="ImageType" value="Folder">
 </OBJECT>
 <UL>
-<% (@files+@classes).sort.each do |index| %>
+<% (@generated_files+@classes).sort.each do |index| %>
 	<LI> <OBJECT type="text/sitemap">
 		<param name="Name" value="<%= index.full_name %>">
 		<param name="Local" value="<%= index.path %>">
@@ -22,6 +22,6 @@
 		<param name="Local" value="<%= method.path %>">
 		</OBJECT>
 <% end # index.method_list.sort %>
-<% end # (@files+@classes).sort %>
+<% end # (@generated_files+@classes).sort %>
 </UL>
-</BODY></HTML>
+</BODY></HTML>

data/lib/rdoc/generator/template/chm/class.rhtml

@@ -0,0 +1,145 @@
+<body id="top" class="<%= klass.type %>">
+  <div id="documentation">
+    <h1 class="<%= klass.type %>"><%= klass.type %> <%= klass.full_name %></h1>
+
+    <div id="description" class="description">
+      <%= klass.description %>
+    </div><!-- description -->
+
+    <!-- Metadata -->
+    <%= render '_class_metadata.rhtml' %>
+
+    <% klass.each_section do |section, constants, attributes| %>
+    <% constants = constants.select { |const| const.display? } %>
+    <% attributes = attributes.select { |attr| attr.display? } %>
+    <section id="<%= section.aref %>" class="documentation-section">
+      <% if section.title then %>
+      <div class="documentation-section-title">
+        <h2 class="section-header">
+          <%= section.title %>
+        </h2>
+        <span class="section-click-top">
+          <a href="#top">&uarr; top</a>
+        </span>
+      </div>
+      <% end %>
+
+      <% if section.comment then %>
+      <div class="description">
+        <%= section.description %>
+      </div>
+      <% end %>
+
+      <% unless constants.empty? then %>
+      <!-- Constants -->
+      <section id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        <% constants.each do |const| %>
+          <dt id="<%= const.name %>"><%= const.name %>
+          <% if const.comment then %>
+          <dd class="description"><%= const.description.strip %>
+          <% else %>
+          <dd class="description missing-docs">(Not documented)
+          <% end %>
+        <% end %>
+        </dl>
+      </section>
+      <% end %>
+
+      <% unless attributes.empty? then %>
+      <!-- Attributes -->
+      <section id="attribute-method-details" class="method-section section">
+        <h3 class="section-header">Attributes</h3>
+
+        <% attributes.each do |attrib| %>
+        <div id="<%= attrib.aref %>" class="method-detail">
+          <div class="method-heading attribute-method-heading">
+            <span class="method-name"><%= h attrib.name %></span><span
+              class="attribute-access-type">[<%= attrib.rw %>]</span>
+          </div>
+
+          <div class="method-description">
+          <% if attrib.comment then %>
+          <%= attrib.description.strip %>
+          <% else %>
+          <p class="missing-docs">(Not documented)
+          <% end %>
+          </div>
+        </div>
+        <% end %>
+      </section><!-- attribute-method-details -->
+      <% end %>
+
+      <!-- Methods -->
+      <% klass.methods_by_type(section).each do |type, visibilities|
+         next if visibilities.empty?
+         visibilities.each do |visibility, methods|
+           next if methods.empty? %>
+       <section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section section">
+        <h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
+
+      <% methods.each do |method| %>
+        <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
+          <% if method.call_seq then %>
+          <%   method.call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
+          <div class="method-heading">
+            <span class="method-callseq">
+              <%= h(call_seq.strip.
+                    gsub( /^\w+\./m, '')).
+                    gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+            </span>
+            <% if i == 0 then %>
+            <span class="method-click-advice">click to toggle source</span>
+            <% end %>
+          </div>
+          <%   end %>
+          <% else %>
+          <div class="method-heading">
+            <span class="method-name"><%= h method.name %></span><span
+              class="method-args"><%= method.param_seq %></span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          <% end %>
+
+          <div class="method-description">
+            <% if method.comment then %>
+            <%= method.description.strip %>
+            <% else %>
+            <p class="missing-docs">(Not documented)
+            <% end %>
+
+            <% if method.token_stream then %>
+            <div class="method-source-code" id="<%= method.html_name %>-source">
+              <pre><%= method.markup_code %></pre>
+            </div><!-- <%= method.html_name %>-source -->
+            <% end %>
+          </div>
+
+          <% unless method.aliases.empty? then %>
+          <div class="aliases">
+            Also aliased as: <%= method.aliases.map do |aka|
+              if aka.parent then # HACK lib/rexml/encodings
+                %{<a href="#{klass.aref_to aka.path}">#{h aka.name}</a>}
+              else
+                h aka.name
+              end
+            end.join ", " %>
+          </div>
+          <% end %>
+
+          <% if method.is_alias_for then %>
+          <div class="aliases">
+            Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+          </div>
+          <% end %>
+        </div><!-- <%= method.html_name %>-method -->
+
+      <% end %>
+      </section><!-- <%= visibility %>-<%= type %>-method-details -->
+    <% end
+       end %>
+    </section><!-- <%= section.aref %> -->
+  <% end %>
+
+  </div><!-- documentation -->

data/lib/rdoc/generator/template/chm/classindex.rhtml

@@ -1,15 +1,3 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
-	<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-	<title>Classes/Modules</title>
-
-	<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
-
-</head>
 <body class="indexpage">	
 
 	<h1><%= h @options.title %></h1>
@@ -22,6 +10,3 @@
 		<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
 		<% end %>
 	</ul>
-
-</body>
-</html>

data/lib/rdoc/generator/template/chm/{contents.rhtml → contents.hhc.rhtml}

@@ -41,7 +41,7 @@
           <param name="Local" value="fileindex.html">
         </OBJECT>
     <UL>
-        <% @files.sort.each do |klass| %>
+        <% @generated_files.sort.each do |klass| %>
         <LI><OBJECT type="text/sitemap">
               <param name="Name" value="<%= klass.full_name %>">
               <param name="Local" value="<%= klass.path %>">
@@ -50,4 +50,4 @@
     </UL>
   </UL>
 </BODY>
-</HTML>
+</HTML>

data/lib/rdoc/generator/template/chm/fileindex.rhtml

@@ -1,30 +1,14 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
-	<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-	<title>Files</title>
-
-	<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
-
-</head>
 <body class="indexpage">	
 
 	<h1><%= h @options.title %></h1>
 
   <p>This is the API documentation for '<%= @options.title %>'.</p>
   
-	<% simple_files = @files.select {|tl| tl.parser == RDoc::Parser::Simple } %>
-	<% unless simple_files.empty? then %>
+  <% unless @generated_files.empty? %>
 	<h2>Files</h2>
 	<ul>
-		<% simple_files.sort.each do |file| %>
+		<% @generated_files.sort.each do |file| %>
 			<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
 		<% end %>
 	</ul>
 	<% end %>
-
-</body>
-</html>

data/lib/rdoc/generator/template/chm/index.rhtml

@@ -1,22 +1,4 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-	"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
-	<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-	<title><%= h @options.title %></title>
-
-	<link type="text/css" media="screen" href="rdoc.css" rel="stylesheet" />
-
-	<script src="js/jquery.js" type="text/javascript" charset="utf-8"></script>
-	<script src="js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
-	<script src="js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
-	<script src="js/darkfish.js" type="text/javascript" charset="utf-8"></script>
-
-</head>
 <body class="indexpage">
-
 	<h1><%= h @options.title %></h1>
 
 	<% if @options.main_page && main_page = @files.find { |f| f.full_name == @options.main_page } %>
@@ -27,49 +9,6 @@
 	<p>This is the API documentation for '<%= @options.title %>'.</p>
 	<% end %>
 
-	<% simple_files = @files.select {|tl| tl.parser == RDoc::Parser::Simple } %>
-	<% unless simple_files.empty? then %>
-	<h2>Files</h2>
-	<ul>
-		<% simple_files.sort.each do |file| %>
-			<li class="file"><a href="<%= file.path %>"><%= h file.base_name %></a></li>
-		<% end %>
-	</ul>
-	<% end %>
-
-	<h2>Classes/Modules</h2>
-	<ul>
-		<% @modsort.each do |klass| %>
-		<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
-		<% end %>
-	</ul>
-
-	<div id="validator-badges">
-		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-			Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
-	</div>
-
-  <img class="initially-hidden" src="images/brick.png"/>
-  <img class="initially-hidden" src="images/brick_link.png"/>
-  <img class="initially-hidden" src="images/bug.png"/>
-  <img class="initially-hidden" src="images/bullet_black.png"/>
-  <img class="initially-hidden" src="images/bullet_toggle_minus.png"/>
-  <img class="initially-hidden" src="images/bullet_toggle_plus.png"/>
-  <img class="initially-hidden" src="images/date.png"/>
-  <img class="initially-hidden" src="images/find.png"/>
-  <img class="initially-hidden" src="images/loadingAnimation.gif"/>
-  <img class="initially-hidden" src="images/macFFBgHack.png"/>
-  <img class="initially-hidden" src="images/package.png"/>
-  <img class="initially-hidden" src="images/page_green.png"/>
-  <img class="initially-hidden" src="images/page_white_text.png"/>
-  <img class="initially-hidden" src="images/page_white_width.png"/>
-  <img class="initially-hidden" src="images/plugin.png"/>
-  <img class="initially-hidden" src="images/ruby.png"/>
-  <img class="initially-hidden" src="images/tag_green.png"/>
-  <img class="initially-hidden" src="images/wrench.png"/>
-  <img class="initially-hidden" src="images/wrench_orange.png"/>
-  <img class="initially-hidden" src="images/zoom.png"/>
+  <%= render '_index_modules_and_files.rhtml' %>
 
-</body>
-</html>
+  <%= render '_hidden_images.rhtml' %>

data/lib/rdoc/generator/template/chm/page.rhtml

@@ -0,0 +1,4 @@
+<body class="file">
+<div id="documentation" class="description">
+  <%= file.description %>
+</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc_chm
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -66,13 +66,18 @@ files:
 - lib/rdoc/discover.rb
 - lib/rdoc/generator/chm.rb
 - lib/rdoc/generator/template/chm/.document
-- lib/rdoc/generator/template/chm/chm_index.rhtml
+- lib/rdoc/generator/template/chm/_class_metadata.rhtml
+- lib/rdoc/generator/template/chm/_index_modules_and_files.rhtml
+- lib/rdoc/generator/template/chm/_hidden_images.rhtml
+- lib/rdoc/generator/template/chm/_head.rhtml
+- lib/rdoc/generator/template/chm/_footer.rhtml
+- lib/rdoc/generator/template/chm/chm_index.hhk.rhtml
 - lib/rdoc/generator/template/chm/classindex.rhtml
-- lib/rdoc/generator/template/chm/classpage.rhtml
-- lib/rdoc/generator/template/chm/contents.rhtml
+- lib/rdoc/generator/template/chm/class.rhtml
+- lib/rdoc/generator/template/chm/contents.hhc.rhtml
 - lib/rdoc/generator/template/chm/fileindex.rhtml
-- lib/rdoc/generator/template/chm/filepage.rhtml
-- lib/rdoc/generator/template/chm/hpp_file.rhtml
+- lib/rdoc/generator/template/chm/page.rhtml
+- lib/rdoc/generator/template/chm/hhp_file.hhp.rhtml
 - lib/rdoc/generator/template/chm/images/brick.png
 - lib/rdoc/generator/template/chm/images/brick_link.png
 - lib/rdoc/generator/template/chm/images/bug.png

data/lib/rdoc/generator/template/chm/classpage.rhtml

@@ -1,180 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-	<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-	<title><%= klass.type.capitalize %>: <%= klass.full_name %></title>
-
-	<link rel="stylesheet" href="<%= rel_prefix %>/rdoc.css" type="text/css" media="screen" />
-
-	<script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
-		charset="utf-8"></script>
-
-</head>
-<body class="<%= klass.type %>">
-
-	<div id="documentation">
-
-		<h1 class="<%= klass.type %>"><%= klass.full_name %></h1>
-
-
-	<!--<div id="metadata"> -->
-		<div id="file-metadata">
-			<div id="file-list-section" class="section">
-				<h3 class="section-header">In Files</h3>
-				<div class="section-body">
-					<ul>
-					<% klass.in_files.each do |tl| %>
-						<li><a href="<%= rel_prefix %>/<%= h tl.path %>"
-							title="<%= h tl.absolute_name %>"><%= h tl.absolute_name %></a></li>
-					<% end %>
-					</ul>
-				</div>
-			</div>
-
-		<div id="class-metadata">
-
-			<!-- Parent Class -->
-			<% if klass.type == 'class' %>
-			<div id="parent-class-section" class="section">
-				<h3 class="section-header">Parent</h3>
-				<% unless String === klass.superclass or klass.superclass.nil? %>
-				<p class="link"><a href="<%= klass.aref_to klass.superclass.path %>"><%= klass.superclass.full_name %></a></p>
-				<% else %>
-				<p class="link"><%= klass.superclass %></p>
-				<% end %>
-			</div>
-			<% end %>
-
-			<!-- Included Modules -->
-			<% unless klass.includes.empty? %>
-			<div id="includes-section" class="section">
-				<h3 class="section-header">Included Modules</h3>
-				<ul class="link-list">
-				<% klass.each_include do |inc| %>
-				<% unless String === inc.module %>
-					<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
-				<% else %>
-					<li><span class="include"><%= inc.name %></span></li>
-				<% end %>
-				<% end %>
-				</ul>
-			</div>
-			<% end %>
-		</div>
-
-	<!-- </div> -->
-
-		<div id="description">
-			<%= klass.description %>
-		</div>
-
-		<!-- Constants -->
-		<% unless klass.constants.empty? %>
-		<div id="constants-list" class="section">
-			<h3 class="section-header">Constants</h3>
-			<dl>
-			<% klass.each_constant do |const| %>
-				<dt><a name="<%= const.name %>"><%= const.name %></a></dt>
-				<% if const.comment %>
-				<dd class="description"><%= const.description.strip %></dd>
-				<% else %>
-				<dd class="description missing-docs">(Not documented)</dd>
-				<% end %>
-			<% end %>
-			</dl>
-		</div>
-		<% end %>
-
-		<!-- Attributes -->
-		<% unless klass.attributes.empty? %>
-		<div id="attribute-method-details" class="method-section section">
-			<h3 class="section-header">Attributes</h3>
-
-			<% klass.each_attribute do |attrib| %>
-			<div id="<%= attrib.html_name %>-attribute-method" class="method-detail">
-				<a name="<%= h attrib.name %>"></a>
-				<% if attrib.rw =~ /w/i %>
-				<a name="<%= h attrib.name %>="></a>
-				<% end %>
-				<div class="method-heading attribute-method-heading">
-					<span class="method-name"><%= h attrib.name %></span><span
-						class="attribute-access-type">[<%= attrib.rw %>]</span>
-				</div>
-
-				<div class="method-description">
-				<% if attrib.comment %>
-				<%= attrib.description.strip %>
-				<% else %>
-				<p class="missing-docs">(Not documented)</p>
-				<% end %>
-				</div>
-			</div>
-			<% end %>
-		</div>
-		<% end %>
-
-		<!-- Methods -->
-		<% klass.methods_by_type.each do |type, visibilities|
-			 next if visibilities.empty?
-			 visibilities.each do |visibility, methods|
-				 next if methods.empty? %>
-		<div id="<%= visibility %>-<%= type %>-method-details" class="method-section section">
-			<h3 class="section-header"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</h3>
-
-		<% methods.each do |method| %>
-			<div id="<%= method.html_name %>-method" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-				<a name="<%= h method.aref %>"></a>
-
-				<div class="method-heading">
-				<% if method.call_seq %>
-					<span class="method-callseq"><%= method.call_seq.strip.gsub(/->/, '&rarr;').gsub( /^\w+\./m, '') %></span>
-					<span class="method-click-advice">click to toggle source</span>
-				<% else %>
-					<span class="method-name"><%= h method.name %></span><span
-						class="method-args"><%= method.params %></span>
-					<span class="method-click-advice">click to toggle source</span>
-				<% end %>
-				</div>
-
-				<div class="method-description">
-					<% if method.comment %>
-					<%= method.description.strip %>
-					<% else %>
-					<p class="missing-docs">(Not documented)</p>
-					<% end %>
-
-					<% if method.token_stream %>
-					<div class="method-source-code"
-						id="<%= method.html_name %>-source">
-<pre>
-<%= method.markup_code %>
-</pre>
-					</div>
-					<% end %>
-				</div>
-
-				<% unless method.aliases.empty? %>
-				<div class="aliases">
-					Also aliased as: <%= method.aliases.map do |aka|
-						%{<a href="#{ klass.aref_to aka.path}">#{h aka.name}</a>}
-					end.join(", ") %>
-				</div>
-				<% end %>
-			</div>
-
-		<% end %>
-		</div>
-	<% end
-		 end %>
-
-	</div>
-</body>
-</html>

data/lib/rdoc/generator/template/chm/filepage.rhtml

@@ -1,74 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-	<meta content="text/html; charset=<%= @options.charset %>" http-equiv="Content-Type" />
-
-	<title>File: <%= file.base_name %> [<%= @options.title %>]</title>
-
-	<link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet" />
-
-	<script src="<%= rel_prefix %>/js/jquery.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="<%= rel_prefix %>/js/thickbox-compressed.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="<%= rel_prefix %>/js/quicksearch.js" type="text/javascript"
-		charset="utf-8"></script>
-	<script src="<%= rel_prefix %>/js/darkfish.js" type="text/javascript"
-		charset="utf-8"></script>
-</head>
-
-<% if file.parser == RDoc::Parser::Simple %>
-<body class="file">
-
-	<div id="documentation">
-		<%= file.description %>
-	</div>
-
-	<div id="validator-badges">
-		<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-		<p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-			Rdoc Generator</a> <%= RDoc::Generator::Darkfish::VERSION %></small>.</p>
-	</div>
-</body>
-<% else %>
-<body class="file file-popup">
-
-	<div id="documentation">
-
-	<!-- <div id="metadata"> -->
-		<dl>
-			<dt class="modified-date">Last Modified</dt>
-			<dd class="modified-date"><%= file.last_modified %></dd>
-
-			<% if file.requires %>
-			<dt class="requires">Requires</dt>
-			<dd class="requires">
-				<ul>
-				<% file.requires.each do |require| %>
-					<li><%= require.name %></li>
-				<% end %>
-				</ul>
-			</dd>
-			<% end %>
-
-			<% if @options.webcvs %>
-			<dt class="scs-url">Trac URL</dt>
-			<dd class="scs-url"><a target="_top"
-				href="<%= file.cvs_url %>"><%= file.cvs_url %></a></dd>
-			<% end %>
-		</dl>
-	<!-- </div> -->
-
-		<% if file.comment %>
-		<div class="description">
-			<h2>Description</h2>
-			<%= file.description %>
-		</div>
-		<% end %>
-	</div>
-</body>
-<% end %>
-</html>
-