https://wiki.eprints.org/w/api.php?action=feedcontributions&feedformat=atom&user=WikiSysopEPrints Documentation - User contributions [en-gb]2026-05-02T11:45:58ZUser contributionsMediaWiki 1.31.8https://wiki.eprints.org/w/index.php?title=StyleGuide&diff=6566StyleGuide2009-08-07T17:33:41Z<p>WikiSysop: /* Licensing */</p>
<hr />
<div>EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new modules.<br />
<br />
==Programming Style==<br />
<br />
===Naming===<br />
<pre><br />
TYPE EXAMPLE<br />
<br />
module StyleGuide<br />
subroutine get_value<br />
global var AUTH_OK<br />
local var $field_name<br />
</pre><br />
===Subroutines===<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1, $arg2 ) = @_;<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Where possible, use "return" rather than an "if" block.<br />
<br />
AVOID:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
my $r;<br />
if( $arg1 )<br />
{<br />
$r = $arg1 * 2;<br />
}<br />
else<br />
{<br />
log( "some error" );<br />
}<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Prefer this style instead, treating the problem like a basic exception to the normal running of the function:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
if( !defined $arg1 )<br />
{<br />
log( "some error" );<br />
return;<br />
}<br />
<br />
return $arg1 * 2;<br />
}<br />
</pre><br />
<br />
===Conditionals===<br />
<br />
<pre><br />
if( ref($a) eq "ARRAY" )<br />
{<br />
print "Dang";<br />
return 0;<br />
}<br />
</pre><br />
<br />
If the code inside the condition this is acceptable:<br />
<pre><br />
return 0 if( ref($a) eq "ARRAY" );<br />
</pre><br />
<br />
<pre><br />
$a = 23 if( !defined $a );<br />
</pre><br />
However this is NEVER OK:<br />
<pre><br />
if( !defined $a ) $a = 23;<br />
</pre><br />
<br />
===Loops===<br />
<pre><br />
foreach my $field ( @fields )<br />
{<br />
push @foo, $field->get_name();<br />
}<br />
<br />
OR, when nested:<br />
<br />
FIELD: foreach my $field ( @fields )<br />
{ <br />
VALUE: foreach my $value ( @{$field->{ "lsd" }} )<br />
{<br />
next VALUE if !defined $value; <br />
$values{ $value } = 1;<br />
}<br />
}<br />
<br />
</pre><br />
<br />
Avoid $_ where possible.<br />
<br />
Try and use "next" rather than if when inside loops.<br />
<br />
<br />
<br />
==Description==<br />
<br />
Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.<br />
<pre><br />
=head1 NAME<br />
<br />
EPrints::MyModule - A one line description of MyModule<br />
<br />
=head1 DESCRIPTION<br />
<br />
One or two paragraphs explaining the function of EPrints::MyModule.<br />
<br />
=head1 SYNOPSIS<br />
<br />
use EPrints::MyModule;<br />
<br />
my $obj = EPrints::MyModule->new( $opts );<br />
$obj->do_thing( $thingy );<br />
<br />
=head1 METHODS<br />
<br />
=over 4<br />
<br />
=cut<br />
</pre><br />
==Methods==<br />
===Public Methods===<br />
Each public subroutine should have POD documentation above it, with hashes to<br />
separate it from the method above. A large module should probably be split into<br />
different sections, e.g. "CONSTRUCTOR METHODS", "ACCESSOR METHODS", etc.<br />
Private methods can be documented using Perl comments.<br />
<pre><br />
######################################################################<br />
<br />
=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )<br />
<br />
A description of what my_sub does and arguments it takes ($opt_arg2 is<br />
shown as optional by using brackets).<br />
<br />
A description of $arg1 if needed, along with an example:<br />
<br />
EPrints::StyleGuide->my_sub( "eprintid" );<br />
<br />
EPrints::StyleGuide->my_sub(<br />
$arg1,<br />
undef,<br />
{<br />
opt1 => $var1, # What is var1<br />
opt2 => $var2, # What is var2<br />
}<br />
);<br />
<br />
Further elaboration on the effect of $var2.<br />
<br />
=cut<br />
<br />
######################################################################<br />
<br />
sub my_sub<br />
{<br />
...<br />
}<br />
</pre><br />
===Private Methods===<br />
<br />
==Automatically reformatting code==<br />
There is a wonderful utility called ''perltidy'' (find link)<br />
<br />
This reformats perl for you (and does a syntax check at the same time... lovely.<br />
<br />
Use:<br />
<br />
perltidy -gnu -csc -b JSON.pm<br />
<br />
-gnu reformats into the general 'gnu' style (as opposed to the "Larry Wall/Perl" style)<br />
-csc adds comments to the end of longish loops<br />
-b edits the file in place (so you may want to leave that off initially)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=StyleGuide&diff=6565StyleGuide2009-08-07T17:32:55Z<p>WikiSysop: /* Conditionals */</p>
<hr />
<div>EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new modules.<br />
<br />
==Programming Style==<br />
<br />
===Naming===<br />
<pre><br />
TYPE EXAMPLE<br />
<br />
module StyleGuide<br />
subroutine get_value<br />
global var AUTH_OK<br />
local var $field_name<br />
</pre><br />
===Subroutines===<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1, $arg2 ) = @_;<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Where possible, use "return" rather than an "if" block.<br />
<br />
AVOID:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
my $r;<br />
if( $arg1 )<br />
{<br />
$r = $arg1 * 2;<br />
}<br />
else<br />
{<br />
log( "some error" );<br />
}<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Prefer this style instead, treating the problem like a basic exception to the normal running of the function:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
if( !defined $arg1 )<br />
{<br />
log( "some error" );<br />
return;<br />
}<br />
<br />
return $arg1 * 2;<br />
}<br />
</pre><br />
<br />
===Conditionals===<br />
<br />
<pre><br />
if( ref($a) eq "ARRAY" )<br />
{<br />
print "Dang";<br />
return 0;<br />
}<br />
</pre><br />
<br />
If the code inside the condition this is acceptable:<br />
<pre><br />
return 0 if( ref($a) eq "ARRAY" );<br />
</pre><br />
<br />
<pre><br />
$a = 23 if( !defined $a );<br />
</pre><br />
However this is NEVER OK:<br />
<pre><br />
if( !defined $a ) $a = 23;<br />
</pre><br />
<br />
===Loops===<br />
<pre><br />
foreach my $field ( @fields )<br />
{<br />
push @foo, $field->get_name();<br />
}<br />
<br />
OR, when nested:<br />
<br />
FIELD: foreach my $field ( @fields )<br />
{ <br />
VALUE: foreach my $value ( @{$field->{ "lsd" }} )<br />
{<br />
next VALUE if !defined $value; <br />
$values{ $value } = 1;<br />
}<br />
}<br />
<br />
</pre><br />
<br />
Avoid $_ where possible.<br />
<br />
Try and use "next" rather than if when inside loops.<br />
<br />
==Licensing==<br />
<br />
We would like everything under the same license.... the EPrints license:<br />
<br />
<pre><br />
######################################################################<br />
#<br />
# This file is part of GNU EPrints 3.<br />
# <br />
# Copyright (c) 2000-2007 University of Southampton, UK. SO17 1BJ.<br />
# <br />
# EPrints 3 is free software; you can redistribute it and/or modify<br />
# it under the terms of the GNU General Public License as published by<br />
# the Free Software Foundation; either version 2 of the License, or<br />
# (at your option) any later version.<br />
# <br />
# EPrints 3 is distributed in the hope that it will be useful,<br />
# but WITHOUT ANY WARRANTY; without even the implied warranty of<br />
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br />
# GNU General Public License for more details.<br />
# <br />
# You should have received a copy of the GNU General Public License<br />
# along with EPrints 3; if not, write to the Free Software<br />
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<br />
#<br />
######################################################################<br />
</pre><br />
<br />
==Description==<br />
<br />
Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.<br />
<pre><br />
=head1 NAME<br />
<br />
EPrints::MyModule - A one line description of MyModule<br />
<br />
=head1 DESCRIPTION<br />
<br />
One or two paragraphs explaining the function of EPrints::MyModule.<br />
<br />
=head1 SYNOPSIS<br />
<br />
use EPrints::MyModule;<br />
<br />
my $obj = EPrints::MyModule->new( $opts );<br />
$obj->do_thing( $thingy );<br />
<br />
=head1 METHODS<br />
<br />
=over 4<br />
<br />
=cut<br />
</pre><br />
==Methods==<br />
===Public Methods===<br />
Each public subroutine should have POD documentation above it, with hashes to<br />
separate it from the method above. A large module should probably be split into<br />
different sections, e.g. "CONSTRUCTOR METHODS", "ACCESSOR METHODS", etc.<br />
Private methods can be documented using Perl comments.<br />
<pre><br />
######################################################################<br />
<br />
=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )<br />
<br />
A description of what my_sub does and arguments it takes ($opt_arg2 is<br />
shown as optional by using brackets).<br />
<br />
A description of $arg1 if needed, along with an example:<br />
<br />
EPrints::StyleGuide->my_sub( "eprintid" );<br />
<br />
EPrints::StyleGuide->my_sub(<br />
$arg1,<br />
undef,<br />
{<br />
opt1 => $var1, # What is var1<br />
opt2 => $var2, # What is var2<br />
}<br />
);<br />
<br />
Further elaboration on the effect of $var2.<br />
<br />
=cut<br />
<br />
######################################################################<br />
<br />
sub my_sub<br />
{<br />
...<br />
}<br />
</pre><br />
===Private Methods===<br />
<br />
==Automatically reformatting code==<br />
There is a wonderful utility called ''perltidy'' (find link)<br />
<br />
This reformats perl for you (and does a syntax check at the same time... lovely.<br />
<br />
Use:<br />
<br />
perltidy -gnu -csc -b JSON.pm<br />
<br />
-gnu reformats into the general 'gnu' style (as opposed to the "Larry Wall/Perl" style)<br />
-csc adds comments to the end of longish loops<br />
-b edits the file in place (so you may want to leave that off initially)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=StyleGuide&diff=6564StyleGuide2009-08-07T17:31:47Z<p>WikiSysop: /* Conditionals */</p>
<hr />
<div>EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new modules.<br />
<br />
==Programming Style==<br />
<br />
===Naming===<br />
<pre><br />
TYPE EXAMPLE<br />
<br />
module StyleGuide<br />
subroutine get_value<br />
global var AUTH_OK<br />
local var $field_name<br />
</pre><br />
===Subroutines===<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1, $arg2 ) = @_;<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Where possible, use "return" rather than an "if" block.<br />
<br />
AVOID:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
my $r;<br />
if( $arg1 )<br />
{<br />
$r = $arg1 * 2;<br />
}<br />
else<br />
{<br />
log( "some error" );<br />
}<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Prefer this style instead, treating the problem like a basic exception to the normal running of the function:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
if( !defined $arg1 )<br />
{<br />
log( "some error" );<br />
return;<br />
}<br />
<br />
return $arg1 * 2;<br />
}<br />
</pre><br />
<br />
===Conditionals===<br />
<br />
(trivial)<br />
<pre><br />
return 0 if( ref($a) eq "ARRAY" );<br />
</pre><br />
<br />
<pre><br />
$a = 23 if( !defined $a );<br />
</pre><br />
<br />
(Multi-line)<br />
<pre><br />
if( ref($a) eq "ARRAY" )<br />
{<br />
print "Dang";<br />
return 0;<br />
}<br />
</pre><br />
<br />
===Loops===<br />
<pre><br />
foreach my $field ( @fields )<br />
{<br />
push @foo, $field->get_name();<br />
}<br />
<br />
OR, when nested:<br />
<br />
FIELD: foreach my $field ( @fields )<br />
{ <br />
VALUE: foreach my $value ( @{$field->{ "lsd" }} )<br />
{<br />
next VALUE if !defined $value; <br />
$values{ $value } = 1;<br />
}<br />
}<br />
<br />
</pre><br />
<br />
Avoid $_ where possible.<br />
<br />
Try and use "next" rather than if when inside loops.<br />
<br />
==Licensing==<br />
<br />
We would like everything under the same license.... the EPrints license:<br />
<br />
<pre><br />
######################################################################<br />
#<br />
# This file is part of GNU EPrints 3.<br />
# <br />
# Copyright (c) 2000-2007 University of Southampton, UK. SO17 1BJ.<br />
# <br />
# EPrints 3 is free software; you can redistribute it and/or modify<br />
# it under the terms of the GNU General Public License as published by<br />
# the Free Software Foundation; either version 2 of the License, or<br />
# (at your option) any later version.<br />
# <br />
# EPrints 3 is distributed in the hope that it will be useful,<br />
# but WITHOUT ANY WARRANTY; without even the implied warranty of<br />
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br />
# GNU General Public License for more details.<br />
# <br />
# You should have received a copy of the GNU General Public License<br />
# along with EPrints 3; if not, write to the Free Software<br />
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<br />
#<br />
######################################################################<br />
</pre><br />
<br />
==Description==<br />
<br />
Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.<br />
<pre><br />
=head1 NAME<br />
<br />
EPrints::MyModule - A one line description of MyModule<br />
<br />
=head1 DESCRIPTION<br />
<br />
One or two paragraphs explaining the function of EPrints::MyModule.<br />
<br />
=head1 SYNOPSIS<br />
<br />
use EPrints::MyModule;<br />
<br />
my $obj = EPrints::MyModule->new( $opts );<br />
$obj->do_thing( $thingy );<br />
<br />
=head1 METHODS<br />
<br />
=over 4<br />
<br />
=cut<br />
</pre><br />
==Methods==<br />
===Public Methods===<br />
Each public subroutine should have POD documentation above it, with hashes to<br />
separate it from the method above. A large module should probably be split into<br />
different sections, e.g. "CONSTRUCTOR METHODS", "ACCESSOR METHODS", etc.<br />
Private methods can be documented using Perl comments.<br />
<pre><br />
######################################################################<br />
<br />
=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )<br />
<br />
A description of what my_sub does and arguments it takes ($opt_arg2 is<br />
shown as optional by using brackets).<br />
<br />
A description of $arg1 if needed, along with an example:<br />
<br />
EPrints::StyleGuide->my_sub( "eprintid" );<br />
<br />
EPrints::StyleGuide->my_sub(<br />
$arg1,<br />
undef,<br />
{<br />
opt1 => $var1, # What is var1<br />
opt2 => $var2, # What is var2<br />
}<br />
);<br />
<br />
Further elaboration on the effect of $var2.<br />
<br />
=cut<br />
<br />
######################################################################<br />
<br />
sub my_sub<br />
{<br />
...<br />
}<br />
</pre><br />
===Private Methods===<br />
<br />
==Automatically reformatting code==<br />
There is a wonderful utility called ''perltidy'' (find link)<br />
<br />
This reformats perl for you (and does a syntax check at the same time... lovely.<br />
<br />
Use:<br />
<br />
perltidy -gnu -csc -b JSON.pm<br />
<br />
-gnu reformats into the general 'gnu' style (as opposed to the "Larry Wall/Perl" style)<br />
-csc adds comments to the end of longish loops<br />
-b edits the file in place (so you may want to leave that off initially)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=StyleGuide&diff=6563StyleGuide2009-08-07T17:30:03Z<p>WikiSysop: </p>
<hr />
<div>EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new modules.<br />
<br />
==Programming Style==<br />
<br />
===Naming===<br />
<pre><br />
TYPE EXAMPLE<br />
<br />
module StyleGuide<br />
subroutine get_value<br />
global var AUTH_OK<br />
local var $field_name<br />
</pre><br />
===Subroutines===<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1, $arg2 ) = @_;<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Where possible, use "return" rather than an "if" block.<br />
<br />
AVOID:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
my $r;<br />
if( $arg1 )<br />
{<br />
$r = $arg1 * 2;<br />
}<br />
else<br />
{<br />
log( "some error" );<br />
}<br />
<br />
return $r;<br />
}<br />
</pre><br />
<br />
Prefer this style instead, treating the problem like a basic exception to the normal running of the function:<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1 ) = @_;<br />
<br />
if( !defined $arg1 )<br />
{<br />
log( "some error" );<br />
return;<br />
}<br />
<br />
return $arg1 * 2;<br />
}<br />
</pre><br />
<br />
===Conditionals===<br />
<pre><br />
if( ref($a) eq "ARRAY" )<br />
{<br />
return 0;<br />
}<br />
</pre><br />
===Loops===<br />
<pre><br />
foreach my $field ( @fields )<br />
{<br />
push @foo, $field->get_name();<br />
}<br />
<br />
OR, when nested:<br />
<br />
FIELD: foreach my $field ( @fields )<br />
{ <br />
VALUE: foreach my $value ( @{$field->{ "lsd" }} )<br />
{<br />
next VALUE if !defined $value; <br />
$values{ $value } = 1;<br />
}<br />
}<br />
<br />
</pre><br />
<br />
Avoid $_ where possible.<br />
<br />
Try and use "next" rather than if when inside loops.<br />
<br />
==Licensing==<br />
<br />
We would like everything under the same license.... the EPrints license:<br />
<br />
<pre><br />
######################################################################<br />
#<br />
# This file is part of GNU EPrints 3.<br />
# <br />
# Copyright (c) 2000-2007 University of Southampton, UK. SO17 1BJ.<br />
# <br />
# EPrints 3 is free software; you can redistribute it and/or modify<br />
# it under the terms of the GNU General Public License as published by<br />
# the Free Software Foundation; either version 2 of the License, or<br />
# (at your option) any later version.<br />
# <br />
# EPrints 3 is distributed in the hope that it will be useful,<br />
# but WITHOUT ANY WARRANTY; without even the implied warranty of<br />
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br />
# GNU General Public License for more details.<br />
# <br />
# You should have received a copy of the GNU General Public License<br />
# along with EPrints 3; if not, write to the Free Software<br />
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<br />
#<br />
######################################################################<br />
</pre><br />
<br />
==Description==<br />
<br />
Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.<br />
<pre><br />
=head1 NAME<br />
<br />
EPrints::MyModule - A one line description of MyModule<br />
<br />
=head1 DESCRIPTION<br />
<br />
One or two paragraphs explaining the function of EPrints::MyModule.<br />
<br />
=head1 SYNOPSIS<br />
<br />
use EPrints::MyModule;<br />
<br />
my $obj = EPrints::MyModule->new( $opts );<br />
$obj->do_thing( $thingy );<br />
<br />
=head1 METHODS<br />
<br />
=over 4<br />
<br />
=cut<br />
</pre><br />
==Methods==<br />
===Public Methods===<br />
Each public subroutine should have POD documentation above it, with hashes to<br />
separate it from the method above. A large module should probably be split into<br />
different sections, e.g. "CONSTRUCTOR METHODS", "ACCESSOR METHODS", etc.<br />
Private methods can be documented using Perl comments.<br />
<pre><br />
######################################################################<br />
<br />
=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )<br />
<br />
A description of what my_sub does and arguments it takes ($opt_arg2 is<br />
shown as optional by using brackets).<br />
<br />
A description of $arg1 if needed, along with an example:<br />
<br />
EPrints::StyleGuide->my_sub( "eprintid" );<br />
<br />
EPrints::StyleGuide->my_sub(<br />
$arg1,<br />
undef,<br />
{<br />
opt1 => $var1, # What is var1<br />
opt2 => $var2, # What is var2<br />
}<br />
);<br />
<br />
Further elaboration on the effect of $var2.<br />
<br />
=cut<br />
<br />
######################################################################<br />
<br />
sub my_sub<br />
{<br />
...<br />
}<br />
</pre><br />
===Private Methods===<br />
<br />
==Automatically reformatting code==<br />
There is a wonderful utility called ''perltidy'' (find link)<br />
<br />
This reformats perl for you (and does a syntax check at the same time... lovely.<br />
<br />
Use:<br />
<br />
perltidy -gnu -csc -b JSON.pm<br />
<br />
-gnu reformats into the general 'gnu' style (as opposed to the "Larry Wall/Perl" style)<br />
-csc adds comments to the end of longish loops<br />
-b edits the file in place (so you may want to leave that off initially)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=StyleGuide&diff=6562StyleGuide2009-08-07T17:25:01Z<p>WikiSysop: /* Loops */</p>
<hr />
<div>EPrints has been under development for many years and has some fluff about the place. For new programmers this document is intended as a 'style guide' to at least keep the code and documentation consistent across new modules.<br />
<br />
==Programming Style==<br />
<br />
===Naming===<br />
<pre><br />
TYPE EXAMPLE<br />
<br />
module StyleGuide<br />
subroutine get_value<br />
global var AUTH_OK<br />
local var $field_name<br />
</pre><br />
===Subroutines===<br />
<pre><br />
sub get_value<br />
{<br />
my( $self, $arg1, $arg2 ) = @_;<br />
<br />
return $r;<br />
}<br />
</pre><br />
===Conditionals===<br />
<pre><br />
if( ref($a) eq "ARRAY" )<br />
{<br />
return 0;<br />
}<br />
</pre><br />
===Loops===<br />
<pre><br />
foreach my $field ( @fields )<br />
{<br />
push @foo, $field->get_name();<br />
}<br />
<br />
OR, when nested:<br />
<br />
FIELD: foreach my $field ( @fields )<br />
{ <br />
VALUE: foreach my $value ( @{$field->{ "lsd" }} )<br />
{<br />
next VALUE if !defined $value; <br />
$values{ $value } = 1;<br />
}<br />
}<br />
<br />
</pre><br />
<br />
Avoid $_ where possible.<br />
<br />
Try and use "next" rather than if when inside loops.<br />
<br />
==Licensing==<br />
<br />
We would like everything under the same license.... the EPrints license:<br />
<br />
<pre><br />
######################################################################<br />
#<br />
# This file is part of GNU EPrints 3.<br />
# <br />
# Copyright (c) 2000-2007 University of Southampton, UK. SO17 1BJ.<br />
# <br />
# EPrints 3 is free software; you can redistribute it and/or modify<br />
# it under the terms of the GNU General Public License as published by<br />
# the Free Software Foundation; either version 2 of the License, or<br />
# (at your option) any later version.<br />
# <br />
# EPrints 3 is distributed in the hope that it will be useful,<br />
# but WITHOUT ANY WARRANTY; without even the implied warranty of<br />
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br />
# GNU General Public License for more details.<br />
# <br />
# You should have received a copy of the GNU General Public License<br />
# along with EPrints 3; if not, write to the Free Software<br />
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA<br />
#<br />
######################################################################<br />
</pre><br />
<br />
==Description==<br />
<br />
Below the license block the name, description and synopsis (a synopsis is an example of usage). Lastly the METHODS title begins the section for inline subroutine documentation.<br />
<pre><br />
=head1 NAME<br />
<br />
EPrints::MyModule - A one line description of MyModule<br />
<br />
=head1 DESCRIPTION<br />
<br />
One or two paragraphs explaining the function of EPrints::MyModule.<br />
<br />
=head1 SYNOPSIS<br />
<br />
use EPrints::MyModule;<br />
<br />
my $obj = EPrints::MyModule->new( $opts );<br />
$obj->do_thing( $thingy );<br />
<br />
=head1 METHODS<br />
<br />
=over 4<br />
<br />
=cut<br />
</pre><br />
==Methods==<br />
===Public Methods===<br />
Each public subroutine should have POD documentation above it, with hashes to<br />
separate it from the method above. A large module should probably be split into<br />
different sections, e.g. "CONSTRUCTOR METHODS", "ACCESSOR METHODS", etc.<br />
Private methods can be documented using Perl comments.<br />
<pre><br />
######################################################################<br />
<br />
=item $objname = EPrints::StyleGuide->my_sub( $arg1, [$opt_arg2], \%opts )<br />
<br />
A description of what my_sub does and arguments it takes ($opt_arg2 is<br />
shown as optional by using brackets).<br />
<br />
A description of $arg1 if needed, along with an example:<br />
<br />
EPrints::StyleGuide->my_sub( "eprintid" );<br />
<br />
EPrints::StyleGuide->my_sub(<br />
$arg1,<br />
undef,<br />
{<br />
opt1 => $var1, # What is var1<br />
opt2 => $var2, # What is var2<br />
}<br />
);<br />
<br />
Further elaboration on the effect of $var2.<br />
<br />
=cut<br />
<br />
######################################################################<br />
<br />
sub my_sub<br />
{<br />
...<br />
}<br />
</pre><br />
===Private Methods===<br />
<br />
==Automatically reformatting code==<br />
There is a wonderful utility called ''perltidy'' (find link)<br />
<br />
This reformats perl for you (and does a syntax check at the same time... lovely.<br />
<br />
Use:<br />
<br />
perltidy -gnu -csc -b JSON.pm<br />
<br />
-gnu reformats into the general 'gnu' style (as opposed to the "Larry Wall/Perl" style)<br />
-csc adds comments to the end of longish loops<br />
-b edits the file in place (so you may want to leave that off initially)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Manual&diff=6561Manual2009-08-07T16:53:53Z<p>WikiSysop: </p>
<hr />
<div>__NOTOC__<br />
See the [[Main Page]] for other areas of this wiki.<br />
<br />
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]] <br />
* New Features in [[New Features in EPrints 3.1|EPrints 3.1]] and planned for [[New Features in EPrints 3.2|EPrints 3.2]] (see also the note on [[EPrints Version Numbering]])<br />
<br />
<table cellpadding="10"><tr><td width="33%" valign="top"><br />
<br />
= Installation and First Steps =<br />
<br />
* [[Quick Server Install Guide (Debian / Ubuntu Server)]]<br />
<br />
== Download ==<br />
{{Download}}<br />
<br />
== Installing EPrints From Binary ==<br />
* [[Installing EPrints 3 via Redhat RPM]]<br />
* [[Installing EPrints 3 via Fedora RPM]]<br />
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]<br />
<br />
== Using the Live CD ==<br />
* [[EPrints Live CD Help]]<br />
* [[Building the Live CD]]<br />
<br />
== Installing EPrints From Source (.tar.gz) ==<br />
<br />
* [[Recommended Platforms]]<br />
* [[Required software]]<br />
* Install Guides<br />
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)<br />
** [[Installing EPrints 3 on RedHat Enterprise 4]]<br />
** [[Installing EPrints 3 on OS X]]<br />
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]<br />
** [[Installing EPrints 3 on Ubuntu 6.10]]<br />
** [[Installing EPrints 3 on Debian]]<br />
** [[Installing in a chroot Debian/Ubuntu]]<br />
** [[:Category:Installation|Installing]] EPrints on various platforms.<br />
* [[Https3 | Installing EPrints 3 with an https server]]<br />
<br />
==Post Installation==<br />
<br />
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]<br />
* [[Migration|Migrating from EPrints 2.3]]<br />
<br />
==Getting Started==<br />
* [[Getting Started with EPrints 3|Getting Started]] <br />
<br />
* Maintenance <br />
** [[Backups]]<br />
** [[Generate Scripts]]<br />
** [[Alerts]]<br />
** [[Log Files]]<br />
** [[Automating your maintenance]]<br />
<br />
* [[Troubleshooting]]<br />
</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;"><br />
<br />
= How-to Guides =<br />
<br />
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]<br />
<br />
* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span><br />
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''<br />
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...'' <br />
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding<br />
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''<br />
** [[Branding, the next level]] - ''how to completely change the interface to your own design''<br />
* [[OAI]]<br />
* [[Adding new views]]<br />
* Workflow<br />
* Deposit Types<br />
** [[Removing types]]<br />
* Metadata<br />
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")<br />
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''<br />
* Searches<br />
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''<br />
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''<br />
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''<br />
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive<br />
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.<br />
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.<br />
* [[:Category:Howto|more ...]]<br />
<br />
= How to contribute =<br />
<br />
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...<br />
<br />
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.<br />
<br />
* [[Contribute: Plugins | Plugins]]<br />
* [[Contribute: Scripts | Scripts]]<br />
* [[Contribute: Themes | Themes]]<br />
* [[Contribute: Translations | Translations]]<br />
* [[Contribute: Other | Other neighbourly things to do]]<br />
* [[Extension Packages]]<br />
<br />
= Misc =<br />
<br />
* [[Preservation Support]] in EPrints 3<br />
* [[i18n]]<br />
</td><td valign="top" width="33%"><br />
<br />
= Technical Reference =<br />
<br />
* [[EPrints Directory Structure]] - will be linked somewhere better, later.<br />
<br />
* [[Metadata]] - configuring metadata fields.<br />
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]<br />
* [[XML Configuration]] Files<br />
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).<br />
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.<br />
** [[Citation Format]]<br />
** [[Workflow Format]] - the structure of the EP3 workflow files<br />
** [[Phrase Format]]<br />
** [[Template Format]]<br />
** [[XPAGE Format]]<br />
* [[XML Export Format]]<br />
* EPrints data structure <br />
** of the software<br />
** of the database (relating the dataobjects to each other using eprints fields)<br />
* [[Data Object]]s and data sets<br />
** The [[EPrint Object]]<br />
** The [[User Object]]<br />
** The [[Document Object]]<br />
** The [[Subject Object]]<br />
** The [[Saved Search Object]]<br />
** The [[History Object]]<br />
** The [[Access Object]]<br />
** The [[Request Object]]<br />
* Plugins<br />
** Import<br />
** [[Export Plugins]]<br />
** Components<br />
** [[Screen Plugins]]<br />
** Convert<br />
* [[Autocompletion]]<br />
** [[Understanding IDs in Workflow Forms]]<br />
* [[API]]<br />
* [[Dynamic Template System]]<br />
</td></tr></table></div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Manual&diff=6560Manual2009-08-07T16:53:33Z<p>WikiSysop: /* Introduction to EPrints 3 */</p>
<hr />
<div>__NOTOC__<br />
See the [[Main Page]] for other areas of this wiki.<br />
<br />
= Introduction to EPrints 3 =<br />
<br />
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]] <br />
* New Features in [[New Features in EPrints 3.1|EPrints 3.1]] and planned for [[New Features in EPrints 3.2|EPrints 3.2]] (see also the note on [[EPrints Version Numbering]])<br />
<br />
<table cellpadding="10"><tr><td width="33%" valign="top"><br />
<br />
= Installation and First Steps =<br />
<br />
* [[Quick Server Install Guide (Debian / Ubuntu Server)]]<br />
<br />
== Download ==<br />
{{Download}}<br />
<br />
== Installing EPrints From Binary ==<br />
* [[Installing EPrints 3 via Redhat RPM]]<br />
* [[Installing EPrints 3 via Fedora RPM]]<br />
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]<br />
<br />
== Using the Live CD ==<br />
* [[EPrints Live CD Help]]<br />
* [[Building the Live CD]]<br />
<br />
== Installing EPrints From Source (.tar.gz) ==<br />
<br />
* [[Recommended Platforms]]<br />
* [[Required software]]<br />
* Install Guides<br />
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)<br />
** [[Installing EPrints 3 on RedHat Enterprise 4]]<br />
** [[Installing EPrints 3 on OS X]]<br />
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]<br />
** [[Installing EPrints 3 on Ubuntu 6.10]]<br />
** [[Installing EPrints 3 on Debian]]<br />
** [[Installing in a chroot Debian/Ubuntu]]<br />
** [[:Category:Installation|Installing]] EPrints on various platforms.<br />
* [[Https3 | Installing EPrints 3 with an https server]]<br />
<br />
==Post Installation==<br />
<br />
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]<br />
* [[Migration|Migrating from EPrints 2.3]]<br />
<br />
==Getting Started==<br />
* [[Getting Started with EPrints 3|Getting Started]] <br />
<br />
* Maintenance <br />
** [[Backups]]<br />
** [[Generate Scripts]]<br />
** [[Alerts]]<br />
** [[Log Files]]<br />
** [[Automating your maintenance]]<br />
<br />
* [[Troubleshooting]]<br />
</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;"><br />
<br />
= How-to Guides =<br />
<br />
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]<br />
<br />
* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span><br />
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''<br />
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...'' <br />
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding<br />
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''<br />
** [[Branding, the next level]] - ''how to completely change the interface to your own design''<br />
* [[OAI]]<br />
* [[Adding new views]]<br />
* Workflow<br />
* Deposit Types<br />
** [[Removing types]]<br />
* Metadata<br />
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")<br />
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''<br />
* Searches<br />
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''<br />
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''<br />
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''<br />
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive<br />
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.<br />
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.<br />
* [[:Category:Howto|more ...]]<br />
<br />
= How to contribute =<br />
<br />
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...<br />
<br />
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.<br />
<br />
* [[Contribute: Plugins | Plugins]]<br />
* [[Contribute: Scripts | Scripts]]<br />
* [[Contribute: Themes | Themes]]<br />
* [[Contribute: Translations | Translations]]<br />
* [[Contribute: Other | Other neighbourly things to do]]<br />
* [[Extension Packages]]<br />
<br />
= Misc =<br />
<br />
* [[Preservation Support]] in EPrints 3<br />
* [[i18n]]<br />
</td><td valign="top" width="33%"><br />
<br />
= Technical Reference =<br />
<br />
* [[EPrints Directory Structure]] - will be linked somewhere better, later.<br />
<br />
* [[Metadata]] - configuring metadata fields.<br />
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]<br />
* [[XML Configuration]] Files<br />
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).<br />
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.<br />
** [[Citation Format]]<br />
** [[Workflow Format]] - the structure of the EP3 workflow files<br />
** [[Phrase Format]]<br />
** [[Template Format]]<br />
** [[XPAGE Format]]<br />
* [[XML Export Format]]<br />
* EPrints data structure <br />
** of the software<br />
** of the database (relating the dataobjects to each other using eprints fields)<br />
* [[Data Object]]s and data sets<br />
** The [[EPrint Object]]<br />
** The [[User Object]]<br />
** The [[Document Object]]<br />
** The [[Subject Object]]<br />
** The [[Saved Search Object]]<br />
** The [[History Object]]<br />
** The [[Access Object]]<br />
** The [[Request Object]]<br />
* Plugins<br />
** Import<br />
** [[Export Plugins]]<br />
** Components<br />
** [[Screen Plugins]]<br />
** Convert<br />
* [[Autocompletion]]<br />
** [[Understanding IDs in Workflow Forms]]<br />
* [[API]]<br />
* [[Dynamic Template System]]<br />
</td></tr></table></div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Manual&diff=6559Manual2009-08-07T16:53:11Z<p>WikiSysop: /* Introduction to EPrints 3 */</p>
<hr />
<div>__NOTOC__<br />
See the [[Main Page]] for other areas of this wiki.<br />
<br />
= Introduction to EPrints 3 =<br />
<br />
* [[Introduction|Introduction to EPrints]] and [[History|History of EPrints]] <br />
* New Features in [[New Features in EPrints 3.1|EPrints 3.1]] and planned for[[New Features in EPrints 3.2|EPrints 3.2]] (see also the note on [[EPrints Version Numbering]])<br />
<br />
<table cellpadding="10"><tr><td width="33%" valign="top"><br />
<br />
= Installation and First Steps =<br />
<br />
* [[Quick Server Install Guide (Debian / Ubuntu Server)]]<br />
<br />
== Download ==<br />
{{Download}}<br />
<br />
== Installing EPrints From Binary ==<br />
* [[Installing EPrints 3 via Redhat RPM]]<br />
* [[Installing EPrints 3 via Fedora RPM]]<br />
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]<br />
<br />
== Using the Live CD ==<br />
* [[EPrints Live CD Help]]<br />
* [[Building the Live CD]]<br />
<br />
== Installing EPrints From Source (.tar.gz) ==<br />
<br />
* [[Recommended Platforms]]<br />
* [[Required software]]<br />
* Install Guides<br />
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)<br />
** [[Installing EPrints 3 on RedHat Enterprise 4]]<br />
** [[Installing EPrints 3 on OS X]]<br />
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]<br />
** [[Installing EPrints 3 on Ubuntu 6.10]]<br />
** [[Installing EPrints 3 on Debian]]<br />
** [[Installing in a chroot Debian/Ubuntu]]<br />
** [[:Category:Installation|Installing]] EPrints on various platforms.<br />
* [[Https3 | Installing EPrints 3 with an https server]]<br />
<br />
==Post Installation==<br />
<br />
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]<br />
* [[Migration|Migrating from EPrints 2.3]]<br />
<br />
==Getting Started==<br />
* [[Getting Started with EPrints 3|Getting Started]] <br />
<br />
* Maintenance <br />
** [[Backups]]<br />
** [[Generate Scripts]]<br />
** [[Alerts]]<br />
** [[Log Files]]<br />
** [[Automating your maintenance]]<br />
<br />
* [[Troubleshooting]]<br />
</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;"><br />
<br />
= How-to Guides =<br />
<br />
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]<br />
<br />
* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span><br />
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''<br />
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...'' <br />
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding<br />
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''<br />
** [[Branding, the next level]] - ''how to completely change the interface to your own design''<br />
* [[OAI]]<br />
* [[Adding new views]]<br />
* Workflow<br />
* Deposit Types<br />
** [[Removing types]]<br />
* Metadata<br />
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")<br />
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''<br />
* Searches<br />
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''<br />
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''<br />
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''<br />
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive<br />
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.<br />
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.<br />
* [[:Category:Howto|more ...]]<br />
<br />
= How to contribute =<br />
<br />
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...<br />
<br />
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.<br />
<br />
* [[Contribute: Plugins | Plugins]]<br />
* [[Contribute: Scripts | Scripts]]<br />
* [[Contribute: Themes | Themes]]<br />
* [[Contribute: Translations | Translations]]<br />
* [[Contribute: Other | Other neighbourly things to do]]<br />
* [[Extension Packages]]<br />
<br />
= Misc =<br />
<br />
* [[Preservation Support]] in EPrints 3<br />
* [[i18n]]<br />
</td><td valign="top" width="33%"><br />
<br />
= Technical Reference =<br />
<br />
* [[EPrints Directory Structure]] - will be linked somewhere better, later.<br />
<br />
* [[Metadata]] - configuring metadata fields.<br />
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]<br />
* [[XML Configuration]] Files<br />
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).<br />
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.<br />
** [[Citation Format]]<br />
** [[Workflow Format]] - the structure of the EP3 workflow files<br />
** [[Phrase Format]]<br />
** [[Template Format]]<br />
** [[XPAGE Format]]<br />
* [[XML Export Format]]<br />
* EPrints data structure <br />
** of the software<br />
** of the database (relating the dataobjects to each other using eprints fields)<br />
* [[Data Object]]s and data sets<br />
** The [[EPrint Object]]<br />
** The [[User Object]]<br />
** The [[Document Object]]<br />
** The [[Subject Object]]<br />
** The [[Saved Search Object]]<br />
** The [[History Object]]<br />
** The [[Access Object]]<br />
** The [[Request Object]]<br />
* Plugins<br />
** Import<br />
** [[Export Plugins]]<br />
** Components<br />
** [[Screen Plugins]]<br />
** Convert<br />
* [[Autocompletion]]<br />
** [[Understanding IDs in Workflow Forms]]<br />
* [[API]]<br />
* [[Dynamic Template System]]<br />
</td></tr></table></div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Manual&diff=6558Manual2009-08-07T16:51:02Z<p>WikiSysop: </p>
<hr />
<div>__NOTOC__<br />
See the [[Main Page]] for other areas of this wiki.<br />
<br />
= Introduction to EPrints 3 =<br />
<br />
* [[Introduction]]<br />
* [[History]] <br />
<br />
* [[New Features in EPrints 3.1]]<br />
* [[New Features in EPrints 3.2]]<br />
<br />
* [[EPrints Version Numbering]]<br />
<br />
<table cellpadding="10"><tr><td width="33%" valign="top"><br />
<br />
= Installation and First Steps =<br />
<br />
* [[Quick Server Install Guide (Debian / Ubuntu Server)]]<br />
<br />
== Download ==<br />
{{Download}}<br />
<br />
== Installing EPrints From Binary ==<br />
* [[Installing EPrints 3 via Redhat RPM]]<br />
* [[Installing EPrints 3 via Fedora RPM]]<br />
* [[Installing EPrints 3 via apt (Debian/Ubuntu)]]<br />
<br />
== Using the Live CD ==<br />
* [[EPrints Live CD Help]]<br />
* [[Building the Live CD]]<br />
<br />
== Installing EPrints From Source (.tar.gz) ==<br />
<br />
* [[Recommended Platforms]]<br />
* [[Required software]]<br />
* Install Guides<br />
** [[Installing Eprints 3 on Fedora Core 7]] (also applicable to FC6)<br />
** [[Installing EPrints 3 on RedHat Enterprise 4]]<br />
** [[Installing EPrints 3 on OS X]]<br />
** [[Debian from source | Installing EPrints 3 on Debian/Ubuntu - The Quick Way]]<br />
** [[Installing EPrints 3 on Ubuntu 6.10]]<br />
** [[Installing EPrints 3 on Debian]]<br />
** [[Installing in a chroot Debian/Ubuntu]]<br />
** [[:Category:Installation|Installing]] EPrints on various platforms.<br />
* [[Https3 | Installing EPrints 3 with an https server]]<br />
<br />
==Post Installation==<br />
<br />
* [[Upgrading EPrints 3 versions | Upgrading from an earlier version of EPrints3]]<br />
* [[Migration|Migrating from EPrints 2.3]]<br />
<br />
==Getting Started==<br />
* [[Getting Started with EPrints 3|Getting Started]] <br />
<br />
* Maintenance <br />
** [[Backups]]<br />
** [[Generate Scripts]]<br />
** [[Alerts]]<br />
** [[Log Files]]<br />
** [[Automating your maintenance]]<br />
<br />
* [[Troubleshooting]]<br />
</td><td width="33%" valign="top" style="border-left: solid 1px #ccc; border-right: solid 1px #ccc;"><br />
<br />
= How-to Guides =<br />
<br />
''[http://en.wikipedia.org/wiki/Howto What is a how-to?]<br />
<br />
* Orientation <span style="color: #f94; font-size: 130%">(Start here)</span><br />
** [[Configuration orientation|New to EPrints 3?]] - ''before diving into the how-tos, take some time to read through this brief orientation guide and familiarise yourself with the EPrints configuration landscape...''<br />
** [[EPrints_3_Configuration_orientation_for_EPrints_2_administrators|Migrated from EPrints 2?]] - ''this orientation guide is intended to help you re-orient yourselves in your new EPrints 3 set up...'' <br />
* [[Front Page Warning | Removing the Front Page Warning]] - Your first go at branding<br />
* [[Branding with confidence]] - ''one of the most common EPrints customisations is to add your own institution's branding and "look and feel" to the interface...''<br />
** [[Branding, the next level]] - ''how to completely change the interface to your own design''<br />
* [[OAI]]<br />
* [[Adding new views]]<br />
* Workflow<br />
* Deposit Types<br />
** [[Removing types]]<br />
* Metadata<br />
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")<br />
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''<br />
* Searches<br />
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''<br />
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''<br />
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''<br />
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive<br />
* [[Demoprints Repository]] - ''How to set up and configure the demoprints.eprints.org repository.<br />
* [[SWORD]] - ''How to configure the SWORD protocol on EPrints.<br />
* [[:Category:Howto|more ...]]<br />
<br />
= How to contribute =<br />
<br />
There's a number of different ways you can contribute to the EPrints project. This section covers all the ones we can think of...<br />
<br />
Always make an entry on http://files.eprints.org/ for your contribution, even if you don't upload the files. This will make it the one-stop place for people to find EPrints extensions.<br />
<br />
* [[Contribute: Plugins | Plugins]]<br />
* [[Contribute: Scripts | Scripts]]<br />
* [[Contribute: Themes | Themes]]<br />
* [[Contribute: Translations | Translations]]<br />
* [[Contribute: Other | Other neighbourly things to do]]<br />
* [[Extension Packages]]<br />
<br />
= Misc =<br />
<br />
* [[Preservation Support]] in EPrints 3<br />
* [[i18n]]<br />
</td><td valign="top" width="33%"><br />
<br />
= Technical Reference =<br />
<br />
* [[EPrints Directory Structure]] - will be linked somewhere better, later.<br />
<br />
* [[Metadata]] - configuring metadata fields.<br />
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]<br />
* [[XML Configuration]] Files<br />
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).<br />
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.<br />
** [[Citation Format]]<br />
** [[Workflow Format]] - the structure of the EP3 workflow files<br />
** [[Phrase Format]]<br />
** [[Template Format]]<br />
** [[XPAGE Format]]<br />
* [[XML Export Format]]<br />
* EPrints data structure <br />
** of the software<br />
** of the database (relating the dataobjects to each other using eprints fields)<br />
* [[Data Object]]s and data sets<br />
** The [[EPrint Object]]<br />
** The [[User Object]]<br />
** The [[Document Object]]<br />
** The [[Subject Object]]<br />
** The [[Saved Search Object]]<br />
** The [[History Object]]<br />
** The [[Access Object]]<br />
** The [[Request Object]]<br />
* Plugins<br />
** Import<br />
** [[Export Plugins]]<br />
** Components<br />
** [[Screen Plugins]]<br />
** Convert<br />
* [[Autocompletion]]<br />
** [[Understanding IDs in Workflow Forms]]<br />
* [[API]]<br />
* [[Dynamic Template System]]<br />
</td></tr></table></div>WikiSysophttps://wiki.eprints.org/w/index.php?title=EPrints_Control_Format&diff=6335EPrints Control Format2009-06-02T10:37:36Z<p>WikiSysop: /* epc:choose, epc:when, epc:otherwise */</p>
<hr />
<div>{{formats}}<br />
<br />
<br />
= EPrints Control =<br />
<br />
== Output Tags ==<br />
<br />
=== epc:print ===<br />
<br />
<epc:print expr='expression' opt='key=value;key2=value2'/><br />
<br />
&lt;cite:citation xmlns="http://www.w3.org/1999/xhtml"<br />
xmlns:cite="http://eprints.org/ep3/citation"<br />
xmlns:epc="http://eprints.org/ep3/control"&gt;<br />
&lt;epc:print expr="$item.citation('default')" /&gt;<br />
&lt;/cite:citation&gt; <br />
<br />
Outputs the result of the expression in the 'expr' attribute. <br />
<br />
Rendering options may be passed in the opt attribute using a key=value form, with semicolons separating multiple options.<br />
<br />
Any [[EPScript]] expression can be used. The most simple is just 'eprintid','title','creators' etc. You can also use values from the configuration files by using '$config{base_url}'.<br />
<br />
=== Print in attributes using {} ===<br />
<br />
Sometimes you may wish to insert a value into an XML attribute. eg. the "href" part of an anchor. Rather than a complicated system, but correct XML, we decide to go for something a bit more readable. Any {} pair in an XML attribute will be treated as a epc:print.<br />
<br />
So you can do something like <br />
<br />
<nowiki><a href="http://eprints.badger.edu/cgi/myscript.pl?eprintid={eprintid}">run myscript on this eprint</a></nowiki><br />
<br />
=== epc:phrase ===<br />
<br />
simple:<br />
<epc:phrase ref='phraseid' /><br />
<br />
with pins:<br />
<epc:phrase ref='phraseid'><br />
<epc:param name='somepin'>Content</epc:param><br />
</epc:phrase><br />
<br />
Outputs the content of the phrase refered to by 'ref'. Any necessary parameters may be set using the <epc:param> tag, with the contents inserted into the pin with the name corresponding to the name attribute.<br />
<br />
== Conditional Tags ==<br />
<br />
=== epc:if ===<br />
<br />
<epc:if test='expr'><br />
...<br />
</epc:if><br />
<br />
Outputs any XHTML content and evaluates any EPrints Control structures within the epc:if block if the expression in the test attribute is true.<br />
<br />
=== epc:choose, epc:when, epc:otherwise ===<br />
<br />
<epc:choose><br />
<epc:when test='expr'> <br />
...<br />
</epc:when><br />
<epc:when test='expr2'> <br />
...<br />
</epc:when><br />
<epc:otherwise><br />
...<br />
</epc:otherwise><br />
</epc:choose><br />
<br />
epc:choose allows for the construction of a complex conditional. Each epc:when block's 'test' attribute is evaluated, and the content of the block is returned if the result is true. If no expressions return true, the optional epc:otherwise block is returned. Note that no subsequent epc:when blocks are evaluated once the first block to return true is reached.<br />
<br />
== Loops ==<br />
<br />
Multiple values can be iterated over. For example.<br />
<br />
<epc:foreach expr="creators_name" iterator="name"><br />
( <epc:print expr="$name" /> )<br />
</epc:foreach>></div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Template:Download&diff=6321Template:Download2009-05-13T12:51:36Z<p>WikiSysop: </p>
<hr />
<div>* '''EPrints 3.1 series (latest release)'''<br />
** [http://files.eprints.org/447/ .tar.gz] v3.1.3 [RECOMMENDED]<br />
** [http://deb.eprints.org/3.1/stable/eprints_3.1.2.1_all.deb Debian/Ubuntu deb] v3.1.2.1<br />
** [http://www.eprints.org/files/eprints3/livecd_v3.1-x.iso Live CD] - Xubuntu 8.04-1 LTS based v3.1.1<br />
* '''EPrints 3.0 series (stable release)'''<br />
** [http://files.eprints.org/350/ .tar.gz] v3.0.5<br />
** [http://deb.eprints.org/unstable/eprints_3.0.5_all.deb Debian/Ubuntu deb] v3.0.5<br />
** [http://www.eprints.org/files/eprints3/livecd_v3.0-x.iso Live CD] - Ubuntu based v3.0.5 (652mb)<br />
* '''Migration Toolkit (for [[Migration]] from EPrints v2)'''<br />
** [http://files.eprints.org/256/ Migration Toolkit 1.0 (beta)]<br />
** When migrating use [http://files.eprints.org/268/ EPrints 3.0.2] or later.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Workflow_Format&diff=6260Workflow Format2009-02-24T12:34:46Z<p>WikiSysop: /* Field Element */</p>
<hr />
<div>{{formats}}<br />
<br />
<br />
The EPrints 3 workflow configuration files are stored in the repository's [[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg/workflows|workflows]] directory, within folders identifying the [[Data Object]]s to which they apply (e.g. eprint or user). Multiple workflows may be defined in each folder, although typically only the default.xml file will be necessary.<br />
<br />
== Structure ==<br />
<br />
At the centre of a workflow is a 'flow' description. This denotes the path through the workflow process from stage to stage. This may contain EPrints Control tags, allowing for the flow to vary depending on parameters of the data object (or other objects). For example, the flow may be different for users with certain roles. The flow is structured like so:<br />
<br />
<flow><br />
<stage ref="type"/><br />
<stage ref="files"/><br />
<stage ref="core"/><br />
<stage ref="subjects"/><br />
</flow><br />
<br />
The 'ref' attribute of the stage element refers to the individual stages. The stage elements describe the components within each screen of the process and, like flow, may contain EPrints Control tags. The 'name' attribute of the stage element is identical to that of the stage element in the 'flow' section.<br />
<br />
<stage name="core"><br />
<component><field ref="title" required="yes" /></component><br />
<component><field ref="abstract"/></component><br />
</stage><br />
<br />
== Components ==<br />
<br />
An EPrints component is responsible for the rendering of a graphical element in a workflow. This may be a text-box for title entry, a collection of fields in an appropriate grouping, or just a piece of XHTML. Six components are provided by default and, as they are plugins, it is straightforward to drop in new components when necessary. The type attribute of the component element corresponds to the plugin to be used.<br />
<br />
== Field-Related Components ==<br />
<br />
=== Field Element ===<br />
<br />
The majority of field-related components in EPrints 3 make use of the field element in their configuration. This provides a reference to a metafield and any attributes which may be relevant to rendering or operation. Several attributes are available to the element:<br />
<br />
<table border="1"><br />
<tr><th>Attribute</th><th>Values</th><th>Description</th></tr> <br />
<tr><td>ref</td><td>A string</td><td>(required) Refers to the name of the metafield this field represents</td></tr><br />
<tr><td>required</td><td>yes/no</td><td>(optional) Whether a value is required in this field before the workflow may complete</td></tr><br />
<tr><td>help</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as help for the field</td></tr><br />
<tr><td>title</td><td>An XHTML block</td><td>(optional) A block of XHTML to be rendered as the title for the field</td></tr><br />
<tr><td>input_lookup_url</td><td>A URL</td><td>(optional) The location of an auto-lookup URL for the field</td></tr><br />
<tr><td>input_lookup_params</td><td>A string</td><td>(optional) An &-separated list of parameters (e.g. sort=descending&number=3</td></tr><br />
</table><br />
<br />
=== Field Component ===<br />
<br />
The default component, this renders the field title, an input box suitable for the field, a star if the field is required, and any help information. A single field element is required:<br />
<br />
<component><field ref="title" required="yes" /></component><br />
<br />
=== Multiple Field Component ===<br />
<br />
The multiple field component is able to render several fields in a group, such as all fields related to a publication or an event. A title element and a help element may be provided that describe the group itself. One or many field elements are also required.<br />
<br />
<component type="Field::Multi"><br />
<title>Event Details</title><br />
<help>Enter information about your event here.</help><br />
<field ref="event_title"/><br />
<field ref="event_type" required="yes" /><br />
<field ref="event_location"/><br />
<field ref="event_dates"/><br />
</component><br />
<br />
=== Subject Component ===<br />
<br />
The subject component allows for the selection of one or more subjects from a subject tree. In this instance, the field element specifies the subject metafield.<br />
<br />
<component type="Field::Subject"><br />
<field ref="subjects" required="yes" /><br />
</component><br />
<br />
== Other Components ==<br />
<br />
=== Upload Component ===<br />
<br />
The upload component provides an interface for files to be uploaded to EPrints documents, and for new documents to be created/edited. It does not require any elements other than the component tag, but field elements to be rendered for each document may be added as in the example. <br />
<br />
<component type="Upload"><br />
<field ref="format" /><br />
<field ref="formatdesc" /><br />
<field ref="security" /><br />
<field ref="license" /><br />
<field ref="date_embargo" /><br />
</component><br />
<br />
=== XHTML Component ===<br />
<br />
This component inserts any contained nodes into the rendered document. As EPrints Control elements may be used, it is possible to insert phrases into the screen.<br />
<br />
<component type="XHTML"><br />
<epc:phrase ref="Plugin/InputForm/Component/Upload:help" /><br />
</component></div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Template:Download&diff=6220Template:Download2008-12-18T12:28:25Z<p>WikiSysop: </p>
<hr />
<div>* '''EPrints 3.1 series (latest release)'''<br />
** [http://files.eprints.org/414/ .tar.gz] v3.1.2 [RECOMMENDED]<br />
** [http://deb.eprints.org/3.1/unstable/eprints_3.1.1_all.deb Debian/Ubuntu deb] v3.1.1<br />
** [http://www.eprints.org/files/eprints3/livecd_v3.1-x.iso Live CD] - Xubuntu 8.04-1 LTS based v3.1.1<br />
* '''EPrints 3.0 series (stable release)'''<br />
** [http://files.eprints.org/350/ .tar.gz] v3.0.5<br />
** [http://deb.eprints.org/unstable/eprints_3.0.5_all.deb Debian/Ubuntu deb] v3.0.5<br />
** [http://www.eprints.org/files/eprints3/livecd_v3.0-x.iso Live CD] - Ubuntu based v3.0.5 (652mb)<br />
* '''Migration Toolkit (for [[Migration]] from EPrints v2)'''<br />
** [http://files.eprints.org/256/ Migration Toolkit 1.0 (beta)]<br />
** When migrating use [http://files.eprints.org/268/ EPrints 3.0.2] or later.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Template:Download&diff=6219Template:Download2008-12-18T12:27:52Z<p>WikiSysop: </p>
<hr />
<div>* '''EPrints 3.0 series (stable release)'''<br />
** [http://files.eprints.org/350/ .tar.gz] v3.0.5<br />
** [http://deb.eprints.org/unstable/eprints_3.0.5_all.deb Debian/Ubuntu deb] v3.0.5<br />
** [http://www.eprints.org/files/eprints3/livecd_v3.0-x.iso Live CD] - Ubuntu based v3.0.5 (652mb)<br />
* '''EPrints 3.1 series (latest release)'''<br />
** [http://files.eprints.org/414/ .tar.gz] v3.1.2<br />
** [http://deb.eprints.org/3.1/unstable/eprints_3.1.1_all.deb Debian/Ubuntu deb] v3.1.1<br />
** [http://www.eprints.org/files/eprints3/livecd_v3.1-x.iso Live CD] - Xubuntu 8.04-1 LTS based v3.1.1<br />
* '''Migration Toolkit (for [[Migration]] from EPrints v2)'''<br />
** [http://files.eprints.org/256/ Migration Toolkit 1.0 (beta)]<br />
** When migrating use [http://files.eprints.org/268/ EPrints 3.0.2] or later.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Files/EPrints_3.1.2&diff=6218Files/EPrints 3.1.22008-12-18T12:23:47Z<p>WikiSysop: New page: Released for Christmas 2008. = Changes since 3.1.1 = == Admin Tools == * "Edit phrases" tool appears in toolbar for admins, on pages that are generated "on the fly". It allows web-based ...</p>
<hr />
<div>Released for Christmas 2008.<br />
<br />
= Changes since 3.1.1 =<br />
<br />
== Admin Tools ==<br />
* "Edit phrases" tool appears in toolbar for admins, on pages that are generated "on the fly". It allows web-based editing of the phrases used to generate the page, including missing phrases.<br />
* Improvements to web based phrase editor.<br />
* "Edit page" option now appears if a static page is viewed by an admin, making it easy to get to the right edit screen.<br />
<br />
== Views ==<br />
* In views, links to empty pages are now rendered as text, not links.<br />
* /view/ pages may now be exported in the same way as searches.<br />
<br />
== Search ==<br />
* search.pl is now split into one file per search.<br />
* Search forms now have a show_help option to allow the help to be always hidden or always shown. The default is the toggle button.<br />
<br />
== Submission ==<br />
* Can now use <upload-methods> option in upload component configuration, in a workflow, to set which methods are available to upload files (or set to an empty list to stop new documents being created). Zip, from url etc.<br />
* Document fields can now be marked as required, and will have the star appear and report problems if not set. <br />
* Now when you add a document or modify one, it's always unrolled when the page upload form is rendered.<br />
<br />
== Import & Export ==<br />
* RSS2 now has thumbnail and media data, this allows some new fun mash-ups.<br />
* New Excel and CSV import and export plugins.<br />
<br />
== Saved Search and Review emails == <br />
* Improved style of HTML format emails.<br />
* Fixed broken links in emails.<br />
<br />
== Other ==<br />
* .xpage files can now have a <template> to override the use of the default template.<br />
* Many bugfixes. Notably in emails, views and unicode handling. See CHANGELOG for details.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6213Adding new views2008-11-19T14:17:00Z<p>WikiSysop: /* variations */</p>
<hr />
<div>{{development}}<br />
<br />
Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br />
<br />
There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository. <br />
Instead with this link you can read a [http://wiki.eprints.org/w/Views.pl complete list of all options] avaible for views.<br />
<br />
__TOC__<br />
<br />
===The basics===<br />
<br />
The views for your repository are defined in the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Open this file and find the browse_views configuration setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
fields => "-date;res=year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
fields => "subjects",<br />
...<br />
},<br />
];<br />
<br />
The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br />
<br />
The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br />
<br />
Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br />
<br />
It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br />
<br />
===Worked example: browse by organisational structure===<br />
<br />
By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br />
<br />
Open the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Add the following definition to the browse_views setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
...<br />
},<br />
{<br />
id => "divisions",<br />
fields => "divisions",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
];<br />
<br />
Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
Open the view page in a Web browser:<br />
<br />
http://your.repository.url/view/<br />
<br />
The view page lists all the available views. You should see your new views on the list:<br />
<br />
[[Image:View_page2.png|frame|none|The view page lists available views]]<br />
<br />
'''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br />
<br />
["viewname_eprint_divisions" not defined]<br />
<br />
Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br />
<br />
Edit the language-specific phrases file for view names:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br />
<br />
Add an appropriate phrase which describes the new view, for example:<br />
<br />
<epp:phrase id="viewname_eprint_divisions">Division</epp:phrase><br />
<br />
Save the phrases file and regenerate the view pages:<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
===Example view definitions===<br />
<br />
====Browse by type====<br />
<br />
Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br />
<br />
{<br />
id => "types",<br />
fields => "type",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
====Browse by author====<br />
<br />
===Example views (combined fields)===<br />
<br />
====Browse by author and editor====<br />
<br />
===Example views (multiple fields)===<br />
<br />
====Browse by journal title, then by volume====<br />
<br />
This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br />
<br />
{<br />
id=>"journal_volume",<br />
fields=>"publication,volume",<br />
order=>"-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
[[Image:Browse_by_journal.png|border]]<br />
<br />
[[Image:Browse_by_journal_volume.png|border]]<br />
<br />
<br />
<br />
===Linking in your view===<br />
<br />
You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br />
<br />
[[Image:Browse_by_navbar.png]]<br />
<br />
====Generating CVs etc====<br />
<br />
===Linking items back to views===<br />
===Views as collections===<br />
<br />
<br />
===New options in EPrints 3.1===<br />
<br />
====subfield no longer supported====<br />
<br />
The subfield option is no longer supported in EPrints 3.1.<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br />
<br />
variations => [<br />
"creators_name;first_letter",<br />
"type",<br />
"DEFAULT"<br />
],<br />
<br />
See [[views.pl]] for the list of options.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Views.pl&diff=6212Views.pl2008-11-19T14:16:26Z<p>WikiSysop: /* variations */</p>
<hr />
<div>== Option avaible for the views config ==<br />
This link is an [http://wiki.eprints.org/w/Adding_new_views 'How to' about views] with examples.<br />
<br />
===Basic===<br />
<br />
====id (mandatory)====<br />
<br />
====fields (mandatory)====<br />
<br />
====order====<br />
<br />
===Standard===<br />
<br />
====allow_null====<br />
<br />
====hideempty:====<br />
<br />
====heading_level====<br />
<br />
====include====<br />
<br />
====subheadings====<br />
<br />
===Extra feature===<br />
<br />
====citation====<br />
<br />
====nocount====<br />
<br />
====nohtml====<br />
<br />
====noindex====<br />
<br />
====nolink====<br />
<br />
===New features===<br />
<br />
====render_menu====<br />
<br />
The name of a config element which defines a function with an alternate way to render the menu page for a view. For an example, try looking in cfg.d/views_render_menu_example.pl<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
<br />
The following options are available:<br />
<br />
{| border="1" cellpadding="4" cellspacing="0"<br />
|reverse<br />
|Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first.<br />
|-<br />
|filename<br />
|Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.<br />
<br />
filename=different_filename<br />
|-<br />
|first_value<br />
|If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br />
|-<br />
|first_initial<br />
|If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.<br />
|-<br />
|first_letter<br />
|The same as 'truncate=1'<br />
|-<br />
|truncate<br />
|Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.<br />
<br />
truncate=4<br />
|-<br />
|tags<br />
|Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.<br />
|-<br />
|cloud<br />
|Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.<br />
|-<br />
|cloudmax<br />
|The % size of the largest tag in a tag cloud.<br />
|-<br />
|cloudmin<br />
|The % size of the smallest tag in a tag cloud.<br />
|-<br />
|jump<br />
|<br />
jump=plain<br />
<br />
Turns of the 'jump to' text before the list of subheading navigation links.<br />
|-<br />
|no_seperator (sic)<br />
|Turns of the separator between each subheading navigation link (by default a vertical bar symbol).<br />
|-<br />
|string<br />
|Uses values 'as is'. No ordervalues, no phrases.<br />
|-<br />
|hideup (since 3.1.1) <br />
|Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)<br />
|-<br />
|render_fn<br />
|Name of a function to render this groupings list of items. For an example, see views_render_items_example.pl<br />
|}</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6211Adding new views2008-11-19T14:14:10Z<p>WikiSysop: /* variations */</p>
<hr />
<div>{{development}}<br />
<br />
Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br />
<br />
There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository. <br />
Instead with this link you can read a [http://wiki.eprints.org/w/Views.pl complete list of all options] avaible for views.<br />
<br />
__TOC__<br />
<br />
===The basics===<br />
<br />
The views for your repository are defined in the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Open this file and find the browse_views configuration setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
fields => "-date;res=year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
fields => "subjects",<br />
...<br />
},<br />
];<br />
<br />
The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br />
<br />
The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br />
<br />
Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br />
<br />
It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br />
<br />
===Worked example: browse by organisational structure===<br />
<br />
By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br />
<br />
Open the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Add the following definition to the browse_views setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
...<br />
},<br />
{<br />
id => "divisions",<br />
fields => "divisions",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
];<br />
<br />
Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
Open the view page in a Web browser:<br />
<br />
http://your.repository.url/view/<br />
<br />
The view page lists all the available views. You should see your new views on the list:<br />
<br />
[[Image:View_page2.png|frame|none|The view page lists available views]]<br />
<br />
'''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br />
<br />
["viewname_eprint_divisions" not defined]<br />
<br />
Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br />
<br />
Edit the language-specific phrases file for view names:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br />
<br />
Add an appropriate phrase which describes the new view, for example:<br />
<br />
<epp:phrase id="viewname_eprint_divisions">Division</epp:phrase><br />
<br />
Save the phrases file and regenerate the view pages:<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
===Example view definitions===<br />
<br />
====Browse by type====<br />
<br />
Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br />
<br />
{<br />
id => "types",<br />
fields => "type",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
====Browse by author====<br />
<br />
===Example views (combined fields)===<br />
<br />
====Browse by author and editor====<br />
<br />
===Example views (multiple fields)===<br />
<br />
====Browse by journal title, then by volume====<br />
<br />
This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br />
<br />
{<br />
id=>"journal_volume",<br />
fields=>"publication,volume",<br />
order=>"-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
[[Image:Browse_by_journal.png|border]]<br />
<br />
[[Image:Browse_by_journal_volume.png|border]]<br />
<br />
<br />
<br />
===Linking in your view===<br />
<br />
You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br />
<br />
[[Image:Browse_by_navbar.png]]<br />
<br />
====Generating CVs etc====<br />
<br />
===Linking items back to views===<br />
===Views as collections===<br />
<br />
<br />
===New options in EPrints 3.1===<br />
<br />
====subfield no longer supported====<br />
<br />
The subfield option is no longer supported in EPrints 3.1.<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br />
<br />
variations => [<br />
"creators_name;first_letter",<br />
"type",<br />
"DEFAULT"<br />
],<br />
<br />
The following options are available:<br />
<br />
{| border="1" cellpadding="4"<br />
|reverse<br />
|Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first.<br />
|-<br />
|filename<br />
|Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.<br />
<br />
filename=different_filename<br />
|-<br />
|first_value<br />
|If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br />
|-<br />
|first_initial<br />
|If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.<br />
|-<br />
|first_letter<br />
|The same as 'truncate=1'<br />
|-<br />
|truncate<br />
|Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.<br />
<br />
truncate=4<br />
|-<br />
|tags<br />
|Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.<br />
|-<br />
|cloud<br />
|Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.<br />
|-<br />
|cloudmax<br />
|The % size of the largest tag in a tag cloud.<br />
|-<br />
|cloudmin<br />
|The % size of the smallest tag in a tag cloud.<br />
|-<br />
|jump<br />
|<br />
jump=plain<br />
<br />
Turns of the 'jump to' text before the list of subheading navigation links.<br />
|-<br />
|no_seperator (sic)<br />
|Turns of the separator between each subheading navigation link (by default a vertical bar symbol).<br />
|-<br />
|string<br />
|Uses values 'as is'. No ordervalues, no phrases.<br />
|-<br />
|hideup (since 3.1.1) <br />
|Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)<br />
|}</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6210Adding new views2008-11-19T14:12:44Z<p>WikiSysop: /* variations */</p>
<hr />
<div>{{development}}<br />
<br />
Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br />
<br />
There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository. <br />
Instead with this link you can read a [http://wiki.eprints.org/w/Views.pl complete list of all options] avaible for views.<br />
<br />
__TOC__<br />
<br />
===The basics===<br />
<br />
The views for your repository are defined in the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Open this file and find the browse_views configuration setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
fields => "-date;res=year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
fields => "subjects",<br />
...<br />
},<br />
];<br />
<br />
The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br />
<br />
The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br />
<br />
Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br />
<br />
It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br />
<br />
===Worked example: browse by organisational structure===<br />
<br />
By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br />
<br />
Open the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Add the following definition to the browse_views setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
...<br />
},<br />
{<br />
id => "divisions",<br />
fields => "divisions",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
];<br />
<br />
Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
Open the view page in a Web browser:<br />
<br />
http://your.repository.url/view/<br />
<br />
The view page lists all the available views. You should see your new views on the list:<br />
<br />
[[Image:View_page2.png|frame|none|The view page lists available views]]<br />
<br />
'''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br />
<br />
["viewname_eprint_divisions" not defined]<br />
<br />
Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br />
<br />
Edit the language-specific phrases file for view names:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br />
<br />
Add an appropriate phrase which describes the new view, for example:<br />
<br />
<epp:phrase id="viewname_eprint_divisions">Division</epp:phrase><br />
<br />
Save the phrases file and regenerate the view pages:<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
===Example view definitions===<br />
<br />
====Browse by type====<br />
<br />
Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br />
<br />
{<br />
id => "types",<br />
fields => "type",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
====Browse by author====<br />
<br />
===Example views (combined fields)===<br />
<br />
====Browse by author and editor====<br />
<br />
===Example views (multiple fields)===<br />
<br />
====Browse by journal title, then by volume====<br />
<br />
This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br />
<br />
{<br />
id=>"journal_volume",<br />
fields=>"publication,volume",<br />
order=>"-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
[[Image:Browse_by_journal.png|border]]<br />
<br />
[[Image:Browse_by_journal_volume.png|border]]<br />
<br />
<br />
<br />
===Linking in your view===<br />
<br />
You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br />
<br />
[[Image:Browse_by_navbar.png]]<br />
<br />
====Generating CVs etc====<br />
<br />
===Linking items back to views===<br />
===Views as collections===<br />
<br />
<br />
===New options in EPrints 3.1===<br />
<br />
====subfield no longer supported====<br />
<br />
The subfield option is no longer supported in EPrints 3.1.<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br />
<br />
variations => [<br />
"creators_name;first_letter",<br />
"type",<br />
"DEFAULT"<br />
],<br />
<br />
The following options are available:<br />
<br />
{|<br />
|reverse<br />
|Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first.<br />
|-<br />
|filename<br />
|Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.<br />
<br />
filename=different_filename<br />
|-<br />
|first_value<br />
|If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br />
|-<br />
|first_initial<br />
|If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.<br />
|-<br />
|first_letter<br />
|The same as 'truncate=1'<br />
|-<br />
|truncate<br />
|Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.<br />
<br />
truncate=4<br />
|tags<br />
|Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.<br />
|-<br />
|cloud<br />
|Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.<br />
|-<br />
|cloudmax<br />
|The % size of the largest tag in a tag cloud.<br />
|-<br />
|cloudmin<br />
|The % size of the smallest tag in a tag cloud.<br />
|-<br />
|jump<br />
|<br />
jump=plain<br />
<br />
Turns of the 'jump to' text before the list of subheading navigation links.<br />
|-<br />
|no_seperator (sic)<br />
|Turns of the separator between each subheading navigation link (by default '|').<br />
|-<br />
|string<br />
|Uses values 'as is'. No ordervalues, no phrases.<br />
|-<br />
|hideup (since 3.1.1) <br />
|Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)<br />
|}</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6209Adding new views2008-11-19T14:11:58Z<p>WikiSysop: /* variations */</p>
<hr />
<div>{{development}}<br />
<br />
Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br />
<br />
There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository. <br />
Instead with this link you can read a [http://wiki.eprints.org/w/Views.pl complete list of all options] avaible for views.<br />
<br />
__TOC__<br />
<br />
===The basics===<br />
<br />
The views for your repository are defined in the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Open this file and find the browse_views configuration setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
fields => "-date;res=year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
fields => "subjects",<br />
...<br />
},<br />
];<br />
<br />
The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br />
<br />
The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br />
<br />
Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br />
<br />
It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br />
<br />
===Worked example: browse by organisational structure===<br />
<br />
By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br />
<br />
Open the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Add the following definition to the browse_views setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
...<br />
},<br />
{<br />
id => "divisions",<br />
fields => "divisions",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
];<br />
<br />
Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
Open the view page in a Web browser:<br />
<br />
http://your.repository.url/view/<br />
<br />
The view page lists all the available views. You should see your new views on the list:<br />
<br />
[[Image:View_page2.png|frame|none|The view page lists available views]]<br />
<br />
'''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br />
<br />
["viewname_eprint_divisions" not defined]<br />
<br />
Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br />
<br />
Edit the language-specific phrases file for view names:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br />
<br />
Add an appropriate phrase which describes the new view, for example:<br />
<br />
<epp:phrase id="viewname_eprint_divisions">Division</epp:phrase><br />
<br />
Save the phrases file and regenerate the view pages:<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
===Example view definitions===<br />
<br />
====Browse by type====<br />
<br />
Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br />
<br />
{<br />
id => "types",<br />
fields => "type",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
====Browse by author====<br />
<br />
===Example views (combined fields)===<br />
<br />
====Browse by author and editor====<br />
<br />
===Example views (multiple fields)===<br />
<br />
====Browse by journal title, then by volume====<br />
<br />
This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br />
<br />
{<br />
id=>"journal_volume",<br />
fields=>"publication,volume",<br />
order=>"-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
[[Image:Browse_by_journal.png|border]]<br />
<br />
[[Image:Browse_by_journal_volume.png|border]]<br />
<br />
<br />
<br />
===Linking in your view===<br />
<br />
You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br />
<br />
[[Image:Browse_by_navbar.png]]<br />
<br />
====Generating CVs etc====<br />
<br />
===Linking items back to views===<br />
===Views as collections===<br />
<br />
<br />
===New options in EPrints 3.1===<br />
<br />
====subfield no longer supported====<br />
<br />
The subfield option is no longer supported in EPrints 3.1.<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br />
<br />
variations => [<br />
"creators_name;first_letter",<br />
"type",<br />
"DEFAULT"<br />
],<br />
<br />
The following options are available:<br />
<br />
{|<br />
|reverse<br />
|Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first.<br />
|-<br />
|filename<br />
|Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.<br />
<br />
filename=different_filename<br />
|}<br />
|-<br />
|first_value<br />
|If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br />
|-<br />
|first_initial<br />
|If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.<br />
|=<br />
|first_letter<br />
|The same as 'truncate=1'<br />
|-<br />
|truncate<br />
|Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.<br />
<br />
truncate=4<br />
|tags<br />
|Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.<br />
|-<br />
|cloud<br />
|Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.<br />
|-<br />
|cloudmax<br />
|The % size of the largest tag in a tag cloud.<br />
|-<br />
|cloudmin<br />
|The % size of the smallest tag in a tag cloud.<br />
|-<br />
|jump<br />
|<br />
jump=plain<br />
<br />
Turns of the 'jump to' text before the list of subheading navigation links.<br />
|-<br />
|no_seperator (sic)<br />
|Turns of the separator between each subheading navigation link (by default '|').<br />
|-<br />
|string<br />
|Uses values 'as is'. No ordervalues, no phrases.<br />
|-<br />
|hideup (since 3.1.1) <br />
|Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)<br />
|}</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Adding_new_views&diff=6199Adding new views2008-10-14T10:49:45Z<p>WikiSysop: /* string */</p>
<hr />
<div>{{development}}<br />
<br />
Browse views provide a way for visitors to your site to discover relevant content without a specific item in mind (for example, browsing all the content associated with a particular topic). Visitors arriving directly at the page for a specific item in the repository (for example, via a search engine) also use views you have defined to discover related content. <br />
<br />
There are two default views in EPrints - '''By Year''' and '''By Subject'''. This guide describes how to add additional views to your repository. <br />
Instead with this link you can read a [http://wiki.eprints.org/w/Views.pl complete list of all options] avaible for views.<br />
<br />
__TOC__<br />
<br />
===The basics===<br />
<br />
The views for your repository are defined in the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Open this file and find the browse_views configuration setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
fields => "-date;res=year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
fields => "subjects",<br />
...<br />
},<br />
];<br />
<br />
The views are defined using a special (Perl) syntax: the view definition consists of a pair of curly braces (''note the comma after each closing brace'') enclosing a list of property/value pairs (note ''the comma'' after each line).<br />
<br />
The key part of the view definition is the '''fields''' property. This names the metadata field (or fields) that EPrints will use to construct the view. For example, for the '''By Year''' view, EPrints groups the records in the repository according to their '''date''' (note that the '''res=year''' suffix tells EPrints to only consider the year part), and constructs a Web page for each date listing the records. Similarly, the '''Browse by Subjscts''' view, groups the records according to the ''subjects'' they have been assigned to (a record may appear in more than one group!).<br />
<br />
Both the '''Browse by Year''' and '''Browse by Subject''' views are constructed using the values of a single field ('''date''' and '''subjects''' respectively).<br />
<br />
It is also possible to construct a view using the ''combined'' values of two or more fields (eg. group records by author '''and''' editor), or even using a sequence of two or more fields (eg. group records by journal title '''and then''' by volume number).<br />
<br />
===Worked example: browse by organisational structure===<br />
<br />
By default, EPrints has a ''divisions'' metadata field which allows authors to associate their deposits with the divisions (units, faculties, schools, departments, institutes, centres..) that were involved in producing their item (for example, the author's department, and the departments of any co-authors). This worked example allows visitors to browse the repository content by division.<br />
<br />
Open the views configuration file:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/views.pl<br />
<br />
Add the following definition to the browse_views setting:<br />
<br />
$c->{browse_views} = [<br />
{<br />
id => "year",<br />
...<br />
},<br />
{<br />
id => "subjects",<br />
...<br />
},<br />
{<br />
id => "divisions",<br />
fields => "divisions",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
];<br />
<br />
Save the file and generate the new view pages (this will also re-generate any existing views defined in the views configuration file):<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
Open the view page in a Web browser:<br />
<br />
http://your.repository.url/view/<br />
<br />
The view page lists all the available views. You should see your new views on the list:<br />
<br />
[[Image:View_page2.png|frame|none|The view page lists available views]]<br />
<br />
'''Fixing the undefined phrase warning''' The new view may appear on the views page with an ''undefined phrase'' warning (you may also notice a similar warning message when running generate_views):<br />
<br />
["viewname_eprint_divisions" not defined]<br />
<br />
Each view you create needs to be assigned a ''human-readable'' name, which EPrints will use on the view Web pages.<br />
<br />
Edit the language-specific phrases file for view names:<br />
<br />
/opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/views.xml<br />
<br />
Add an appropriate phrase which describes the new view, for example:<br />
<br />
<epp:phrase id="viewname_eprint_divisions">Division</epp:phrase><br />
<br />
Save the phrases file and regenerate the view pages:<br />
<br />
bin/generate_views ARCHIVEID --verbose<br />
<br />
===Example view definitions===<br />
<br />
====Browse by type====<br />
<br />
Every deposit in EPrints has a type (article, book, thesis...). To allow visitors to browse your repository content by type, add the following definition to the browse_views setting:<br />
<br />
{<br />
id => "types",<br />
fields => "type",<br />
order => "-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
====Browse by author====<br />
<br />
===Example views (combined fields)===<br />
<br />
====Browse by author and editor====<br />
<br />
===Example views (multiple fields)===<br />
<br />
====Browse by journal title, then by volume====<br />
<br />
This example lets visitors browse the journals items in your repository have been published in, and then volumes within each journal.<br />
<br />
{<br />
id=>"journal_volume",<br />
fields=>"publication,volume",<br />
order=>"-date/title",<br />
hideempty => 1,<br />
},<br />
<br />
[[Image:Browse_by_journal.png|border]]<br />
<br />
[[Image:Browse_by_journal_volume.png|border]]<br />
<br />
<br />
<br />
===Linking in your view===<br />
<br />
You now need to add a link to your repository pages which takes visitors directly to your new view, or to the views page from where they can access all available views.<br />
<br />
[[Image:Browse_by_navbar.png]]<br />
<br />
====Generating CVs etc====<br />
<br />
===Linking items back to views===<br />
===Views as collections===<br />
<br />
<br />
===New options in EPrints 3.1===<br />
<br />
====subfield no longer supported====<br />
<br />
The subfield option is no longer supported in EPrints 3.1.<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br />
<br />
variations => [<br />
"creators_name;first_letter",<br />
"type",<br />
"DEFAULT"<br />
],<br />
<br />
The following options are available:<br />
<br />
=====reverse=====<br />
<br />
Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first.<br />
<br />
=====filename=====<br />
<br />
Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.<br />
<br />
filename=different_filename<br />
<br />
=====first_value=====<br />
<br />
If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br />
<br />
=====first_initial=====<br />
<br />
If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.<br />
<br />
=====first_letter=====<br />
<br />
The same as 'truncate=1'<br />
<br />
=====truncate=====<br />
<br />
Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.<br />
<br />
truncate=4<br />
<br />
=====tags=====<br />
<br />
Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.<br />
<br />
=====cloud=====<br />
<br />
Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.<br />
<br />
=====cloudmax=====<br />
<br />
The % size of the largest tag in a tag cloud.<br />
<br />
=====cloudmin=====<br />
<br />
The % size of the smallest tag in a tag cloud.<br />
<br />
=====jump=====<br />
<br />
jump=plain<br />
<br />
Turns of the 'jump to' text before the list of subheading navigation links.<br />
<br />
=====no_seperator (sic)=====<br />
<br />
Turns of the separator between each subheading navigation link (by default '|').<br />
<br />
=====string=====<br />
<br />
Uses values 'as is'. No ordervalues, no phrases.<br />
<br />
=====hideup (since 3.1.1) =====<br />
Defaults to "0". If set to "1" this hides the "up to parent" link (often you want to hide this on .include files)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Views.pl&diff=6174Views.pl2008-07-14T16:47:49Z<p>WikiSysop: /* New features */</p>
<hr />
<div>== Option avaible for the views config ==<br />
This link is an [http://wiki.eprints.org/w/Adding_new_views 'How to' about views] with examples.<br />
<br />
===Basic===<br />
<br />
====id (mandatory)====<br />
<br />
====fields (mandatory)====<br />
<br />
====order====<br />
<br />
===Standard===<br />
<br />
====allow_null====<br />
<br />
====hideempty:====<br />
<br />
====heading_level====<br />
<br />
====include====<br />
<br />
====subheadings====<br />
<br />
===Extra feature===<br />
<br />
====citation====<br />
<br />
====nocount====<br />
<br />
====nohtml====<br />
<br />
====noindex====<br />
<br />
====nolink====<br />
<br />
===New features===<br />
<br />
====render_menu====<br />
<br />
The name of a config element which defines a function with an alternate way to render the menu page for a view. For an example, try looking in cfg.d/views_render_menu_example.pl<br />
<br />
====new_column_at====<br />
<br />
This is an array of integers representing the number of items in a view list before another column is added. For example:<br />
<br />
[ 10 ]<br />
<br />
This would have one column of values until there were 11, then there would be 2 columns.<br />
<br />
[ 10, 10 ]<br />
<br />
This would have one column if there were ten or less values, two columns if there were between eleven and twenty (ten + ten) values, and three columns for all other cases.<br />
<br />
[ 0, 0 ]<br />
<br />
This would always have three columns.<br />
<br />
Add one to the number of integers in the array and you get the maximum number of columns. The value of each integer defines the point at which that column becomes full, and more values cause an 'overflow' into the next column.<br />
<br />
====variations====<br />
<br />
This controls the various ways in which a browse view can be subheaded. It consists of a list of strings. Each string is the name of a non-compound metadata field (or the keyword DEFAULT, for an unsubheaded list), optionally followed by a semi-colon and a comma separated list of options. E.G:<br />
<br />
variations => [<br />
"creators_name;first_letter",<br />
"type",<br />
"DEFAULT"<br />
],<br />
<br />
The following options are available:<br />
<br />
<br />
* '''reverse'''<br />
<br />
Reverses the order in which the groupings are shown. Default is the ordervalue for that field (usually alphanumeric). Useful for dates as you may want the highest values first.<br />
<br />
<br />
* '''filename'''<br />
<br />
Changes the filename of the view variation. The default is the name of the metadata field used, so if two variations use the same metadata field with different options, this is needed.<br />
<br />
filename=different_filename<br />
<br />
<br />
* '''first_value'''<br />
<br />
If a field is multiple, only use the first value. Otherwise each item will appear once for each value.<br />
<br />
<br />
* '''first_initial'''<br />
<br />
If using a name, truncate the given name to the first initial. This will make items like "Les Carr" and "Leslie Carr" appear together. Note it will also make "John Smith" and "Jake Smith" appear together too, showing that you really never can win.<br />
<br />
<br />
* '''first_letter'''<br />
<br />
The same as 'truncate=1'<br />
<br />
<br />
* '''truncate'''<br />
<br />
Use the first X characters of a value to group by. truncate=4 may be useful for dates as it will group by the first four digits (the year) only.<br />
<br />
truncate=4<br />
<br />
<br />
* '''tags'''<br />
<br />
Useful for fields like keywords where values may be separated by commas or semi-colons. The value is split on these two characters ( , and ; ) and a heading is created for each.<br />
<br />
<br />
* '''cloud'''<br />
<br />
Creates a tag cloud. Sets jump to 'plain', cloudmax to 200, cloudmin to 80 and no_separator, then resizes the jump-to links according to frequency of use.<br />
<br />
<br />
* '''cloudmax'''<br />
<br />
The % size of the largest tag in a tag cloud.<br />
<br />
<br />
* '''cloudmin'''<br />
<br />
The % size of the smallest tag in a tag cloud.<br />
<br />
<br />
* '''jump'''<br />
<br />
jump=plain<br />
<br />
Turns of the 'jump to' text before the list of subheading navigation links.<br />
<br />
<br />
* '''no_seperator (sic)'''<br />
<br />
Turns of the separator between each subheading navigation link (by default '|').<br />
<br />
<br />
* '''string'''<br />
<br />
Uses values 'as is'. No ordervalues, no phrases.<br />
<br />
* '''render_fn''' <br />
<br />
Name of a function to render this groupings list of items. For an example, see views_render_items_example.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Template:Download&diff=6011Template:Download2008-04-11T17:56:52Z<p>WikiSysop: </p>
<hr />
<div>* '''EPrints 3.x Series'''<br />
** Stable <br />
*** [http://files.eprints.org/318/ .tar.gz] v3.0.3<br />
*** [http://deb.eprints.org/stable/eprints_3.0.3-1_all.deb Debian/Ubuntu deb] v3.0.3<br />
*** [http://rpm.eprints.org/rhel4/noarch/eprints3-eprints-3.noarch.rpm Redhat rpm] v3.0.0<br />
*** [http://rpm.eprints.org/fc6/noarch/eprints3-eprints-3.noarch.rpm Fedora (FC6)] v3.0.0<br />
** Latest 3.0 series<br />
*** [http://files.eprints.org/319/ .tar.gz] v3.0.4-rc-1<br />
*** [http://deb.eprints.org/unstable/eprints_3.0.4-rc1-1_all.deb Debian/Ubuntu deb] v3.0.4-rc-1<br />
** Latest 3.1 series<br />
*** [http://files.eprints.org/339/ .tar.gz] v3.1.0-beta-2<br />
*** [http://deb.eprints.org/3.1/unstable/eprints_3.1.0-beta-2_all.deb Debian/Ubuntu deb] v3.1.0-beta-2<br />
** Live CD (Release v1.1)<br />
*** [http://www.eprints.org/files/eprints3/livecd_v1.1.iso Live CD] Ubuntu based v3.0.3-rc-1 (652mb)<br />
* '''Migration Toolkit (for [[Migration]] from EPrints v2)'''<br />
** [http://files.eprints.org/256/ Migration Toolkit 1.0 (beta)]<br />
** When migrating use [http://files.eprints.org/268/ EPrints 3.0.2] or later.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=6010New Features in EPrints 3.12008-04-10T10:44:46Z<p>WikiSysop: /* lang/en/phrases/views.xml */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/views.pl ===<br />
<br />
The "subheadings" option has been '''replaced''' by the variations heading. This only allows one level of subheading but is much faster.<br />
<br />
=== lang/en/phrases/views.xml ===<br />
<br />
The way the titles of views pages are configured has '''changed'''.<br />
<br />
The title of the first page of the view with id "subjects" is now:<br />
<epp:phrase id="viewtitle_eprint_subjects_menu_1">Browse by Subject and Year</epp:phrase><br />
<br />
if there's a second level menu, configure it with:<br />
<epp:phrase id="viewtitle_eprint_subjects_menu_2">Browse by Year where Subject is "<epc:pin name="value1" />"</epp:phrase><br />
<br />
The actual list page title is configured like this:<br />
<epp:phrase id="viewtitle_eprint_subjects_list">Items where Subject is "<epc:pin name="value1" />" and <br />
Year is <epc:pin name="value2" /> (Grouped by <epc:pin name="grouping" />)</epp:phrase><br />
<br />
=== cfg.d/indexing.pl ===<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster.<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=6009New Features in EPrints 3.12008-04-10T10:44:28Z<p>WikiSysop: /* lang/en/phrases/views.xml */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/views.pl ===<br />
<br />
The "subheadings" option has been '''replaced''' by the variations heading. This only allows one level of subheading but is much faster.<br />
<br />
=== lang/en/phrases/views.xml ===<br />
<br />
The way the titles of views pages are configured has '''changed'''.<br />
<br />
The title of the first page of the view with id "subjects" is now:<br />
<epp:phrase id="viewtitle_eprint_subjects_menu_1">Browse by Subject and Year</epp:phrase><br />
<br />
if there's a second level menu, configure it with:<br />
<epp:phrase id="viewtitle_eprint_subjects_menu_2">Browse by Year where Subject is "<epc:pin name="value1" />"</epp:phrase><br />
<br />
The actual list page title is configured like this:<br />
<epp:phrase id="viewtitle_eprint_subjects_list">Items where Subject is "<epc:pin name="value1" />" and <br />
Year is <epc:pin name="value2" /> (Grouped by <epc:pin name="grouping" />)</epp:phrase><br />
<br />
=== cfg.d/indexing.pl ===<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster.<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=6008New Features in EPrints 3.12008-04-10T10:43:59Z<p>WikiSysop: /* cfg.d/views.pl */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/views.pl ===<br />
<br />
The "subheadings" option has been '''replaced''' by the variations heading. This only allows one level of subheading but is much faster.<br />
<br />
=== lang/en/phrases/views.xml ===<br />
<br />
The way the titles of views pages are configured has '''changed'''.<br />
<br />
The title of the first page of the view with id "subjects" is now:<br />
<epp:phrase id="viewtitle_eprint_subjects_menu_1">Browse by Subject and Year</epp:phrase><br />
<br />
if there's a second level menu, configure it with:<br />
<epp:phrase id="viewtitle_eprint_subjects_menu_2">Browse by Year where Subject is "<epc:pin name="value1" />"</epp:phrase><br />
<br />
The <br />
<epp:phrase id="viewtitle_eprint_subjects_list">Items where Subject is "<epc:pin name="value1" />" and Year is <epc:pin name="value2" /> (Grouped by <epc:pin name="grouping" />)</epp:phrase><br />
<br />
=== cfg.d/indexing.pl ===<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster.<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Upgrading_EPrints_3_versions&diff=6007Upgrading EPrints 3 versions2008-04-09T16:46:05Z<p>WikiSysop: /* Upgrading 3.0.x to 3.1.x */</p>
<hr />
<div>EPrints developer Christopher Gutteridge gives the following instructions:<br />
<br />
== Upgrading 3.0.x to 3.0.y ==<br />
<br />
This is very easy - just run <tt>configure</tt> with the <br />
<tt>--prefix</tt> set to the location of the current repo (you may also need to set the --with-user and --with-group options). Then run install.pl to upgrade the software. Then run<br />
<br />
epadmin upgrade REPOID<br />
<br />
For each repository to update the database. Normally minor updates would not update the db at all. In this case all it does is add an SQL index to make things go faster. Restart the webserver in indexer after an upgrade. (or better, shut them off before you start to upgrade)<br />
<br />
(lightly edited from [http://www.eprints.org/tech.php/6598.html], 2007-04-13 to eprints-tech)<br />
<br />
== Upgrading 3.0.x to 3.1.x ==<br />
<br />
This is not yet widely tested, so at your own risk. Initial notes on 3.1.0-beta-2.<br />
* large repositories can take a significant chunk of time to run epadmin upgrade (many minutes)<br />
* "Views" get a little screwed up as the new configuration options are slightly altered.<br />
* [[New Features in EPrints 3.1]] has a list of suggested configuration changes. The "variations" option replaces "subheadings" option.<br />
<br />
Known issues:<br />
* epadmin upgrade reports lots of SQL errors, but these don't cause any problems <br />
* VLit plugin is broken <br />
* beta-2 has a bug which means "Smith, J" searches don't work on names but searching "Smith" does.<br />
* "include" option in view.pl is being ignored.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=6006New Features in EPrints 3.12008-04-09T16:41:42Z<p>WikiSysop: /* New Document Formats */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/views.pl ===<br />
<br />
The "subheadings" option has been '''replaced''' by the variations heading. This only allows one level of subheading but is much faster.<br />
<br />
=== cfg.d/indexing.pl ===<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster.<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Upgrading_EPrints_3_versions&diff=6005Upgrading EPrints 3 versions2008-04-09T16:40:31Z<p>WikiSysop: /* Upgrading 3.0.x to 3.1.x */</p>
<hr />
<div>EPrints developer Christopher Gutteridge gives the following instructions:<br />
<br />
== Upgrading 3.0.x to 3.0.y ==<br />
<br />
This is very easy - just run <tt>configure</tt> with the <br />
<tt>--prefix</tt> set to the location of the current repo (you may also need to set the --with-user and --with-group options). Then run install.pl to upgrade the software. Then run<br />
<br />
epadmin upgrade REPOID<br />
<br />
For each repository to update the database. Normally minor updates would not update the db at all. In this case all it does is add an SQL index to make things go faster. Restart the webserver in indexer after an upgrade. (or better, shut them off before you start to upgrade)<br />
<br />
(lightly edited from [http://www.eprints.org/tech.php/6598.html], 2007-04-13 to eprints-tech)<br />
<br />
== Upgrading 3.0.x to 3.1.x ==<br />
<br />
This is not yet widely tested, so at your own risk. Initial notes on 3.1.0-beta-2.<br />
* epadmin upgrade reports lots of SQL errors, but these don't cause any problems (and will be suppressed by -rc-1)<br />
* large repositories can take a significant chunk of time to run epadmin upgrade (many minutes)<br />
* "Views" get a little screwed up as the new configuration options are slightly altered.<br />
* [[New Features in EPrints 3.1]] has a list of suggested configuration changes. The "variations" option replaces "subheadings" option.<br />
* VLit plugin is broken (needs fixing before release)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Upgrading_EPrints_3_versions&diff=5994Upgrading EPrints 3 versions2008-04-07T15:25:16Z<p>WikiSysop: /* Upgrading 3.0.x to 3.1.x */</p>
<hr />
<div>EPrints developer Christopher Gutteridge gives the following instructions:<br />
<br />
== Upgrading 3.0.x to 3.0.y ==<br />
<br />
This is very easy - just run <tt>configure</tt> with the <br />
<tt>--prefix</tt> set to the location of the current repo (you may also need to set the --with-user and --with-group options). Then run install.pl to upgrade the software. Then run<br />
<br />
epadmin upgrade REPOID<br />
<br />
For each repository to update the database. Normally minor updates would not update the db at all. In this case all it does is add an SQL index to make things go faster. Restart the webserver in indexer after an upgrade. (or better, shut them off before you start to upgrade)<br />
<br />
(lightly edited from [http://www.eprints.org/tech.php/6598.html], 2007-04-13 to eprints-tech)<br />
<br />
== Upgrading 3.0.x to 3.1.x ==<br />
<br />
This is not yet widely tested, so at your own risk. Initial notes on 3.1.0-beta-2.<br />
* epadmin upgrade reports lots of SQL errors, but these don't cause any problems (and will be suppressed by -rc-1)<br />
* large repositories can take a significant chunk of time to run epadmin upgrade (many minutes)<br />
* "Views" get a little screwed up as the new configuration options are slightly altered.<br />
* [[New Features in EPrints 3.1]] has a list of suggested configuration changes.<br />
* VLit plugin is broken (needs fixing before release)</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Upgrading_EPrints_3_versions&diff=5993Upgrading EPrints 3 versions2008-04-07T15:16:31Z<p>WikiSysop: </p>
<hr />
<div>EPrints developer Christopher Gutteridge gives the following instructions:<br />
<br />
== Upgrading 3.0.x to 3.0.y ==<br />
<br />
This is very easy - just run <tt>configure</tt> with the <br />
<tt>--prefix</tt> set to the location of the current repo (you may also need to set the --with-user and --with-group options). Then run install.pl to upgrade the software. Then run<br />
<br />
epadmin upgrade REPOID<br />
<br />
For each repository to update the database. Normally minor updates would not update the db at all. In this case all it does is add an SQL index to make things go faster. Restart the webserver in indexer after an upgrade. (or better, shut them off before you start to upgrade)<br />
<br />
(lightly edited from [http://www.eprints.org/tech.php/6598.html], 2007-04-13 to eprints-tech)<br />
<br />
== Upgrading 3.0.x to 3.1.x ==<br />
<br />
This is not yet widely tested, so at your own risk. Initial notes on 3.1.0-beta-2.<br />
* epadmin upgrade reports lots of SQL errors, but these don't cause any problems (and will be suppressed by -rc-1)<br />
* large repositories can take a significant chunk of time to run epadmin upgrade (many minutes)<br />
* "Views" get a little screwed up as the new configuration options are slightly altered.<br />
* [[New Features in EPrints 3.1]] has a list of suggested configuration changes.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5992New Features in EPrints 3.12008-04-07T12:31:00Z<p>WikiSysop: /* Handy Hooks */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/indexing.pl ===<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster.<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5991New Features in EPrints 3.12008-04-07T12:30:49Z<p>WikiSysop: /* New Document Formats */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/indexing.pl ===<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster.<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5990New Features in EPrints 3.12008-04-07T12:30:28Z<p>WikiSysop: /* eprint_fields.pl */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/indexing.pl<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster. <br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== cfg.d/eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5989New Features in EPrints 3.12008-04-07T12:30:06Z<p>WikiSysop: /* Changes to default configuration */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to repository configuration =<br />
We've made some changes to the configuration of a new repository. These will not be automatically applied to your current repositories when upgrading.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/indexing.pl<br />
A new version of this was added in the 3.0 series, but if you're using an early 3.0 version of this file, then replace it with the one that comes with 3.1 - it's much faster. <br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5988New Features in EPrints 3.12008-04-07T12:27:42Z<p>WikiSysop: </p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to default configuration =<br />
These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5987New Features in EPrints 3.12008-04-07T12:25:57Z<p>WikiSysop: /* Changes to default configuration */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to default configuration =<br />
These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
== Suggested Changes ==<br />
If upgrading from 3.0 to 3.1, the following changes to your own configuration are suggested to gain the features described above.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt> - this now chops the end of very long URLs for nicer page rendering.<br />
* related_url: <tt>'render_value' => 'EPrints::Extras::render_related_url'</tt> - this is a renderer specifically for this field. It links the word "author", or "publisher", etc. to the URL. If no type is specified, it links the URL (truncated if over 40 chars).<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5986New Features in EPrints 3.12008-04-07T12:21:54Z<p>WikiSysop: /* Changes to default configuration */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to default configuration =<br />
These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
=== New Document Formats ===<br />
Added new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video. <br />
* lang/en/phrases/document_formats.xml<br />
* namedsets/document<br />
<br />
=== cfg.d/search.pl ===<br />
* added documents.format to advanced search <br />
* changed all searches on "userid" to search "userid.username" instead. Another good option might be userid.name or even userid.usertype<br />
* Most earches are now configured by default to show zero results (rather than returning to the search form). The option to add to searches in search.pl is <tt>show_zero_results => 1</tt>. This is handy for people who want to make a saved search, even if there were no results yet,.<br />
<br />
=== cfg.d/roles.pl ===<br />
* Added the "edit-config" role to admin users.<br />
<br />
=== workflows/eprint/default.xml ===<br />
* added "content" to the "Upload" component, as the first field (just before "format").<br />
<br />
=== namedsets/eprint_relation ===<br />
This is a new file which describes the options in the new "document.content" field. Add this file if you enabled the field in the workflow.<br />
<br />
=== workflows/user/default.xml ===<br />
* Removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
* Added user.roles to the "usertype" stage, so it's only editable by people who can also set the usertype.<br />
<br />
=== issues.xml ===<br />
This is a new (optional) configuration file which defines some simple issues to warn about in live eprints.<br />
<br />
=== eprint_fields.pl ===<br />
We applied some of the new Extras render and order methods:<br />
* title field: <tt>'make_single_value_orderkey' => 'EPrints::Extras::english_title_orderkey'</tt> - so when ordering by title, leading "a", "an" and "the" are ignored. If you add this as an upgrade you'll need to run <tt>epadmin reorder <i>repositoryid</i> eprint</tt><br />
* id_number field: <tt>'render_value' => 'EPrints::Extras::render_possible_doi'</tt> - which links to the DOI resolver if the field looks like a DOI.<br />
* offical_url: <tt>'render_value' => 'EPrints::Extras::render_url_truncate_end'</tt><br />
* some eprint fields now use the new Extras for ordering and rendering:<br />
** related_urls uses the related urls renderer.<br />
** official_url uses the end-truncating URL renderer.<br />
** title now uses english_title_orderkey<br />
** id_number uses render_possible_doi<br />
<br />
== Other Changes to the default configuration ==<br />
These are changes from 3.0 which you probably don't need to bother applying when upgrading.<br />
<br />
=== cfg.d/eprint_fields_automatic.pl ===<br />
* Changed thesis to only be set to "unpub" if its' not yet defined. Thesis are not always unpublished.<br />
<br />
=== Contributor Field ===<br />
The contributor field is like the creators field, but each contributor has a "type" set (with a default list of about 200 possible types of contribution. This field is not added to the workflow, by default, as it's more than most sites need. We suggest trimming the contributor type list down, but we started with a big list to ensure commonality of the values over all repositories using it.<br />
* eprint_files.pl: added contributor field<br />
* namedsets/contributor_type: List of all possible types of contributor.<br />
* lang/en/phrases/eprint_fields.xml: Added related phrases.<br />
* workflows/eprint/default.xml: Added the field in a comment, so people can add it if needed.<br />
<br />
=== Homepage ===<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
<br />
=== Comments ===<br />
* Some cfg.d/*.pl files gained additional example code. Eg. user_roles.pl</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5985New Features in EPrints 3.12008-04-07T11:10:11Z<p>WikiSysop: /* New Features */</p>
<hr />
<div>= New Features =<br />
<br />
Important note. Some new features will be enabled in NEW repositories, but if you upgrade you will need to modify your configuration to use them. We strongly recommend you review the "changes to default configuration" section at the end of this page, and apply them to your configuration, where appropriate.<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== New field-rendering tools ==<br />
We've added some new field renderers to EPrints::Extras. If you're upgrading, you'll need to add these to eprint_fields.pl by hand.<br />
* renderer for URLs which truncates very long URLs at the end<br />
* renderer for URLs which truncates very long URLs in the middle<br />
* renderer for the related-urls field to lay out the values more sensibly.<br />
* render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
<br />
== Issues tracking system ==<br />
The new issues system allows the discovery of eprints with issues. For example, duplicate titles, or an item from five years ago still listed as "in press". You can configure the issues system via a simple XML file, similar to the citation file format. More richly specified issues discovery can be achieved using the new issues-plugins system.<br />
* A issues_audit script is run nightly to discover and note issues. Issues which were there last time, but not there today are marked as "resolved" so you can review the resolution time. This audits items in the live archive and review buffer.<br />
* An Issues Tab on the eprint control page shows the current logged issues, and also a live list of issues (although not all issues, such as a search for similar titles, can currently be done "on the fly")<br />
* An Issues Search tool to search the <br />
* New "Issues" system and plugins, with a tab on eprints and an issues search. You can order the list of items with issues by the number of issues, or by the most recently discovered issues.<br />
<br />
=== Planned extensions to the issues system ===<br />
These are not yet implemented, but we may provide as a set of plugins to 3.1.<br />
* Tool to allow QA staff to mark auto-discovered issues as "ignored". For example, two items which really DO have the same title.<br />
* Tool to allow staff to add issues by hand, and mark these issues as resolved.<br />
<br />
== Uncategorised features ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added. You're not restricted to the ones we think our useful - eg. "fullsize" is handy to add to get a large image of the front page of documents.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns. This makes search pages much more tidy.<br />
* Added config option to set the citation style used in in saved search emails.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
<br />
= Changes to default configuration =<br />
These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
* added contributor field with a related nameset for type of contributor.<br />
* new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
* added documents.format to eprint search<br />
* added several more sub-object searches to default cfg.<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
* Searches are now configured by default to show zero results (rather than returning to the search form).<br />
* admin users gain role "edit-config"<br />
* some eprint fields now use the new Extras for ordering and rendering:<br />
** related_urls uses the related urls renderer.<br />
** official_url uses the end-truncating URL renderer.<br />
** title now uses english_title_orderkey<br />
** id_number uses render_possible_doi<br />
* added document.content to the workflow<br />
* Added user.roles to the workflow (for admins to edit)<br />
* thesis only defaults to unpublished, not forced to be unpublished.<br />
* added a default issues.xml file to spot some common issues.<br />
* removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
<br />
Phew. Enjoy.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Files/EPrints_3.1-beta-1&diff=5984Files/EPrints 3.1-beta-12008-04-07T10:56:05Z<p>WikiSysop: Redirecting to New Features in EPrints 3.1</p>
<hr />
<div>#REDIRECT [[New Features in EPrints 3.1]]</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=Files/EPrints_3.1-beta-2&diff=5983Files/EPrints 3.1-beta-22008-04-07T10:55:52Z<p>WikiSysop: Redirecting to New Features in EPrints 3.1</p>
<hr />
<div>#REDIRECT [[New Features in EPrints 3.1]]</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5980New Features in EPrints 3.12008-04-07T01:20:39Z<p>WikiSysop: /* Toolbox */</p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
== Other odds and ends ==<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added - eg. fullsize.<br />
* Added some new Extra render fields:<br />
** renderer for URLs which truncates very long URLs at the end<br />
** renderer for URLs which truncates very long URLs in the middle<br />
** renderer for the related-urls field to lay out the values more sensibly.<br />
** render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
* Added config option to set citation style sent out in saved searches.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
* New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
** EPrint Tab<br />
** Audit Script<br />
** Issues Search<br />
** Issues Plugins<br />
<br />
= Changes to default configuration =<br />
These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
* added contributor field with a related nameset for type of contributor.<br />
* new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
* added documents.format to eprint search<br />
* added several more sub-object searches to default cfg.<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
* Searches are now configured by default to show zero results (rather than returning to the search form).<br />
* admin users gain role "edit-config"<br />
* some eprint fields now use the new Extras for ordering and rendering:<br />
** related_urls uses the related urls renderer.<br />
** official_url uses the end-truncating URL renderer.<br />
** title now uses english_title_orderkey<br />
** id_number uses render_possible_doi<br />
* added document.content to the workflow<br />
* Added user.roles to the workflow (for admins to edit)<br />
* thesis only defaults to unpublished, not forced to be unpublished.<br />
* added a default issues.xml file to spot some common issues.<br />
* removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
<br />
Phew. Enjoy.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5979New Features in EPrints 3.12008-04-07T01:10:44Z<p>WikiSysop: </p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
* And you can define a new role. These are hats for assigning to individual users. For example a "edit item in buffer, but don't approve" hat.<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
* oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
* New types of "thumbnail" format can be added - eg. fullsize.<br />
* Added some new Extra render fields:<br />
** renderer for URLs which truncates very long URLs at the end<br />
** renderer for URLs which truncates very long URLs in the middle<br />
** renderer for the related-urls field to lay out the values more sensibly.<br />
** render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
* Added EPrints::Extras::english_title_orderkey - which can be used to cause a field to be sorted, ignoring a leading a/an/the<br />
* added importid to eprints to link them to the related import object.<br />
* added source_id to eprints to describe the id in the source repository.<br />
* Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
* Added config option to set citation style sent out in saved searches.<br />
* New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
* New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
** EPrint Tab<br />
** Audit Script<br />
** Issues Search<br />
** Issues Plugins<br />
<br />
= Changes to default configuration =<br />
These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
* added contributor field with a related nameset for type of contributor.<br />
* new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
* added documents.format to eprint search<br />
* added several more sub-object searches to default cfg.<br />
* Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
* Searches are now configured by default to show zero results (rather than returning to the search form).<br />
* admin users gain role "edit-config"<br />
* some eprint fields now use the new Extras for ordering and rendering:<br />
** related_urls uses the related urls renderer.<br />
** official_url uses the end-truncating URL renderer.<br />
** title now uses english_title_orderkey<br />
** id_number uses render_possible_doi<br />
* added document.content to the workflow<br />
* Added user.roles to the workflow (for admins to edit)<br />
* thesis only defaults to unpublished, not forced to be unpublished.<br />
* added a default issues.xml file to spot some common issues.<br />
* removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.<br />
<br />
Phew. Enjoy.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5978New Features in EPrints 3.12008-04-07T01:03:49Z<p>WikiSysop: </p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history:owner". <br />
* A "role" is a bunch of related privs that may be assigned to a user or usertype.<br />
* A "user" has a "usertype". The user_roles.pl config file defines what roles are assigned to each usertype.<br />
Now for the changes in 3.1:<br />
* You can add (and remove) individual privs in the user_roles.pl<br />
* Also a new field in User can be used to assign <br />
* New roles can be configured (roles are a set of related privileges)<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5977New Features in EPrints 3.12008-04-06T23:37:14Z<p>WikiSysop: </p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* When a user logs out.<br />
* When the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilege handling ==<br />
First, a quick refresher on the way privileges, roles and usertypes relate to each other:<br />
* A privilege is a very fine-grained right. It allows, for example, a user to view the "history" tab on eprints they submitted, while the eprint is in the inbox. In this case "eprint/inbox/history=user"<br />
* New roles can be configured (roles are a set of related privileges)<br />
<br />
== Templates ==<br />
Additional templates can be added and used instead of the default template. You can configure a search and view to use such a template. You can also apply a different template to a static page, abstract page or screen plugin. <br />
A good application of this new feature would be to create a view and search filtered to only show items from the university maths department, and give that view and search a template in the style of the maths dept. <br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
* Abstract pages can now be refreshed using epadmin or the web-interface.<br />
specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5976New Features in EPrints 3.12008-04-06T23:11:38Z<p>WikiSysop: /* Redesigned "Manage Deposits" and "Review" pages */</p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== "Abstract" pages (the page which describes an eprint) ==<br />
* These can now be refreshed using epadmin or the web-interface.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* when a user logs out.<br />
* when the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
== Configuration ==<br />
* New form based interface for admins to add metadata fields via the web.<br />
* Admins may view configuration via the web.<br />
* Admins may modify configuration via the web.<br />
* Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
* Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
* When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
* errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
* epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
* Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
* Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
== Administration ==<br />
* Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
* New buttons on the admin screen:<br />
** send a test email (to check outgoing email is working).<br />
** refresh the abstracts (on request, not right now)<br />
** refresh the views (on request, not right now)<br />
** reload the all configuration files.<br />
* Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
* New status screen to show database schema (replacing explain_sql)<br />
<br />
== Semantic Web/Complex Objects ==<br />
* We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
* EP3 XML Export now adds the URI to each record.<br />
* URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
* URIs for eprints redirect the abstract page for that eprint.<br />
* URIs for documents redirect the base URL of that document.<br />
* Added a "Content" field to documents to describe their relationship to the main record.<br />
* Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
== Indexing ==<br />
* Significant improvemnts to the speed items are indexed.<br />
<br />
== Autocompletion ==<br />
* Can now auto-complete on "select" fields.<br />
* New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
* Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
== Searching ==<br />
* Float fields are now searchable (and searches can be mixed with ints)<br />
* search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
* Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
== Improved privilage handling ==<br />
<br />
== Templates ==<br />
<br />
== Toolbox ==<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
<br />
- Support for alternate templates for a view, subject, abstract page and static file. Also screens can tell their processor to use a different template file.<br />
- specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- abstracts now regenerate if older than a set date.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5975New Features in EPrints 3.12008-04-06T23:00:58Z<p>WikiSysop: /* Submission Process */</p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== "Abstract" pages (the page which describes an eprint) ==<br />
* These can now be refreshed using epadmin or the web-interface.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* when a user logs out.<br />
* when the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
== Export ==<br />
* Existing export plugins have been improved in terms of speed and memory usage.<br />
* The BibTeX export no longer requires an external module.<br />
* EAP (SWAP) Plugin - The EPrints Application Profile.<br />
* XSLT based export plugins support.<br />
* IDs Plugin - just export the IDs of each item.<br />
* ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
* DatabaseSchema Plugin - exports the database schema.<br />
* Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
== Import ==<br />
* XSLT import plugin system<br />
* Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
* Added import dataset for keeping track of imports.<br />
* In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
* Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
== Search ==<br />
* Search by a sub-object field (eg. search eprints by the format of their documents)<br />
* Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
== Database ==<br />
* Abstracted database layer to allow support of other databases.<br />
* Oracle Support!<br />
* Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
* EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
* Messages and login_tickets are now datasets.<br />
* epadmin has a command to create anything missing in the database. Handy if you want to add a field, you no longer have to fiddle with the SQL.<br />
<br />
== Redesigned "Manage Deposits" and "Review" pages ==<br />
* Columns may now be moved left and right.<br />
* Columns may be deleted.<br />
* A column may be added for any eprint field.<br />
* Changes to columns are saved on the user record.<br />
* Added icons for common actions (edit, deposit, etc.)<br />
<br />
Configuration<br />
- New form based interface for admins to add metadata fields via the web.<br />
- Admins may view configuration via the web.<br />
- Admins may modify configuration via the web.<br />
- Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
- Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
- When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
- errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
- epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
- Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
- Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
Administration<br />
- Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
- New buttons on the admin screen:<br />
-- send a test email (to check outgoing email is working).<br />
-- refresh the abstracts (on request, not right now)<br />
-- refresh the views (on request, not right now)<br />
-- reload the all configuration files.<br />
- Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
- New status screen to show database schema (replacing explain_sql)<br />
<br />
Semantic Web/Complex Objects<br />
- We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
- EP3 XML Export now adds the URI to each record.<br />
- URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
- URIs for eprints redirect the abstract page for that eprint.<br />
- URIs for documents redirect the base URL of that document.<br />
- Added a "Content" field to documents to describe their relationship to the main record.<br />
- Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
Indexing<br />
- Significant improvemnts to the speed items are indexed.<br />
<br />
Autocompletion<br />
- Can now auto-complete on "select" fields.<br />
- New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
- Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
Searching<br />
- Float fields are now searchable (and searches can be mixed with ints)<br />
- search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
- Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
Improved privilage handling<br />
<br />
Templates<br />
<br />
Toolbox<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
<br />
*******************************************<br />
- Added the toolbox command line and cgi tools.<br />
- Support for alternate templates for a view, subject, abstract page and static file. Also screens can tell their processor to use a different template file.<br />
- specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- abstracts now regenerate if older than a set date.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5974New Features in EPrints 3.12008-04-06T22:56:13Z<p>WikiSysop: /* STRING.strlen() */</p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== "Abstract" pages (the page which describes an eprint) ==<br />
* These can now be refreshed using epadmin or the web-interface.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings.<br />
<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
=== today() ===<br />
The today() function takes no parameters and returns the current date.<br />
=== DATE.datemath( CHANGE, TYPE ) ===<br />
CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
For example:<br />
today().datemath( -6, "month" )<br />
would return a date six months before today.<br />
<br />
== Handy Hooks ==<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
* when a user logs out.<br />
* when the thumbnails for a document are (re)generated.<br />
<br />
== Submission Process ==<br />
* Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
* Document Upload offers "capture from URL".<br />
* Documents now have an option to convert them to any format available in the convert plugins.<br />
* There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
* Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
* Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
Export<br />
- Existing export plugins have been improved in terms of speed and memory usage.<br />
- The BibTeX export no longer requires an external module.<br />
- EAP (SWAP) Plugin - The EPrints Application Profile.<br />
- XSLT export plugins supported.<br />
- IDs Plugin - just export the IDs of each item.<br />
- ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
- DatabaseSchema Plugin - exports the database schema.<br />
- Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
Import<br />
- XSLT import plugin system<br />
- Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
- Added import dataset for keeping track of imports.<br />
- In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
- Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
Search<br />
- Search by a sub-object field (eg. search eprints by the format of their documents)<br />
- Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
Database<br />
- Abstracted database layer to allow support of other databases.<br />
- Oracle Support!<br />
- Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
- EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
- Messages and login_tickets are now datasets.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
<br />
<br />
Redesigned "Manage Deposits" and "Review" pages.<br />
- Columns may now be moved left and right.<br />
- Columns may be deleted.<br />
- A column may be added for any eprint field.<br />
- Changes to columns are saved on the user record.<br />
- Added icons for common actions (edit, deposit, etc.)<br />
<br />
Configuration<br />
- New form based interface for admins to add metadata fields via the web.<br />
- Admins may view configuration via the web.<br />
- Admins may modify configuration via the web.<br />
- Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
- Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
- When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
- errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
- epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
- Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
- Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
Administration<br />
- Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
- New buttons on the admin screen:<br />
-- send a test email (to check outgoing email is working).<br />
-- refresh the abstracts (on request, not right now)<br />
-- refresh the views (on request, not right now)<br />
-- reload the all configuration files.<br />
- Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
- New status screen to show database schema (replacing explain_sql)<br />
<br />
Semantic Web/Complex Objects<br />
- We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
- EP3 XML Export now adds the URI to each record.<br />
- URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
- URIs for eprints redirect the abstract page for that eprint.<br />
- URIs for documents redirect the base URL of that document.<br />
- Added a "Content" field to documents to describe their relationship to the main record.<br />
- Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
Indexing<br />
- Significant improvemnts to the speed items are indexed.<br />
<br />
Autocompletion<br />
- Can now auto-complete on "select" fields.<br />
- New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
- Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
Searching<br />
- Float fields are now searchable (and searches can be mixed with ints)<br />
- search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
- Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
Improved privilage handling<br />
<br />
Templates<br />
<br />
Toolbox<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
<br />
*******************************************<br />
- Added the toolbox command line and cgi tools.<br />
- Support for alternate templates for a view, subject, abstract page and static file. Also screens can tell their processor to use a different template file.<br />
- specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- abstracts now regenerate if older than a set date.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5973New Features in EPrints 3.12008-04-06T22:53:40Z<p>WikiSysop: /* <epc:foreach> */</p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== "Abstract" pages (the page which describes an eprint) ==<br />
* These can now be refreshed using epadmin or the web-interface.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<pre><nowiki><br />
<ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki></pre><br />
which would resolve to something like:<br />
<pre><nowiki><br />
<ol><br />
<li>(Smith, John)</li><br />
<li>(Jones, Davy)</li><br />
</ol></nowiki></pre><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings. eg.<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
- Added "DATE" variable type to EPScript.<br />
- Added today() function which returns the current date.<br />
- Added DATE.datemath( CHANGE, TYPE ) - CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
Handy Hooks<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
- when a user logs out.<br />
- when the thumbnails for a document are (re)generated.<br />
<br />
Submission Process<br />
- Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
- Document Upload offers "capture from URL".<br />
- Documents now have an option to convert them to any format available in the convert plugins.<br />
- There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
- Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
- Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
Export<br />
- Existing export plugins have been improved in terms of speed and memory usage.<br />
- The BibTeX export no longer requires an external module.<br />
- EAP (SWAP) Plugin - The EPrints Application Profile.<br />
- XSLT export plugins supported.<br />
- IDs Plugin - just export the IDs of each item.<br />
- ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
- DatabaseSchema Plugin - exports the database schema.<br />
- Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
Import<br />
- XSLT import plugin system<br />
- Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
- Added import dataset for keeping track of imports.<br />
- In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
- Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
Search<br />
- Search by a sub-object field (eg. search eprints by the format of their documents)<br />
- Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
Database<br />
- Abstracted database layer to allow support of other databases.<br />
- Oracle Support!<br />
- Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
- EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
- Messages and login_tickets are now datasets.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
<br />
<br />
Redesigned "Manage Deposits" and "Review" pages.<br />
- Columns may now be moved left and right.<br />
- Columns may be deleted.<br />
- A column may be added for any eprint field.<br />
- Changes to columns are saved on the user record.<br />
- Added icons for common actions (edit, deposit, etc.)<br />
<br />
Configuration<br />
- New form based interface for admins to add metadata fields via the web.<br />
- Admins may view configuration via the web.<br />
- Admins may modify configuration via the web.<br />
- Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
- Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
- When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
- errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
- epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
- Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
- Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
Administration<br />
- Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
- New buttons on the admin screen:<br />
-- send a test email (to check outgoing email is working).<br />
-- refresh the abstracts (on request, not right now)<br />
-- refresh the views (on request, not right now)<br />
-- reload the all configuration files.<br />
- Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
- New status screen to show database schema (replacing explain_sql)<br />
<br />
Semantic Web/Complex Objects<br />
- We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
- EP3 XML Export now adds the URI to each record.<br />
- URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
- URIs for eprints redirect the abstract page for that eprint.<br />
- URIs for documents redirect the base URL of that document.<br />
- Added a "Content" field to documents to describe their relationship to the main record.<br />
- Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
Indexing<br />
- Significant improvemnts to the speed items are indexed.<br />
<br />
Autocompletion<br />
- Can now auto-complete on "select" fields.<br />
- New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
- Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
Searching<br />
- Float fields are now searchable (and searches can be mixed with ints)<br />
- search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
- Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
Improved privilage handling<br />
<br />
Templates<br />
<br />
Toolbox<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
<br />
*******************************************<br />
- Added the toolbox command line and cgi tools.<br />
- Support for alternate templates for a view, subject, abstract page and static file. Also screens can tell their processor to use a different template file.<br />
- specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- abstracts now regenerate if older than a set date.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysophttps://wiki.eprints.org/w/index.php?title=New_Features_in_EPrints_3.1&diff=5972New Features in EPrints 3.12008-04-06T22:52:42Z<p>WikiSysop: /* <epc:foreach> */</p>
<hr />
<div>= New Features =<br />
<br />
== Views ==<br />
The views part of EPrints has had a significant rewrite.<br />
* Significant speed improvements<br />
* On the command line, epadmin refresh_views, and a button on the Admin web page, which both cause all view pages to be regenerated next time they are requested.<br />
* Groupings: You may configure alternate groupings for the views pages. Eg. group results by type, or by creators first initial.<br />
* Views can be set to regenerate if they are requested and the file on disk is older than a specified age.<br />
* Generate_views can be limited to just one view or language. Also just the menu pages, or just the lists-of-citations pages.<br />
<br />
== "Abstract" pages (the page which describes an eprint) ==<br />
* These can now be refreshed using epadmin or the web-interface.<br />
<br />
== XML based Scripting ==<br />
=== <epc:foreach> ===<br />
This is a new tag for XML files: <epc:foreach> takes a list (eg. the value of a "multiple" field) and returns the contents of the tag once for each value in the list.eg.<br />
<nowiki><ol><br />
<epc:foreach expr="creators_name" iterator="name"><br />
<li>(<epc:print expr="$name" />)</li><br />
</epc:foreach><br />
</ol></nowiki><br />
which would resolve to something like:<br />
<nowiki><ol><li>(Smith, John)</li><li>(Jones, Davy)</li></ol></nowiki><br />
<br />
=== STRING.strlen()===<br />
This just returns the length of a string. Useful in the issues.xml for identifying very long or short strings. eg.<spc:print expr="title.strlen()" /><br />
would return the number of characters in the title field.<br />
- Added "DATE" variable type to EPScript.<br />
- Added today() function which returns the current date.<br />
- Added DATE.datemath( CHANGE, TYPE ) - CHANGE is a positive or negative value and type is year, month or day. Returns the resulting date.<br />
Handy Hooks<br />
Hooks are easy ways to add some code to be run on certain events. New hooks are:<br />
- when a user logs out.<br />
- when the thumbnails for a document are (re)generated.<br />
<br />
Submission Process<br />
- Document Upload now allows upload+unpacking of .tgz or .zip files.<br />
- Document Upload offers "capture from URL".<br />
- Documents now have an option to convert them to any format available in the convert plugins.<br />
- There's a convert plugin to turn .doc into .pdf, which is available from the upload screen convert option.<br />
- Also plugins to convert PDFs and images to various image formats (png, jpg etc.)<br />
- Option to allow import plugins to caputre full text from URLs in the imported data.<br />
<br />
Export<br />
- Existing export plugins have been improved in terms of speed and memory usage.<br />
- The BibTeX export no longer requires an external module.<br />
- EAP (SWAP) Plugin - The EPrints Application Profile.<br />
- XSLT export plugins supported.<br />
- IDs Plugin - just export the IDs of each item.<br />
- ListUserEmails Plugin - lists the emails of a set of users. Only available to repository staff. This replaces the list_user_emails command.<br />
- DatabaseSchema Plugin - exports the database schema.<br />
- Plugin to Export history dataobjects in ical format. Potentially useful for preserving/sharing history in a standard format.<br />
<br />
Import<br />
- XSLT import plugin system<br />
- Import scripts can now download documents from a URL (mainly aimed at the EP3 XML format).<br />
- Added import dataset for keeping track of imports.<br />
- In the web interface, you can import from a file instead of just cut-and-pasting metadata.<br />
- Also, the Import screen has an import full text option, if web imports are enabled in the config.<br />
<br />
Search<br />
- Search by a sub-object field (eg. search eprints by the format of their documents)<br />
- Search by a related-object field (eg. search eprints by the name of the depositing user)<br />
<br />
Database<br />
- Abstracted database layer to allow support of other databases.<br />
- Oracle Support!<br />
- Writing objects which have not changed is now optimised to not actually write, speeding up some parts of the system.<br />
- EPrints fields may be marked as volatile. These fields can be modified without causing a change to the last_modified time of the eprint, the revision_id does not increase and no history event is created. These fields are useful for storing values which change frequently, such as citation counts or hit counts imported from an external tool.<br />
- Messages and login_tickets are now datasets.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
<br />
<br />
Redesigned "Manage Deposits" and "Review" pages.<br />
- Columns may now be moved left and right.<br />
- Columns may be deleted.<br />
- A column may be added for any eprint field.<br />
- Changes to columns are saved on the user record.<br />
- Added icons for common actions (edit, deposit, etc.)<br />
<br />
Configuration<br />
- New form based interface for admins to add metadata fields via the web.<br />
- Admins may view configuration via the web.<br />
- Admins may modify configuration via the web.<br />
- Phrases, Citations, Workflows, Templates and static files are automatically re-read if they are altered. This means no more running generate_static every five minutes (although you still need it to ADD files)<br />
- Buttons to refresh the configuration, the views and the abstracts, via the Admin page.<br />
- When creating a new repository, a db connection error doesn't abort the process, and you are offered a random password to use for the db account.<br />
- errors and warnings in executing code from .pl files now show correct line number and filename making debugging less annoying.<br />
- epadmin erase_data now recreates all tables, rather than drop and recreate the entire database.<br />
- Added plugin-masking so a local plugin can take the id of an existing plugin even though it has a different Perl class.<br />
- epadmin has a command to create anything missing in the database. Handy if you want to add a field.<br />
- Plugins can now be installed in a repository-specific plugins dir, although the perl package names must be unique.<br />
<br />
Administration<br />
- Batch editing: An administrator can perform a search and then set or modify values on all items which match the search.<br />
- New buttons on the admin screen:<br />
-- send a test email (to check outgoing email is working).<br />
-- refresh the abstracts (on request, not right now)<br />
-- refresh the views (on request, not right now)<br />
-- reload the all configuration files.<br />
- Staff can now queue an eprint for re-indexing via a button in the list of EPrint actions.<br />
- New status screen to show database schema (replacing explain_sql)<br />
<br />
Semantic Web/Complex Objects<br />
- We've assigned URI's to each object in each dataset, and you can get at them using $eprint->uri, $user->uri etc.<br />
- EP3 XML Export now adds the URI to each record.<br />
- URIs take the format <ARCHIVE_URL>/id/<datasetid>/<objectid> eg. http://foo.eprints.org/id/eprint/23<br />
- URIs for eprints redirect the abstract page for that eprint.<br />
- URIs for documents redirect the base URL of that document.<br />
- Added a "Content" field to documents to describe their relationship to the main record.<br />
- Added a "Relation" field to documents and eprints. This is a list of URI's and relationship type, and using several eprints records, complex objects can be described.<br />
<br />
Indexing<br />
- Significant improvemnts to the speed items are indexed.<br />
<br />
Autocompletion<br />
- Can now auto-complete on "select" fields.<br />
- New options for autocompletion to target cells in the row being autocompleted, and to hide & show HTML elements when the auto-completion is triggered.<br />
- Added some divs to the input forms to act as targets for the autocompletion and other javascript.<br />
<br />
Searching<br />
- Float fields are now searchable (and searches can be mixed with ints)<br />
- search cgi now understands the "EX" flag for exact matching. Not available via the form interface, but handy for some scripts.<br />
- Made it possible for search results to show zero matches (so you can create an export).<br />
<br />
Improved privilage handling<br />
<br />
Templates<br />
<br />
Toolbox<br />
The toolbox is a command line tool allows eprints and documents to be searched, queried and modified. Even adding files to documents. This is potentially very powerful as it allows a way to script reading and writing data without learning Perl. There's also a CGI interface, but it should be carefully secured before use.<br />
<br />
<br />
*******************************************<br />
- Added the toolbox command line and cgi tools.<br />
- Support for alternate templates for a view, subject, abstract page and static file. Also screens can tell their processor to use a different template file.<br />
- specifying privs can now be done at the level of individual privs.<br />
- Privs/roles can be set on individual users. - allowing hats to be assigned.<br />
- oai_accesslog script to allow users with a given privilage to get access to access-logs via OAI.- New random data generating script to create any amount of random eprints.<br />
- abstracts now regenerate if older than a set date.<br />
- New types of "thumbnail" format can be added - eg. fullsize.<br />
- Added some new Extra render fields:<br />
-- renderer for URLs which truncates very long URLs at the end<br />
-- renderer for URLs which truncates very long URLs in the middle<br />
-- renderer for the related-urls field to lay out the values more sensibly.<br />
-- render_possible_doi links to the DOI resolver if the field appears to be a DOI, otherwise doesn't.<br />
- New EPrints::Extras to add some useful ordering functions.<br />
-- english_title_orderkey - shifts a/an/the to the end of the sortkey. Also removes any non alphanumerics from the start of the title.<br />
- added importid to eprints to link them to the related import object.<br />
- added source_id to eprints to describe the id in the source repository.<br />
- Lists of checkboxes which are more than 5 items long are now rendered as two columns.<br />
- Added config option to set ciation style sent out in saved searches.<br />
- New document icons for zip, tgz, rtf, xml, ppt, video, audio.<br />
- New "Issues" system and plugins, with a tab on eprints and an issues search.<br />
-- EPrint Tab<br />
-- Audit Script<br />
-- Issues Search<br />
-- Issues Plugins<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
<br />
Changes to default configuration. These will not appear in your configuration, but you should consider applying any you like the sound of! See the lib/defaultcfg dir to see the default config files for a new repository.<br />
<br />
- added contributor field with a related nameset for type of contributor.<br />
- new default document formats: zip, tgz, rtf, xml, ppt, bz2, audio and video.<br />
- added documents.format to eprint search<br />
- added several more sub-object searches to default cfg.<br />
- Improved the message at the top of the default homepage to be more friendly and link to a "what next?" page in the wiki.<br />
- Searches are now configured by default to show zero results (rather than returning to the search form).<br />
- admin users gain role "edit-config"<br />
- some eprint fields now use the new Extras for ordering and rendering:<br />
-- related_urls uses the related urls renderer.<br />
-- official_url uses the end-truncating URL renderer.<br />
-- title now uses english_title_orderkey<br />
-- id_number uses render_possible_doi<br />
- added document.content to the workflow<br />
- thesis only defaults to unpublished, not forced to be unpublished.<br />
- added a default issues.xml file to spot some common issues.<br />
- removed item_fields and review_fields from the user workflow as these can now be modified more easily from the screens themselves.</div>WikiSysop