File Stats
- Last Modified
- Sun Mar 21 12:08:29 -0400 2010
Class Index
- WebRI
- WebRI::Blackfish
- WebRI::Component
- WebRI::Generator
- WebRI::GeneratorOne
- WebRI::GitHub
- WebRI::Heirarchy
- WebRI::Highlight
- WebRI::Icons
- WebRI::JSONFile
- WebRI::Longfish
- WebRI::Metadata
- WebRI::Newfish
- WebRI::Oldfish
- WebRI::Onefish
- WebRI::Prettify
- WebRI::Redfish
- WebRI::RiService
- WebRI::Search
- WebRI::Search::FilesTree
- WebRI::Server
- WebRI::Subversion
- WebRI::Template
- WebRI::TimeDelta
- WebRI::Twofish
- RDoc
- RDoc::AnyMethod
- RDoc::ClassModule
- RDoc::Options
- RDoc::Parser
- RDoc::Parser::C
- RDoc::TopLevel
- Syckle
- Syckle::Plugins
- Syckle::Plugins::WebRI
- Object
- OpEsc
Method Index
- WebRI::Generator ::components
- WebRI ::entry_to_path
- WebRI::Server ::esc
- OpEsc ::escape
- WebRI::Generator ::for
- WebRI::Generator ::include
- WebRI::Generator ::inherited
- WebRI::Heirarchy ::new
- WebRI::Server ::new
- WebRI::RiService ::new
- WebRI::Generator ::new
- WebRI::GeneratorOne ::new
- WebRI::Template ::new
- WebRI::Component ::new
- WebRI::Generator ::new
- WebRI ::path_to_entry
- OpEsc ::unescape
- WebRI::Heirarchy #[]
- WebRI::Heirarchy #[]=
- WebRI::Search::FilesTree #add
- WebRI::Search #add_class_search_index
- WebRI::Search #add_file_search_index
- WebRI::Search #add_method_search_index
- WebRI::JSONFile #all_methods
- WebRI::GeneratorOne #asset
- WebRI::Server #autolink
- WebRI::Template #class_dir
- WebRI::Generator #class_dir
- WebRI::JSONFile #class_tree
- WebRI::Template #classes
- WebRI::Generator #classes
- WebRI::JSONFile #classes
- WebRI::Generator #classes_hash
- WebRI::Template #classes_hash
- WebRI::Generator #classes_salient
- WebRI::Template #classes_salient
- WebRI::Generator #classes_toplevel
- WebRI::Template #classes_toplevel
- Syckle::Plugins::WebRI #clean
- WebRI::GitHub #commit_sha1
- WebRI::Template #copyright
- WebRI::Generator #copyright
- WebRI::GeneratorOne #css
- WebRI::Server #current_content
- WebRI::GeneratorOne #current_content
- WebRI::Generator #current_content
- WebRI::Generator #debug_msg
- WebRI::Component #debug_msg
- WebRI::Server #directory
- Syckle::Plugins::WebRI #document
- RDoc::ClassModule #document_self_or_methods
- WebRI::Blackfish #each_letter_group
- WebRI::Generator #erb_template
- WebRI::Server #esc
- WebRI::Generator #eval_template
- WebRI::Template #file_dir
- WebRI::Generator #file_dir
- WebRI::Heirarchy #file_name
- WebRI::JSONFile #file_tree
- WebRI::Generator #files
- WebRI::Template #files
- WebRI::JSONFile #files
- WebRI::Generator #files_hash
- WebRI::Template #files_hash
- WebRI::Generator #files_toplevel
- WebRI::Template #files_toplevel
- Object #fileutils
- RDoc::Parser::C #find_class_comment
- RDoc::Parser::C #find_class_comment
- WebRI::Template #find_class_named
- WebRI::Generator #find_class_named
- WebRI::Generator #find_file_named
- WebRI::Template #find_file_named
- WebRI::Generator #find_module_named
- WebRI::Template #find_module_named
- WebRI::Generator #find_type_named
- WebRI::Template #find_type_named
- WebRI::Heirarchy #full_name
- WebRI::Generator #generate
- WebRI::Search #generate
- WebRI::JSONFile #generate
- WebRI::Generator #generate
- WebRI::GeneratorOne #generate
- WebRI::Component #generate
- WebRI::JSONFile #generate_class_tree
- WebRI::JSONFile #generate_class_tree_level
- WebRI::Onefish #generate_classes
- WebRI::Generator #generate_classes
- WebRI::Generator #generate_commons
- WebRI::Generator #generate_components
- WebRI::Search #generate_file_tree
- WebRI::JSONFile #generate_file_tree
- WebRI::JSONFile #generate_file_tree_level
- WebRI::Search #generate_file_tree_level
- WebRI::Generator #generate_files
- WebRI::Onefish #generate_files
- WebRI::Twofish #generate_html_tree
- WebRI::Generator #generate_index
- WebRI::Generator #generate_recurse
- WebRI::GeneratorOne #generate_recurse
- WebRI::Search #generate_search_index
- WebRI::Search #generate_search_tree
- WebRI::Search #generate_search_tree_level
- WebRI::Generator #generate_setup
- WebRI::Component #generate_static
- WebRI::Generator #generate_static
- WebRI::GeneratorOne #generate_support_files
- WebRI::Generator #generate_support_files
- WebRI::Generator #generate_template
- WebRI::Server #generate_tree
- WebRI::Metadata #get_metadata
- WebRI::Subversion #get_svninfo
- WebRI::GitHub #github_url
- WebRI::GitHub #github_url_cache
- WebRI::Blackfish #group_name
- WebRI::Server #heirarchy
- WebRI::Twofish #html_tree
- WebRI::GitHub #in_dir
- WebRI::Template #include_template
- WebRI::Template #include_template
- WebRI::Server #index
- WebRI::Longfish #index_description
- WebRI::Generator #index_file
- WebRI::Longfish #index_title
- WebRI::RiService #info
- WebRI::Generator #initialize_components
- Syckle::Plugins::WebRI #initialize_defaults
- WebRI::GitHub #initialize_methods
- WebRI::Subversion #initialize_methods
- WebRI::Generator #initialize_methods
- WebRI::Component #initialize_methods
- WebRI::Generator #initialize_template
- WebRI::Heirarchy #inspect
- WebRI::GeneratorOne #jquery
- WebRI::Generator #json_creatable?
- WebRI::Heirarchy #key
- WebRI::Server #lookup
- Syckle::Plugins::WebRI #main_document
- WebRI::Metadata #metadata
- WebRI::Template #method_missing
- WebRI::Component #method_missing
- WebRI::Generator #methods_all
- WebRI::Template #methods_all
- WebRI::Template #modules
- WebRI::Generator #modules
- WebRI::Template #modules_hash
- WebRI::Generator #modules_hash
- WebRI::Template #modules_salient
- WebRI::Generator #modules_salient
- WebRI::Template #modules_toplevel
- WebRI::Generator #modules_toplevel
- WebRI::Component #name
- WebRI::RiService #names
- WebRI::RiService #names_from_all
- WebRI::RiService #names_from_library
- WebRI::Template #options
- RDoc::Options #parse
- WebRI::Longfish #parse_index_header
- WebRI::Search #path
- WebRI::Longfish #path
- WebRI::Subversion #path
- WebRI::Generator #path
- WebRI::Generator #path_output_relative
- WebRI::GitHub #path_relative_to_repository
- WebRI::Component #path_static
- WebRI::Generator #path_static
- WebRI::Generator #path_template
- WebRI::GitHub #path_to_git_dir
- WebRI::Generator #provision
- WebRI::Component #provision
- RDoc::Options #rdoc_parse
- Syckle::Plugins::WebRI #rdoc_target
- WebRI::Server #render
- WebRI::Template #render
- WebRI::Generator #render_template
- WebRI::GitHub #repository_url
- Syckle::Plugins::WebRI #reset
- WebRI::RiService #ri_opts
- WebRI::GeneratorOne #rijquery
- WebRI::Heirarchy #root?
- WebRI::JSONFile #save_data
- WebRI::Metadata #scm
- WebRI::Search #search_string
- WebRI::Longfish #site_community
- WebRI::Longfish #site_homepage
- WebRI::Longfish #site_news
- WebRI::Longfish #site_repository
- WebRI::Search #snippet
- WebRI::Generator #sort_salient
- WebRI::Subversion #svninfo
- WebRI::Server #template
- WebRI::TimeDelta #time_delta_string
- WebRI::Server #title
- WebRI::Template #title
- WebRI::Generator #title
- RDoc::TopLevel #to_h
- RDoc::ClassModule #to_h
- RDoc::AnyMethod #to_h
- RDoc::AnyMethod #to_json
- RDoc::ClassModule #to_json
- RDoc::TopLevel #to_json
- WebRI::Server #tree
- WebRI::Template #types
- WebRI::Generator #types
- WebRI::Generator #types_hash
- WebRI::Template #types_hash
- WebRI::Template #types_salient
- WebRI::Generator #types_salient
- WebRI::Generator #types_toplevel
- WebRI::Template #types_toplevel
- RDoc::ClassModule #with_documentation?
- WebRI::GeneratorOne #write
- WebRI::Generator #write
RELEASE HISTORY
1.2 / 2010-03-21
This release adjusts for change in plugin directory name (i.e. plugins/) for the latest version of the plugin gem. This release also adds method quicksearch to the redfish template.
Changes:
- Rename ‘plugin’ directory to ‘plugins’.
- Add quicksearch to redfish template’s method list.
1.1 / 2009-11-16
This release improves the projects underlying design, makes minor improvements to the templates and adds a couple of new components.
Changes:
- Simplifed generator and component layouts.
- Added Icon component to provide a semi-standard set of icons.
- Added Prettify component, which is easier to use than highlight.js.
1.0 / 2009-11-01
This second time I’ve built and RDoc template. If RDoc changes everything again I’m going to be quiet frazzled! ;)
Changes:
- 1 Bigfat Change
* She were created anew!
0.6 / 2009-08-24
Add autolinking feature to generated HTML. The new code uses Regexps to locate class or module names and method names and inserts appropriate hyperlinks for them, allowing one to navigate via the page rather than solely via the class hierarchy tree.
Changes:
- 1 Major Enhancement
* Inserts appropriate hyperlinks in ri generated HTML.
0.5.0 / 2009-08-14
This release fixes WebRI to work with the latest versions of RDoc 2.0+. It will no longer work with the older versions.
Changes:
- 3 Major Enhancements
- Updated to work with RDoc 2.3+. It will not work with older versions.
- Support for —system, —site, —gems and —home flags.
- Methods list are now extracted from ri doc files for speed-up.
0.4.0 / 2009-06-14
This release adds a static website generation feature. Simple specify the —output directory option on the commandline and the WebRI files will be generated to that directory. Ex.
$ cd myproject $ webri --output doc/webri doc/ri
Changes:
- 1 Major Enhancement
- Added static website generation.
0.3.0 / 2009-05-30
This release simply fixes a bug that prevent class methods form appearing the class hierarchy.
Changes:
- 1 Major Bug Fix
- Fixed issue that prevented class methods from showing up.
0.2.0 / 2008-07-06
Changes:
- 2 Major Enhancements
- Shelling out to RI b/c it’s easier than using the RDoc API.
- Not using FastRI b/c no HTML output.
- Initial Release
0.1.0 / 2008-03-28
Changes:
- Happy Birthday!