EPrints Documentation - User contributions [en-gb]

Customizing RSS Output

2007-12-06T10:56:37Z

Hk:

How to customize RSS output to show an institution's or person's last ''n'' publications.

This is valid for EPrints 2 only! In EPrints 3 RSS feeds are available for any search anyway.

RSS output is generated by <tt>/opt/eprints2/cgi/latest_tool</tt> (URL: <nowiki>http://<base_url>/perl/latest_tool</nowiki>). In the default configuration <tt>latest_tool</tt> will generate output for fixed searches (filters) only. These filters define both metadata fields and values searched in the archive configuration. One would have to add a filter to the archive configuration for every person or institution that would like its own RSS feed.

Instead, we add a new parameter <tt>allow_user_value</tt> to a latest_tool mode's configuration. When <tt>allow_user_value</tt> is set to "true" in the filter definition the value of the CGI parameter <tt>value</tt> will be searched for in the metadata fields that are defined in the archive configuration.

1. Edit <tt>/opt/eprints2/archives/<archive_id>/cfg/ArchiveConfig.pm</tt>'s "Latest_tool Configuration" section to read:

$c->{latest_tool_modes} = {
default => { citation => "neat" },
person => {
citation => "neat",
filters => [
{ meta_fields => [ "creators.id", "editors.id" ], value => "" }
],
allow_user_value => 1,
max => 10
},
institution => {
citation => "neat",
filters => [
{ meta_fields => [ "institutions" ], value => "" }
],
allow_user_value => 1,
max => 20
}
};

2. Alter <tt>/opt/eprints2/cgi/latest_tool</tt> (starting from line 45) to read:

if( defined $conf )
{
my $allow_user_value = 0;
foreach my $key (keys %{$conf} )
{
$citation = $conf->{"citation"} if( $key eq "citation" );
$filters = $conf->{"filters"} if( $key eq "filters" );
$allow_user_value = $conf->{"allow_user_value"} if( $key eq "allow_user_value" );
$max = $conf->{"max"} if( $key eq "max" );
}
if ( $allow_user_value ) {
my $value = $session->param( "value" );
if ( defined $value ) {
@$filters[0]->{"value"} = $value;
}
}
$class.= "_".$mode;
}
...

3. Restart Apache.

Your customized RSS feeds will be located at

*<nowiki>http://<base_url>/perl/latest_tool?mode=person</nowiki>

Customizing RSS Output

2007-12-06T10:56:18Z

Hk:

How to customize RSS output to show an institution's or person's last ''n'' publications.

This is valid for EPrints 2 only! in EPrints 3 RSS feeds are available for any search anyway.

RSS output is generated by <tt>/opt/eprints2/cgi/latest_tool</tt> (URL: <nowiki>http://<base_url>/perl/latest_tool</nowiki>). In the default configuration <tt>latest_tool</tt> will generate output for fixed searches (filters) only. These filters define both metadata fields and values searched in the archive configuration. One would have to add a filter to the archive configuration for every person or institution that would like its own RSS feed.

Instead, we add a new parameter <tt>allow_user_value</tt> to a latest_tool mode's configuration. When <tt>allow_user_value</tt> is set to "true" in the filter definition the value of the CGI parameter <tt>value</tt> will be searched for in the metadata fields that are defined in the archive configuration.

1. Edit <tt>/opt/eprints2/archives/<archive_id>/cfg/ArchiveConfig.pm</tt>'s "Latest_tool Configuration" section to read:

$c->{latest_tool_modes} = {
default => { citation => "neat" },
person => {
citation => "neat",
filters => [
{ meta_fields => [ "creators.id", "editors.id" ], value => "" }
],
allow_user_value => 1,
max => 10
},
institution => {
citation => "neat",
filters => [
{ meta_fields => [ "institutions" ], value => "" }
],
allow_user_value => 1,
max => 20
}
};

2. Alter <tt>/opt/eprints2/cgi/latest_tool</tt> (starting from line 45) to read:

if( defined $conf )
{
my $allow_user_value = 0;
foreach my $key (keys %{$conf} )
{
$citation = $conf->{"citation"} if( $key eq "citation" );
$filters = $conf->{"filters"} if( $key eq "filters" );
$allow_user_value = $conf->{"allow_user_value"} if( $key eq "allow_user_value" );
$max = $conf->{"max"} if( $key eq "max" );
}
if ( $allow_user_value ) {
my $value = $session->param( "value" );
if ( defined $value ) {
@$filters[0]->{"value"} = $value;
}
}
$class.= "_".$mode;
}
...

3. Restart Apache.

Your customized RSS feeds will be located at

*<nowiki>http://<base_url>/perl/latest_tool?mode=person</nowiki>

How to import users from another archive and keep their passwords

2007-10-24T06:27:48Z

Hk: Improvement to mysql command.

== Problem ==

You have a number of users that you want to transfer to another archive. However, no password information is contained in the XML file with the exported users. Therefore users are not able to login to the new archive.

== Solution ==

First import the users' data from the XML export file. Then (re)set their passwords. The password hashes are taken directly from the MySQL database.

== The Details ==

XML exports of users data do not include the password hashes. I guess this is for security reasons. Therefore, all passwords of the imported users are set to NULL. (I personally think it would be nice to have the pasword hashes included in the export file. At least when requested by a command line option.)

However, the following workaround went well for me:

First export user data as XML:

<pre>
bin/export old_archive user XML > somefile.xml
</pre>
Then retrieve the passwords in a handy format:

<pre>
mysql -u db_user -p old_archive_db --skip-column-names -e 'select concat("update user set password=\"", password, "\" where username=\"", username, "\";") from user;' > passwords.sql
</pre>

Import the users into the new archive:

<pre>
bin/import new_archive user XML somefile.xml
</pre>

Finally (re)set the passwords from the SQL file:

<pre>
mysql -u new_archive_user -p new_archive < passwords.sql
</pre>

How to import users from another archive and keep their passwords

2007-10-23T14:01:32Z

Hk: New HowTo

== Problem ==

You have a number of users that you want to transfer to another archive. However, no password information is contained in the XML file with the exported users. Therefore users are not able to login to the new archive.

== Solution ==

First import the users' data from the XML export file. Then (re)set their passwords. The password hashes are taken directly from the MySQL database.

== The Details ==

XML exports of users data do not include the password hashes. I guess this is for security reasons. Therefore, all passwords of the imported users are set to NULL. (I personally think it would be nice to have the pasword hashes included in the export file. At least when requested by a command line option.)

However, the following workaround went well for me:

First export user data as XML:

<pre>
bin/export old_archive user XML > somefile.xml
</pre>
Then retrieve the passwords in a handy format:

<pre>
mysql -u db_user -p old_archive_db -e 'select concat("update user set password=\"", password, "\" where username=\"", username, "\";") from user;' > passwords.sql
</pre>

Now delete the first line (table heading) of passwords.sql to leave only SQL statements.

Import the users into the new archive:

<pre>
bin/import new_archive user XML somefile.xml
</pre>

Finally (re)set the passwords from the SQL file:

<pre>
mysql -u new_archive_user -p new_archive < passwords.sql
</pre>

Compound field

2007-10-04T07:43:11Z

Hk: /* Database */

{{fieldtypes}}
__NOTOC__
== Inheritance ==
* [[Metadata]]
** [[Compound field]]

== Description ==

== Properties ==

{| border="1" cellpadding="3" cellspacing="0"
| name || default || description
|-
| '''fields''' || n/a || '''This property is always required.'''
|-
| '''fields_cache''' || n/a || '''This property is always required.'''
|-
| '''show_in_fieldlist''' || 0 || ...
|}

== Required Phrases ==

== Database ==

Each subfield within a compound field has its own table named <dataset>_<fieldname>_<subfieldname>. For example, the related URL for an EPrint (related_url) has a URL and a type, so would have tables named eprint_related_url_url and eprint_related_url_type.

The tables in this instance have the following structure:

eprint_related_url_url: eprintid INT(11), pos INT(11), related_url_url VARCHAR(255)
eprint_related_url_type: eprintid INT(11), pos INT(11), related_url_type VARCHAR(255)

eprintid is the ID of the EPrint to which the field applies, pos contains the position of the entry (starting at 0), and the remaining field uses the appropriate field type for the subfield (in this case VARCHAR(255) for both URL and type).

== API ==

Archives/ARCHIVEID/cfg/namedsets/

2007-09-17T12:50:21Z

Hk: Reverted edit of Av7Q2y, changed back to last version by WikiSysOp (spam delete)

{{dirs}}
These are files which contain lists of values for named set fields. namedset fields work just like set fields, except that their options are stored in one of these files, rather than directly in the field configuration. Spaces in these files are not recommended.

*'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/archives|archives]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID|ARCHIVEID]]/[[EPrints_Directory_Structure/eprints3/archives/ARCHIVEID/cfg|cfg]]/namedsets'''
** '''document''' - document types. Ideally these are mime types.
** '''eprint''' - eprint types. eg. article, book etc.
** '''languages''' - the languages used in the "language" field of documents. (this field is hidden, by default).
** '''licenses''' - options for the license in the document fields (eg. creative commons)
** '''security''' - options for the security level of a document
** '''user''' - types of user, eg "user" or "editor" or "admin".

The screen name for these is taken from a phrase of the form:
''setid''_typename_''value''

so the version of the "public" option of the security namedset which users see would be defined by the following phrase:
<epp:phrase id="security_typename_public">Anyone</epp:phrase>

HTTPS

2007-08-23T09:08:21Z

Hk: Deleted spam

#REDIRECT [[How to use EPrints with HTTPS]]

How much will it cost?

2007-08-23T09:05:36Z

Hk: spam delete

Estimating how much an eprints archive costs...

Basically the problem is that (so far) many archives are set up as

# a personal misson of a single person, who devotes spare time to it
# a research project side-effect. That is the funding is to set up an eprints archive and then do research based on it.

The main cost of setting up is staff time which is very hard to calculate but I would suggest as a minimum:

* £1000 - Good PC
* £0 - Software - it's all free, although getting Redhat Enterprise is probably worth the small cost.
* £1000 - per/year backup provision and network connectivity (wild guess!)

Staff time: I am assuming:

* Little or no quality checking performed by a human being on data being submitted
* The UNIX admin already knows how to run apache, perl, redhat linux, XML etc.
* The archive will run an (almost) default configuration of EPrints. The default is suitable for a university archive.

Setup: One week of skilled admin time to get a machine installed with redhat linux, the required libraries installed, eprints installed and an archive set up with minimal customisations (maybe a new webpage template and some fields removed). UK Estimate: ~£1000

Per Record: Once someone learns the basics, adding an eprint is about [http://eprints.ecs.soton.ac.uk/10688/ 15 minutes work], so cost depends on "value" of staff member doing the deposit. UK Estimate: ~£8

Most people ignore the cost-per-record as it's absorbed by many peoples time.

Also usually the staff costs will be increased by many many many meetings. The above is a theoretical minimum, assuming they just mostly take the default options.

== See Also ==

''CalTech Review and Cost Estimate'' (2001) [http://www.arl.org/sparc/pubs/enews/aug01.html#6]

Manual

2007-08-23T08:58:20Z

Hk: Reverted edit of CyaD0m (vandalism), changed back to last version by WikiSysop

See the [[Main Page]] for other areas of this wiki.
__NOTOC__
= Introduction =

* [[Introduction]]
* How to Get Help/Support
* [[History]]

= Installing EPrints & Getting Started =

* [[Required software]]
* [[Installation|Installing EPrints]]
** [[Recommended Platforms]]
** [[Installing Eprints 3 on Fedora Core 6]]
** [[Installing EPrints 3 on RedHat Enterprise 4]]
** [[Installing EPrints 3 on OS X]]
** [[Installing EPrints 3 on Ubuntu 6.10]]
** ''[[:Category:Installation|other platforms]]''
* [[Upgrading EPrints 3 versions]]
* [[Migration|Migrating from EPrints 2.3]]
* [[Getting Started with EPrints 3|Getting Started]]
* [[Backups]]
* [[Troubleshooting]]
* Advanced Installation
** [[Https3]]
* [[:Category:Installation|Installing]] EPrints on various platforms.

= How-to Guides =

''[http://en.wikipedia.org/wiki/Howto What is a how-to?]

* Orientation (Start here)
** [[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...''
** [[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...''
* [[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...''
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
* [[Adding new views]]
* Workflow
* Deposit Types
** [[Removing types]]
* Metadata
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''
* Searches
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive
* [[Customisation|more]]

= Misc =

* [[Preservation Support]] in GNU EPrints 3
* [[i18n]]
* [[How to contribute]]
** [[Extension Packages]]

= Technical Reference =

* [[EPrints Directory Structure]] - will be linked somewhere better, later.

* [[Metadata]] - configuring metadata fields.
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
* [[XML Configuration]] Files
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
** [[Citation Format]]
** [[Workflow Format]] - the structure of the EP3 workflow files
** [[Phrase Format]]
** [[Template Format]]
** [[XPAGE Format]]
* [[XML Export Format]]
* EPrints data structure
** of the software
** of the database (relating the dataobjects to each other using eprints fields)
* [[Data Object]]s and data sets
** The [[EPrint Object]]
** The [[User Object]]
** The [[Document Object]]
** The [[Subject Object]]
** The [[Saved Search Object]]
** The [[History Object]]
** The [[Access Object]]
** The [[Request Object]]
* Plugins
** Import
** [[Export Plugins]]
** Components
** Screen
** Convert
* [[Autocompletion]]
** [[Understanding IDs in Workflow Forms]]
* [[API]]
* [[Dynamic Template System]]

Manual

2007-04-19T08:58:57Z

Hk: Reverted to zhis revision as someone deleted almost everything on page

See the [[Main Page]] for other areas of this wiki.
__NOTOC__
= Introduction =

* [[Introduction]]
* How to Get Help/Support
* [[History]]

= Installing EPrints & Getting Started =

* [[Required software]]
* [[Installation|Installing EPrints]]
** [[Recommended Platforms]]
** [[Installing Eprints 3 on Fedora Core 6]]
** [[Installing EPrints 3 on RedHat Enterprise 4]]
** [[Installing EPrints 3 on OS X]]
** ''[[:Category:Installation|other platforms]]''
* Upgrading EPrints 3 versions
* [[Migration|Migrating from EPrints 2.3]]
* [[Getting Started with EPrints 3|Getting Started]]
* [[Backups]]
* [[Troubleshooting]]
* Advanced Installation
** [[HTTPS]]
* [[:Category:Installation|Installing]] EPrints on various platforms.

= How-to Guides =

''[http://en.wikipedia.org/wiki/Howto What is a how-to?]

* Orientation (Start here)
** [[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...''
** [[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...''
* [[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...''
** [[Branding, the next level]] - ''how to completely change the interface to your own design''
* [[Adding new views]]
* Workflow
* Deposit Types
* Metadata
* Subjects (fold in with Organisation Hierarchy under "controled vocabularies")
* [[EPrints_3_Organisation_Hierarchy|Organisation Hierarchy]] - ''how to put your own organisation's Hierarchy into EPrints 3''
* Searches
* [[Autocompletion and Authority Files (Romeo Autocomplete)]] - ''add autocomplete functionality to the Publication Title input field based on an authority file downloaded from EPrints Romeo...''
* [[Create Export Plugins]] - ''create a Perl Module that will export your data...''
* [[Login-Only Repository]] - ''require a username and password to access all pages (including search, browse, and the front page)...''
* [[Change Deposit Status in Bulk]] - ''move a large number of deposits from inbox to archive
* [[Customisation|more]]

= Misc =

* [[Preservation Support]] in GNU EPrints 3
* I18n
* [[How to contribute]]
** [[Extension Packages]]

= Technical Reference =

* [[EPrints Directory Structure]] - will be linked somewhere better, later.

* [[Metadata]] - configuring metadata fields.
* [[Archives/ARCHIVEID/cfg/|Repository Configuration]]
* [[XML Configuration]] Files
** [[EPScript]] - documentation for the EP3 Scripting language (for use in citations and workflow files).
** [[EPrints Control Format]] - the structure used to embed EPScript in an XML configuration file.
** [[Citation Format]]
** [[Workflow Format]] - the structure of the EP3 workflow files
** [[Phrase Format]]
** [[Template Format]]
** [[XPAGE Format]]
* [[XML Export Format]]
* EPrints data structure
** of the software
** of the database (relating the dataobjects to each other using eprints fields)
* [[Data Object]]s and data sets
** The [[EPrint Object]]
** The [[User Object]]
** The [[Document Object]]
** The [[Subject Object]]
** The [[Saved Search Object]]
** The [[History Object]]
** The [[Access Object]]
** The [[Request Object]]
* Plugins
** Import
** [[Export Plugins]]
** Components
** Screen
** Convert
* [[Autocompletion]]
** [[Understanding IDs in Workflow Forms]]
* [[API]]
* [[Dynamic Template System]]

HOW TO: Add a New Field

2007-01-17T14:07:18Z

Hk:

Adding a new field to EPrints 3 essentially works like for EPrints 2.3. Just the files to edit and the syntax somewhat changed. For EPrints 2.3 see [http://www.eprints.org/documentation/tech/php/howto.php#how_to__add_a_new_field this page].

This covers adding a new field to a new system, not a live system. It is possible to add a new field to a live system but involves SQL hacking.

In this example we add a new "set" field called "local" which will have 3 options "yes","no" and "partial" - this will indicate if the item in question was produced in our organisation or not.

= Add the Field to archives/ARCHIVEID/cfg/cfg.d/eprint_fields.pl =

Add the field to the appropriate part of eprint_fields.pl

{
'name' => 'local',
'type' => 'set',
'options' => [
'yes',
'no',
'partial',
],
'input_rows' => 1,
},

input_rows being set to one will make it appear as a pull-down menu.

= Add the Field to Workflow =

If you want the user to be able to edit this field for any or all types of eprint/user then you need to add it to each appropriate type in archives/ARCHIVEID/cfg/workflows/eprint/default.xml (this can be changed on a live system without any serious consequencies). Add the following to an approriate place in the core section:

<component><field ref="local" required="yes" /></component>

= Add the Field Information to the Archive Phrase File(s) =

Normally we just need to add fieldname and fieldhelp, but this is an option field so we need to add names for each option. If we run the archive in more than one language then we add this to each phrase file (but in the appropriate language). Phrases for eprint fields are found in archives/ARCHIVEID/cfg/lang/en/phrases/eprint_fields.xml.

<epp:phrase id="eprint_fieldname_local">Produced Locally</epp:phrase>
<epp:phrase id="eprint_fieldhelp_local">Please indicate if this item was
produces in the foo organisation, or not.</epp:phrase>
<epp:phrase id="eprint_fieldopt_local_yes">produced locally</epp:phrase>
<epp:phrase id="eprint_fieldopt_local_no">not produced locally</epp:phrase>
<epp:phrase id="eprint_fieldopt_local_partial">only partially produced
locally</epp:phrase>

== Other things you may wish to change after adding a new field ==

= Add it to the citations file =

This is optional, only do this if you want it to appear in the citated forms.

In our example case we only want this to appear when citing technical reports, so we add the following to archives/ARCHIVEID/cfg/lang/en/phrases/eprint_fields.xml:

<if test="type = 'techreport'">
<print expr="local"/>
</if>

The <print> element is not inside <if test="local"></if> as it is a required field and will (should) always be set.

= Add it to the the Abstract (or View-User) page =

This is also optional. If you want it to appear on the web page for this item then edit either archives/ARCHIVEID/cfg/cfg.d/eprint_render.pl or archives/ARCHIVEID/cfg/cfg.d/user_render.pl.

In our example we only want to mention items if an item was not produced locally. We'll add it below the documents and above the abstract...

Single language example:

if( $eprint->get_value( "local" ) ne "yes" )
{
# don't need to "my $p" as it's done earlier.
$p = $session->make_element( "p" );
$p->appendChild( $session->make_text( "This item was " ) );
$p->appendChild( $eprint->render_value( "local" ) );
$p->appendChild( $session->make_text( "." ) );

# Append our new paragraph to the page.
$page->appendChild( $p );
}

Multiple-language example:

If you want to make it handle more than language then we'll need to use the archive phrase file - we would add something like this to each languages file:

<epp:phrase id="page:itemnotlocal">This item was <pin ref="status" />.</epp:phrase>

And to the archives/ARCHIVEID/cfg/cfg.d/eprint_render.pl file:

if( $eprint->get_value( "local" ) ne "yes" )
{
my $localmsg = $session->html_phrase(
"page:itemnotlocal",
status=>$eprint->render_value( "local" ) );
$page->appendChild( $localmsg );
}

You may prefer to use this method even if you are only using a single language.

How to Create Cover Images in EPrints 3

2007-01-15T16:36:05Z

Hk: Finished

This describes how to generate cover images on the abstract pages. Cover images are
rendered differently from other document types.

=== Create a new document type "coverimage" ===

Add following line to /opt/eprints3/archives/ARCHIVEID/cfg/namedsets/document

cover_image

Add a phrase to

/opt/eprints3/archives/ARCHIVEID/cfg/lang/en/phrases/document_formats.xml

<epp:phrase id="document_typename_cover_image">Cover Image</epp:phrase>

Add phrases for all other languages your repository supports.

When you deposit an image, EPrints 3 should automatically create thumbnails for you, of different sizes.

=== Add rendering of abstract pages ===

Edit

/opt/eprints3/archives/ARCHIVEID/cfg/cfg.d/eprint_render.pl

This is the code that generates the abstract page.

Decide where you want to put the cover image (e.g. next to the citation). Add the following code to simply add an HTML img tag:

# Cover image
foreach my $doc ( $eprint->get_all_documents() )
{
if( $doc->get_type eq "cover_image" )
{
$page->appendChild( $session->make_element(
"img",
src => $doc->thumbnail_url( "medium" ),
alt => "Cover image" ) ); # Size may be one of small, medium, preview
}
}

Next you might want to keep the cover image from appearing in the list of documents. Look for the lines that says

# Available documents
my @documents = $eprint->get_all_documents();

This part of the code is where the documents get rendered at the top of
the abstract page.

A few lines below in the foreach loop add code to stop rendering the cover image:

foreach my $doc ( @documents )
{
# Do not show cover image in document list.
next if $doc->get_type eq "cover_image";
...

=== Do not forget to restart Apache! ===

Restart Apache to make changes effective.

=== Run generate_abstracts ===

Run generate_abstracts (you can pass in the ID of a record with a
"cover_image" document) and reload the abstract page - you should see the
cover image displayed near the top of the page.

How to Create Cover Images in EPrints 3

2007-01-15T15:34:58Z

Hk: /* 1. Create a new document type "coverimage" */

'''Beware: This is work in progress!'''

This describes how to generate cover images on the abstract pages. Cover images are
rendered differently from other document types.

=== 1. Create a new document type "coverimage" ===

Add following line to /opt/eprints3/archives/<archive_id>/cfg/namedsets/document

cover_image

Add a phrase to

/opt/eprints3/archives/<archive_id>/cfg/lang/en/phrases/document_formats.xml

<epp:phrase id="document_typename_cover_image">Cover Image</epp:phrase>

Add phrases for all other languages your repository supports.

=== 2. Add rendering of abstract pages ===

Still to come!

=== 3. Do not forget to restart Apache! ===

How to Create Cover Images in EPrints 3

2007-01-15T08:16:50Z

Hk:

'''Beware: This is work in progress!'''

This describes how to generate cover images on the abstract pages. Cover images are
rendered differently from other document types.

=== 1. Create a new document type "coverimage" ===

Add following line to /opt/eprints3/archives/<archive_id>/cfg/namedsets/document

coverimage

Add a phrase to

/opt/eprints3/archives/<archive_id>/cfg/lang/en/phrases/document_formats.xml

<epp:phrase id="document_typename_coverimage">Cover Image</epp:phrase>

Add phrases for all other languages your repository supports.

=== 2. Add rendering of abstract pages ===

Still to come!

=== 3. Do not forget to restart Apache! ===

How to Create Cover Images in EPrints 3

2007-01-15T08:11:00Z

Hk:

'''Beware: This is work in progress!'''

This describes how to generate cover images on the abstract pages. Cover images are
rendered differently from other document types.

=== 1. Create a new document type "coverimage" ===

Add following line to /opt/eprints3/archives/<archive_id>/cfg/namedsets/document

coverimage

Add a phrase to

/opt/eprints3/archives/<archive_id>/cfg/lang/en/phrases/document_formats.xml

<epp:phrase id="document_typename_other">Other</epp:phrase>

Add phrases for all other languages your repository supports.

=== 2. Add rendering of abstract pages ===

Still to come!

=== 3. Do not forget to restart Apache! ===

How to Create Cover Images in EPrints 3

2007-01-15T08:10:18Z

Hk:

== How to Create Cover Images in EPrints 3 ==

'''Beware: This is work in progress!'''

This describes how to generate cover images on the abstract pages. Cover images are
rendered differently from other document types.

=== 1. Create a new document type "coverimage" ===

Add following line to /opt/eprints3/archives/<archive_id>/cfg/namedsets/document

coverimage

Add a phrase to

/opt/eprints3/archives/<archive_id>/cfg/lang/en/phrases/document_formats.xml

<epp:phrase id="document_typename_other">Other</epp:phrase>

Add phrases for all other languages your repository supports.

=== 2. Add rendering of abstract pages ===

Still to come!

=== 3. Do not forget to restart Apache! ===

Customizing RSS Output

2006-08-07T14:11:46Z

Hk:

How to customize RSS output to show an institution's or person's last ''n'' publications.

RSS output is generated by <tt>/opt/eprints2/cgi/latest_tool</tt> (URL: <nowiki>http://<base_url>/perl/latest_tool</nowiki>). In the default configuration <tt>latest_tool</tt> will generate output for fixed searches (filters) only. These filters define both metadata fields and values searched in the archive configuration. One would have to add a filter to the archive configuration for every person or institution that would like its own RSS feed.

Instead, we add a new parameter <tt>allow_user_value</tt> to a latest_tool mode's configuration. When <tt>allow_user_value</tt> is set to "true" in the filter definition the value of the CGI parameter <tt>value</tt> will be searched for in the metadata fields that are defined in the archive configuration.

1. Edit <tt>/opt/eprints2/archives/<archive_id>/cfg/ArchiveConfig.pm</tt>'s "Latest_tool Configuration" section to read:

$c->{latest_tool_modes} = {
default => { citation => "neat" },
person => {
citation => "neat",
filters => [
{ meta_fields => [ "creators.id", "editors.id" ], value => "" }
],
allow_user_value => 1,
max => 10
},
institution => {
citation => "neat",
filters => [
{ meta_fields => [ "institutions" ], value => "" }
],
allow_user_value => 1,
max => 20
}
};

2. Alter <tt>/opt/eprints2/cgi/latest_tool</tt> (starting from line 45) to read:

if( defined $conf )
{
my $allow_user_value = 0;
foreach my $key (keys %{$conf} )
{
$citation = $conf->{"citation"} if( $key eq "citation" );
$filters = $conf->{"filters"} if( $key eq "filters" );
$allow_user_value = $conf->{"allow_user_value"} if( $key eq "allow_user_value" );
$max = $conf->{"max"} if( $key eq "max" );
}
if ( $allow_user_value ) {
my $value = $session->param( "value" );
if ( defined $value ) {
@$filters[0]->{"value"} = $value;
}
}
$class.= "_".$mode;
}
...

3. Restart Apache.

Your customized RSS feeds will be located at

*<nowiki>http://<base_url>/perl/latest_tool?mode=person&value=<person_id>&output=rss</nowiki>
*<nowiki>http://<base_url>/perl/latest_tool?mode=institution&value=<institution_id>&output=rss</nowiki>

Customizing RSS Output

2006-08-07T14:06:43Z

Hk:

How to customize RSS output to show an institution's or person's last ''n'' publications.

RSS output is generated by <tt>/opt/eprints2/cgi/latest_tool</tt> (URL: *<nowiki>http://<base_url>/perl/latest_tool</nowiki>). In the default configuration <tt>latest_tool</tt> will generate output for fixed searches (filters) only. These filters define both metadata fields and values in the archive configuration. One would have to add a filter to the archive configuration for every person or institution that would like its own RSS feed.

Instead, we add a new parameter <tt>allow_user_value</tt> to a latest tool mode's configuration. When set to "true" a CGI parameter <tt>value</tt> will be searched for in the metadata fields defined in the filter definition.

1. Edit <tt>/opt/eprints2/archives/<archive_id>/cfg/ArchiveConfig.pm</tt>'s "Latest_tool Configuration" section to read:

$c->{latest_tool_modes} = {
default => { citation => "neat" },
person => {
citation => "neat",
filters => [
{ meta_fields => [ "creators.id", "editors.id" ], value => "" }
],
allow_user_value => 1,
max => 10
},
institution => {
citation => "neat",
filters => [
{ meta_fields => [ "institutions" ], value => "" }
],
allow_user_value => 1,
max => 20
}
};

2. Alter <tt>/opt/eprints2/cgi/latest_tool</tt> (starting from line 45) to read:

if( defined $conf )
{
my $allow_user_value = 0;
foreach my $key (keys %{$conf} )
{
$citation = $conf->{"citation"} if( $key eq "citation" );
$filters = $conf->{"filters"} if( $key eq "filters" );
$allow_user_value = $conf->{"allow_user_value"} if( $key eq "allow_user_value" );
$max = $conf->{"max"} if( $key eq "max" );
}
if ( $allow_user_value ) {
my $value = $session->param( "value" );
if ( defined $value ) {
@$filters[0]->{"value"} = $value;
}
}
$class.= "_".$mode;
}
...

3. Restart Apache.

Your customized RSS feeds will be located at

*<nowiki>http://<base_url>/perl/latest_tool?mode=person&value=<person_id>&output=rss</nowiki>
*<nowiki>http://<base_url>/perl/latest_tool?mode=institution&value=<institution_id>&output=rss</nowiki>