How to - Revision history

Drn@ecs.soton.ac.uk: Tidied up code parts

2022-01-22T18:51:06Z

Tidied up code parts

← Older revision		Revision as of 18:51, 22 January 2022
Line 349:		Line 349:
	===htdig, or similar software===		===htdig, or similar software===
	There is plenty of software which will provide a full text search of a website. To add non-eprints cgi scripts to your site create a directory in the cgi dir:		There is plenty of software which will provide a full text search of a website. To add non-eprints cgi scripts to your site create a directory in the cgi dir:


	~~<code>~~
	mkdir /opt/eprints2/cgi/local		mkdir /opt/eprints2/cgi/local
	~~</code>~~
	and place your scripts in there, they will have URLs under <tt>http://yoursite.com/perl/</tt>		and place your scripts in there, they will have URLs under <tt>http://yoursite.com/perl/</tt>

Line 360:		Line 356:

	A really easy solution is to just make a form which links to our "google_site" script which just adds "site:yoursite.com" to the google request to limit the search results. The HTML for this would be something like:		A really easy solution is to just make a form which links to our "google_site" script which just adds "site:yoursite.com" to the google request to limit the search results. The HTML for this would be something like:
			<form action="/perl/google_site">
	<form action="/perl/google_site">		Use Google to search this site:
	Use Google to search this site:		<input name="q" value="" />
	<input name="q" value="" />		<input type="submit" name="go" value="Search" />
	<input type="submit" name="go" value="Search" />		</form>
	</form>

	For other search engines; see their documentation for how to make a form to search only your site.		For other search engines; see their documentation for how to make a form to search only your site.

Drn@ecs.soton.ac.uk: Tidied up code parts

2022-01-22T18:49:24Z

Tidied up code parts

Show changes

Drn@ecs.soton.ac.uk: Tidied up code parts

2022-01-22T18:43:54Z

Tidied up code parts

@@ Line 228: / Line 228: @@
 Please note that this code is not internationalised.
 ==HOW TO: Website Integration==
 ===Make the latest additions to your archive appear on your main website===

Drn@ecs.soton.ac.uk: Tidied up code parts

2022-01-22T18:39:16Z

Tidied up code parts

