rdoc 2.2.1 → 2.3.0

data/lib/rdoc/generator/chm.rb

@@ -1,113 +0,0 @@
-require 'rdoc/generator/html'
-
-class RDoc::Generator::CHM < RDoc::Generator::HTML
-
-  HHC_PATH = "c:/Program Files/HTML Help Workshop/hhc.exe"
-
-  ##
-  # Standard generator factory
-
-  def self.for(options)
-    new(options)
-  end
-
-  def initialize(*args)
-    super
-    @op_name = @options.op_name || "rdoc"
-    check_for_html_help_workshop
-  end
-
-  def check_for_html_help_workshop
-    stat = File.stat(HHC_PATH)
-  rescue
-    $stderr <<
-      "\n.chm output generation requires that Microsoft's Html Help\n" <<
-      "Workshop is installed. RDoc looks for it in:\n\n    " <<
-      HHC_PATH <<
-      "\n\nYou can download a copy for free from:\n\n" <<
-      "    http://msdn.microsoft.com/library/default.asp?" <<
-      "url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp\n\n"
-  end
-
-  ##
-  # Generate the html as normal, then wrap it in a help project
-
-  def generate(info)
-    super
-    @project_name = @op_name + ".hhp"
-    create_help_project
-  end
-
-  ##
-  # The project contains the project file, a table of contents and an index
-
-  def create_help_project
-    create_project_file
-    create_contents_and_index
-    compile_project
-  end
-
-  ##
-  # The project file links together all the various
-  # files that go to make up the help.
-
-  def create_project_file
-    template = RDoc::TemplatePage.new @template::HPP_FILE
-    values = { "title" => @options.title, "opname" => @op_name }
-    files = []
-    @files.each do |f|
-      files << { "html_file_name" => f.path }
-    end
-
-    values['all_html_files'] = files
-
-    File.open(@project_name, "w") do |f|
-      template.write_html_on(f, values)
-    end
-  end
-
-  ##
-  # The contents is a list of all files and modules.
-  # For each we include  as sub-entries the list
-  # of methods they contain. As we build the contents
-  # we also build an index file
-
-  def create_contents_and_index
-    contents = []
-    index    = []
-
-    (@files+@classes).sort.each do |entry|
-      content_entry = { "c_name" => entry.name, "ref" => entry.path }
-      index << { "name" => entry.name, "aref" => entry.path }
-
-      internals = []
-
-      methods = entry.build_method_summary_list(entry.path)
-
-      content_entry["methods"] = methods unless methods.empty?
-      contents << content_entry
-      index.concat methods
-    end
-
-    values = { "contents" => contents }
-    template = RDoc::TemplatePage.new @template::CONTENTS
-    File.open("contents.hhc", "w") do |f|
-      template.write_html_on(f, values)
-    end
-
-    values = { "index" => index }
-    template = RDoc::TemplatePage.new @template::CHM_INDEX
-    File.open("index.hhk", "w") do |f|
-      template.write_html_on(f, values)
-    end
-  end
-
-  ##
-  # Invoke the windows help compiler to compiler the project
-
-  def compile_project
-    system(HHC_PATH, @project_name)
-  end
-
-end
-

data/lib/rdoc/generator/chm/chm.rb

