git.oblomov.eu Git - ikiwiki/blob - doc/plugins/contrib/xslt.mdwn

   1 [[!template id=plugin name=xslt author="[[rubykat]]"]]
   2 [[!tag type/chrome]]
   3 ## NAME
   4
   5 IkiWiki::Plugin::xslt - ikiwiki directive to process an XML file with XSLT
   6
   7 ## SYNOPSIS
   8
   9 \[[!xslt file="data1.xml" stylesheet="style1.xsl"]]
  10
  11 ## DESCRIPTION
  12
  13 IkiWiki::Plugin::xslt is an IkiWiki plugin implementing a directive
  14 to process an input XML data file with XSLT, and output the result in
  15 the page where the directive was called.
  16
  17 It is expected that the XSLT stylesheet will output valid HTML markup.
  18
  19 ## OPTIONS
  20
  21 There are two arguments to this directive.
  22
  23 * **file:**
  24   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.
  25
  26 * **stylesheet:**
  27   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.
  28
  29 ## PREREQUISITES
  30
  31     IkiWiki
  32     XML::LibXML
  33     XML::LibXSLT
  34
  35 ## DOWNLOAD
  36
  37 * browse at GitHub: <http://github.com/rubykat/ikiplugins/blob/master/IkiWiki/Plugin/xslt.pm>
  38 * git repo at git://github.com/rubykat/ikiplugins.git
  39