diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-04-01 07:45:16 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2010-04-01 07:45:16 +0000 |
commit | 46580b51477355fece514573c88cb67030f4a502 (patch) | |
tree | 779c1a64466643461b3daa4cd9a3548b84f0fd55 /lib/rdoc/generator/html | |
parent | 9b40cdfe8c973a061c5683ad78c283b9ddb8b2e9 (diff) |
Import RDoc 2.5
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@27147 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/generator/html')
-rw-r--r-- | lib/rdoc/generator/html/common.rb | 24 | ||||
-rw-r--r-- | lib/rdoc/generator/html/frameless.rb | 92 | ||||
-rw-r--r-- | lib/rdoc/generator/html/hefss.rb | 150 | ||||
-rw-r--r-- | lib/rdoc/generator/html/html.rb | 769 | ||||
-rw-r--r-- | lib/rdoc/generator/html/kilmer.rb | 151 | ||||
-rw-r--r-- | lib/rdoc/generator/html/kilmerfactory.rb | 427 | ||||
-rw-r--r-- | lib/rdoc/generator/html/one_page_html.rb | 122 |
7 files changed, 0 insertions, 1735 deletions
diff --git a/lib/rdoc/generator/html/common.rb b/lib/rdoc/generator/html/common.rb deleted file mode 100644 index b25f009a72..0000000000 --- a/lib/rdoc/generator/html/common.rb +++ /dev/null @@ -1,24 +0,0 @@ -# -# The templates require further refactoring. In particular, -# * Some kind of HTML generation library should be used. -# -# Also, all of the templates require some TLC from a designer. -# -# Right now, this file contains some constants that are used by all -# of the templates. -# -module RDoc::Generator::HTML::Common - XHTML_STRICT_PREAMBLE = <<-EOF -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" -"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> -EOF - - XHTML_FRAME_PREAMBLE = <<-EOF -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" -"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"> -EOF - - HTML_ELEMENT = <<-EOF -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -EOF -end diff --git a/lib/rdoc/generator/html/frameless.rb b/lib/rdoc/generator/html/frameless.rb deleted file mode 100644 index 0375fee313..0000000000 --- a/lib/rdoc/generator/html/frameless.rb +++ /dev/null @@ -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 diff --git a/lib/rdoc/generator/html/hefss.rb b/lib/rdoc/generator/html/hefss.rb deleted file mode 100644 index 01425a4556..0000000000 --- a/lib/rdoc/generator/html/hefss.rb +++ /dev/null @@ -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 diff --git a/lib/rdoc/generator/html/html.rb b/lib/rdoc/generator/html/html.rb deleted file mode 100644 index 5e5b4d5531..0000000000 --- a/lib/rdoc/generator/html/html.rb +++ /dev/null @@ -1,769 +0,0 @@ -require 'rdoc/generator/html' -require 'rdoc/generator/html/common' - -## -# = 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 visibility of each method's source with each click on the -# '[source]' link. -# -# This template *also* forms the basis of the frameless template. -# -# == 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::HTML - - include RDoc::Generator::HTML::Common - - FONTS = "Verdana,Arial,Helvetica,sans-serif" - - STYLE = <<-EOF -body { - font-family: #{FONTS}; - font-size: 90%; - margin: 0; - margin-left: 40px; - padding: 0; - background: white; - color: black; -} - -h1, h2, h3, h4 { - margin: 0; - background: transparent; -} - -h1 { - font-size: 150%; -} - -h2,h3,h4 { - margin-top: 1em; -} - -:link, :visited { - background: #eef; - color: #039; - text-decoration: none; -} - -:link:hover, :visited:hover { - background: #039; - color: #eef; -} - -/* Override the base stylesheet's Anchor inside a table cell */ -td > :link, td > :visited { - background: transparent; - color: #039; - text-decoration: none; -} - -/* and inside a section title */ -.section-title > :link, .section-title > :visited { - background: transparent; - color: #eee; - text-decoration: none; -} - -/* === Structural elements =================================== */ - -.index { - margin: 0; - margin-left: -40px; - padding: 0; - font-size: 90%; -} - -.index :link, .index :visited { - margin-left: 0.7em; -} - -.index .section-bar { - margin-left: 0px; - padding-left: 0.7em; - background: #ccc; - font-size: small; -} - -#classHeader, #fileHeader { - width: auto; - color: white; - padding: 0.5em 1.5em 0.5em 1.5em; - margin: 0; - margin-left: -40px; - border-bottom: 3px solid #006; -} - -#classHeader :link, #fileHeader :link, -#classHeader :visited, #fileHeader :visited { - background: inherit; - color: white; -} - -#classHeader td, #fileHeader td { - background: inherit; - color: white; -} - -#fileHeader { - background: #057; -} - -#classHeader { - background: #048; -} - -.class-name-in-header { - font-size: 180%; - font-weight: bold; -} - -#bodyContent { - padding: 0 1.5em 0 1.5em; -} - -#description { - padding: 0.5em 1.5em; - background: #efefef; - border: 1px dotted #999; -} - -#description h1, #description h2, #description h3, -#description h4, #description h5, #description h6 { - color: #125; - background: transparent; -} - -#validator-badges { - text-align: center; -} - -#validator-badges img { - border: 0; -} - -#copyright { - color: #333; - background: #efefef; - font: 0.75em sans-serif; - margin-top: 5em; - margin-bottom: 0; - padding: 0.5em 2em; -} - -/* === Classes =================================== */ - -table.header-table { - color: white; - font-size: small; -} - -.type-note { - font-size: small; - color: #dedede; -} - -.section-bar { - color: #333; - border-bottom: 1px solid #999; - margin-left: -20px; -} - -.section-title { - background: #79a; - color: #eee; - padding: 3px; - margin-top: 2em; - margin-left: -30px; - border: 1px solid #999; -} - -.top-aligned-row { - vertical-align: top -} - -.bottom-aligned-row { - vertical-align: bottom -} - -#diagram img { - border: 0; -} - -/* --- Context section classes ----------------------- */ - -.context-row { } - -.context-item-name { - font-family: monospace; - font-weight: bold; - color: black; -} - -.context-item-value { - font-size: small; - color: #448; -} - -.context-item-desc { - color: #333; - padding-left: 2em; -} - -/* --- Method classes -------------------------- */ - -.method-detail { - background: #efefef; - padding: 0; - margin-top: 0.5em; - margin-bottom: 1em; - border: 1px dotted #ccc; -} - -.method-heading { - color: black; - background: #ccc; - border-bottom: 1px solid #666; - padding: 0.2em 0.5em 0 0.5em; -} - -.method-signature { - color: black; - background: inherit; -} - -.method-name { - font-weight: bold; -} - -.method-args { - font-style: italic; -} - -.method-description { - padding: 0 0.5em 0 0.5em; -} - -/* --- Source code sections -------------------- */ - -:link.source-toggle, :visited.source-toggle { - font-size: 90%; -} - -div.method-source-code { - background: #262626; - color: #ffdead; - margin: 1em; - padding: 0.5em; - border: 1px dashed #999; - overflow: auto; -} - -div.method-source-code pre { - color: #ffdead; -} - -/* --- Ruby keyword styles --------------------- */ - -.standalone-code { - background: #221111; - color: #ffdead; - overflow: auto; -} - -.ruby-constant { - color: #7fffd4; - background: transparent; -} - -.ruby-keyword { - color: #00ffff; - background: transparent; -} - -.ruby-ivar { - color: #eedd82; - background: transparent; -} - -.ruby-operator { - color: #00ffee; - background: transparent; -} - -.ruby-identifier { - color: #ffdead; - background: transparent; -} - -.ruby-node { - color: #ffa07a; - background: transparent; -} - -.ruby-comment { - color: #b22222; - font-weight: bold; - background: transparent; -} - -.ruby-regexp { - color: #ffa07a; - background: transparent; -} - -.ruby-value { - color: #7fffd4; - background: transparent; -} -EOF - - -##################################################################### -### H E A D E R T E M P L A T E -##################################################################### - - HEADER = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + <<-EOF -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> - <meta http-equiv="Content-Script-Type" content="text/javascript" /> - <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" /> - <script type="text/javascript"> - // <![CDATA[ - - function popupCode( url ) { - window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") - } - - function toggleCode( id ) { - if ( document.getElementById ) - elem = document.getElementById( id ); - else if ( document.all ) - elem = eval( "document.all." + id ); - else - return false; - - elemStyle = elem.style; - - if ( elemStyle.display != "block" ) { - elemStyle.display = "block" - } else { - elemStyle.display = "none" - } - - return true; - } - - // Make codeblocks hidden by default - document.writeln( "<style type=\\"text/css\\">div.method-source-code { display: none }<\\/style>" ) - - // ]]> - </script> - -</head> -<body> -EOF - -##################################################################### -### F O O T E R T E M P L A T E -##################################################################### - - FOOTER = <<-EOF -<div id="validator-badges"> - <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> -</div> - -</body> -</html> - EOF - - -##################################################################### -### F I L E P A G E H E A D E R T E M P L A T E -##################################################################### - - FILE_PAGE = <<-EOF - <div id="fileHeader"> - <h1><%= values["short_name"] %></h1> - <table class="header-table"> - <tr class="top-aligned-row"> - <td><strong>Path:</strong></td> - <td><%= values["full_path"] %> -<% if values["cvsurl"] then %> - (<a href="<%= values["cvsurl"] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>) -<% end %> - </td> - </tr> - <tr class="top-aligned-row"> - <td><strong>Last Update:</strong></td> - <td><%= values["dtm_modified"] %></td> - </tr> - </table> - </div> - EOF - -##################################################################### -### C L A S S P A G E H E A D E R T E M P L A T E -##################################################################### - - CLASS_PAGE = <<-EOF - <div id="classHeader"> - <table class="header-table"> - <tr class="top-aligned-row"> - <td><strong><%= values["classmod"] %></strong></td> - <td class="class-name-in-header"><%= values["full_name"] %></td> - </tr> - <tr class="top-aligned-row"> - <td><strong>In:</strong></td> - <td> -<% values["infiles"].each do |infiles| %> -<% if infiles["full_path_url"] then %> - <a href="<%= infiles["full_path_url"] %>"> -<% end %> - <%= infiles["full_path"] %> -<% if infiles["full_path_url"] then %> - </a> -<% end %> -<% if infiles["cvsurl"] then %> - (<a href="<%= infiles["cvsurl"] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>) -<% end %> - <br /> -<% end %><%# values["infiles"] %> - </td> - </tr> - -<% if values["parent"] then %> - <tr class="top-aligned-row"> - <td><strong>Parent:</strong></td> - <td> -<% if values["par_url"] then %> - <a href="<%= values["par_url"] %>"> -<% end %> - <%= values["parent"] %> -<% if values["par_url"] then %> - </a> -<% end %> - </td> - </tr> -<% end %> - </table> - </div> - EOF - -##################################################################### -### M E T H O D L I S T T E M P L A T E -##################################################################### - - METHOD_LIST = <<-EOF - <div id="contextContent"> -<% if values["diagram"] then %> - <div id="diagram"> - <%= values["diagram"] %> - </div> -<% end - - if values["description"] then %> - <div id="description"> - <%= values["description"] %> - </div> -<% end - - if values["requires"] then %> - <div id="requires-list"> - <h3 class="section-bar">Required files</h3> - - <div class="name-list"> -<% values["requires"].each do |requires| %> - <%= href requires["aref"], requires["name"] %> -<% end %><%# values["requires"] %> - </div> - </div> -<% end - - if values["toc"] then %> - <div id="contents-list"> - <h3 class="section-bar">Contents</h3> - <ul> -<% values["toc"].each do |toc| %> - <li><a href="#<%= toc["href"] %>"><%= toc["secname"] %></a></li> -<% end %><%# values["toc"] %> - </ul> -<% end %> - </div> - -<% if values["methods"] then %> - <div id="method-list"> - <h3 class="section-bar">Methods</h3> - - <div class="name-list"> -<% values["methods"].each do |methods| %> - <%= href methods["aref"], methods["name"] %> -<% end %><%# values["methods"] %> - </div> - </div> -<% end %> - </div> - - <!-- if includes --> -<% if values["includes"] then %> - <div id="includes"> - <h3 class="section-bar">Included Modules</h3> - - <div id="includes-list"> -<% values["includes"].each do |includes| %> - <span class="include-name"><%= href includes["aref"], includes["name"] %></span> -<% end %><%# values["includes"] %> - </div> - </div> -<% end - - values["sections"].each do |sections| %> - <div id="section"> -<% if sections["sectitle"] then %> - <h2 class="section-title"><a name="<%= sections["secsequence"] %>"><%= sections["sectitle"] %></a></h2> -<% if sections["seccomment"] then %> - <div class="section-comment"> - <%= sections["seccomment"] %> - </div> -<% end - end - - if sections["classlist"] then %> - <div id="class-list"> - <h3 class="section-bar">Classes and Modules</h3> - - <%= sections["classlist"] %> - </div> -<% end - - if sections["constants"] then %> - <div id="constants-list"> - <h3 class="section-bar">Constants</h3> - - <div class="name-list"> - <table summary="Constants"> -<% sections["constants"].each do |constants| %> - <tr class="top-aligned-row context-row"> - <td class="context-item-name"><%= constants["name"] %></td> - <td>=</td> - <td class="context-item-value"><%= constants["value"] %></td> -<% if constants["desc"] then %> - <td> </td> - <td class="context-item-desc"><%= constants["desc"] %></td> -<% end %> - </tr> -<% end %><%# sections["constants"] %> - </table> - </div> - </div> -<% end - - if sections["aliases"] then %> - <div id="aliases-list"> - <h3 class="section-bar">External Aliases</h3> - - <div class="name-list"> - <table summary="aliases"> -<% sections["aliases"].each do |aliases| %> - <tr class="top-aligned-row context-row"> - <td class="context-item-name"><%= aliases["old_name"] %></td> - <td>-></td> - <td class="context-item-value"><%= aliases["new_name"] %></td> - </tr> -<% if aliases["desc"] then %> - <tr class="top-aligned-row context-row"> - <td> </td> - <td colspan="2" class="context-item-desc"><%= aliases["desc"] %></td> - </tr> -<% end - end %><%# sections["aliases"] %> - </table> - </div> - </div> -<% end %> - -<% if sections["attributes"] then %> - <div id="attribute-list"> - <h3 class="section-bar">Attributes</h3> - - <div class="name-list"> - <table> -<% sections["attributes"].each do |attribute| %> - <tr class="top-aligned-row context-row"> - <td class="context-item-name"><%= attribute["name"] %></td> -<% if attribute["rw"] then %> - <td class="context-item-value"> [<%= attribute["rw"] %>] </td> -<% end - unless attribute["rw"] then %> - <td class="context-item-value"> </td> -<% end %> - <td class="context-item-desc"><%= attribute["a_desc"] %></td> - </tr> -<% end %><%# sections["attributes"] %> - </table> - </div> - </div> -<% end %> - - <!-- if method_list --> -<% if sections["method_list"] then %> - <div id="methods"> -<% sections["method_list"].each do |method_list| - if method_list["methods"] then %> - <h3 class="section-bar"><%= method_list["type"] %> <%= method_list["category"] %> methods</h3> - -<% method_list["methods"].each do |methods| %> - <div id="method-<%= methods["aref"] %>" class="method-detail"> - <a name="<%= methods["aref"] %>"></a> - - <div class="method-heading"> -<% if methods["codeurl"] then %> - <a href="<%= methods["codeurl"] %>" target="Code" class="method-signature" - onclick="popupCode('<%= methods["codeurl"] %>');return false;"> -<% end - if methods["sourcecode"] then %> - <a href="#<%= methods["aref"] %>" class="method-signature"> -<% end - if methods["callseq"] then %> - <span class="method-name"><%= methods["callseq"] %></span> -<% end - unless methods["callseq"] then %> - <span class="method-name"><%= methods["name"] %></span><span class="method-args"><%= methods["params"] %></span> -<% end - if methods["codeurl"] then %> - </a> -<% end - if methods["sourcecode"] then %> - </a> -<% end %> - </div> - - <div class="method-description"> -<% if methods["m_desc"] then %> - <%= methods["m_desc"] %> -<% end - if methods["sourcecode"] then %> - <p><a class="source-toggle" href="#" - onclick="toggleCode('<%= methods["aref"] %>-source');return false;">[Source]</a></p> - <div class="method-source-code" id="<%= methods["aref"] %>-source"> -<pre> -<%= methods["sourcecode"] %> -</pre> - </div> -<% end %> - </div> - </div> - -<% end %><%# method_list["methods"] %><% - end - end %><%# sections["method_list"] %> - - </div> -<% end %> -<% end %><%# values["sections"] %> - EOF - -##################################################################### -### B O D Y T E M P L A T E -##################################################################### - - BODY = HEADER + %{ - -<%= template_include %> <!-- banner header --> - - <div id="bodyContent"> - -} + METHOD_LIST + %{ - - </div> - -} + FOOTER - -##################################################################### -### S O U R C E C O D E T E M P L A T E -##################################################################### - - SRC_PAGE = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + <<-EOF -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> - <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" /> -</head> -<body class="standalone-code"> - <pre><%= values["code"] %></pre> -</body> -</html> - EOF - - -##################################################################### -### I N D E X F I L E T E M P L A T E S -##################################################################### - - FR_INDEX_BODY = %{<%= template_include %>} - - FILE_INDEX = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + <<-EOF -<!-- - - <%= values["title"] %> - - --> -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> - <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" /> - <base target="docwin" /> -</head> -<body> -<div class="index"> - <h1 class="section-bar"><%= values["list_title"] %></h1> - <div id="index-entries"> -<% values["entries"].each do |entries| %> - <a href="<%= entries["href"] %>"><%= entries["name"] %></a><br /> -<% end %><%# values["entries"] %> - </div> -</div> -</body> -</html> - EOF - - CLASS_INDEX = FILE_INDEX - METHOD_INDEX = FILE_INDEX - - INDEX = XHTML_FRAME_PREAMBLE + HTML_ELEMENT + <<-EOF -<!-- - - <%= values["title"] %> - - --> -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> -</head> -<frameset rows="20%, 80%"> - <frameset cols="25%,35%,45%"> - <frame src="fr_file_index.html" title="Files" name="Files" /> - <frame src="fr_class_index.html" name="Classes" /> - <frame src="fr_method_index.html" name="Methods" /> - </frameset> - <frame src="<%= values["initial_page"] %>" name="docwin" /> -</frameset> -</html> - EOF - -end - diff --git a/lib/rdoc/generator/html/kilmer.rb b/lib/rdoc/generator/html/kilmer.rb deleted file mode 100644 index 233a9259a2..0000000000 --- a/lib/rdoc/generator/html/kilmer.rb +++ /dev/null @@ -1,151 +0,0 @@ -require 'rdoc/generator/html' -require 'rdoc/generator/html/kilmerfactory' - -module RDoc::Generator::HTML::KILMER - - FONTS = "Verdana, Arial, Helvetica, sans-serif" - - CENTRAL_STYLE = <<-EOF -body,td,p { font-family: <%= values["fonts"] %>; - color: #000040; -} - -.attr-rw { font-size: xx-small; color: #444488 } - -.title-row { background-color: #CCCCFF; - color: #000010; -} - -.big-title-font { - color: black; - font-weight: bold; - font-family: <%= values["fonts"] %>; - font-size: large; - height: 60px; - padding: 10px 3px 10px 3px; -} - -.small-title-font { color: black; - font-family: <%= values["fonts"] %>; - font-size:10; } - -.aqua { color: black } - -#diagram img { - border: 0; -} - -.method-name, .attr-name { - font-family: font-family: <%= values["fonts"] %>; - font-weight: bold; - font-size: small; - margin-left: 20px; - color: #000033; -} - -.tablesubtitle, .tablesubsubtitle { - width: 100%; - margin-top: 1ex; - margin-bottom: .5ex; - padding: 5px 0px 5px 3px; - font-size: large; - color: black; - background-color: #CCCCFF; - border: thin; -} - -.name-list { - margin-left: 5px; - margin-bottom: 2ex; - line-height: 105%; -} - -.description { - margin-left: 5px; - margin-bottom: 2ex; - line-height: 105%; - font-size: small; -} - -.methodtitle { - font-size: small; - font-weight: bold; - text-decoration: none; - color: #000033; - background: #ccc; -} - -.srclink { - font-size: small; - font-weight: bold; - text-decoration: none; - color: #0000DD; - background-color: white; -} - -.srcbut { float: right } - -.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 } - EOF - - INDEX_STYLE = <<-EOF -body { - background-color: #ddddff; - font-family: #{FONTS}; - font-size: 11px; - font-style: normal; - line-height: 14px; - color: #000040; -} - -div.banner { - background: #0000aa; - 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) - - 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 diff --git a/lib/rdoc/generator/html/kilmerfactory.rb b/lib/rdoc/generator/html/kilmerfactory.rb deleted file mode 100644 index 1407840839..0000000000 --- a/lib/rdoc/generator/html/kilmerfactory.rb +++ /dev/null @@ -1,427 +0,0 @@ -require 'rdoc/generator/html' -require 'rdoc/generator/html/common' - -# -# This class generates Kilmer-style templates. Right now, -# rdoc is shipped with two such templates: -# * kilmer -# * hefss -# -# Kilmer-style templates use frames. The left side of the page has -# three frames stacked on top of each other: one lists -# files, one lists classes, and one lists methods. If source code -# is not inlined, an additional frame runs across the bottom of -# the page and will be used to display method source code. -# The central (and largest frame) display class and file -# pages. -# -# The constructor of this class accepts a Hash containing stylistic -# attributes. Then, a get_BLAH instance method of this class returns a -# value for the template's BLAH constant. get_BODY, for instance, returns -# the value of the template's BODY constant. -# -class RDoc::Generator::HTML::KilmerFactory - - include RDoc::Generator::HTML::Common - - # - # The contents of the stylesheet that should be used for the - # central frame (for the class and file pages). - # - # This must be specified in the Hash passed to the constructor. - # - attr_reader :central_css - - # - # The contents of the stylesheet that should be used for the - # index pages. - # - # This must be specified in the Hash passed to the constructor. - # - attr_reader :index_css - - # - # The heading that should be displayed before listing methods. - # - # If not supplied, this defaults to "Methods". - # - attr_reader :method_list_heading - - # - # The heading that should be displayed before listing classes and - # modules. - # - # If not supplied, this defaults to "Classes and Modules". - # - attr_reader :class_and_module_list_heading - - # - # The heading that should be displayed before listing attributes. - # - # If not supplied, this defaults to "Attributes". - # - attr_reader :attribute_list_heading - - # - # ====Description: - # This method constructs a KilmerFactory instance, which - # can be used to build Kilmer-style template classes. - # The +style_attributes+ argument is a Hash that contains the - # values of the classes attributes (Symbols mapped to Strings). - # - # ====Parameters: - # [style_attributes] - # A Hash describing the appearance of the Kilmer-style. - # - def initialize(style_attributes) - @central_css = style_attributes[:central_css] - if(!@central_css) - raise ArgumentError, "did not specify a value for :central_css" - end - - @index_css = style_attributes[:index_css] - if(!@index_css) - raise ArgumentError, "did not specify a value for :index_css" - end - - @method_list_heading = style_attributes[:method_list_heading] - if(!@method_list_heading) - @method_list_heading = "Methods" - end - - @class_and_module_list_heading = style_attributes[:class_and_module_list_heading] - if(!@class_and_module_list_heading) - @class_and_module_list_heading = "Classes and Modules" - end - - @attribute_list_heading = style_attributes[:attribute_list_heading] - if(!@attribute_list_heading) - @attribute_list_heading = "Attributes" - end - end - - def get_STYLE - return @central_css - end - - def get_METHOD_LIST - return %{ -<% if values["diagram"] then %> -<div id="diagram"> -<table width="100%"><tr><td align="center"> -<%= values["diagram"] %> -</td></tr></table> -</div> -<% end %> - -<% if values["description"] then %> -<div class="description"><%= values["description"] %></div> -<% end %> - -<% if values["requires"] then %> -<table cellpadding="5" width="100%"> -<tr><td class="tablesubtitle">Required files</td></tr> -</table><br /> -<div class="name-list"> -<% values["requires"].each do |requires| %> -<%= href requires["aref"], requires["name"] %> -<% end %><%# values["requires"] %> -</div> -<% end %> - -<% if values["methods"] then %> -<table cellpadding="5" width="100%"> -<tr><td class="tablesubtitle">#{@method_list_heading}</td></tr> -</table><br /> -<div class="name-list"> -<% values["methods"].each do |methods| %> -<%= href methods["aref"], methods["name"] %>, -<% end %><%# values["methods"] %> -</div> -<% end %> - -<% if values["includes"] then %> -<div class="tablesubsubtitle">Included modules</div><br /> -<div class="name-list"> -<% values["includes"].each do |includes| %> - <span class="method-name"><%= href includes["aref"], includes["name"] %></span> -<% end %><%# values["includes"] %> -</div> -<% end %> - -<% values["sections"].each do |sections| %> - <div id="section"> -<% if sections["sectitle"] then %> - <h2 class="section-title"><a name="<%= sections["secsequence"] %>"><%= sections["sectitle"] %></a></h2> -<% if sections["seccomment"] then %> - <div class="section-comment"> - <%= sections["seccomment"] %> - </div> -<% end %> -<% end %> -<% if sections["attributes"] then %> -<table cellpadding="5" width="100%"> -<tr><td class="tablesubtitle">#{@attribute_list_heading}</td></tr> -</table><br /> -<table cellspacing="5"> -<% sections["attributes"].each do |attributes| %> - <tr valign="top"> -<% if attributes["rw"] then %> - <td align="center" class="attr-rw"> [<%= attributes["rw"] %>] </td> -<% end %> -<% unless attributes["rw"] then %> - <td></td> -<% end %> - <td class="attr-name"><%= attributes["name"] %></td> - <td><%= attributes["a_desc"] %></td> - </tr> -<% end %><%# sections["attributes"] %> -</table> -<% end %> - -<% if sections["classlist"] then %> -<table cellpadding="5" width="100%"> -<tr><td class="tablesubtitle">#{@class_and_module_list_heading}</td></tr> -</table><br /> -<%= sections["classlist"] %><br /> -<% end %> - -<% if sections["method_list"] then %> -<% sections["method_list"].each do |method_list| %> -<% if method_list["methods"] then %> -<table cellpadding="5" width="100%"> -<tr><td class="tablesubtitle"><%= method_list["type"] %> <%= method_list["category"] %> methods</td></tr> -</table> -<% method_list["methods"].each do |methods| %> -<table width="100%" cellspacing="0" cellpadding="5" border="0"> -<tr><td class="methodtitle"> -<a name="<%= methods["aref"] %>"> -<% if methods["callseq"] then %> -<b><%= methods["callseq"] %></b> -<% end %> -<% unless methods["callseq"] then %> - <b><%= methods["name"] %></b><%= methods["params"] %> -<% end %> -</a> -<% if methods["codeurl"] then %> -<a href="<%= methods["codeurl"] %>" target="source" class="srclink">src</a> -<% end %> -</td></tr> -</table> -<% if methods["m_desc"] then %> -<div class="description"> -<%= methods["m_desc"] %> -</div> -<% end %> -<% if methods["aka"] then %> -<div class="aka"> -This method is also aliased as -<% methods["aka"].each do |aka| %> -<a href="<%= methods["aref"] %>"><%= methods["name"] %></a> -<% end %><%# methods["aka"] %> -</div> -<% end %> -<% if methods["sourcecode"] then %> -<pre class="source"> -<%= methods["sourcecode"] %> -</pre> -<% end %> -<% end %><%# method_list["methods"] %> -<% end %> -<% end %><%# sections["method_list"] %> -<% end %> - -<% end %><%# values["sections"] %> -</div> -} - end - - def get_BODY - return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{ -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> - <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" /> - <script type="text/javascript"> - <!-- - function popCode(url) { - parent.frames.source.location = url - } - //--> - </script> -</head> -<body> -<div class="bodyContent"> -<%= template_include %> <!-- banner header --> - -#{get_METHOD_LIST()} -</div> -</body> -</html> -} - end - -def get_FILE_PAGE - return %{ -<table width="100%"> - <tr class="title-row"> - <td><table width="100%"><tr> - <td class="big-title-font" colspan="2">File<br /><%= values["short_name"] %></td> - <td align="right"><table cellspacing="0" cellpadding="2"> - <tr> - <td class="small-title-font">Path:</td> - <td class="small-title-font"><%= values["full_path"] %> -<% if values["cvsurl"] then %> - (<a href="<%= values["cvsurl"] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>) -<% end %> - </td> - </tr> - <tr> - <td class="small-title-font">Modified:</td> - <td class="small-title-font"><%= values["dtm_modified"] %></td> - </tr> - </table> - </td></tr></table></td> - </tr> -</table><br /> -} -end - -def get_CLASS_PAGE - return %{ -<table width="100%" border="0" cellspacing="0"> - <tr class="title-row"> - <td class="big-title-font"> - <%= values["classmod"] %><br /><%= values["full_name"] %> - </td> - <td align="right"> - <table cellspacing="0" cellpadding="2"> - <tr valign="top"> - <td class="small-title-font">In:</td> - <td class="small-title-font"> -<% values["infiles"].each do |infiles| %> -<%= href infiles["full_path_url"], infiles["full_path"] %> -<% if infiles["cvsurl"] then %> - (<a href="<%= infiles["cvsurl"] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>) -<% end %> -<% end %><%# values["infiles"] %> - </td> - </tr> -<% if values["parent"] then %> - <tr> - <td class="small-title-font">Parent:</td> - <td class="small-title-font"> -<% if values["par_url"] then %> - <a href="<%= values["par_url"] %>" class="cyan"> -<% end %> -<%= values["parent"] %> -<% if values["par_url"] then %> - </a> -<% end %> - </td> - </tr> -<% end %> - </table> - </td> - </tr> -</table><br /> -} -end - -def get_SRC_PAGE - return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{ -<head><title><%= values["title"] %></title> -<meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> -<link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" /> -</head> -<body> -<pre><%= values["code"] %></pre> -</body> -</html> -} -end - -def get_FR_INDEX_BODY - return %{<%= template_include %>} -end - -def get_FILE_INDEX - return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{ -<head> -<title><%= values["title"] %></title> -<meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> -<style type="text/css"> -<!-- -#{@index_css} ---> -</style> -<base target="docwin" /> -</head> -<body> -<div class="index"> -<div class="banner"><%= values["list_title"] %></div> -<% values["entries"].each do |entries| %> -<a href="<%= entries["href"] %>"><%= entries["name"] %></a><br /> -<% end %><%# values["entries"] %> -</div> -</body></html> -} -end - -def get_CLASS_INDEX - return get_FILE_INDEX -end - -def get_METHOD_INDEX - return get_FILE_INDEX -end - -def get_INDEX - return XHTML_FRAME_PREAMBLE + HTML_ELEMENT + %{ -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> -</head> - -<frameset cols="20%,*"> - <frameset rows="15%,35%,50%"> - <frame src="fr_file_index.html" title="Files" name="Files" /> - <frame src="fr_class_index.html" name="Classes" /> - <frame src="fr_method_index.html" name="Methods" /> - </frameset> -<% if values["inline_source"] then %> - <frame src="<%= values["initial_page"] %>" name="docwin" /> -<% end %> -<% unless values["inline_source"] then %> - <frameset rows="80%,20%"> - <frame src="<%= values["initial_page"] %>" name="docwin" /> - <frame src="blank.html" name="source" /> - </frameset> -<% end %> -</frameset> - -</html> -} -end - -def get_BLANK - # This will be displayed in the source code frame before - # any source code has been selected. - return XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{ -<head> - <title>Source Code Frame <%= values["title_suffix"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> - <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" /> -</head> -<body> -</body> -</html> -} -end - -def write_extra_pages(values) - template = RDoc::TemplatePage.new(get_BLANK()) - File.open("blank.html", "w") { |f| template.write_html_on(f, values) } -end - -end diff --git a/lib/rdoc/generator/html/one_page_html.rb b/lib/rdoc/generator/html/one_page_html.rb deleted file mode 100644 index 5bae2f34f7..0000000000 --- a/lib/rdoc/generator/html/one_page_html.rb +++ /dev/null @@ -1,122 +0,0 @@ -require 'rdoc/generator/html' -require 'rdoc/generator/html/common' - -module RDoc::Generator::HTML::ONE_PAGE_HTML - - include RDoc::Generator::HTML::Common - - CONTENTS_XML = <<-EOF -<% if defined? classes and classes["description"] then %> -<%= classes["description"] %> -<% end %> - -<% if defined? files and files["requires"] then %> -<h4>Requires:</h4> -<ul> -<% files["requires"].each do |requires| %> -<% if requires["aref"] then %> -<li><a href="<%= requires["aref"] %>"><%= requires["name"] %></a></li> -<% end %> -<% unless requires["aref"] then %> -<li><%= requires["name"] %></li> -<% end %> -<% end %><%# files["requires"] %> -</ul> -<% end %> - -<% if defined? classes and classes["includes"] then %> -<h4>Includes</h4> -<ul> -<% classes["includes"].each do |includes| %> -<% if includes["aref"] then %> -<li><a href="<%= includes["aref"] %>"><%= includes["name"] %></a></li> -<% end %> -<% unless includes["aref"] then %> -<li><%= includes["name"] %></li> -<% end %> -<% end %><%# classes["includes"] %> -</ul> -<% end %> - -<% if defined? classes and classes["sections"] then %> -<% classes["sections"].each do |sections| %> -<% if sections["attributes"] then %> -<h4>Attributes</h4> -<table> -<% sections["attributes"].each do |attributes| %> -<tr><td><%= attributes["name"] %></td><td><%= attributes["rw"] %></td><td><%= attributes["a_desc"] %></td></tr> -<% end %><%# sections["attributes"] %> -</table> -<% end %> - -<% if sections["method_list"] then %> -<h3>Methods</h3> -<% sections["method_list"].each do |method_list| %> -<% if method_list["methods"] then %> -<% method_list["methods"].each do |methods| %> -<h4><%= methods["type"] %> <%= methods["category"] %> method: -<% if methods["callseq"] then %> -<a name="<%= methods["aref"] %>"><%= methods["callseq"] %></a> -<% end %> -<% unless methods["callseq"] then %> -<a name="<%= methods["aref"] %>"><%= methods["name"] %><%= methods["params"] %></a></h4> -<% end %> - -<% if methods["m_desc"] then %> -<%= methods["m_desc"] %> -<% end %> - -<% if methods["sourcecode"] then %> -<blockquote><pre> -<%= methods["sourcecode"] %> -</pre></blockquote> -<% end %> -<% end %><%# method_list["methods"] %> -<% end %> -<% end %><%# sections["method_list"] %> -<% end %> -<% end %><%# classes["sections"] %> -<% end %> - EOF - - ONE_PAGE = XHTML_STRICT_PREAMBLE + HTML_ELEMENT + %{ -<head> - <title><%= values["title"] %></title> - <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" /> -</head> -<body> -<% values["files"].each do |files| %> -<h2>File: <a name="<%= files["href"] %>"><%= files["short_name"] %></a></h2> -<table> - <tr><td>Path:</td><td><%= files["full_path"] %></td></tr> - <tr><td>Modified:</td><td><%= files["dtm_modified"] %></td></tr> -</table> -} + CONTENTS_XML + %{ -<% end %><%# values["files"] %> - -<% if values["classes"] then %> -<h2>Classes</h2> -<% values["classes"].each do |classes| %> -<% if classes["parent"] then %> -<h3><%= classes["classmod"] %> <a name="<%= classes["href"] %>"><%= classes["full_name"] %></a> < <%= href classes["par_url"], classes["parent"] %></h3> -<% end %> -<% unless classes["parent"] then %> -<h3><%= classes["classmod"] %> <%= classes["full_name"] %></h3> -<% end %> - -<% if classes["infiles"] then %> -(in files -<% classes["infiles"].each do |infiles| %> -<%= href infiles["full_path_url"], infiles["full_path"] %> -<% end %><%# classes["infiles"] %> -) -<% end %> -} + CONTENTS_XML + %{ -<% end %><%# values["classes"] %> -<% end %> -</body> -</html> -} - -end - |