NAME

text_xml_renderer.pm - a renderer (HTML) for text_xml type MOBY Objects

AUTHOR

Please report all bugs to Mark Wilkinson (markw at illuminae.com)

SYNOPSIS

just put the renderer in your gbrowse.conf/MobyServices folder and it will work.

DESCRIPTION

This renderer returns HTML that fits between the <td> tags in a web-page to display the content of a text_xml (or ontological child of) object.

Without the renderer your browser will ignore the tags which are not part of the HTML specification. In consequence the xml document structure, element names and attributes/values will be invisible in the result output - which is probably not what you would expect...

METHODS

The module has two methods:

type

this returns a scalar indicating the MOBY Object Class that this renderer is designed to handle. Objects of this type, or objects that inherit from this type, will be passed to this renderer.

render

This is called with three pieces of data which may or may not be useful to your script:

1) $data - an XML::LibXML object representing the deserialized MOBY object

2) $htmldir - the full path to the directory serving your html

e.g. /usr/local/apache/htdocs/

(this is the HTDOCS parameter you specified
 when you installed Gbrowse)

3) $imgdir - the additional path information to a writable directory for images

e.g. /gbrowse/tmp

(this is the folder specified in the tmpimages parameter
 in your organism.conf file)

RETURNS

The subroutine should return two pieces of data:

1) An HTML representation of the Object

this will appear between <td></td> tags in the webpage

2) A boolean indicating whether the renderer has parsed all sub-objects, or just the top level object

'1' indicates that the renderer has fully parsed the Object XML
'0' indicates that you need Gbrowse to follow child objects
    and render them independently