Difference between revisions of "API:EPrints"

From EPrints Documentation
Jump to: navigation, search
Line 12: Line 12:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 29: Line 32:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 40: Line 46:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 53: Line 62:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 65: Line 77:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 82: Line 97:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 91: Line 109:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 105: Line 126:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 117: Line 141:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 131: Line 158:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 145: Line 175:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 157: Line 190:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 168: Line 204:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
Line 182: Line 221:
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
 
</div>
 
</div>
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Revision as of 12:58, 25 February 2010

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.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints - Institutional Repository software

User Comments


SYNOPSIS

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

User Comments


DESCRIPTION

See http://www.eprints.org/.

User Comments


Available Symbols

You can pass options to the EPrints package that effect the EPrints initialisation e.g.

 use EPrints qw( no_check_user );
 

User Comments


no_check_user

Do not check the current user/group is the same as the user/group in Systemsettings.

User Comments


Debugging Slow Processes

This module installs a signal handler that will print a stack trace if given a USR2 signal (if your system supports this signal). To print a stack trace to the error log execute:

$ kill -USR2 PID
 

Where PID is the id number of the stalled process.

A shell script will print the stack trace to the console.

User Comments


METHODS

User Comments


EPrints->abort( $errmsg )

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.

User Comments


$ep = EPrints->new();

Construct a new EPrints system object.

User Comments


$repo = $ep->repository( $repository_id, %options );

Return the repository with the given ID, or undef. Options are... optional.

Options noise=>1, etc.

User Comments


$repo = $ep->current_repository( %options );

Return the repository based on the current web request, or undef.

%options as for $ep->repository(..)

User Comments


@ids = $eprints->repository_ids

Returns a list of the active repository ids.

User Comments


SEE ALSO

EPrints::Session

User Comments


COPYRIGHT

__COPYRIGHT__

Copyright 2000-2008 University of Southampton. All Rights Reserved.

__LICENSE__

User Comments