Difference between revisions of "API:EPrints"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
Line 2: Line 2:
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
  -->{{Pod2Wiki}}{{API:Source|file=EPrints.pm|package_name=EPrints}}[[Category:API|EPrints]]<!-- End of Pod2Wiki -->
 
  -->{{Pod2Wiki}}{{API:Source|file=EPrints.pm|package_name=EPrints}}[[Category:API|EPrints]]<!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_abort -->=abort=
+
<!-- Pod2Wiki=head_name -->=NAME=
 +
'''EPrints''' - EPrints Software
 +
 
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=head_synopsis -->=SYNOPSIS=
 +
  use EPrints;
 +
 
 +
  my $session = EPrints::Session-&gt;new( 1, "xxx" );
 +
 
 +
  $session-&gt;terminate;
 +
 
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 +
EPrints is generic repository building software developed by the University of Southampton. It is intended to create a highly configurable web-based repository.
 +
 
 +
For more information on EPrints see http://www.eprints.org/software/.
 +
 
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=head_methods -->=METHODS=
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=item_abort -->==abort==
  
 
   EPrints::abort( $msg )
 
   EPrints::abort( $msg )
Line 11: Line 31:
  
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
 
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 
 
<!-- Pod2Wiki=item_deprecated -->==deprecated==
 
<!-- Pod2Wiki=item_deprecated -->==deprecated==
 +
 +
  EPrints::deprecated()
 +
 +
Prints a deprecated warning for the calling sub.
  
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_try -->==try==
 
<!-- Pod2Wiki=item_try -->==try==
 +
 +
  EPrints::try( CODE_REF )
 +
 +
Attempts to call CODE_REF and if an error occurs calls {{API:PodLink|file=|package_name=|section=abort|text=/abort}} with the error message.
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=head_see_also -->=SEE ALSO=
 +
[[API:EPrints/Session|EPrints::Session]], [[API:EPrints/Repository|EPrints::Repository]].
 +
 +
<!-- End of Pod2Wiki -->
 +
<!-- Pod2Wiki=head_author -->=AUTHOR=
 +
Copyright 2000-2009 University of Southampton, UK.
  
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->

Revision as of 18:46, 11 August 2009

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

NAME

EPrints - EPrints Software

SYNOPSIS

 use EPrints;
 
 my $session = EPrints::Session->new( 1, "xxx" );
 
 $session->terminate;
 

DESCRIPTION

EPrints is generic repository building software developed by the University of Southampton. It is intended to create a highly configurable web-based repository.

For more information on EPrints see http://www.eprints.org/software/.

METHODS

abort

 EPrints::abort( $msg )

Print an error message and exit. If running under mod_perl then print the error as a webpage and exit.

This subroutine is loaded before other modules so that it may be used to report errors when initialising modules.

deprecated

 EPrints::deprecated()

Prints a deprecated warning for the calling sub.

try

 EPrints::try( CODE_REF )

Attempts to call CODE_REF and if an error occurs calls /abort with the error message.

SEE ALSO

EPrints::Session, EPrints::Repository.

AUTHOR

Copyright 2000-2009 University of Southampton, UK.