doc/plugins/contrib/xslt.mdwn

   1 [[!template id=plugin name=xslt author="rubykat"]]
   2 ## NAME
   3
   4 IkiWiki::Plugin::xslt - ikiwiki directive to process an XML file with XSLT
   5
   6 ## SYNOPSIS
   7
   8 \[[!xslt file="data1.xml" stylesheet="style1.xsl"]]
   9
  10 ## DESCRIPTION
  11
  12 IkiWiki::Plugin::xslt is an IkiWiki plugin implementing a directive
  13 to process an input XML data file with XSLT, and output the result in
  14 the page where the directive was called.
  15
  16 It is expected that the XSLT stylesheet will output valid HTML markup.
  17
  18 ## OPTIONS
  19
  20 There are two arguments to this directive.
  21
  22 * **file:**
  23   The file which contains XML data to be processed. This file *must* have a `.xml` extension (`filename.xml`). This file is searched for using the usual IkiWiki mechanism, thus finding the file first in the same directory as the page, then in the directory above, and so on.
  24
  25 * **stylesheet:**
  26   The file which contains XSLT stylesheet to apply to the XML data.  This file *must* have a `.xsl` extension (`filename.xsl`). This file is searched for using the usual IkiWiki mechanism, thus finding the file first in the same directory as the page, then in the directory above, and so on.
  27
  28 ## PREREQUISITES
  29
  30     IkiWiki
  31     XML::LibXML
  32     XML::LibXSLT
  33
  34 ## DOWNLOAD
  35
  36 * browse at GitHub: <http://github.com/rubykat/ikiplugins/blob/master/IkiWiki/Plugin/xslt.pm>
  37 * git repo at git://github.com/rubykat/ikiplugins.git
  38