API:EPrints/Plugin/Export/XSLT

From EPrints Documentation
Revision as of 10:47, 25 August 2011 by Tdb01r (Talk | contribs)

Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Plugin::Export::XSLT - XSLT-based exports

User Comments


SYNOPSIS

Create a file in Plugins/Export/XSLT/ called 'Title.xsl' containing:

 <?xml version="1.0"?> 
 
 <xsl:stylesheet
   version="1.0"
   xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
   ept:name="Titles"
   ept:visible="all"
   ept:advertise="1"
   ept:accept="list/eprint dataobj/eprint"
   ept:mime_type="application/xml; charset=utf-8"
   ept:qs="0.1"
   xmlns:ept="http://eprints.org/ep2/xslt/1.0"
   xmlns:ep="http://eprints.org/ep2/data/2.0"
   exclude-result-prefixes="ept ep"
 >
 
 <xsl:param name="results" />
 
 <xsl:template match="text()" />
 
 <xsl:template match="/ept:template">
 <titles><xsl:value-of select="$results"/></titles>
 </xsl:template>
 
 <xsl:template match="/ep:eprints/ep:eprint">
   <title><xsl:value-of select="ep:title"/></title>
 </xsl:template>
 
 </xsl:stylesheet>
 

User Comments


DESCRIPTION

This export plugin allows you to use XSL Transforms to export data from EPrints. The plugin is fed EPrints XML and can output any resulting data supported by XSLT.

This is the inverse process of EPrints::Plugin::Import::XSLT.

User Comments


Headers and Footers

You can specify a template to use for your output:

 <xsl:template match="ept:template">
   <html>
     <body>
       <xsl:value-of select="$results"/>
     </body>
   </html>
 </xsl:template>
 

Note: you can output unbalanced XML by using disable-output-escaping:

 <xsl:template match="ept:template">
   <xsl:text disable-output-escaping="yes">
     &lt;html&gt;
       &lt;body&gt;
   </xsl:text>
   <xsl:value-of select="$results"/>
 </xsl:template>
 

User Comments


Controlling XML Declarations

If your stylesheet outputs XML (the default):

 <xsl:output method="xml"/>
 

The XML declaration will only be outputted once at the start of the export, regardless of how many records there are.

To output as XML and suppress the XML declaration entirely define an empty prefix:

 <xsl:stylesheet
   xmlns:ept="http://eprints.org/ep2/xslt/1.0"
   ept:prefix=""
 >
 

User Comments


PLUGIN OPTIONS

All attributes on <xsl:stylesheet> that are in the EPT namespace are treated as plugin parameters. In addition to those parameters used by all EPrints::Plugin::Export plugins XSLT uses:

 prefix
   Value is printed before any content (defaults to XML decl.)
 postfix
   Value is printed after any content.
 

User Comments


STYLESHEET PARAMETERS

The following parameters are passed to the transform for each item:

 total
   Total items in result set.
 position
   1-indexed position in result set.
 dataset
   Base id of the item's dataset (e.g. "eprint").
 

User Comments


EXTENDED FUNCTIONS

The standard EPrints global extended XPath functions are supported, see EPrints::XSLT.

User Comments


SEE ALSO

EPrints::Plugin::Export

User Comments


COPYRIGHT

User Comments