# # = CSS2 RDoc HTML template # # This is a template for RDoc that uses XHTML 1.0 Transitional 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. # # == Authors # # * Michael Granger # # 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 module Page FONTS = "Verdana,Arial,Helvetica,sans-serif" STYLE = %{ body { font-family: Verdana,Arial,Helvetica,sans-serif; font-size: 90%; margin: 0; margin-left: 40px; padding: 0; background: white; } h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; } h1 { font-size: 150%; } h2,h3,h4 { margin-top: 1em; } a { background: #eef; color: #039; text-decoration: none; } a:hover { background: #039; color: #eef; } /* Override the base stylesheet's Anchor inside a table cell */ td > a { background: transparent; color: #039; text-decoration: none; } /* and inside a section title */ .section-title > a { background: transparent; color: #eee; text-decoration: none; } /* === Structural elements =================================== */ div#index { margin: 0; margin-left: -40px; padding: 0; font-size: 90%; } div#index a { margin-left: 0.7em; } div#index .section-bar { margin-left: 0px; padding-left: 0.7em; background: #ccc; font-size: small; } div#classHeader, div#fileHeader { width: auto; color: white; padding: 0.5em 1.5em 0.5em 1.5em; margin: 0; margin-left: -40px; border-bottom: 3px solid #006; } div#classHeader a, div#fileHeader a { background: inherit; color: white; } div#classHeader td, div#fileHeader td { background: inherit; color: white; } div#fileHeader { background: #057; } div#classHeader { background: #048; } div#nodeHeader { background: #7f7f7f; } .class-name-in-header { font-size: 180%; font-weight: bold; } div#bodyContent { padding: 0 1.5em 0 1.5em; } div#description { padding: 0.5em 1.5em; background: #efefef; border: 1px dotted #999; } div#description h1,h2,h3,h4,h5,h6 { color: #125;; background: transparent; } div#validator-badges { text-align: center; } div#validator-badges img { border: 0; } div#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; } .xxsection-bar { background: #eee; color: #333; padding: 3px; } .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 } /* --- 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 -------------------- */ a.source-toggle { font-size: 90%; } div.method-source-code { background: #262626; color: #ffdead; margin: 1em; padding: 0.5em; border: 1px dashed #999; overflow: hidden; } div.method-source-code pre { color: #ffdead; overflow: hidden; } /* --- Ruby keyword styles --------------------- */ .standalone-code { background: #221111; color: #ffdead; overflow: hidden; } .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; } } ##################################################################### ### H E A D E R T E M P L A T E ##################################################################### XHTML_PREAMBLE = %{ } HEADER = XHTML_PREAMBLE + %{ %title% } ##################################################################### ### C O N T E X T C O N T E N T T E M P L A T E ##################################################################### CONTEXT_CONTENT = %{ } ##################################################################### ### F O O T E R T E M P L A T E ##################################################################### FOOTER = %{

[Validate]

} ##################################################################### ### F I L E P A G E H E A D E R T E M P L A T E ##################################################################### FILE_PAGE = %{

%short_name%

Path: %full_path% IF:cvsurl  (CVS) ENDIF:cvsurl
Last Update: %dtm_modified%
} ##################################################################### ### 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 = %{
IF:parent ENDIF:parent
%classmod% %full_name%
In: START:infiles IF:full_path_url ENDIF:full_path_url %full_path% IF:full_path_url ENDIF:full_path_url IF:cvsurl  (CVS) ENDIF:cvsurl
END:infiles
Parent: IF:par_url ENDIF:par_url %parent% IF:par_url ENDIF:par_url
} NODE_PAGE = %{
IF:parent ENDIF:parent
%classmod% %full_name%
In: START:infiles IF:full_path_url ENDIF:full_path_url %full_path% IF:full_path_url ENDIF:full_path_url IF:cvsurl  (CVS) ENDIF:cvsurl
END:infiles
Parent: IF:par_url ENDIF:par_url %parent% IF:par_url ENDIF:par_url
} PLUGIN_PAGE = %{
%classmod% %full_name%
In: START:infiles IF:full_path_url ENDIF:full_path_url %full_path% IF:full_path_url ENDIF:full_path_url IF:cvsurl  (CVS) ENDIF:cvsurl
END:infiles
} ##################################################################### ### M E T H O D L I S T T E M P L A T E ##################################################################### PLUGIN_LIST = %{
IF:description
%description%
ENDIF:description IF:toc

