How to - Revision history

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

2022-01-22T18:51:06Z

Tidied up code parts

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

2022-01-22T18:49:24Z

Tidied up code parts

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

2022-01-22T18:43:54Z

Tidied up code parts

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

2022-01-22T18:39:16Z

Tidied up code parts

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

2022-01-22T18:22:01Z

Tidied up code parts

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

2022-01-22T18:03:06Z

‎HOW TO: Fields

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

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

2012-10-18T15:40:13Z

‎HOW TO: Fields

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

2012-05-24T09:04:57Z

Fix typos

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

2012-05-24T09:00:50Z

Fix typos

@@ Line 349: / Line 349: @@
 ===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:
   mkdir /opt/eprints2/cgi/local
 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:
+  &lt;form action="/perl/google_site"&gt;
-  <form action="/perl/google_site">
+   Use Google to search this site:
- Use Google to search this site:
+   &lt;input name="q" value="" /&gt;
- <input name="q" value="" />
+   &lt;input type="submit" name="go" value="Search" /&gt;
- <input type="submit" name="go" value="Search" />
+  &lt;/form&gt;
 For other search engines; see their documentation for how to make a form to search only your site.

@@ Line 268: / Line 268: @@
 ===Make the latest additions to your archive appear on your main website===
 The contents of the "latest" page - /perl/latest - can be included via a cron tab using wget and a server side include or using something like PHP's command to do:
   readfile( "http://eprints.foo.org/perl/latest?mainonly=yes" );
 The "mainonly=yes" flag is a hack which supresses the template of any eprints page in the /perl/ area so that it can be included, but it is most useful for "latest".
@@ Line 285: / Line 281: @@
 The code implements local caching of the generated HTML in a text file which is never more than an hour old, unless there is a problem with the server whereupon the last good cached version is used.
   require_once('D:/website/[path to]/magpierss/rss_fetch.inc');
-  <span style="color: green; font-weight: bold">//set some variables here:</span>
+  &lt;span style="color: green; font-weight: bold"&gt;//set some variables here:&lt;/span&gt;
-  $anchor = '<t4 type="meta" meta="html_anchor" />';
+  $anchor = '&lt;t4 type="meta" meta="html_anchor" /&gt;';
-  <span style="color: green; font-weight: bold"># All items in Terminal4's cms have an anchor - we like break it apart to get the Unique id, to name the cache file.</span>
+  &lt;span style="color: green; font-weight: bold"&gt;# All items in Terminal4's cms have an anchor - we like break it apart to get the Unique id, to name the cache file.&lt;/span&gt;
   $TTL = 3600;
-  <span style="color: green; font-weight: bold"># Time to live - one hour only.</span>
+  &lt;span style="color: green; font-weight: bold"&gt;# Time to live - one hour only.&lt;/span&gt;
-  $feed = '<t4 type="content" name="RSS_Feed_URL" output="normal" modifiers=""  />';
+  $feed = '&lt;t4 type="content" name="RSS_Feed_URL" output="normal" modifiers=""  /&gt;';
   $uniqueID = explode("\"", $anchor);
   $filename = "./" . str_replace('.', '-', $uniqueID[1]) . ".txt";
