Difference between revisions of "API:EPrints/Citation"

From EPrints Documentation
Jump to: navigation, search
(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'...")
 
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- 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' comments will be lost.
 
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Citation.pm|package_name=EPrints::Citation}}[[Category:API|CITATION]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Citation.pm|package_name=EPrints::Citation}}[[Category:API|CITATION]][[Category:API:EPrints/Citation|CITATION]]<div><!-- Edit below this comment -->
  
  

Revision as of 08:40, 15 December 2021

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 - loading and rendering of citation styles

User Comments


DESCRIPTION

User Comments


SYNOPSIS

 my $citation = $repo->dataset( "eprint" )->citation( "default" );
 
 $ok = $citation->freshen();
 
 $citation->render( $eprint, %opts );
 

User Comments


METHODS

User Comments


new

$citation = EPrints::Citation->new( $filename, %opts )

Returns a new EPrints::Citation object read from $filename.

Options:

   dataset - dataset this citation belongs to

User Comments


freshen

$ok = $citation->freshen()

Attempts to reload the citation source file.

Returns undef if the file could not be loaded.

User Comments


load_source

$ok = $citation->load_source()

Reads the source file.

User Comments


render

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

Renders a EPrints::DataObj using this citation style.

User Comments


type

$type = $citation->type()

Returns the type of this citation. Only supported value is "table_row".

User Comments


COPYRIGHT

© Copyright 2023 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