Boxes on Abstract Pages - Revision history

Drn@ecs.soton.ac.uk: Fixed a couple of typos

2015-01-29T15:32:57Z

Fixed a couple of typos

DaveTarrant at 15:17, 20 July 2011

2011-07-20T15:17:29Z

Pm705 at 15:33, 28 March 2011

2011-03-28T15:33:03Z

DaveTarrant: /* Installing as a package */

2010-12-03T15:27:10Z

‎Installing as a package

DaveTarrant: /* Extension Exercise */

2010-12-03T15:22:01Z

‎Extension Exercise

DaveTarrant: /* Extension Exercise */

2010-12-01T15:36:00Z

‎Extension Exercise

DaveTarrant: /* Extension Exercise */

2010-12-01T15:35:47Z

‎Extension Exercise

DaveTarrant: Created page with 'This tutorial looks at ways to add items to eprint abstract pages without the need to manipulate any XML code. This can be done by adding a box to either the top,bottom,left or…'

2010-12-01T15:35:18Z

Created page with 'This tutorial looks at ways to add items to eprint abstract pages without the need to manipulate any XML code. This can be done by adding a box to either the top,bottom,left or…'

New page

This tutorial looks at ways to add items to eprint abstract pages without the need to manipulate any XML code.

This can be done by adding a box to either the top,bottom,left or right of the abstract page.

These can be useful but don't always turn out in the correct place, hence manipulating XML can be more preferable in the long run.

=An EPrints Box=

These are very simple and live under the Screen plug-ins Box directory:

* cfg/plugins/EPrints/Plugin/Screen/EPrint/Box/package_name.pm

All they require is a render method as shown in the basic shell below:

package EPrints::Plugin::Screen::EPrint::Box::package_name;

@ISA = ( 'EPrints::Plugin::Screen::EPrint::Box' );

use strict;

sub render
{
my( $self ) = @_;

my $repository = $self->{repository};
my $eprint = $self->{processor}->{eprint};

my $frag = $repository->make_doc_fragment;

$frag->appendChild($repository->make_text("HELLO"));

return $frag;
}

=Configuring your box=

For this you need a config file in cfg/cfg.d/package_name.pl which contains the following:

$c->{plugins}->{"Screen::EPrint::Box::package_name"}->{appears}->{summary_top} = undef;
$c->{plugins}->{"Screen::EPrint::Box::package_name"}->{appears}->{summary_right} = undef;
$c->{plugins}->{"Screen::EPrint::Box::package_name"}->{appears}->{summary_bottom} = 800;
$c->{plugins}->{"Screen::EPrint::Box::package_name"}->{appears}->{summary_left} = undef;

So this box will appear bellow the summary_page citation with a priority of 800 (anything less will appear below and anything more above).

=Installing as a package=

If you specify you config file properly in the spec file you should be able to click the "Configure Add-on" button to change these values.

=Extension Exercise=

Make a screen plug-in which has a '''postinst''' and '''prerm''' which invalidate the abstract pages. The render method of this screen should still re-direct the user to the config file however!

Clue:

my $config_file = "cfg.d/package_name.pl";
my $screen_id = "Admin::Config::View::Perl";
my $redirect_url = $session->current_url() . "?screen=" . $screen_id . "&configfile=" . $config_file;
$session->redirect( $redirect_url );
exit();

← Older revision		Revision as of 15:33, 28 March 2011
Line 1:		Line 1:
		+	[[Category:EPrints_Bazaar]]
	This tutorial looks at ways to add items to eprint abstract pages without the need to manipulate any XML code.		This tutorial looks at ways to add items to eprint abstract pages without the need to manipulate any XML code.

← Older revision		Revision as of 15:22, 3 December 2010
Line 49:		Line 49:

	=Extension Exercise=		=Extension Exercise=
		+
		+	It is recommended that this exercise is done after [[XML manipulation of the Abstract page using a Bazaar Module]]

	Make a screen plug-in which has a '''postinst''' and '''prerm''' which invalidate the abstract pages. The render method of this screen should still re-direct the user to the config file however!		Make a screen plug-in which has a '''postinst''' and '''prerm''' which invalidate the abstract pages. The render method of this screen should still re-direct the user to the config file however!

@@ Line 54: / Line 54: @@
 For the invalidate abstract code see [[XML manipulation of the Abstract page using a Bazaar Module]]
-Clue:
+Clue to the redirecting:
    my $config_file = "cfg.d/package_name.pl";

← Older revision		Revision as of 15:35, 1 December 2010
Line 51:		Line 51:

	Make a screen plug-in which has a '''postinst''' and '''prerm''' which invalidate the abstract pages. The render method of this screen should still re-direct the user to the config file however!		Make a screen plug-in which has a '''postinst''' and '''prerm''' which invalidate the abstract pages. The render method of this screen should still re-direct the user to the config file however!
		+
		+	For the invalidate abstract code see [[XML manipulation of the Abstract page using a Bazaar Module]]

	Clue:		Clue:

@@ Line 43: / Line 43: @@
    $c->{plugins}->{"Screen::EPrint::Box::package_name"}->{appears}->{summary_left} = undef;
-So this box will appear bellow the summary_page citation with a priority of 800 (anything less will appear below and anything more above).
+So this box will appear below the summary_page citation with a priority of 800 (anything less will appear below and anything more above).
 =Installing as a package=
-To see your box you will need to invalidate the abstarct pages which can be done via the "Regenerate Abstracts" button under the "System Tools" tab of the admin interface.
+To see your box you will need to invalidate the abstract pages which can be done via the "Regenerate Abstracts" button under the "System Tools" tab of the admin interface.
 If you specify you config file properly in the spec file you should be able to click the "Configure Add-on" button to change these values.

@@ Line 10: / Line 10: @@
 These are very simple and live under the Screen plug-ins Box directory:
-* cfg/plugins/EPrints/Plugin/Screen/EPrint/Box/package_name.pm
+* lib/plugins/EPrints/Plugin/Screen/EPrint/Box/package_name.pm
 All they require is a render method as shown in the basic shell below: