--- !ruby/object:RI::ClassDescription attributes: [] class_methods: [] comment: - !ruby/struct:SM::Flow::P body: This is how you define the HTML that RDoc generates. Simply create a file in rdoc/generators/html_templates that creates the module RDoc::Page and populate it as described below. Then invoke rdoc using the --template <name of your file> option, and your template will be used. - !ruby/struct:SM::Flow::P body: "The constants defining pages use a simple templating system:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "*" body: The templating system is passed a hash. Keys in the hash correspond to tags on this page. The tag %abc% is looked up in the hash, and is replaced by the corresponding hash value. - !ruby/struct:SM::Flow::LI label: "*" body: Some tags are optional. You can detect this using IF/ENDIF - !ruby/struct:SM::Flow::VERB body: " IF: title\n The value of title is %title%\n ENDIF: title\n" - !ruby/struct:SM::Flow::LI label: "*" body: "Some entries in the hash have values that are arrays, where each entry in the array is itself a hash. These are used to generate lists using the START: construct. For example, given a hash containing" - !ruby/struct:SM::Flow::VERB body: " { 'people' => [ { 'name' => 'Fred', 'age' => '12' },\n { 'name' => 'Mary', 'age' => '21' } ]\n" - !ruby/struct:SM::Flow::P body: You could generate a simple table using - !ruby/struct:SM::Flow::VERB body: " <table>\n START:people\n <tr><td>%name%<td>%age%</tr>\n END:people\n </table>\n" - !ruby/struct:SM::Flow::P body: These lists can be nested to an arbitrary depth - !ruby/struct:SM::Flow::LI label: "*" body: "the construct HREF:url:name: generates <a href="%url%">%name%</a> if url is defined in the hash, or %name% otherwise." type: :BULLET - !ruby/struct:SM::Flow::P body: Your file must contain the following constants - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "*FONTS*" body: a list of fonts to be used - !ruby/struct:SM::Flow::LI label: "*STYLE*" body: a CSS section (without the <style> or comments). This is used to generate a style.css file - !ruby/struct:SM::Flow::LI label: "*BODY*" body: "The main body of all non-index RDoc pages. BODY will contain two !INCLUDE!s. The first is used to include a document-type specific header (FILE_PAGE or CLASS_PAGE). The second include is for the method list (METHOD_LIST). THe body is passed:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%title%:" body: the page's title - !ruby/struct:SM::Flow::LI label: "%style_url%:" body: the url of a style sheet for this page - !ruby/struct:SM::Flow::LI label: "%diagram%:" body: the optional URL of a diagram for this page - !ruby/struct:SM::Flow::LI label: "%description%:" body: a (potentially multi-paragraph) string containing the description for th file/class/module. - !ruby/struct:SM::Flow::LI label: "%requires%:" body: an optional list of %aref%/%name% pairs, one for each module required by this file. - !ruby/struct:SM::Flow::LI label: "%methods%:" body: an optional list of %aref%/%name%, one for each method documented on this page. This is intended to be an index. - !ruby/struct:SM::Flow::LI label: "%attributes%:" body: "An optional list. For each attribute it contains:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%name%:" body: the attribute name - !ruby/struct:SM::Flow::LI label: "%rw%:" body: r/o, w/o, or r/w - !ruby/struct:SM::Flow::LI label: "%a_desc%:" body: description of the attribute type: :NOTE - !ruby/struct:SM::Flow::LI label: "%classlist%:" body: An optional string containing an already-formatted list of classes and modules documented in this file type: :NOTE - !ruby/struct:SM::Flow::P body: For FILE_PAGE entries, the body will be passed - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%short_name%:" body: The name of the file - !ruby/struct:SM::Flow::LI label: "%full_path%:" body: The full path to the file - !ruby/struct:SM::Flow::LI label: "%dtm_modified%:" body: The date/time the file was last changed type: :NOTE - !ruby/struct:SM::Flow::P body: For class and module pages, the body will be passed - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%classmod%:" body: The name of the class or module - !ruby/struct:SM::Flow::LI label: "%files%:" body: "A list. For each file this class is defined in, it contains:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%full_path_url%:" body: an (optional) URL of the RDoc page for this file - !ruby/struct:SM::Flow::LI label: "%full_path%:" body: the name of the file type: :NOTE - !ruby/struct:SM::Flow::LI label: "%par_url%:" body: The (optional) URL of the RDoc page documenting this class's parent class - !ruby/struct:SM::Flow::LI label: "%parent%:" body: The name of this class's parent. type: :NOTE - !ruby/struct:SM::Flow::P body: "For both files and classes, the body is passed the following information on includes and methods:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%includes%:" body: Optional list of included modules. For each, it receives - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%aref%:" body: optional URL to RDoc page for the module - !ruby/struct:SM::Flow::LI label: "%name%:" body: the name of the module type: :NOTE - !ruby/struct:SM::Flow::LI label: "%method_list%:" body: Optional list of methods of a particular class and category. type: :NOTE - !ruby/struct:SM::Flow::P body: "Each method list entry contains:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%type%:" body: public/private/protected - !ruby/struct:SM::Flow::LI label: "%category%:" body: instance/class - !ruby/struct:SM::Flow::LI label: "%methods%:" body: a list of method descriptions type: :NOTE - !ruby/struct:SM::Flow::P body: "Each method description contains:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%aref%:" body: a target aref, used when referencing this method description. You should code this as <a name="%aref%"> - !ruby/struct:SM::Flow::LI label: "%codeurl%:" body: the optional URL to the page containing this method's source code. - !ruby/struct:SM::Flow::LI label: "%name%:" body: the method's name - !ruby/struct:SM::Flow::LI label: "%params%:" body: the method's parameters - !ruby/struct:SM::Flow::LI label: "%callseq%:" body: a full calling sequence - !ruby/struct:SM::Flow::LI label: "%m_desc%:" body: the (potentially multi-paragraph) description of this method. type: :NOTE - !ruby/struct:SM::Flow::LI label: "*CLASS_PAGE*" body: Header for pages documenting classes and modules. See BODY above for the available parameters. - !ruby/struct:SM::Flow::LI label: "*FILE_PAGE*" body: Header for pages documenting files. See BODY above for the available parameters. - !ruby/struct:SM::Flow::LI label: "*METHOD_LIST*" body: Controls the display of the listing of methods. See BODY for parameters. - !ruby/struct:SM::Flow::LI label: "*INDEX*" body: The top-level index page. For a browser-like environment define a frame set that includes the file, class, and method indices. Passed - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%title%:" body: title of page - !ruby/struct:SM::Flow::LI label: "%initial_page% :" body: url of initial page to display type: :NOTE - !ruby/struct:SM::Flow::LI label: "*CLASS_INDEX*" body: "Individual files for the three indexes. Passed:" - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%index_url%:" body: URL of main index page - !ruby/struct:SM::Flow::LI label: "%entries%:" body: List of - !ruby/object:SM::Flow::LIST contents: - !ruby/struct:SM::Flow::LI label: "%name%:" body: name of an index entry - !ruby/struct:SM::Flow::LI label: "%href%:" body: url of corresponding page type: :NOTE type: :NOTE - !ruby/struct:SM::Flow::LI label: "*METHOD_INDEX*" body: Same as CLASS_INDEX for methods - !ruby/struct:SM::Flow::LI label: "*FILE_INDEX*" body: Same as CLASS_INDEX for methods - !ruby/struct:SM::Flow::LI label: "*FR_INDEX_BODY*" body: A wrapper around CLASS_INDEX, METHOD_INDEX, and FILE_INDEX. If those index strings contain the complete HTML for the output, then FR_INDEX_BODY can simply be !INCLUDE! - !ruby/struct:SM::Flow::LI label: "*SRC_PAGE*" body: Page used to display source code. Passed %title% and %code%, the latter being a multi-line string of code. type: :LABELED constants: - !ruby/object:RI::Constant comment: name: HPP_FILE value: "%{ [OPTIONS] Auto Index = Yes Compatibility=1.1 or later Compiled file=%opname%.chm Contents file=contents.hhc Full-text search=Yes Index file=index.hhk Language=0x409 English(United States) Title=%title% [FILES] START:all_html_files %html_file_name% END:all_html_files }" - !ruby/object:RI::Constant comment: name: CONTENTS value: "%{ }" - !ruby/object:RI::Constant comment: name: CHM_INDEX value: "%{ }" - !ruby/object:RI::Constant comment: name: CONTENTS_RDF value: "%{ IF:description %description% ENDIF:description IF:requires START:requires END:requires ENDIF:requires IF:attributes START:attributes IF:rw %rw% ENDIF:rw %a_desc% END:attributes ENDIF:attributes IF:includes START:includes END:includes ENDIF:includes IF:method_list START:method_list IF:methods START:methods %params% IF:m_desc %m_desc% ENDIF:m_desc IF:sourcecode %sourcecode% ENDIF:sourcecode END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: [] name: ONE_PAGE value: "%{ START:files %full_path% %dtm_modified% } + CONTENTS_RDF + %{ END:files START:classes <%classmod% rd:name=\"%full_name%\" rd:id=\"%full_name%\"> IF:infiles START:infiles END:infiles ENDIF:infiles IF:parent HREF:par_url:parent: ENDIF:parent } + CONTENTS_RDF + %{ END:classes }" - !ruby/object:RI::Constant comment: name: CONTENTS_XML value: "%{ IF:description %description% ENDIF:description IF:requires START:requires END:requires ENDIF:requires IF:attributes START:attributes IF:rw %rw% ENDIF:rw %a_desc% END:attributes ENDIF:attributes IF:includes START:includes END:includes ENDIF:includes IF:method_list START:method_list IF:methods START:methods %params% IF:m_desc %m_desc% ENDIF:m_desc IF:sourcecode %sourcecode% ENDIF:sourcecode END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: [] name: ONE_PAGE value: "%{ START:files %full_path% %dtm_modified% } + CONTENTS_XML + %{ END:files START:classes <%classmod% name=\"%full_name%\" id=\"%full_name%\"> IF:infiles START:infiles HREF:full_path_url:full_path: END:infiles ENDIF:infiles IF:parent HREF:par_url:parent: ENDIF:parent } + CONTENTS_XML + %{ END:classes }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: The following is used for the -1 option name: CONTENTS_XML value: "%{ IF:description %description% ENDIF:description IF:requires

Requires:

ENDIF:requires IF:attributes

Attributes

START:attributes END:attributes
%name%%rw%%a_desc%
ENDIF:attributes IF:includes

Includes

ENDIF:includes IF:method_list

Methods

START:method_list IF:methods START:methods

%type% %category% method: IF:callseq %callseq% ENDIF:callseq IFNOT:callseq %name%%params%

ENDIF:callseq IF:m_desc %m_desc% ENDIF:m_desc IF:sourcecode
 %sourcecode% 
ENDIF:sourcecode END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: [] name: ONE_PAGE value: "%{ %title% START:files

File: %short_name%

Path:%full_path%
Modified:%dtm_modified%
} + CONTENTS_XML + %{ END:files IF:classes

Classes

START:classes IF:parent

%classmod% %full_name% < HREF:par_url:parent:

ENDIF:parent IFNOT:parent

%classmod% %full_name%

ENDIF:parent IF:infiles (in files START:infiles HREF:full_path_url:full_path: END:infiles ) ENDIF:infiles } + CONTENTS_XML + %{ END:classes ENDIF:classes }" - !ruby/object:RI::Constant comment: name: FONTS value: "\"Verdana, Arial, Helvetica, sans-serif\"" - !ruby/object:RI::Constant comment: name: STYLE value: "%{ body,td,p { font-family: %fonts%; color: #000040; } .attr-rw { font-size: x-small; color: #444488 } .title-row { background: #0000aa; color: #eeeeff; } .big-title-font { color: white; font-family: %fonts%; font-size: large; height: 50px} .small-title-font { color: aqua; font-family: %fonts%; font-size: xx-small; } .aqua { color: aqua } .method-name, attr-name { font-family: monospace; font-weight: bold; } .tablesubtitle, .tablesubsubtitle { width: 100%; margin-top: 1ex; margin-bottom: .5ex; padding: 5px 0px 5px 20px; font-size: large; color: aqua; background: #3333cc; } .name-list { font-family: monospace; margin-left: 40px; margin-bottom: 2ex; line-height: 140%; } .description { margin-left: 40px; margin-top: -2ex; margin-bottom: 2ex; } .description p { line-height: 140%; } .aka { margin-left: 40px; margin-bottom: 2ex; line-height: 100%; font-size: small; color: #808080; } .methodtitle { font-size: medium; text-decoration: none; color: #0000AA; background: white; } .paramsig { font-size: small; } .srcbut { float: right } pre { font-size: 1.2em; } tt { font-size: 1.2em; } pre.source { border-style: groove; background-color: #ddddff; margin-left: 40px; padding: 1em 0em 1em 2em; } .classlist { margin-left: 40px; margin-bottom: 2ex; line-height: 140%; } li { display: list-item; margin-top: .6em; } .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 } }" - !ruby/object:RI::Constant comment: [] name: HEADER value: "%{ %title% }" - !ruby/object:RI::Constant comment: [] name: METHOD_LIST value: "%{ IF:includes
Included modules
START:includes HREF:aref:name: END:includes
ENDIF:includes IF:method_list START:method_list IF:methods
%type% %category% methods
START:methods
IF:codeurl ENDIF:codeurl IF:callseq %callseq% ENDIF:callseq IFNOT:callseq %name%%params% ENDIF:callseq IF:codeurl ENDIF:codeurl
IF:m_desc
%m_desc%
ENDIF:m_desc IF:aka
This method is also aliased as START:aka %name% END:aka
ENDIF:aka IF:sourcecode
 %sourcecode% 
ENDIF:sourcecode END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: [] name: CONTEXT_CONTENT value: "%{ IF:diagram
%diagram%
ENDIF:diagram IF:description
%description%
ENDIF:description IF:requires
Required files
START:requires HREF:aref:name:    END:requires
ENDIF:requires IF:methods
Methods
START:methods HREF:aref:name:    END:methods
ENDIF:methods IF:constants
Constants
START:constants IF:desc ENDIF:desc END:constants
%name%=%value%
%desc%
ENDIF:constants IF:aliases
External Aliases
START:aliases %old_name% -> %new_name%
END:aliases
ENDIF:aliases IF:attributes
Attributes
START:attributes IF:rw ENDIF:rw IFNOT:rw ENDIF:rw END:attributes
%name% [%rw%] %a_desc%
ENDIF:attributes IF:classlist
Classes and Modules
%classlist%
ENDIF:classlist }" - !ruby/object:RI::Constant comment: [] name: BODY value: HEADER + %{ !INCLUDE! } + CONTEXT_CONTENT + METHOD_LIST + %{ } - !ruby/object:RI::Constant comment: [] name: FILE_PAGE value: <<_FILE_PAGE_
%short_name%
Path: %full_path% IF:cvsurl  (CVS) ENDIF:cvsurl
Modified: %dtm_modified%
_FILE_PAGE_ - !ruby/object:RI::Constant comment: [] name: CLASS_PAGE value: "%{
%classmod% %full_name% IF:parent ENDIF:parent
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
}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: "Source code ##########################" name: SRC_PAGE value: "%{ %title%
%code%
}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: "Index ################################" name: FR_INDEX_BODY value: "%{ !INCLUDE! }" - !ruby/object:RI::Constant comment: name: FILE_INDEX value: "%{ %list_title%
%list_title%
START:entries %name%
END:entries }" - !ruby/object:RI::Constant comment: name: CLASS_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: METHOD_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: INDEX value: "%{ %title% <body bgcolor=\"white\"> Sorry, RDoc currently only generates HTML using frames. </body> }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: The following is used for the -1 option name: CONTENTS_XML value: "%{ IF:description %description% ENDIF:description IF:requires

Requires:

ENDIF:requires IF:attributes

Attributes

START:attributes END:attributes
%name%%rw%%a_desc%
ENDIF:attributes IF:includes

Includes

ENDIF:includes IF:method_list

Methods

START:method_list IF:methods START:methods

%type% %category% method: %name%%params%

IF:m_desc %m_desc% ENDIF:m_desc IF:sourcecode
 %sourcecode% 
ENDIF:sourcecode END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: name: FONTS value: "\"Verdana,Arial,Helvetica,sans-serif\"" - !ruby/object:RI::Constant comment: name: STYLE value: "%{ 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; } .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; } }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: H E A D E R T E M P L A T E name: XHTML_PREAMBLE value: "%{ }" - !ruby/object:RI::Constant comment: name: HEADER value: "XHTML_PREAMBLE + %{ %title% }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: C O N T E X T C O N T E N T T E M P L A T E name: CONTEXT_CONTENT value: "%{ }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: F O O T E R T E M P L A T E name: FOOTER value: "%{

[Validate]

}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: F I L E P A G E H E A D E R T E M P L A T E name: FILE_PAGE value: "%{

%short_name%

Path: %full_path% IF:cvsurl  (CVS) ENDIF:cvsurl
Last Update: %dtm_modified%
}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: C L A S S P A G E H E A D E R T E M P L A T E name: CLASS_PAGE value: "%{
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
}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: M E T H O D L I S T T E M P L A T E name: METHOD_LIST value: "%{
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