Contents

ENDIF:toc
IF:confine START:confine

Confine

%type% %value%
END:confine ENDIF:confine IF:type

Type

%type%
ENDIF:type START:sections
IF:sectitle

%sectitle%

IF:seccomment
%seccomment%
ENDIF:seccomment ENDIF:sectitle END:sections } METHOD_LIST = %{
IF:diagram
%diagram%
ENDIF:diagram IF:description
%description%
ENDIF:description IF:requires

Required files

START:requires HREF:aref:name:   END:requires
ENDIF:requires IF:toc

Contents

ENDIF:toc
IF:methods

Defines

START:methods HREF:aref:name:   END:methods
ENDIF:methods IF:resources

Resources

START:resources HREF:aref:name:   END:resources
ENDIF:resources
IF:includes

Included Classes

START:includes HREF:aref:name: END:includes
ENDIF:includes START:sections
IF:sectitle

%sectitle%

IF:seccomment
%seccomment%
ENDIF:seccomment ENDIF:sectitle IF:facts

Custom Facts

START:facts HREF:aref:name:   END:facts
ENDIF:facts IF:plugins

Plugins

START:plugins HREF:aref:name:   END:plugins
ENDIF:plugins IF:nodelist

Nodes

%nodelist%
ENDIF:nodelist IF:classlist

Classes and Modules

%classlist%
ENDIF:classlist IF:constants

Global Variables

START:constants IF:desc ENDIF:desc END:constants
%name% = %value%  %desc%
ENDIF:constants IF:aliases

External Aliases

START:aliases IF:desc ENDIF:desc END:aliases
%old_name% -> %new_name%
  %desc%
ENDIF:aliases IF:attributes

Attributes

START:attributes IF:rw ENDIF:rw IFNOT:rw ENDIF:rw END:attributes
%name% [%rw%]   %a_desc%
ENDIF:attributes IF:method_list
START:method_list IF:methods

Defines

START:methods
IF:m_desc %m_desc% ENDIF:m_desc IF:sourcecode

[Source]

%sourcecode%
ENDIF:sourcecode
END:methods ENDIF:methods END:method_list
ENDIF:method_list IF:resource_list

Resources

START:resource_list
%name%
IF:params START:params    %name% => %value%
END:params ENDIF:params
IF:m_desc %m_desc% ENDIF:m_desc
END:resource_list
ENDIF:resource_list END:sections } ##################################################################### ### B O D Y T E M P L A T E ##################################################################### BODY = HEADER + %{ !INCLUDE!
} + METHOD_LIST + %{
} + FOOTER BODYINC = HEADER + %{ !INCLUDE!
!INCLUDE!
} + FOOTER ##################################################################### ### S O U R C E C O D E T E M P L A T E ##################################################################### SRC_PAGE = XHTML_PREAMBLE + %{ %title%
%code%
} ##################################################################### ### I N D E X F I L E T E M P L A T E S ##################################################################### FR_INDEX_BODY = %{ !INCLUDE! } FILE_INDEX = XHTML_PREAMBLE + %{ %list_title%

%list_title%

START:entries %name%
END:entries
} TOP_INDEX = XHTML_PREAMBLE + %{ %list_title%

%list_title%

START:entries %name%
END:entries
} CLASS_INDEX = FILE_INDEX METHOD_INDEX = FILE_INDEX COMBO_INDEX = XHTML_PREAMBLE + %{ %classes_title% & %defines_title%
All Classes

Module

START:module %name%
END:module
IF:nodes

%nodes_title%

START:nodes %name%
END:nodes
ENDIF:nodes IF:classes

%classes_title%

START:classes %name%
END:classes
ENDIF:classes IF:defines

%defines_title%

START:defines %name%
END:defines
ENDIF:defines IF:facts

%facts_title%

START:facts %name%
END:facts
ENDIF:facts IF:plugins

%plugins_title%

START:plugins %name%
END:plugins
ENDIF:plugins
} INDEX = %{ %title% } end # module Page end # class RDoc require 'rdoc/generators/template/html/one_page_html'