Editing Customizing RSS Output (section)

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

{{Obsolete}}

The following section applies to EPrints 2.  In EPrints 3, author feed links are included on the creators browse view pages.

RSS output is generated by <tt>/opt/eprints2/cgi/<b>latest_tool</b></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/<b>ArchiveConfig.pm</b></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/<b>latest_tool</b></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>

[[Category:Howto]]
[[Category:Plugins]]