API:EPrints/Citation - Revision history

Pod2wiki at 12:31, 4 March 2022

2022-03-04T12:31:11Z

← Older revision		Revision as of 12:31, 4 March 2022
Line 19:		Line 19:
	Renders citations for data objects using a paticular style defined in it own configuration file.		Renders citations for data objects using a paticular style defined in it own configuration file.

	This is an abstract class used by [[API:EPrints:Citation/EPC\|EPrints:Citation::EPC]] and [[API:EPrints/Citation/XSL\|EPrints::Citation::XSL]] whichb use XML EPC and XSL respecively to define citation style files.		This is an abstract class used by [[API:EPrints/Citation/EPC\|EPrints::Citation::EPC]] and [[API:EPrints/Citation/XSL\|EPrints::Citation::XSL]] whichb use XML EPC and XSL respecively to define citation style files.

	<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%; '>

Pod2wiki at 12:30, 4 March 2022

2022-03-04T12:30:16Z

← Older revision		Revision as of 12:30, 4 March 2022
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]][[Category:API:EPrints/Citation~~\|CITATION]]<div><!-- Edit below this comment -->		-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/Citation.pm\|package_name=EPrints::Citation}}[[Category:API\|CITATION]]<div><!-- Edit below this comment -->


	<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->		<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
	==NAME==		==NAME==
	'''EPrints::Citation''' - ~~loading~~ and rendering of citation styles		'''EPrints::Citation''' - Loading and rendering of 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%; '>		<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
Line 17:		Line 17:
	<!-- Pod2Wiki=head_description -->		<!-- Pod2Wiki=head_description -->
	==DESCRIPTION==		==DESCRIPTION==
			Renders citations for data objects using a paticular style defined in it own configuration file.

			This is an abstract class used by [[API:EPrints:Citation/EPC\|EPrints:Citation::EPC]] and [[API:EPrints/Citation/XSL\|EPrints::Citation::XSL]] whichb use XML EPC and XSL respecively to define citation style files.

	<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%; '>
	<span style='display:none'>User Comments</span>		<span style='display:none'>User Comments</span>
Line 25:		Line 29:
	</div>		</div>
	<!-- Pod2Wiki=head_synopsis -->		<!-- Pod2Wiki=head_synopsis -->
	==SYNOPSIS==		===SYNOPSIS===
	my $citation = $repo->dataset( "eprint" )->citation( "default" );		my $citation = $repo->dataset( "eprint" )->citation( "default" );

Line 52:		Line 56:

	$citation = EPrints::Citation->new( $filename, %opts )		$citation = EPrints::Citation->new( $filename, %opts )
	Returns a new EPrints::Citation object read from $filename.		Returns a new EPrints::Citation object read from <tt>$filename</tt>.

	Options:		Options:
Line 70:		Line 74:
	Attempts to reload the citation source file.		Attempts to reload the citation source file.

	Returns undef if the file could not be loaded.		Returns <tt>undef</tt> if the file could not be 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 109:		Line 113:

	$type = $citation->type()		$type = $citation->type()
	Returns the type of this citation. Only supported value is "table_row".		Returns the type of this citation. Only supported value is <tt>table_row</tt>.

	<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%; '>

Pod2wiki at 08:40, 15 December 2021

2021-12-15T08:40:14Z

← Older revision		Revision as of 08:40, 15 December 2021
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 -->

Pod2wiki: Created page with "