EnsEMBL::Web::Tools::DocumentView

Methods

DESTROY
Desctructor.
View source
EnsEMBL::Web::Tools::DocumentView::DESTROY


_html_path_from_package
Returns an export location from a package name
View source
EnsEMBL::Web::Tools::DocumentView::_html_path_from_package


base_url
Accessor.
View source
EnsEMBL::Web::Tools::DocumentView::base_url


copy_support_files
Copies support files (stylesheets etc) to the export location (set by support.
View source
EnsEMBL::Web::Tools::DocumentView::copy_support_files


element_count_from_package
Returns the number of elements in a package name.
View source
EnsEMBL::Web::Tools::DocumentView::element_count_from_package


html_footer
Returns a simple HTML footer
View source
EnsEMBL::Web::Tools::DocumentView::html_footer


html_header
($package, $class) Returns an HTML header. When supplied, $package is used to determine relative links and $class determins the class of the HTML body.
View source
EnsEMBL::Web::Tools::DocumentView::html_header


include_javascript
Returns HTML to include a javascript file.
View source
EnsEMBL::Web::Tools::DocumentView::include_javascript


include_stylesheet
Returns the HTML to include a CSS stylesheet.
View source
EnsEMBL::Web::Tools::DocumentView::include_stylesheet


link_for_method
Returns the HTML formatted link to a method page in a module page.
View source
EnsEMBL::Web::Tools::DocumentView::link_for_method


link_for_package
Returns the HTML location of a package, excluding <A HREF> markup.
View source
EnsEMBL::Web::Tools::DocumentView::link_for_package


location
Accessor.
View source
EnsEMBL::Web::Tools::DocumentView::location


markup_documentation
Marks up documentation text for links and embedded tables. See also markup_links and markup_embedded_table.
View source
EnsEMBL::Web::Tools::DocumentView::markup_documentation


markup_embedded_table
Marks up key value pairs when embedded in documentation. An embedded table should be delineated with a starting and ending triple underscore.
View source
EnsEMBL::Web::Tools::DocumentView::markup_embedded_table


markup_links
Parses documentation for special e! doc markup. Links to other modules and methods can be included between double braces. For example: { { EnsEMBL::Web::Tools::Document::Module::new } } is parsed to EnsEMBL::Web::Tools::Document::Module::new. Simple method and module names can also be used. markup_links does not perform any error checking on the names of modules and methods.
View source
EnsEMBL::Web::Tools::DocumentView::markup_links


markup_method_table
Returns tabulated documentation.
View source
EnsEMBL::Web::Tools::DocumentView::markup_method_table


methods_html
Returns a formatted list of method names and documentation.
View source
EnsEMBL::Web::Tools::DocumentView::methods_html


new
Constructor. Inside-out class for writing documentation HTML.
View source
EnsEMBL::Web::Tools::DocumentView::new


package_prefix
package name.Returns the relative path prefix for a particular
View source
EnsEMBL::Web::Tools::DocumentView::package_prefix


path_from_package
Returns file system path to package
View source
EnsEMBL::Web::Tools::DocumentView::path_from_package


server_root
Accessor.
View source
EnsEMBL::Web::Tools::DocumentView::server_root


source_code_link
Returns a link to the AJAX source code view
View source
EnsEMBL::Web::Tools::DocumentView::source_code_link


support
Accessor.
View source
EnsEMBL::Web::Tools::DocumentView::support


toc_html
Returns the table of contents for the module methods.
View source
EnsEMBL::Web::Tools::DocumentView::toc_html


write_base_frame
Writes the home page for the e! doc.
View source
EnsEMBL::Web::Tools::DocumentView::write_base_frame


write_frameset
Writes the frameset for the e! doc collection.
View source
EnsEMBL::Web::Tools::DocumentView::write_frameset


write_hierarchy
Returns a formatted list of inheritance and subclass information for a given module.
View source
EnsEMBL::Web::Tools::DocumentView::write_hierarchy


write_info_page
Writes information page for the documentation.
View source
EnsEMBL::Web::Tools::DocumentView::write_info_page


write_method_frame
Writes a complete list of methods from all modules to an HTML file.
View source
EnsEMBL::Web::Tools::DocumentView::write_method_frame


write_module_page
Writes the complete HTML documentation page for a module.
View source
EnsEMBL::Web::Tools::DocumentView::write_module_page


write_module_pages
Writes module documentation page for every found module.
View source
EnsEMBL::Web::Tools::DocumentView::write_module_pages


write_package_frame
Writes the HTML package listing.
View source
EnsEMBL::Web::Tools::DocumentView::write_package_frame