Methods

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

Included Modules

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

%sectitle%

IF:seccomment
%seccomment%
ENDIF:seccomment ENDIF:sectitle IF:classlist

Classes and Modules

%classlist%
ENDIF:classlist IF:constants

Constants

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

%type% %category% methods

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 END:sections }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: B O D Y T E M P L A T E name: BODY value: HEADER + %{ !INCLUDE!
} + METHOD_LIST + %{
} + FOOTER - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: S O U R C E C O D E T E M P L A T E name: SRC_PAGE value: XHTML_PREAMBLE + %{ %title%
%code%
} - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: I N D E X F I L E T E M P L A T E S name: FR_INDEX_BODY value: "%{ !INCLUDE! }" - !ruby/object:RI::Constant comment: name: FILE_INDEX value: XHTML_PREAMBLE + %{ %list_title%

%list_title%

START:entries %name%
END:entries
} - !ruby/object:RI::Constant comment: name: CLASS_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: METHOD_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: INDEX value: "%{ %title% }" - !ruby/object:RI::Constant comment: name: FONTS value: "\"Verdana, Arial, Helvetica, sans-serif\"" - !ruby/object:RI::Constant comment: name: STYLE value: "%{ 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 } }" - !ruby/object:RI::Constant comment: [] name: BODY value: "%{ %title% !INCLUDE! IF:diagram
%diagram%
ENDIF:diagram IF:description
%description%
ENDIF:description IF:requires
Required files