@@ -1,100 +0,0 @@
-require 'rdoc/generator/chm'
-require 'rdoc/generator/html/html'
-
-module RDoc::Generator::CHM::CHM
-
-  HTML = RDoc::Generator::HTML::HTML
-
-  INDEX = HTML::INDEX
-  
-  STYLE = HTML::STYLE
-
-  CLASS_INDEX = HTML::CLASS_INDEX
-  CLASS_PAGE = HTML::CLASS_PAGE
-  FILE_INDEX = HTML::FILE_INDEX
-  FILE_PAGE = HTML::FILE_PAGE
-  METHOD_INDEX = HTML::METHOD_INDEX
-  METHOD_LIST = HTML::METHOD_LIST
-
-  FR_INDEX_BODY = HTML::FR_INDEX_BODY
-
-  # This is a nasty little hack, but hhc doesn't support the <?xml tag, so...
-  BODY = HTML::BODY.sub!(/<\?xml.*\?>/, '')
-  SRC_PAGE = HTML::SRC_PAGE.sub!(/<\?xml.*\?>/, '')
-
-  HPP_FILE = <<-EOF
-[OPTIONS]
-Auto Index = Yes
-Compatibility=1.1 or later
-Compiled file=<%= values["opname"] %>.chm
-Contents file=contents.hhc
-Full-text search=Yes
-Index file=index.hhk
-Language=0x409 English(United States)
-Title=<%= values["title"] %>
-
-[FILES]
-<% values["all_html_files"].each do |all_html_files| %>
-<%= all_html_files["html_file_name"] %>
-<% end # values["all_html_files"] %>
-  EOF
-
-  CONTENTS = <<-EOF
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
-<HTML>
-<HEAD>
-<meta name="GENERATOR" content="Microsoft&reg; HTML Help Workshop 4.1">
-<!-- Sitemap 1.0 -->
-</HEAD><BODY>
-<OBJECT type="text/site properties">
-	<param name="Foreground" value="0x80">
-	<param name="Window Styles" value="0x800025">
-	<param name="ImageType" value="Folder">
-</OBJECT>
-<UL>
-<% values["contents"].each do |contents| %>
-	<LI> <OBJECT type="text/sitemap">
-		<param name="Name" value="<%= contents["c_name"] %>">
-		<param name="Local" value="<%= contents["ref"] %>">
-		</OBJECT>
-<% if contents["methods"] then %>
-<ul>
-<% contents["methods"].each do |methods| %>
-	<LI> <OBJECT type="text/sitemap">
-		<param name="Name" value="<%= methods["name"] %>">
-		<param name="Local" value="<%= methods["aref"] %>">
-		</OBJECT>
-<% end # contents["methods"] %>
-</ul>
-<% end %>
-        </LI>
-<% end # values["contents"] %>
-</UL>
-</BODY></HTML>
-  EOF
-
-  CHM_INDEX = <<-EOF
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
-<HTML>
-<HEAD>
-<meta name="GENERATOR" content="Microsoft&reg; HTML Help Workshop 4.1">
-<!-- Sitemap 1.0 -->
-</HEAD><BODY>
-<OBJECT type="text/site properties">
-	<param name="Foreground" value="0x80">
-	<param name="Window Styles" value="0x800025">
-	<param name="ImageType" value="Folder">
-</OBJECT>
-<UL>
-<% values["index"].each do |index| %>
-	<LI> <OBJECT type="text/sitemap">
-		<param name="Name" value="<%= index["name"] %>">
-		<param name="Local" value="<%= index["aref"] %>">
-		</OBJECT>
-<% end # values["index"] %>
-</UL>
-</BODY></HTML>
-  EOF
-
-end
-

data/lib/rdoc/generator/html/frameless.rb

@@ -1,92 +0,0 @@
-require 'rdoc/generator/html/html'
-
-##
-# = CSS2 RDoc HTML template
-#
-# This is a template for RDoc that uses XHTML 1.0 Strict and dictates a
-# bit more of the appearance of the output to cascading stylesheets than the
-# default. It was designed for clean inline code display, and uses DHTMl to
-# toggle the visbility of each method's source with each click on the '[source]'
-# link.
-#
-# Frameless basically is the html template without frames.
-#
-# == Authors
-#
-# * Michael Granger <ged@FaerieMUD.org>
-#
-# Copyright (c) 2002, 2003 The FaerieMUD Consortium. Some rights reserved.
-#
-# This work is licensed under the Creative Commons Attribution License. To view
-# a copy of this license, visit http://creativecommons.org/licenses/by/1.0/ or
-# send a letter to Creative Commons, 559 Nathan Abbott Way, Stanford, California
-# 94305, USA.
-
-module RDoc::Generator::HTML::FRAMELESS
-
-  FRAMELESS = true
-
-  FONTS = RDoc::Generator::HTML::HTML::FONTS
-
-  STYLE = RDoc::Generator::HTML::HTML::STYLE
-
-  HEADER = RDoc::Generator::HTML::HTML::HEADER
-
-  FOOTER = <<-EOF
-  <div id="popupmenu" class="index">
-    <br />
-    <h1 class="index-entries section-bar">Files</h1>
-      <ul>
-<% values["file_list"].each do |file| %>
-        <li><a href="<%= file["href"] %>"><%= file["name"] %></a></li>
-<% end %>
-      </ul>
-
-    <br />
-    <h1 class="index-entries section-bar">Classes</h1>
-      <ul>
-<% values["class_list"].each do |klass| %>
-        <li><a href="<%= klass["href"] %>"><%= klass["name"] %></a></li>
-<% end %>
-      </ul>
-
-    <br />
-    <h1 class="index-entries section-bar">Methods</h1>
-      <ul>
-<% values["method_list"].each do |method| %>
-        <li><a href="<%= method["href"] %>"><%= method["name"] %></a></li>
-<% end %>
-      </ul>
-  </div>
-</body>
-</html>
-  EOF
-
-  FILE_PAGE = RDoc::Generator::HTML::HTML::FILE_PAGE
-
-  CLASS_PAGE = RDoc::Generator::HTML::HTML::CLASS_PAGE
-
-  METHOD_LIST = RDoc::Generator::HTML::HTML::METHOD_LIST
-
-  BODY = HEADER + %{
-
-<%= template_include %>  <!-- banner header -->
-
-  <div id="bodyContent">
-
-} +  METHOD_LIST + %{
-
-  </div>
-
-} + FOOTER
-
-  SRC_PAGE = RDoc::Generator::HTML::HTML::SRC_PAGE
-
-  FR_INDEX_BODY = RDoc::Generator::HTML::HTML::FR_INDEX_BODY
-
-  FILE_INDEX = RDoc::Generator::HTML::HTML::FILE_INDEX
-
-  CLASS_INDEX = RDoc::Generator::HTML::HTML::CLASS_INDEX
-
-  METHOD_INDEX = RDoc::Generator::HTML::HTML::METHOD_INDEX
-end

data/lib/rdoc/generator/html/hefss.rb

@@ -1,150 +0,0 @@
-require 'rdoc/generator/html'
-require 'rdoc/generator/html/kilmerfactory'
-
-module RDoc::Generator::HTML::HEFSS
-
-  FONTS = "Verdana, Arial, Helvetica, sans-serif"
-
-  CENTRAL_STYLE = <<-EOF
-body,p { font-family: <%= values["fonts"] %>;
-       color: #000040; background: #BBBBBB;
-}
-
-td { font-family: <%= values["fonts"] %>;
-       color: #000040;
-}
-
-.attr-rw { font-size: small; color: #444488 }
-
-.title-row {color:      #eeeeff;
-	    background: #BBBBDD;
-}
-
-.big-title-font { color: white;
-                  font-family: <%= values["fonts"] %>;
-                  font-size: large;
-                  height: 50px}
-
-.small-title-font { color: purple;
-                    font-family: <%= values["fonts"] %>;
-                    font-size: small; }
-
-.aqua { color: purple }
-
-#diagram img {
-  border: 0;
-}
-
-.method-name, attr-name {
-      font-family: monospace; font-weight: bold;
-}
-
-.tablesubtitle {
-   width: 100%;
-   margin-top: 1ex;
-   margin-bottom: .5ex;
-   padding: 5px 0px 5px 20px;
-   font-size: large;
-   color: purple;
-   background: #BBBBCC;
-}
-
-.tablesubsubtitle {
-   width: 100%;
-   margin-top: 1ex;
-   margin-bottom: .5ex;
-   padding: 5px 0px 5px 20px;
-   font-size: medium;
-   color: white;
-   background: #BBBBCC;
-}
-
-.name-list {
-  font-family: monospace;
-  margin-left: 40px;
-  margin-bottom: 2ex;
-  line-height: 140%;
-}
-
-.description {
-  margin-left: 40px;
-  margin-bottom: 2ex;
-  line-height: 140%;
-}
-
-.methodtitle {
-  font-size: medium;
-  text_decoration: none;
-  padding: 3px 3px 3px 20px;
-  color: #0000AA;
-}
-
-.ruby-comment    { color: green; font-style: italic }
-.ruby-constant   { color: #4433aa; font-weight: bold; }
-.ruby-identifier { color: #222222;  }
-.ruby-ivar       { color: #2233dd; }
-.ruby-keyword    { color: #3333FF; font-weight: bold }
-.ruby-node       { color: #777777; }
-.ruby-operator   { color: #111111;  }
-.ruby-regexp     { color: #662222; }
-.ruby-value      { color: #662222; font-style: italic }
-
-.srcbut { float: right }
-  EOF
-
-  INDEX_STYLE = <<-EOF
-body {
-  background-color: #bbbbbb;
-  font-family: #{FONTS};
-  font-size: 11px;
-  font-style: normal;
-  line-height: 14px;
-  color: #000040;
-}
-
-div.banner {
-  background: #bbbbcc;
-  color: white;
-  padding: 1;
-  margin: 0;
-  font-size: 90%;
-  font-weight: bold;
-  line-height: 1.1;
-  text-align: center;
-  width: 100%;
-}
-EOF
-
-  FACTORY = RDoc::Generator::HTML::
-    KilmerFactory.new(:central_css => CENTRAL_STYLE,
-                      :index_css => INDEX_STYLE,
-                      :method_list_heading => "Subroutines and Functions",
-                      :class_and_module_list_heading => "Classes and Modules",
-                      :attribute_list_heading => "Arguments")
-
-  STYLE = FACTORY.get_STYLE()
-
-  METHOD_LIST = FACTORY.get_METHOD_LIST()
-  
-  BODY = FACTORY.get_BODY()
-  
-  FILE_PAGE = FACTORY.get_FILE_PAGE()
-
-  CLASS_PAGE = FACTORY.get_CLASS_PAGE()
-
-  SRC_PAGE = FACTORY.get_SRC_PAGE()
-
-  FR_INDEX_BODY = FACTORY.get_FR_INDEX_BODY()
-
-  FILE_INDEX = FACTORY.get_FILE_INDEX()
-
-  CLASS_INDEX = FACTORY.get_CLASS_INDEX()
-
-  METHOD_INDEX = FACTORY.get_METHOD_INDEX()
-
-  INDEX = FACTORY.get_INDEX()
-
-  def self.write_extra_pages(values)
-    FACTORY.write_extra_pages(values)
-  end
-end