Difference between revisions of "API:EPrints/Citation/XSL"
(Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
==NAME== | ==NAME== | ||
| − | '''EPrints::Citation::XSL''' - | + | '''EPrints::Citation::XSL''' - Loading and rendering of XSL based citation styles. |
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=head_description --> | ||
| + | ==DESCRIPTION== | ||
| + | Loads XSL citation style files and renders citations for a particular type of data object. | ||
| + | |||
| + | This class inherits from [[API:EPrints/Citation|EPrints::Citation]]. | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 29: | Line 42: | ||
$citation->load_source | $citation->load_source | ||
Load XSL citation source from file. | Load XSL citation source from file. | ||
| + | |||
| + | Returns 1 if citation source was successfully loaded. | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 42: | Line 57: | ||
$frag = $citation->render( $dataobj, %opts ) | $frag = $citation->render( $dataobj, %opts ) | ||
Renders a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style. | Renders a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style. | ||
| + | |||
| + | Returns a XML document fragment of the citation rendering. | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 54: | Line 71: | ||
$citation->error( $type, $message ) | $citation->error( $type, $message ) | ||
| − | Add $message of $type to array of messages for this citation. | + | Add <tt>$message</tt> of <tt>$type</tt> to array of messages for this citation. |
| + | |||
| + | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| + | <span style='display:none'>User Comments</span> | ||
| + | <!-- Edit below this comment --> | ||
| + | |||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
| + | <!-- Pod2Wiki=head_see_also --> | ||
| + | ==SEE ALSO== | ||
| + | [[API:EPrints/Citation|EPrints::Citation]] | ||
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
Latest revision as of 17:24, 16 March 2023
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::Citation::XSL - Loading and rendering of XSL based citation styles.
DESCRIPTION
Loads XSL citation style files and renders citations for a particular type of data object.
This class inherits from EPrints::Citation.
METHODS
load_source
$citation->load_source
Load XSL citation source from file.
Returns 1 if citation source was successfully loaded.
render
$frag = $citation->render( $dataobj, %opts )
Renders a EPrints::DataObj using this citation style.
Returns a XML document fragment of the citation rendering.
error
$citation->error( $type, $message )
Add $message of $type to array of messages for this citation.
SEE ALSO
COPYRIGHT
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.