START:requires HREF:aref:name: END:requires ENDIF:requires
IF:methods
Subroutines and Functions

START:methods HREF:aref:name:, END:methods
ENDIF:methods IF:attributes
Arguments

START:attributes IF:rw ENDIF:rw IFNOT:rw ENDIF:rw END:attributes
 [%rw%] %name% %a_desc%
ENDIF:attributes IF:classlist
Modules

%classlist%
ENDIF:classlist !INCLUDE! }" - !ruby/object:RI::Constant comment: [] name: FILE_PAGE value: <<_FILE_PAGE_
File
%short_name%
Path: %full_path% IF:cvsurl  (CVS) ENDIF:cvsurl
Modified: %dtm_modified%

_FILE_PAGE_ - !ruby/object:RI::Constant comment: [] name: CLASS_PAGE value: "%{
%classmod%
%full_name%
IF:parent ENDIF:parent
In: START:infiles HREF:full_path_url:full_path: IF:cvsurl  (CVS) ENDIF:cvsurl END:infiles
Parent: IF:par_url ENDIF:par_url %parent% IF:par_url ENDIF:par_url

}" - !ruby/object:RI::Constant comment: [] name: METHOD_LIST value: "%{ IF:includes
Uses

START:includes HREF:aref:name: END:includes
ENDIF:includes IF:method_list START:method_list IF:methods
%type% %category% methods
START:methods
%name%%params% IF:codeurl src ENDIF:codeurl
IF:m_desc
%m_desc%
ENDIF:m_desc END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: "Source code ##########################" name: SRC_PAGE value: "%{ %title%
%code%
}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: "Index ################################" name: FR_INDEX_BODY value: "%{ !INCLUDE! }" - !ruby/object:RI::Constant comment: name: FILE_INDEX value: "%{
%list_title%
START:entries %name%
END:entries }" - !ruby/object:RI::Constant comment: name: CLASS_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: METHOD_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: INDEX value: "%{ %title% <body bgcolor=\"#BBBBBB\"> Click <a href=\"html/index.html\">here</a> for a non-frames version of this page. </body> }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: and a blank page to use as a target name: BLANK value: "%{ }" - !ruby/object:RI::Constant comment: name: FONTS value: "\"Verdana, Arial, Helvetica, sans-serif\"" - !ruby/object:RI::Constant comment: name: STYLE value: "%{ body,td,p { font-family: %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: %fonts%; font-size: large; height: 60px; padding: 10px 3px 10px 3px; } .small-title-font { color: black; font-family: %fonts%; font-size:10; } .aqua { color: black } .method-name, .attr-name { font-family: font-family: %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-color: white; } .srclink { font-size: small; font-weight: bold; text-decoration: none; color: #0000DD; background-color: white; } .paramsig { font-size: small; } .srcbut { float: right } }" - !ruby/object:RI::Constant comment: [] name: BODY value: "%{ %title% !INCLUDE! IF:diagram
%diagram%
ENDIF:diagram IF:description
%description%
ENDIF:description IF:requires
Required files

START:requires HREF:aref:name: END:requires ENDIF:requires
IF:methods
Methods

START:methods HREF:aref:name:, END:methods
ENDIF:methods START:sections
IF:sectitle

%sectitle%

IF:seccomment
%seccomment%
ENDIF:seccomment ENDIF:sectitle IF:attributes
Attributes

START:attributes IF:rw ENDIF:rw IFNOT:rw ENDIF:rw END:attributes
 [%rw%] %name% %a_desc%
ENDIF:attributes IF:classlist
Classes and Modules

%classlist%
ENDIF:classlist !INCLUDE! END:sections }" - !ruby/object:RI::Constant comment: [] name: FILE_PAGE value: <<_FILE_PAGE_
File
%short_name%
Path: %full_path% IF:cvsurl  (CVS) ENDIF:cvsurl
Modified: %dtm_modified%

