activeRenderer provides its Web services through both REST and XML-RPC APIs.
REST API calls are regular HTTP GET requests.
The activeRenderer REST service answers at http://api.activerenderer.com/activeRenderer/render/
You need to add parameters to the server's URL: http://api.activerenderer.com/activeRenderer/render/?param=value¶m=value...
As you can see, the separator between the URL and the first parameter name is a question mark (?).
Values are assigned to their parameter name by the equal sign (=).
Separators between a value and the next parameter name are ampersands (&).
You can add any number of parameters from the following list, only the first one, src, is mandatory.
Parameters list
Common
src (mandatory)
URL of the RSS or OPML file to render.
Must start with "http://" for online documents,
or "file://" for local ones.
output
Specifies output format.
Defaults to 'html': fully formed HTML page
Use the default format to render 'src' in an IFRAME, a FRAME or a different browser window.
Other values:
text:
HTML rendering of 'src', without the full HTML header/body structure.
Use this output format to retrieve the HTML rendering of 'src' in a string variable when using another programming language, such as Perl, Python or PHP.
js:
Javascript call to the 'display' function, with the HTML rendering of 'src' and optional 'domId' passed as a string parameters.
If domId is not specified, the display function inserts the rendered HTML at the point where the call to activeRenderer was made.
will insert the rendered content of the someOPML document.
uniqId
Stem for all outline node ids generation.
cssClassName
CSS class name stem for rendered outline nodes, defaults to 'active'
cssClassLevel
starting depth for all generated outline nodes, default is 0.
Specific to OPML rendering
link
name of the attribute designating a link attachments to outline nodes.
activeRenderer tries this parameter first, then 'xmlUrl', then 'url'.
opmlCall
name of the Javascript function called to render OPML links transclusion.
defaults to 'transclude'.
rssCall
name of the Javascript function called to render RSS links transclusion.
defaults to 'transclude'.
imgCall
name of the Javascript function called to render picture files (GIF, JPG or PNG) transclusion.
defaults to 'imgLoad'.
mmCall
name of the Javascript function called to render multimedia files (QT and SWF) transclusion.
defaults to 'mmLoad'.
htmlCall
name of the Javascript function called to render HTML links.
defaults to 'pageLoad'.
expandTitle
Tooltip text to appear when placing the mouse cursor over a closed outline wedge.
Defaults to 'expand'.
collapseTitle
Tooltip text to appear when placing the mouse cursor over a collapsed outline wedge.
Defaults to 'collapse'.
textClass
CSS class of the rendered text of each outline node.
Defaults to 'clickable'. You may want to replace the defaults with an empty string: &textClass=
renderUids
When true (&renderUids=yes), outline nodes with a uid attribute are rendered with an HTML anchor before the text content of the node.
The name of the anchor tag is the OPML uid.
renderDescriptions
When true (&renderDescriptions=yes), each outline node with a description attribute in addition to the text attribute is rendered so that the text is inserted into an empty HTML span, with an HTML title attribute set after the OPML description attribute.
As a result, placing the mouse cursor over the rendered outline node displays its description as a floating tooltip label.
Specific to HTML (default) output
template
Specifies the url of an HTML template file to replace the default rendering template.
will insert the rendered content of someOPML inside the "insertHere" div.
XML-RPC transmits XML formatted function calls and returned values through HTTP POST requests.
XML-RPC is great for calling rendering services from other programming languages, provided these languages support XML-RPC natively or through a library.
Here are a few XML-RPC links.
Java
Apache XML-RPC
Marquee XML-RPC
Javascript
XML-RPC Message Builder
vcXMLRPC Library
Mozilla
Perl
RPC::XML
SOAP::Lite
Frontier::RPC
PHP
xmlrpc-epi-php
xmlrpc library
Python
xmlrpclib
py-xmlrpc
Usertalk
Other resources
The activeRenderer XML-RPC service answers at http://rpc.activerenderer.com/, on port 80.
You can call 2 rendering functions. Both functions return a string, including the HTML rendering of the string you've passed as first parameter, but not including the full HTML header/body structure.
activeRenderer.opmlRenderer
Parameters (in sequence):
opml
string, mandatory.
the OPML formatted text you want to render as dynamic HTML.
uniqId
string, empty by default.
optional prefix for all outline node divs id generation.
cssClassName
string, defaults to "active".
CSS class name stem for rendered node divs.
cssClassLevel
integer, defaults to 0.
starting depth for all generated outline nodes.
link
string, defaults to "url"
name of the attribute designating a link attachments to outline nodes.
activeRenderer tries this parameter first, then 'url', then 'xmlUrl'.
opmlCall
string, defaults to "transclude"
name of the Javascript function called to render OPML links transclusion.
imgCall
string, defaults to "imgLoad"
name of the Javascript function called to render picture files (GIF, JPG or PNG) transclusion.
rssCall
string, defaults to "transclude"
name of the Javascript function called to render RSS links transclusion.
mmCall
string, defaults to "mmLoad"
name of the Javascript function called to render multimedia files (QT and SWF) transclusion.
htmlCall
string, defaults to "pageLoad"
name of the Javascript function called to render simple HTML links.
targetFrame
string, empty by defaults, links are opened in the same frame/window as source.
name of the destination frame for rendered HTML links.
flDisplayHTMLWedge
boolean, false by default.
when true, render link type attributes linking to HTML content as 'page' node wedges.
when false, render them as regular HTML links.
flOutliner
boolean, false by default.
when true, adds additional HTML rendering for outliner-type functions support in the browser.
this is only useful if you are trying to create a full web based outliner :-)
flDisplayDirectives
boolean, false by default
when true, render outline nodes starting with # (Frontier directives).
when false, skip nodes with Frontier directives.
flRoll
boolean, false by default
when true, modify HTML rendering to better fit blogrolls (deprecated).
activeRenderer.rssRenderer
Parameters (in sequence):
rss
string, mandatory.
the RSS formatted text you want to render as dynamic HTML.
uniqId
string, empty by default.
optional prefix for all outline node divs id generation.
cssClassName
string, defaults to "active".
CSS class name stem for rendered node divs.
cssClassLevel
integer, defaults to 0.
starting depth for all generated outline nodes.
flIncludeChannelTitle
boolean, false by default.
when true, include the RSS channel's title as first node.
flCollapseChannelTitle
boolean, false by default.
when true and flIncludeChannelTitle is true, render the RSS Channel title node as collapsed.
itemCnt
integer, defaults to 0, render all items.
number of RSS items to render, starting from top.
expandedCnt
integer, defaults to 0 for none.
number of item nodes to render as expanded, starting from top.
titleWordCnt
integer, defaults to 0 for all words.
maximum number of words per title nodes.
flCreateHeader
boolean, false by default.
when true, creates a header node out of each RSS item description's first sentence.
when false, do not create header nodes.
flOutliner
boolean, false by default.
when true, adds additional HTML rendering for outliner-type functions support in the browser.
this is only useful if you are trying to create a full web based outliner :-)
opmlCall
string, defaults to "transclude"
name of the Javascript function called to render OPML links transclusion.
imgCall
string, defaults to "imgLoad"
name of the Javascript function called to render picture files (GIF, JPG or PNG) transclusion.
rssCall
string, defaults to "transclude"
name of the Javascript function called to render RSS links transclusion.
mmCall
string, defaults to "mmLoad"
name of the Javascript function called to render multimedia files (QT and SWF) transclusion.
htmlCall
string, defaults to "pageLoad"
name of the Javascript function called to render simple HTML links.
flDisplayHTMLWedge
boolean, false by default.
when true, render link type attributes linking to HTML content as 'page' node wedges.
when false, render them as regular HTML links.
flRoll
boolean, false by default
when true, modify HTML rendering to better fit blogrolls (deprecated).
targetFrame
string, empty by defaults, links are opened in the same frame/window as source.
name of the destination frame for rendered HTML links.
flFilterImages
boolean, false by default.
when true, replaces img HTML tags with '[image]', linking to the image file in a different window.
flFilterQuotes
boolean, false by default.
when true, replaces blockquote HTML tags with divs of class rssQuote.
flRenderContentTag
boolean, false by default.
when true, uses the content:encoded tag of RSS 1.0 and RSS 2.0 to render each item's body node.
when false, uses the description tag.
flTitleLink
Defaults to false.
When true, a link is inserted around the last word of each item's title if a link is provided with the item.
Implementation notes
The dynamic HTML code generated by activeRenderer relies on 2 external resources:
A Javascript program: activerenderer.js
A CSS stylesheet: activerenderer.css
When generating HTML pages from your application, remember to include links to those 2 files in your page header, linking either to the files on the activerenderer.com site, or - best - to your own versions stored on your server.
Entering the following code in Radio's quickscript editor will render your subscriptions list by calling the activeRenderer RPC server. No need to instal activeRenderer :-)
opml 1.0