← Older revision		Revision as of 18:39, 22 January 2022
Line 114:		Line 114:

	; Add the Field to ArchiveMetafieldConfig.pm : Add the field to the appropriate part of ArchiveMetafieldConfig.pm (the "eprint" section in our example)		; Add the Field to ArchiveMetafieldConfig.pm : Add the field to the appropriate part of ArchiveMetafieldConfig.pm (the "eprint" section in our example)
			{
			name => "local",
			type => "set",
			input_rows => 1,
			options => [
			"yes",
			"no",
			"partial"
			]
			}
			input_rows being set to one will make it appear as a pull-down menu.

	~~<code>~~
	~~{ name => "local", type => "set", input_rows => 1,~~
	~~options => [ "yes", "no", "partial" ] }~~
	~~</code>~~
	~~input_rows being set to one will make it appear as a pull-down menu.~~
	; Add the Field to metadata-types.xml : 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 metadata-types.xml (this can be changed on a live system without any serious consequences).		; Add the Field to metadata-types.xml : 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 metadata-types.xml (this can be changed on a live system without any serious consequences).
			<field name="local" required="yes" />

	~~<code>~~
	~~<field name="local" required="yes" />~~
	~~</code>~~
	; 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).		; 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).
			<ep:phrase ref="eprint_fieldname_local">Produced Locally</ep:phrase>
	~~<code>~~		<ep:phrase ref="eprint_fieldhelp_local">Please indicate if this item was produced in the foo organisation, or not.</ep:phrase>
	<ep:phrase ref="eprint_fieldname_local">Produced Locally</ep:phrase>		<ep:phrase ref="eprint_fieldopt_local_yes">produced locally</ep:phrase>
	<ep:phrase ref="eprint_fieldhelp_local">Please indicate if this item was produced in the foo organisation, or not.</ep:phrase>		<ep:phrase ref="eprint_fieldopt_local_no">not produced locally</ep:phrase>
	<ep:phrase ref="eprint_fieldopt_local_yes">produced locally</ep:phrase>		<ep:phrase ref="eprint_fieldopt_local_partial">only partially produced locally</ep:phrase>
	<ep:phrase ref="eprint_fieldopt_local_no">not produced locally</ep:phrase>
	<ep:phrase ref="eprint_fieldopt_local_partial">only partially produced locally</ep:phrase>
	~~</code>~~

	====Other things you may wish to change after adding a new field====		====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.		; 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 change that entry to:		In our example case we only want this to appear when citing technical reports, so we change that entry to:
			<ep:citation type="eprint_techreport">
			<ep:linkhere>
			<span class="citation">&authors; <ep:ifset name="year">(&year;) </ep:ifset> &title;. Technical Report<ep:ifset name="reportno"> &reportno;</ep:ifset><ep:ifset name="department">, &department;</ep:ifset><ep:ifset name="institution">, &institution;</ep:ifset>. &local;.</span>
			</ep:linkhere>
			</ep:citation>
			All we've done is add <tt>&local;.</tt> to the end. It's not inside <tt> <ep:ifset name="local"> </tt> as it is a required field and will (should) always be set.

	~~<code>~~
	~~<ep:citation type="eprint_techreport"><ep:linkhere><span~~
	~~class="citation">&authors; <ep:ifset name="year">(&year;)~~
	~~</ep:ifset>&title;. Technical Report<ep:ifset name="reportno">~~
	~~&reportno;</ep:ifset><ep:ifset name="department">, &department;~~
	~~</ep:ifset><ep:ifset name="institution">, &institution;</ep:ifset>.~~
	~~&local;.</span></ep:linkhere></ep:citation>~~
	~~</code>~~
	~~All we've done is add <tt>&local;.</tt> to the end. It's not inside <tt> <ep:ifset name="local"> </tt> 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 ArchiveRenderConfig.pm and select the appropriate function, either eprint_render or user_render.		; 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 ArchiveRenderConfig.pm and select the appropriate function, either eprint_render or user_render.
	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...		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:		Single language example:

	~~<code>~~
	if( $eprint->get_value( "local" ) ne "yes" )		if( $eprint->get_value( "local" ) ne "yes" )
	{		{
Line 160:		Line 157:
	$p->appendChild( $eprint->render_value( "local" ) );		$p->appendChild( $eprint->render_value( "local" ) );
	$p->appendChild( $session->make_text( "." ) );		$p->appendChild( $session->make_text( "." ) );

	# Append our new paragraph to the page.		# Append our new paragraph to the page.
	$page->appendChild( $p );		$page->appendChild( $p );
	}		}
	~~</code>~~
	Multiple-language example:		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:		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:
			<ep:phrase ref="page:itemnotlocal">
	~~<code>~~		<p>This item was <pin ref="status" />.</p>
	<ep:phrase ref="page:itemnotlocal"><p>This item was <pin ref="status" />.</p></ep:phrase>		</ep:phrase>
	~~</code>~~
	And to the ArchiveRenderConfig.pm file:		And to the ArchiveRenderConfig.pm file:

	~~<code>~~
	if( $eprint->get_value( "local" ) ne "yes" )		if( $eprint->get_value( "local" ) ne "yes" )
	{		{
	my $localmsg = $session->html_phrase(		my $localmsg = $session->html_phrase(
	"page:itemnotlocal",		"page:itemnotlocal",
	status=>$eprint->render_value( "local" ) );		status=>$eprint->render_value( "local" ) );
	$page->appendChild( $localmsg );		$page->appendChild( $localmsg );
	}		}
	~~</code>~~
	You may prefer to use this method even if you are only using a single language.		You may prefer to use this method even if you are only using a single language.

	; Add extra Validation Routines : If you need to validate this field in a special way, add code into ArchiveValidateConfig.pm		; Add extra Validation Routines : If you need to validate this field in a special way, add code into ArchiveValidateConfig.pm
	; Add it to the OAI metadata (eprints only) : If this field can be rendered into Dublin Core (or other metadata formats you are using) then add it to the appropriate place in the ArchiveOAIConfig.pm file.		; Add it to the OAI metadata (eprints only) : If this field can be rendered into Dublin Core (or other metadata formats you are using) then add it to the appropriate place in the ArchiveOAIConfig.pm file.

Drn@ecs.soton.ac.uk: Tidied up code parts

2022-01-22T18:22:01Z

Tidied up code parts

Show changes

Drn@ecs.soton.ac.uk: /* HOW TO: Fields */

2022-01-22T18:03:06Z

HOW TO: Fields