_FILE_PAGE_ - !ruby/object:RI::Constant comment: [] name: CLASS_PAGE value: "%{
%classmod%
%full_name%
IF:parent ENDIF:parent
In: START:infiles HREF:full_path_url:full_path: IF:cvsurl  (CVS) ENDIF:cvsurl END:infiles
Parent: IF:par_url ENDIF:par_url %parent% IF:par_url ENDIF:par_url

}" - !ruby/object:RI::Constant comment: [] name: METHOD_LIST value: "%{ IF:includes
Included modules

START:includes HREF:aref:name: END:includes
ENDIF:includes IF:method_list START:method_list IF:methods
%type% %category% methods
START:methods
IF:callseq %callseq% ENDIF:callseq IFNOT:callseq %name%%params% ENDIF:callseq IF:codeurl src ENDIF:codeurl
IF:m_desc
%m_desc%
ENDIF:m_desc IF:aka
This method is also aliased as START:aka %name% END:aka
ENDIF:aka IF:sourcecode
 %sourcecode% 
ENDIF:sourcecode END:methods ENDIF:methods END:method_list ENDIF:method_list }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: "Source code ##########################" name: SRC_PAGE value: "%{ %title%
%code%
}" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: "Index ################################" name: FR_INDEX_BODY value: "%{ !INCLUDE! }" - !ruby/object:RI::Constant comment: name: FILE_INDEX value: "%{
%list_title%
START:entries %name%
END:entries }" - !ruby/object:RI::Constant comment: name: CLASS_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: METHOD_INDEX value: FILE_INDEX - !ruby/object:RI::Constant comment: name: INDEX value: "%{ %title% IF:inline_source ENDIF:inline_source IFNOT:inline_source ENDIF:inline_source <body bgcolor=\"white\"> Click <a href=\"html/index.html\">here</a> for a non-frames version of this page. </body> }" - !ruby/object:RI::Constant comment: - !ruby/struct:SM::Flow::P body: and a blank page to use as a target name: BLANK value: "%{ }" full_name: RDoc::Page includes: [] instance_methods: - !ruby/object:RI::MethodSummary name: write_extra_pages - !ruby/object:RI::MethodSummary name: write_extra_pages name: Page superclass: