API:EPrints - Revision history

Tdb01r at 09:56, 22 January 2013

2013-01-22T09:56:07Z

Show changes

Tdb01r at 15:25, 16 December 2011

2011-12-16T15:25:58Z

Tdb01r at 10:46, 25 August 2011

2011-08-25T10:46:32Z

Pm705 at 17:26, 31 December 2010

2010-12-31T17:26:50Z

Tdb01r at 13:05, 17 June 2010

2010-06-17T13:05:21Z

Tdb01r at 15:12, 25 February 2010

2010-02-25T15:12:27Z

Tdb01r at 13:21, 25 February 2010

2010-02-25T13:21:23Z

Tdb01r at 12:58, 25 February 2010

2010-02-25T12:58:38Z

Show changes

Tdb01r: Blanked the page

2010-02-25T12:58:32Z

Blanked the page

Show changes

Tdb01r at 12:58, 25 February 2010

2010-02-25T12:58:06Z

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
 This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
-  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints.pm|package_name=EPrints}}[[Category:API|EPRINTS]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints|package_name=EPrints}}[[Category:API|EPRINTS]]<div><!-- Edit below this comment -->

@@ Line 6: / Line 6: @@
 <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
-'''EPrints''' - Institutional Repository software
+EPrints - Institutional Repository software
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 80: / Line 80: @@
 <!-- Pod2Wiki=head_methods -->
 ==METHODS==
 <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>
@@ Line 94: / Line 120: @@
 When running under Mod_Perl this method is replaced.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 118: / Line 157: @@
 ===repository===
-  $repo = $ep-&gt;repository( $repository_id, %options );
+  $repo = $ep-&gt;repository( $repository_id, [%options] );
-Return the repository with the given ID, or undef. Options are... optional.
+Return the [[API:EPrints/Repository|EPrints::Repository]] with the given ID, or undef. Options are... optional.
 Options noise=&gt;1, etc.
@@ Line 134: / Line 173: @@
   $repo = $ep-&gt;current_repository();
-Returns the current repository.
+Returns the current [[API:EPrints/Repository|EPrints::Repository]]. The current  repository is determined by the apache request.
 Returns undef if there is no current repository active.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 171: / Line 197: @@
 <!-- Pod2Wiki=head_copyright -->
 ==COPYRIGHT==
 <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>

@@ Line 18: / Line 18: @@
 ==SYNOPSIS==
    use EPrints qw();
    $eprints = EPrints-&gt;new;
@@ Line 27: / Line 30: @@
    $repo = $eprints-&gt;current_repository;
-   ...
+   if( EPrints-&gt;VERSION() gt v3.2.0 )
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 64: / Line 70: @@
 Do not check the current user/group is the same as the user/group in SystemSettings.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 156: / Line 145: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_repository_ids -->
+<!-- Pod2Wiki=item_version -->
-===repository_ids===
+===version===
-  @ids = $eprints-&gt;repository_ids
+  $version = EPrints-&gt;VERSION()
-Returns a list of the active repository ids.
+Returns the version of EPrints in 'v' format.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 19: / Line 19: @@
    use EPrints qw();
-   my $session = EPrints::Session-&gt;new( 1, "demoprints" );
+   $eprints = EPrints-&gt;new;
    ...
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 59: / Line 63: @@
 ====no_check_user====
-Do not check the current user/group is the same as the user/group in Systemsettings.
+Do not check the current user/group is the same as the user/group in SystemSettings.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 98: / Line 102: @@
   EPrints-&gt;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.
-This subroutine is loaded before other modules so that it may be used to report errors when initialising modules.
+When running under Mod_Perl this method is replaced.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 140: / Line 144: @@
 ===current_repository===
-  $repo = $ep-&gt;current_repository( %options );
+  $repo = $ep-&gt;current_repository();
-Return the repository based on the current web request, or undef.
+Returns the current repository.
-%options as for $ep-&gt;repository(..)
+Returns undef if there is no current repository active.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
 This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
-  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints.pm|package_name=EPrints}}[[Category:API|EPrints]]<div><!-- Edit below this comment -->
+  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints.pm|package_name=EPrints}}[[Category:API|EPRINTS]]<div><!-- Edit below this comment -->

@@ Line 95: / Line 95: @@
 </div>
 <!-- Pod2Wiki=item_abort -->
-===EPrints-&gt;abort( $errmsg )===
+===abort===
 Print an error message and exit. If running under mod_perl then print the error as a webpage and exit.
@@ Line 109: / Line 110: @@
 </div>
 <!-- Pod2Wiki=item_new -->
-===$ep = EPrints-&gt;new();===
+===new===
 Construct a new EPrints system object.
@@ Line 121: / Line 123: @@
 </div>
 <!-- Pod2Wiki=item_repository -->
-===$repo = $ep-&gt;repository( $repository_id, %options );===
+===repository===
 Return the repository with the given ID, or undef. Options are... optional.
@@ Line 135: / Line 138: @@
 </div>
 <!-- Pod2Wiki=item_current_repository -->
-===$repo = $ep-&gt;current_repository( %options );===
+===current_repository===
 Return the repository based on the current web request, or undef.
@@ Line 149: / Line 153: @@
 </div>
 <!-- Pod2Wiki=item_repository_ids -->
-===@ids = $eprints-&gt;repository_ids===
+===repository_ids===
 Returns a list of the active repository ids.
@@ Line 162: / Line 167: @@
 <!-- Pod2Wiki=head_see_also -->
 ==SEE ALSO==
-[[API:EPrints/Session|EPrints::Session]]
+[[API:EPrints/Repository|EPrints::Repository]]
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>