← Older revision		Revision as of 18:03, 22 January 2022
Line 81:		Line 81:

	==HOW TO: Fields==		==HOW TO: Fields==
	===Add a new Field		===Add a new Field===
	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.		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.

Libjlrs@leeds.ac.uk: /* HOW TO: Set up a Complex Custom View */

2012-10-22T12:37:51Z

HOW TO: Set up a Complex Custom View

← Older revision		Revision as of 12:37, 22 October 2012
Line 1:		Line 1:
	[[Category:Howto]]		[[Category:Howto]]
	==HOW TO: Set up a Complex Custom View==		==HOW TO: Set up a Complex Custom View==
			'''NOTE: http://wiki.eprints.org/w/Adding_new_views is a better page to start with for newer version of EPrints.'''

	Simple instructions are in the ArchiveConfig.pm section.		Simple instructions are in the ArchiveConfig.pm section.

Alan.stiles@open.ac.uk: /* HOW TO: Fields */

2012-10-18T15:40:13Z

HOW TO: Fields

← Older revision		Revision as of 15:40, 18 October 2012
Line 100:		Line 100:
	<code>		<code>
	<ep:phrase ref="eprint_fieldname_local">Produced Locally</ep:phrase>		<ep:phrase ref="eprint_fieldname_local">Produced Locally</ep:phrase>
	<ep:phrase ref="eprint_fieldhelp_local">Please indicate if this item was		<ep:phrase ref="eprint_fieldhelp_local">Please indicate if this item was produced in the foo organisation, or not.</ep:phrase>
	~~produces~~ in the foo organisation, or not.
	<ep:phrase ref="eprint_fieldopt_local_yes">produced locally</ep:phrase>		<ep:phrase ref="eprint_fieldopt_local_yes">produced locally</ep:phrase>
	<ep:phrase ref="eprint_fieldopt_local_no">not produced locally</ep:phrase>		<ep:phrase ref="eprint_fieldopt_local_no">not produced locally</ep:phrase>
	<ep:phrase ref="eprint_fieldopt_local_partial">only partially produced		<ep:phrase ref="eprint_fieldopt_local_partial">only partially produced locally</ep:phrase>
	locally</ep:phrase>
	</code>		</code>

A.d.bell@ecs.soton.ac.uk: Fix typos

2012-05-24T09:04:57Z

Fix typos

← Older revision		Revision as of 09:04, 24 May 2012
Line 194:		Line 194:
	Add a citation for this document to the citations file.		Add a citation for this document to the citations file.

	If you want this to be one of the must-have-one-of document types then add ~~it's~~ id to the list in ArchiveConfig.pm		If you want this to be one of the must-have-one-of document types then add its id to the list in ArchiveConfig.pm

	If you want to do something "clever" on the abstract page then edit the ArchiveRenderConfig.pm file. If you don't then it will use the ~~citiation~~ you created to render it in the list, as with PDF, HTML etc.		If you want to do something "clever" on the abstract page then edit the ArchiveRenderConfig.pm file. If you don't then it will use the citation you created to render it in the list, as with PDF, HTML etc.

	==HOW TO: Add a Discussion Forum for Each EPrint==		==HOW TO: Add a Discussion Forum for Each EPrint==

A.d.bell@ecs.soton.ac.uk: Fix typos

2012-05-24T09:00:50Z

Fix typos

← Older revision		Revision as of 09:00, 24 May 2012
Line 80:		Line 80:
	==HOW TO: Fields==		==HOW TO: Fields==
	===Add a new Field		===Add a new Field
	This ~~convers~~ 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 ~~invloves~~ SQL hacking.		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.		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 ArchiveMetafieldConfig.pm : Add the field to the appropriate part of ArchiveMetafieldConfig.pm (the "eprint" section in our example)		; Add the Field to ArchiveMetafieldConfig.pm : Add the field to the appropriate part of ArchiveMetafieldConfig.pm (the "eprint" section in our example)
Line 91:		Line 91:
	</code>		</code>
	input_rows being set to one will make it appear as a pull-down menu.		input_rows being set to one will make it appear as a pull-down menu.
	; Add the Field to metadata-types.xml : 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 metadata-types.xml (this can be changed on a live system without any serious ~~consequencies~~).		; Add the Field to metadata-types.xml : 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 metadata-types.xml (this can be changed on a live system without any serious consequences).

	<code>		<code>