lib/rdoc/generator/html/html.rb

   1 require 'rdoc/generator/html'
   2 require 'rdoc/generator/html/one_page_html'
   3
   4 ##
   5 # = CSS2 RDoc HTML template
   6 #
   7 # This is a template for RDoc that uses XHTML 1.0 Transitional and dictates a
   8 # bit more of the appearance of the output to cascading stylesheets than the
   9 # default. It was designed for clean inline code display, and uses DHTMl to
  10 # toggle the visibility of each method's source with each click on the
  11 # '[source]' link.
  12 #
  13 # == Authors
  14 #
  15 # * Michael Granger <ged@FaerieMUD.org>
  16 #
  17 # Copyright (c) 2002, 2003 The FaerieMUD Consortium. Some rights reserved.
  18 #
  19 # This work is licensed under the Creative Commons Attribution License. To
  20 # view a copy of this license, visit
  21 # http://creativecommons.org/licenses/by/1.0/ or send a letter to Creative
  22 # Commons, 559 Nathan Abbott Way, Stanford, California 94305, USA.
  23
  24 module RDoc::Generator::HTML::HTML
  25
  26   FONTS = "Verdana,Arial,Helvetica,sans-serif"
  27
  28   STYLE = <<-EOF
  29 body {
  30     font-family: Verdana,Arial,Helvetica,sans-serif;
  31     font-size:   90%;
  32     margin: 0;
  33     margin-left: 40px;
  34     padding: 0;
  35     background: white;
  36 }
  37
  38 h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
  39 h1 { font-size: 150%; }
  40 h2,h3,h4 { margin-top: 1em; }
  41
  42 a { background: #eef; color: #039; text-decoration: none; }
  43 a:hover { background: #039; color: #eef; }
  44
  45 /* Override the base stylesheet's Anchor inside a table cell */
  46 td > a {
  47   background: transparent;
  48   color: #039;
  49   text-decoration: none;
  50 }
  51
  52 /* and inside a section title */
  53 .section-title > a {
  54   background: transparent;
  55   color: #eee;
  56   text-decoration: none;
  57 }
  58
  59 /* === Structural elements =================================== */
  60
  61 div#index {
  62     margin: 0;
  63     margin-left: -40px;
  64     padding: 0;
  65     font-size: 90%;
  66 }
  67
  68
  69 div#index a {
  70     margin-left: 0.7em;
  71 }
  72
  73 div#index .section-bar {
  74    margin-left: 0px;
  75    padding-left: 0.7em;
  76    background: #ccc;
  77    font-size: small;
  78 }
  79
  80
  81 div#classHeader, div#fileHeader {
  82     width: auto;
  83     color: white;
  84     padding: 0.5em 1.5em 0.5em 1.5em;
  85     margin: 0;
  86     margin-left: -40px;
  87     border-bottom: 3px solid #006;
  88 }
  89
  90 div#classHeader a, div#fileHeader a {
  91     background: inherit;
  92     color: white;
  93 }
  94
  95 div#classHeader td, div#fileHeader td {
  96     background: inherit;
  97     color: white;
  98 }
  99
 100
 101 div#fileHeader {
 102     background: #057;
 103 }
 104
 105 div#classHeader {
 106     background: #048;
 107 }
 108
 109
 110 .class-name-in-header {
 111   font-size:  180%;
 112   font-weight: bold;
 113 }
 114
 115
 116 div#bodyContent {
 117     padding: 0 1.5em 0 1.5em;
 118 }
 119
 120 div#description {
 121     padding: 0.5em 1.5em;
 122     background: #efefef;
 123     border: 1px dotted #999;
 124 }
 125
 126 div#description h1,h2,h3,h4,h5,h6 {
 127     color: #125;;
 128     background: transparent;
 129 }
 130
 131 div#validator-badges {
 132     text-align: center;
 133 }
 134 div#validator-badges img { border: 0; }
 135
 136 div#copyright {
 137     color: #333;
 138     background: #efefef;
 139     font: 0.75em sans-serif;
 140     margin-top: 5em;
 141     margin-bottom: 0;
 142     padding: 0.5em 2em;
 143 }
 144
 145
 146 /* === Classes =================================== */
 147
 148 table.header-table {
 149     color: white;
 150     font-size: small;
 151 }
 152
 153 .type-note {
 154     font-size: small;
 155     color: #DEDEDE;
 156 }
 157
 158 .xxsection-bar {
 159     background: #eee;
 160     color: #333;
 161     padding: 3px;
 162 }
 163
 164 .section-bar {
 165    color: #333;
 166    border-bottom: 1px solid #999;
 167     margin-left: -20px;
 168 }
 169
 170
 171 .section-title {
 172     background: #79a;
 173     color: #eee;
 174     padding: 3px;
 175     margin-top: 2em;
 176     margin-left: -30px;
 177     border: 1px solid #999;
 178 }
 179
 180 .top-aligned-row {  vertical-align: top }
 181 .bottom-aligned-row { vertical-align: bottom }
 182
 183 /* --- Context section classes ----------------------- */
 184
 185 .context-row { }
 186 .context-item-name { font-family: monospace; font-weight: bold; color: black; }
 187 .context-item-value { font-size: small; color: #448; }
 188 .context-item-desc { color: #333; padding-left: 2em; }
 189
 190 /* --- Method classes -------------------------- */
 191 .method-detail {
 192     background: #efefef;
 193     padding: 0;
 194     margin-top: 0.5em;
 195     margin-bottom: 1em;
 196     border: 1px dotted #ccc;
 197 }
 198 .method-heading {
 199   color: black;
 200   background: #ccc;
 201   border-bottom: 1px solid #666;
 202   padding: 0.2em 0.5em 0 0.5em;
 203 }
 204 .method-signature { color: black; background: inherit; }
 205 .method-name { font-weight: bold; }
 206 .method-args { font-style: italic; }
 207 .method-description { padding: 0 0.5em 0 0.5em; }
 208
 209 /* --- Source code sections -------------------- */
 210
 211 a.source-toggle { font-size: 90%; }
 212 div.method-source-code {
 213     background: #262626;
 214     color: #ffdead;
 215     margin: 1em;
 216     padding: 0.5em;
 217     border: 1px dashed #999;
 218     overflow: hidden;
 219 }
 220
 221 div.method-source-code pre { color: #ffdead; overflow: hidden; }
 222
 223 /* --- Ruby keyword styles --------------------- */
 224
 225 .standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
 226
 227 .ruby-constant  { color: #7fffd4; background: transparent; }
 228 .ruby-keyword { color: #00ffff; background: transparent; }
 229 .ruby-ivar    { color: #eedd82; background: transparent; }
 230 .ruby-operator  { color: #00ffee; background: transparent; }
 231 .ruby-identifier { color: #ffdead; background: transparent; }
 232 .ruby-node    { color: #ffa07a; background: transparent; }
 233 .ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
 234 .ruby-regexp  { color: #ffa07a; background: transparent; }
 235 .ruby-value   { color: #7fffd4; background: transparent; }
 236 EOF
 237
 238
 239 #####################################################################
 240 ### H E A D E R   T E M P L A T E
 241 #####################################################################
 242
 243   XHTML_PREAMBLE = <<-EOF
 244 <?xml version="1.0" encoding="<%= values["charset"] %>"?>
 245 <!DOCTYPE html
 246      PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 247      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 248   EOF
 249
 250   HEADER = XHTML_PREAMBLE + <<-EOF
 251 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 252 <head>
 253   <title><%= values["title"] %></title>
 254   <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" />
 255   <meta http-equiv="Content-Script-Type" content="text/javascript" />
 256   <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" />
 257   <script type="text/javascript">
 258   // <![CDATA[
 259
 260   function popupCode( url ) {
 261     window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
 262   }
 263
 264   function toggleCode( id ) {
 265     if ( document.getElementById )
 266       elem = document.getElementById( id );
 267     else if ( document.all )
 268       elem = eval( "document.all." + id );
 269     else
 270       return false;
 271
 272     elemStyle = elem.style;
 273
 274     if ( elemStyle.display != "block" ) {
 275       elemStyle.display = "block"
 276     } else {
 277       elemStyle.display = "none"
 278     }
 279
 280     return true;
 281   }
 282
 283   // Make codeblocks hidden by default
 284   document.writeln( "<style type=\\"text/css\\">div.method-source-code { display: none }</style>" )
 285
 286   // ]]>
 287   </script>
 288
 289 </head>
 290 <body>
 291 EOF
 292
 293 #####################################################################
 294 ### C O N T E X T   C O N T E N T   T E M P L A T E
 295 #####################################################################
 296
 297   CONTEXT_CONTENT = %{
 298 }
 299
 300 #####################################################################
 301 ### F O O T E R   T E M P L A T E
 302 #####################################################################
 303
 304   FOOTER = <<-EOF
 305 <div id="validator-badges">
 306   <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 307 </div>
 308
 309 </body>
 310 </html>
 311   EOF
 312
 313
 314 #####################################################################
 315 ### F I L E   P A G E   H E A D E R   T E M P L A T E
 316 #####################################################################
 317
 318   FILE_PAGE = <<-EOF
 319   <div id="fileHeader">
 320     <h1><%= values["short_name"] %></h1>
 321     <table class="header-table">
 322     <tr class="top-aligned-row">
 323       <td><strong>Path:</strong></td>
 324       <td><%= values["full_path"] %>
 325 <% if values["cvsurl"] then %>
 326         &nbsp;(<a href="<%= values["cvsurl"] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
 327 <% end %>
 328       </td>
 329     </tr>
 330     <tr class="top-aligned-row">
 331       <td><strong>Last Update:</strong></td>
 332       <td><%= values["dtm_modified"] %></td>
 333     </tr>
 334     </table>
 335   </div>
 336   EOF
 337
 338 #####################################################################
 339 ### C L A S S   P A G E   H E A D E R   T E M P L A T E
 340 #####################################################################
 341
 342   CLASS_PAGE = <<-EOF
 343     <div id="classHeader">
 344         <table class="header-table">
 345         <tr class="top-aligned-row">
 346           <td><strong><%= values["classmod"] %></strong></td>
 347           <td class="class-name-in-header"><%= values["full_name"] %></td>
 348         </tr>
 349         <tr class="top-aligned-row">
 350             <td><strong>In:</strong></td>
 351             <td>
 352 <% values["infiles"].each do |infiles| %>
 353 <% if infiles["full_path_url"] then %>
 354                 <a href="<%= infiles["full_path_url"] %>">
 355 <% end %>
 356                 <%= infiles["full_path"] %>
 357 <% if infiles["full_path_url"] then %>
 358                 </a>
 359 <% end %>
 360 <% if infiles["cvsurl"] then %>
 361         &nbsp;(<a href="<%= infiles["cvsurl"] %>"><acronym title="Concurrent Versioning System">CVS</acronym></a>)
 362 <% end %>
 363         <br />
 364 <% end %><%# values["infiles"] %>
 365             </td>
 366         </tr>
 367
 368 <% if values["parent"] then %>
 369         <tr class="top-aligned-row">
 370             <td><strong>Parent:</strong></td>
 371             <td>
 372 <% if values["par_url"] then %>
 373                 <a href="<%= values["par_url"] %>">
 374 <% end %>
 375                 <%= values["parent"] %>
 376 <% if values["par_url"] then %>
 377                </a>
 378 <% end %>
 379             </td>
 380         </tr>
 381 <% end %>
 382         </table>
 383     </div>
 384   EOF
 385
 386 #####################################################################
 387 ### M E T H O D   L I S T   T E M P L A T E
 388 #####################################################################
 389
 390   METHOD_LIST = <<-EOF
 391   <div id="contextContent">
 392 <% if values["diagram"] then %>
 393     <div id="diagram">
 394       <%= values["diagram"] %>
 395     </div>
 396 <% end
 397
 398    if values["description"] then %>
 399     <div id="description">
 400       <%= values["description"] %>
 401     </div>
 402 <% end
 403
 404    if values["requires"] then %>
 405     <div id="requires-list">
 406       <h3 class="section-bar">Required files</h3>
 407
 408       <div class="name-list">
 409 <% values["requires"].each do |requires| %>
 410         <%= href requires["aref"], requires["name"] %>&nbsp;&nbsp;
 411 <% end %><%# values["requires"] %>
 412       </div>
 413     </div>
 414 <% end
 415
 416    if values["toc"] then %>
 417     <div id="contents-list">
 418       <h3 class="section-bar">Contents</h3>
 419       <ul>
 420 <% values["toc"].each do |toc| %>
 421       <li><a href="#<%= toc["href"] %>"><%= toc["secname"] %></a></li>
 422 <% end %><%# values["toc"] %>
 423      </ul>
 424 <% end %>
 425    </div>
 426
 427 <% if values["methods"] then %>
 428     <div id="method-list">
 429       <h3 class="section-bar">Methods</h3>
 430
 431       <div class="name-list">
 432 <%   values["methods"].each do |methods| %>
 433         <%= href methods["aref"], methods["name"] %>&nbsp;&nbsp;
 434 <%   end %><%# values["methods"] %>
 435       </div>
 436     </div>
 437 <% end %>
 438   </div>
 439
 440     <!-- if includes -->
 441 <% if values["includes"] then %>
 442     <div id="includes">
 443       <h3 class="section-bar">Included Modules</h3>
 444
 445       <div id="includes-list">
 446 <% values["includes"].each do |includes| %>
 447         <span class="include-name"><%= href includes["aref"], includes["name"] %></span>
 448 <% end %><%# values["includes"] %>
 449       </div>
 450     </div>
 451 <% end
 452
 453    values["sections"].each do |sections| %>
 454     <div id="section">
 455 <%   if sections["sectitle"] then %>
 456       <h2 class="section-title"><a name="<%= sections["secsequence"] %>"><%= sections["sectitle"] %></a></h2>
 457 <%     if sections["seccomment"] then %>
 458       <div class="section-comment">
 459         <%= sections["seccomment"] %>
 460       </div>
 461 <%     end
 462      end
 463
 464      if sections["classlist"] then %>
 465     <div id="class-list">
 466       <h3 class="section-bar">Classes and Modules</h3>
 467
 468       <%= sections["classlist"] %>
 469     </div>
 470 <%   end
 471
 472      if sections["constants"] then %>
 473     <div id="constants-list">
 474       <h3 class="section-bar">Constants</h3>
 475
 476       <div class="name-list">
 477         <table summary="Constants">
 478 <%     sections["constants"].each do |constants| %>
 479         <tr class="top-aligned-row context-row">
 480           <td class="context-item-name"><%= constants["name"] %></td>
 481           <td>=</td>
 482           <td class="context-item-value"><%= constants["value"] %></td>
 483 <%       if sections["desc"] then %>
 484           <td width="3em">&nbsp;</td>
 485           <td class="context-item-desc"><%= constants["desc"] %></td>
 486 <%       end %>
 487         </tr>
 488 <%     end %><%# sections["constants"] %>
 489         </table>
 490       </div>
 491     </div>
 492 <%   end
 493
 494      if sections["aliases"] then %>
 495     <div id="aliases-list">
 496       <h3 class="section-bar">External Aliases</h3>
 497
 498       <div class="name-list">
 499       <table summary="aliases">
 500 <%     sections["aliases"].each do |aliases| %>
 501         <tr class="top-aligned-row context-row">
 502           <td class="context-item-name"><%= aliases["old_name"] %></td>
 503           <td>-&gt;</td>
 504           <td class="context-item-value"><%= aliases["new_name"] %></td>
 505         </tr>
 506 <%       if aliases["desc"] then %>
 507       <tr class="top-aligned-row context-row">
 508         <td>&nbsp;</td>
 509         <td colspan="2" class="context-item-desc"><%= aliases["desc"] %></td>
 510       </tr>
 511 <%       end
 512        end %><%# sections["aliases"] %>
 513         </table>
 514       </div>
 515     </div>
 516 <%   end %>
 517
 518 <%   if sections["attributes"] then %>
 519     <div id="attribute-list">
 520       <h3 class="section-bar">Attributes</h3>
 521
 522       <div class="name-list">
 523         <table>
 524 <%     sections["attributes"].each do |attribute| %>
 525         <tr class="top-aligned-row context-row">
 526           <td class="context-item-name"><%= attribute["name"] %></td>
 527 <%       if attribute["rw"] then %>
 528           <td class="context-item-value">&nbsp;[<%= attribute["rw"] %>]&nbsp;</td>
 529 <%       end
 530          unless attribute["rw"] then %>
 531           <td class="context-item-value">&nbsp;&nbsp;</td>
 532 <%       end %>
 533           <td class="context-item-desc"><%= attribute["a_desc"] %></td>
 534         </tr>
 535 <%     end %><%# sections["attributes"] %>
 536         </table>
 537       </div>
 538     </div>
 539 <%   end %>
 540
 541     <!-- if method_list -->
 542 <%   if sections["method_list"] then %>
 543     <div id="methods">
 544 <%     sections["method_list"].each do |method_list|
 545          if method_list["methods"] then %>
 546       <h3 class="section-bar"><%= method_list["type"] %> <%= method_list["category"] %> methods</h3>
 547
 548 <%         method_list["methods"].each do |methods| %>
 549       <div id="method-<%= methods["aref"] %>" class="method-detail">
 550         <a name="<%= methods["aref"] %>"></a>
 551
 552         <div class="method-heading">
 553 <%           if methods["codeurl"] then %>
 554           <a href="<%= methods["codeurl"] %>" target="Code" class="method-signature"
 555             onclick="popupCode('<%= methods["codeurl"] %>');return false;">
 556 <%           end
 557              if methods["sourcecode"] then %>
 558           <a href="#<%= methods["aref"] %>" class="method-signature">
 559 <%           end
 560              if methods["callseq"] then %>
 561           <span class="method-name"><%= methods["callseq"] %></span>
 562 <%           end
 563              unless methods["callseq"] then %>
 564           <span class="method-name"><%= methods["name"] %></span><span class="method-args"><%= methods["params"] %></span>
 565 <%           end
 566              if methods["codeurl"] then %>
 567           </a>
 568 <%           end
 569              if methods["sourcecode"] then %>
 570           </a>
 571 <%           end %>
 572         </div>
 573
 574         <div class="method-description">
 575 <%           if methods["m_desc"] then %>
 576           <%= methods["m_desc"] %>
 577 <%           end
 578                if methods["sourcecode"] then %>
 579           <p><a class="source-toggle" href="#"
 580             onclick="toggleCode('<%= methods["aref"] %>-source');return false;">[Source]</a></p>
 581           <div class="method-source-code" id="<%= methods["aref"] %>-source">
 582 <pre>
 583 <%= methods["sourcecode"] %>
 584 </pre>
 585           </div>
 586 <%           end %>
 587         </div>
 588       </div>
 589
 590 <%         end %><%# method_list["methods"] %><%
 591          end
 592        end %><%# sections["method_list"] %>
 593
 594     </div>
 595 <%   end %>
 596 <% end %><%# values["sections"] %>
 597   EOF
 598
 599 #####################################################################
 600 ### B O D Y   T E M P L A T E
 601 #####################################################################
 602
 603   BODY = HEADER + %{
 604
 605 <%= template_include %>  <!-- banner header -->
 606
 607   <div id="bodyContent">
 608
 609 } +  METHOD_LIST + %{
 610
 611   </div>
 612
 613 } + FOOTER
 614
 615 #####################################################################
 616 ### S O U R C E   C O D E   T E M P L A T E
 617 #####################################################################
 618
 619   SRC_PAGE = XHTML_PREAMBLE + <<-EOF
 620 <html>
 621 <head>
 622   <title><%= values["title"] %></title>
 623   <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" />
 624   <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" media="screen" />
 625 </head>
 626 <body class="standalone-code">
 627   <pre><%= values["code"] %></pre>
 628 </body>
 629 </html>
 630   EOF
 631
 632
 633 #####################################################################
 634 ### I N D E X   F I L E   T E M P L A T E S
 635 #####################################################################
 636
 637   FR_INDEX_BODY = %{
 638 <%= template_include %>
 639 }
 640
 641   FILE_INDEX = XHTML_PREAMBLE + <<-EOF
 642 <!--
 643
 644     <%= values["list_title"] %>
 645
 646   -->
 647 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 648 <head>
 649   <title><%= values["list_title"] %></title>
 650   <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" />
 651   <link rel="stylesheet" href="<%= values["style_url"] %>" type="text/css" />
 652   <base target="docwin" />
 653 </head>
 654 <body>
 655 <div id="index">
 656   <h1 class="section-bar"><%= values["list_title"] %></h1>
 657   <div id="index-entries">
 658 <% values["entries"].each do |entries| %>
 659     <a href="<%= entries["href"] %>"><%= entries["name"] %></a><br />
 660 <% end %><%#  values["entries"] %>
 661   </div>
 662 </div>
 663 </body>
 664 </html>
 665   EOF
 666
 667   CLASS_INDEX = FILE_INDEX
 668   METHOD_INDEX = FILE_INDEX
 669
 670   INDEX = <<-EOF
 671 <?xml version="1.0" encoding="<%= values["charset"] %>"?>
 672 <!DOCTYPE html
 673      PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
 674      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
 675
 676 <!--
 677
 678     <%= values["title"] %>
 679
 680   -->
 681 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 682 <head>
 683   <title><%= values["title"] %></title>
 684   <meta http-equiv="Content-Type" content="text/html; charset=<%= values["charset"] %>" />
 685 </head>
 686 <frameset rows="20%, 80%">
 687     <frameset cols="25%,35%,45%">
 688         <frame src="fr_file_index.html"   title="Files" name="Files" />
 689         <frame src="fr_class_index.html"  name="Classes" />
 690         <frame src="fr_method_index.html" name="Methods" />
 691     </frameset>
 692     <frame src="<%= values["initial_page"] %>" name="docwin" />
 693 </frameset>
 694 </html>
 695   EOF
 696
 697 end
 698