Difference between revisions of "API:EPrints/Citation/EPC"

From EPrints Documentation
Jump to: navigation, search
Line 42: Line 42:
 
  $citation->load_source
 
  $citation->load_source
 
Load EPC citation source from file.
 
Load EPC 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 54: Line 56:
  
 
  $frag = $citation-&gt;render( $dataobj, %opts )
 
  $frag = $citation-&gt;render( $dataobj, %opts )
Renders a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style.
+
Used to render a [[API:EPrints/DataObj|EPrints::DataObj]] using this citation style.
 +
 
 +
Returns an 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%; '>

Revision as of 17:21, 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


API: Core API

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


NAME

EPrints::Citation::EPC - Loading and rendering of EPC XML based citation styles.

User Comments


DESCRIPTION

Loads EPC XML citation style files and renders citations for a particular type of data object.

This class inherits from EPrints::Citation.

User Comments


METHODS

User Comments


load_source

$citation->load_source

Load EPC citation source from file.

Returns 1 if citation source was successfully loaded.

User Comments


render

$frag = $citation->render( $dataobj, %opts )

Used to render a EPrints::DataObj using this citation style.

Returns an XML document fragment of the citation rendering.

User Comments


SEE ALSO

EPrints::Citation

User Comments


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/.

User Comments