Aaron Straup Cope

NAME

Apache::XBEL - mod_perl handler to transform XBEL into exciting and foofy HTML documents.

SYNOPSIS

 <Location />
  SetHandler  perl-script
  PerlHandler Apache::XBEL

  PerlSetVar  XbelPath     /path/to/yer-xbel-file.xbel
  PerlSetVar  XslPath      /path/to/apache-xbel.xsl
  PerlSetVar  CacheDir     /path/to/yer-cache-dir

  # If set to "On", output-escaping will be disabled
  # for title and description nodes in the XSL stylesheet

  PerlSetVar DisableEscaping   On

 </Location> 

DESCRIPTION

Apache::XBEL is an Apache mod_perl handler that uses XSLT to transform XML Bookmarks Exchange Language (XBEL) files into exciting and foofy dynamic HTML documents.

Documents are rendered as collapsible outlines and individual nodes may be viewed and bookmarked as unique pages, so you don't have to click through a gazillion nested leaves to find what you're looking for.

Once individual nodes/pages have been rendered, they are cached to reduce the load on the server. Cache files are updated whenever any of the widgets involved in the transformation are modified.

OPTIONS

XbelPath

required

The path to the XBEL file you are transforming.

XslPath

required

The path to the XSL file used to do the transforming.

CacheDir

required

The path to a directory where the mod_perl interpreter can write cache files.

DisableEscaping

If set to "On" (case-insenstive) output-escaping will be disabled for title and description nodes in the XSL stylesheet.

HtmlLang

Set this as the value of /html[@xml:lang]

VERSION

1.3

DATE

$Date: 2004/03/01 21:25:11 $

AUTHOR

Aaron Straup Cope <ascope@cpan.org>

SEE ALSO

http://pyxml.sourceforge.net/topics/xbel/

http://aaronland.info/perl/apache/xbel/example/1.3

http://aaronland.info/xsl/xbel/apache-xbel

NOTES

  • If you are running this handler on a server that is also running AxKit, pre version 1.5, Apache::XBEL may periodically fail and return a server error. Some reports have suggested that reloading the page may cause the widget to load properly. Or not.

  • Hooks for munging outliner documents with Text::Outline have been removed as of release 1.3. They may come back, at a later date, in a separate Apache::XBEL::Outline package.

TO DO

  • Replace nested 'div' elements with some flavour of nested lists and de-couple CSS from apache-xbel.xsl. De-couple JavaScript from apache-xbel.xsl These changes are slated for version 1.4

  • Support for expanding <alias> elements. This is slated for version 1.5

  • Support for mod_perl 2.0. This is slated for version 2.0

BUGS

Please report all bugs to : http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Apache::XBEL

LICENSE

Copyright (c) 2001-2004 Aaron Straup Cope. All Rights Reserved.

This is free software, you may use it and distribute it under the same terms as Perl itself.