diff options
author | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2003-12-01 07:12:49 +0000 |
---|---|---|
committer | dave <dave@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2003-12-01 07:12:49 +0000 |
commit | 87762adcb0d38d6c575448f67c2906964215f3a1 (patch) | |
tree | c74f6e5b2b51f641cdc7895a37eb4c161b2c6d72 /lib/rdoc/generators/template/html/hefss.rb | |
parent | c1c55573bdaecbd972f57b46dd22dfbd0e1a02dd (diff) |
Add RDoc
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@5073 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/generators/template/html/hefss.rb')
-rw-r--r-- | lib/rdoc/generators/template/html/hefss.rb | 418 |
1 files changed, 418 insertions, 0 deletions
diff --git a/lib/rdoc/generators/template/html/hefss.rb b/lib/rdoc/generators/template/html/hefss.rb new file mode 100644 index 0000000000..ff4f557b71 --- /dev/null +++ b/lib/rdoc/generators/template/html/hefss.rb @@ -0,0 +1,418 @@ +module RDoc +module Page + + +FONTS = "Verdana, Arial, Helvetica, sans-serif" + +STYLE = %{ +body,p { font-family: Verdana, Arial, Helvetica, sans-serif; + color: #000040; background: #BBBBBB; +} + +td { font-family: Verdana, Arial, Helvetica, sans-serif; + color: #000040; +} + +.attr-rw { font-size: small; color: #444488 } + +.title-row {color: #eeeeff; + background: #BBBBDD; +} + +.big-title-font { color: white; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: large; + height: 50px} + +.small-title-font { color: purple; + font-family: Verdana, Arial, Helvetica, sans-serif; + font-size: small; } + +.aqua { color: purple } + +.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; +} + +.column-title { + font-size: medium; + font-weight: bold; + text_decoration: none; + padding: 3px 3px 3px 20px; + color: #3333CC; + } + +.variable-name { + font-family: monospace; + font-size: medium; + text_decoration: none; + padding: 3px 3px 3px 20px; + color: #0000AA; +} + +.row-name { + font-size: medium; + font-weight: medium; + font-family: monospace; + text_decoration: none; + padding: 3px 3px 3px 20px; +} + +.paramsig { + font-size: small; +} + +.srcbut { float: right } + +} + + +############################################################################ + + +BODY = %{ +<html><head> + <title>%title%</title> + <meta http-equiv="Content-Type" content="text/html; charset=%charset%"> + <link rel=StyleSheet href="%style_url%" type="text/css" media=screen> + <script type="text/javascript" language="JavaScript"> + <!-- + function popCode(url) { + parent.frames.source.location = url + } + //--> + </script> +</head> +<body bgcolor="#BBBBBB"> + +!INCLUDE! <!-- banner header --> + +IF:diagram +<table width="100%"><tr><td align="center"> +%diagram% +</td></tr></table> +ENDIF:diagram + +IF:description +<div class="description">%description%</div> +ENDIF:description + +IF:requires +<table cellpadding=5 width="100%"> +<tr><td class="tablesubtitle">Required files</td></tr> +</table><br> +<div class="name-list"> +START:requires +HREF:aref:name: +END:requires +ENDIF:requires +</div> + +IF:methods +<table cellpadding=5 width="100%"> +<tr><td class="tablesubtitle">Subroutines and Functions</td></tr> +</table><br> +<div class="name-list"> +START:methods +HREF:aref:name:, +END:methods +</div> +ENDIF:methods + +IF:attributes +<table cellpadding=5 width="100%"> +<tr><td class="tablesubtitle">Arguments</td></tr> +</table><br> +<table cellspacing=5> +START:attributes + <tr valign="top"> +IF:rw + <td align="center" class="attr-rw"> [%rw%] </td> +ENDIF:rw +IFNOT:rw + <td></td> +ENDIF:rw + <td class="attr-name">%name%</td> + <td>%a_desc%</td> + </tr> +END:attributes +</table> +ENDIF:attributes + +IF:classlist +<table cellpadding=5 width="100%"> +<tr><td class="tablesubtitle">Modules</td></tr> +</table><br> +%classlist%<br> +ENDIF:classlist + + !INCLUDE! <!-- method descriptions --> + +</body> +</html> +} + +############################################################################### + +FILE_PAGE = <<_FILE_PAGE_ +<table width="100%"> + <tr class="title-row"> + <td><table width="100%"><tr> + <td class="big-title-font" colspan=2><font size=-3><B>File</B><BR></font>%short_name%</td> + <td align="right"><table cellspacing=0 cellpadding=2> + <tr> + <td class="small-title-font">Path:</td> + <td class="small-title-font">%full_path% +IF:cvsurl + (<a href="%cvsurl%">CVS</a>) +ENDIF:cvsurl + </td> + </tr> + <tr> + <td class="small-title-font">Modified:</td> + <td class="small-title-font">%dtm_modified%</td> + </tr> + </table> + </td></tr></table></td> + </tr> +</table><br> +_FILE_PAGE_ + +################################################################### + +CLASS_PAGE = %{ +<table width="100%" border=0 cellspacing=0> + <tr class="title-row"> + <td class="big-title-font"> + <font size=-3><B>%classmod%</B><BR></font>%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"> +START:infiles +HREF:full_path_url:full_path: +IF:cvsurl + (<a href="%cvsurl%">CVS</a>) +ENDIF:cvsurl +END:infiles + </td> + </tr> +IF:parent + <tr> + <td class="small-title-font">Parent:</td> + <td class="small-title-font"> +IF:par_url + <a href="%par_url%" class="cyan"> +ENDIF:par_url +%parent% +IF:par_url + </a> +ENDIF:par_url + </td> + </tr> +ENDIF:parent + </table> + </td> + </tr> +</table><br> +} + +################################################################### + +METHOD_LIST = %{ +IF:includes +<div class="tablesubsubtitle">Uses</div><br> +<div class="name-list"> +START:includes + <span class="method-name">HREF:aref:name:</span> +END:includes +</div> +ENDIF:includes + +IF:method_list +START:method_list +IF:methods +<table cellpadding=5 width="100%"> +<tr><td class="tablesubtitle">%type% %category% methods</td></tr> +</table> +START:methods +<table width="100%" cellspacing = 0 cellpadding=5 border=0> +<tr><td class="methodtitle"> +<a name="%aref%"> +<b>%name%</b>%params% +IF:codeurl +<a href="%codeurl%" target="source" class="srclink">src</a> +ENDIF:codeurl +</a></td></tr> +</table> +IF:m_desc +<div class="description"> +%m_desc% +</div> +ENDIF:m_desc +END:methods +ENDIF:methods +END:method_list +ENDIF:method_list +} + +=begin +=end + +########################## Source code ########################## + +SRC_PAGE = %{ +<html> +<head><title>%title%</title> +<meta http-equiv="Content-Type" content="text/html; charset=%charset%"> +<style> + .kw { color: #3333FF; font-weight: bold } + .cmt { color: green; font-style: italic } + .str { color: #662222; font-style: italic } + .re { color: #662222; } +.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 } +</style> +</head> +<body bgcolor="#BBBBBB"> +<pre>%code%</pre> +</body> +</html> +} + +########################## Index ################################ + +FR_INDEX_BODY = %{ +!INCLUDE! +} + +FILE_INDEX = %{ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=%charset%"> +<style> +<!-- + 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%; +} + +--> +</style> +<base target="docwin"> +</head> +<body> +<div class="banner">%list_title%</div> +START:entries +<a href="%href%">%name%</a><br> +END:entries +</body></html> +} + +CLASS_INDEX = FILE_INDEX +METHOD_INDEX = FILE_INDEX + +INDEX = %{ +<html> +<head> + <title>%title%</title> + <meta http-equiv="Content-Type" content="text/html; charset=%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="Modules"> + <frame src="fr_method_index.html" name="Subroutines and Functions"> + </frameset> + <frameset rows="80%,20%"> + <frame src="%initial_page%" name="docwin"> + <frame src="blank.html" name="source"> + </frameset> + <noframes> + <body bgcolor="#BBBBBB"> + Click <a href="html/index.html">here</a> for a non-frames + version of this page. + </body> + </noframes> +</frameset> + +</html> +} + +# and a blank page to use as a target +BLANK = %{ +<html><body bgcolor="#BBBBBB"></body></html> +} + +def write_extra_pages + template = TemplatePage.new(BLANK) + File.open("blank.html", "w") { |f| template.write_html_on(f, {}) } +end + +end +end |