-  <span style="color: green; font-weight: bold">#filename of cache - generated from unique id in T4 content management system.</span>
+  &lt;span style="color: green; font-weight: bold"&gt;#filename of cache - generated from unique id in T4 content management system.&lt;/span&gt;
-  $max_items = <t4 type="content" name="MaxNumberToShow" output="normal" modifiers=""  />;
+  $max_items = &lt;t4 type="content" name="MaxNumberToShow" output="normal" modifiers=""  /&gt;;
-  <span style="color: green; font-weight: bold"># $max_items = 30; // this is set in EPrints as well, will not exceed Eprints' own internal limit.</span>
+  &lt;span style="color: green; font-weight: bold"&gt;# $max_items = 30; // this is set in EPrints as well, will not exceed Eprints' own internal limit.&lt;/span&gt;
-  $with_summaries = '<t4 type="content" name="ShowSummary" output="normal" modifiers=""  />'; # could be 'yes' or 'no'
+  $with_summaries = '&lt;t4 type="content" name="ShowSummary" output="normal" modifiers=""  /&gt;'; # could be 'yes' or 'no'
   $age = 0;
   if(file_exists($filename)){
- 	$age = time() - filemtime($filename);
+   $age = time() - filemtime($filename);
   }else{
- 	$fh = fopen($filename, "w");
+   $fh = fopen($filename, "w");
- 	fwrite($fh, $news_feed);
+   fwrite($fh, $news_feed);
- 	fclose($fh);
+   fclose($fh);
- 	$age = $TTL;
+   $age = $TTL;
+  }
   function getFromCache($f){
- 	$fh = fopen($f, "r");
+   $fh = fopen($f, "r");
- 	$size = filesize($f);
+   $size = filesize($f);
- 	$data = fread($fh, $size);
+   $data = fread($fh, $size);
- 	print $data;
+   print $data;
- 	fclose($fh);
+   fclose($fh);
+  }
-−
+  if($age &gt;= $TTL){
+   if($rss = fetch_rss($feed)){
-  if($age >= $TTL){
+     $items = array_slice($rss-&gt;items, 0);
- 	if($rss = fetch_rss($feed)){
+     $find = array("/^\.?/");
- 		$items = array_slice($rss->items, 0);
+     $replace = array(" ");
- 		$find = array("/^\.?/");
+     $news_feed = "&lt;ul class=\"rss_list\"&gt;\n";
- 		$replace = array(" ");
+     foreach ($items as $item ){
- 		$news_feed = "&lt;ul class=\"rss_list\">\n";
+       if($count &lt; $max_items){
- 			foreach ($items as $item ){
+         $news_feed .= "\t&lt;li class=\"rss_item\"&gt;\n";
- 				if($count &lt; $max_items){
+         $news_feed .= "\t\t&lt;span class=\"rss_title\"&gt;&lt;a href=\"" . $item['link'] . "\" target=\"_blank\"&gt;";
- 					$news_feed .= "\t&lt;li class=\"rss_item\">\n";
+         $news_feed .= $item['title'] . "&lt;/a&gt;&lt;/span&gt;\n\t\t&lt;br /&gt;\n";
- 					$news_feed .= "\t\t&lt;span class=\"rss_title\">&lt;a href=\"" . $item['link'] . "\" target=\"_blank\">";
+         if($with_summaries == 'yes'){
- 					$news_feed .= $item['title'] . "&lt;/a>&lt;/span>\n\t\t&lt;br />\n";
+           $news_feed .= "\t\t&lt;span class=\"rss_summary\"&gt;\n\t\t\t";
- 					if($with_summaries == 'yes'){
+           $news_feed .= str_replace(($item['title'] . "."), "", htmlentities($item['summary'])) . "&lt;br/&gt;\n\t\t&lt;/span&gt;\n";
- 						$news_feed .= "\t\t&lt;span class=\"rss_summary\">\n\t\t\t";
- 						$news_feed .= str_replace(($item['title'] . "."), "", htmlentities($item['summary'])) . "&lt;br/>\n\t\t&lt;/span>\n";
+         $news_feed .= "\t\t&lt;br /&gt;\n\t&lt;/li&gt;\n";
+         $count += 1;
- 					$news_feed .= "\t\t&lt;br />\n\t</li>\n";
- 					$count += 1;
+     $news_feed .= "&lt;/ul&gt;\n\n";
+     echo $news_feed;
- 		$news_feed .= "&lt;/ul>\n\n";
+     $fh = fopen($filename, "w");
- 		echo $news_feed;
+     fwrite($fh, $news_feed);
- 		$fh = fopen($filename, "w");
+     fclose($fh);
- 		fwrite($fh, $news_feed);
+   }else{
- 		fclose($fh);
+     getFromCache($filename);
- 	}else{
   }else{
- 	getFromCache($filename);
+   getFromCache($filename);
+  }
-  <span style="color: green; font-weight: bold"># David Kane, Waterford Institute of Technology</span>
+  &lt;span style="color: green; font-weight: bold"&gt;# David Kane, Waterford Institute of Technology&lt;/span&gt;
 ==HOW TO: Add full text searching==

@@ 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===

@@ 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 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 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).
+  &lt;ep:phrase ref="eprint_fieldname_local"&gt;Produced Locally&lt;/ep:phrase&gt;
-<code>
+  &lt;ep:phrase ref="eprint_fieldhelp_local"&gt;Please indicate if this item was produced in the foo organisation, or not.&lt;/ep:phrase&gt;
-  <ep:phrase ref="eprint_fieldname_local">Produced Locally</ep:phrase>
+  &lt;ep:phrase ref="eprint_fieldopt_local_yes"&gt;produced locally&lt;/ep:phrase&gt;
-  <ep:phrase ref="eprint_fieldhelp_local">Please indicate if this item was produced in the foo organisation, or not.</ep:phrase>
+  &lt;ep:phrase ref="eprint_fieldopt_local_no"&gt;not produced locally&lt;/ep:phrase&gt;
-  <ep:phrase ref="eprint_fieldopt_local_yes">produced locally</ep:phrase>
+  &lt;ep:phrase ref="eprint_fieldopt_local_partial"&gt;only partially produced locally&lt;/ep:phrase&gt;
 ====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 change that entry to:
 ; 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...
 Single language example:
   if( $eprint->get_value( "local" ) ne "yes" )
+  {
@@ Line 160: / Line 157: @@
        $p->appendChild( $eprint->render_value( "local" ) );
        $p->appendChild( $session->make_text( "." ) );
-−
        # Append our new paragraph to the page.
        $page->appendChild( $p );
+  }
-</code>
 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:
+  &lt;ep:phrase ref="page:itemnotlocal"&gt;
-<code>
+   &lt;p&gt;This item was &lt;pin ref="status" /&gt;.&lt;/p&gt;
-  <ep:phrase ref="page:itemnotlocal"><p>This item was <pin ref="status" />.</p></ep:phrase>
+ &lt;/ep:phrase&gt;
 And to the ArchiveRenderConfig.pm file:
   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 );
+  }
 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 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.

@@ Line 6: / Line 6: @@
 Example situation: On my main website www.foobars.ac.uk I have a page per research project, of which we have hundreds. Each project has a short unique id code, eg. "manticore". I have a field in my eprints archive (eprints.foobars.ac.uk) which is configured:
-−
+  {
+   name=>"projectcodes",
-<code>
+   type=>"text",
-  { name=>"projectcodes", type=>"text", multiple=>1 }
+   multiple=>1
-</code>
 I add the following browse view:
-−
+  {
+   id=>"by_project",
-<code>
+   allow_null=>0,
-  { id=>"by_project", allow_null=>0, fields=>"projectcodes",
+   fields=>"projectcodes",
- order=>"-year/title" }
+   order=>"-year/title"
-</code>
 This will generate a page http://eprints.foobars.ac.uk/views/by_project/manticore.html with a list of all papers in that project, we can link to that URL!
@@ Line 23: / Line 23: @@
 If you want a subject to link the subject browse page of that value, add the '''browse_link''' property to the field (and regenerate the abstracts if you want).
-If you remove the browse view you should remove the browse_link or it will be a broken link.
+If you remove the browse view you should remove the '''browse_link''' or it will be a broken link.
 Values rendered inside citations which are used to link to the main record will not link into the browse view for obvious reasons.
 ===Including a view in another page===
 If you change that to:
-−
+  {
+   id=>"by_project",
-<code>
+   allow_null=>0,
-  { id=>"by_project", allow_null=>0, fields=>"projectcodes",
+   fields=>"projectcodes",
- order=>"-year/title", noindex=>1, nolink=>1, nohtml=>1, include=>1 }
+   order=>"-year/title",
-</code>
+   noindex=>1,
-This will generate a view which is NOT listed on the /view/ page and it will not skip making the .html file and make a .include file per value. This will only contain the "count" of items and the XHTML of their citations. This can be used as part of a page on the http://www.foobaars.ac.uk/ site; either by using php and capturing it on-the-fly using <tt>readfile</tt> or scripting it with perl or NFS exporting the filesystem onto the main server (or just doing it all on one computer) and using server side includes to place it in a page.
+   nolink=>1,
 ===Customising the way each item is cited===
@@ Line 41: / Line 46: @@
 I add some ''more'' options to the browse view:
-−
+  {
+   id=>"by_project",
-<code>
+   allow_null=>0,
-  { id=>"by_project", allow_null=>0, fields=>"projectcodes",
+   fields=>"projectcodes",
- order=>"-year/title", noindex=>1, nolink=>1, nohtml=>1, include=>1,
+   order=>"-year/title",
- nocount=>1, citation=>"project_table" }
+   noindex=>1,
-</code>
+   nolink=>1,
 Now I add a new citation to the citations config file:
+  &lt;ep:citation type="project_table"&gt;
+   &lt;tr&gt;
-<code>
+     &lt;td&gt;&title;&lt;/td&gt;
-  <ep:citation type="project_table"><tr><td>&title;</td><td>&authors;</td>
+     &lt;td&gt;&authors;&lt;/td&gt;
- <td>&year;</td><td><ep:linkhere><img
+     &lt;td&gt;&year;&lt;/td&gt;
- src="http://www.foobars.ac.uk/images/paperlink.png" alt="view" width="32"
+     &lt;td&gt;
- height="64" border="0" /></ep:linkhere></td></tr></ep:citation>
+       &lt;ep:linkhere&gt;
-</code>
+         &lt;img src="http://www.foobars.ac.uk/images/paperlink.png" alt="view" width="32" height="64" border="0" /&gt;
 That should generate for the manticore project, in the ".include" file (I've cut the contents of the "img" tag for readability:
 ===A "CV" page - a list of all of Alices records===
 This is where the authors and editors field having an ID comes in handy.
 Say we use local username to identify people in the "Person ID" fields, we can now set up a view:
-−
+  {
+   id=>"by_person",
-<code>
+   allow_null=>0,
-  { id=>"by_person", allow_null=>0, fields=>"authors.id/editors.id",
+   fields=>"authors.id/editors.id",
- order=>"-year/title", noindex=>1, include=>1 }
+   order=>"-year/title",
-</code>
+   noindex=>1,
 This will generate both .html pages and .include pages. An member of your organisation can get a list of their records either by linking to <tt>/views/by_person/alice.html</tt> (where alice is their username) or by snarfing the URL <tt>/views/by_person/alice.include</tt> into his own homepage.

@@ Line 81: / Line 81: @@
 ==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.

@@ Line 1: / Line 1: @@
 [[Category:Howto]]
 ==HOW TO: Set up a Complex Custom View==
 Simple instructions are in the ArchiveConfig.pm section.

@@ Line 194: / Line 194: @@
 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==

@@ Line 80: / Line 80: @@
 ==HOW TO: Fields==
 ===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)
@@ Line 91: / Line 91: @@
 </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 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>