Editing How to (section)

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

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", 
   type=>"text", 
   multiple=>1
 }
I add the following browse view:
 { 
   id=>"by_project", 
   allow_null=>0, 
   fields=>"projectcodes", 
   order=>"-year/title" 
 }
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!

===Making the Field link to the Browse Page===
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.

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", 
   allow_null=>0, 
   fields=>"projectcodes", 
   order=>"-year/title", 
   noindex=>1, 
   nolink=>1, 
   nohtml=>1, 
   include=>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.

===Customising the way each item is cited===
I want to list the project papers in a strict format in a table with 4 columns: title, author(s), year and an icon which links to the document abstract page...

I add some ''more'' options to the browse view:
 { 
   id=>"by_project",
   allow_null=>0, 
   fields=>"projectcodes", 
   order=>"-year/title", 
   noindex=>1, 
   nolink=>1, 
   nohtml=>1, 
   include=>1, 
   nocount=>1, 
   citation=>"project_table" 
 }
Now I add a new citation to the citations config file:
 &lt;ep:citation type="project_table"&gt;
   &lt;tr&gt;
     &lt;td&gt;&title;&lt;/td&gt;
     &lt;td&gt;&authors;&lt;/td&gt;
     &lt;td&gt;&year;&lt;/td&gt;
     &lt;td&gt;
       &lt;ep:linkhere&gt;
         &lt;img src="http://www.foobars.ac.uk/images/paperlink.png" alt="view" width="32" height="64" border="0" /&gt;
       &lt;/ep:linkhere&gt;
     &lt;/td&gt;
   &lt;/tr&gt;
 &lt;/ep:citation&gt;
That should generate for the manticore project, in the ".include" file (I've cut the contents of the "img" tag for readability:
 &lt;tr&gt;
   &lt;td&gt;Making Stuff&lt;/td&gt;
   &lt;td&gt;Guy, A.&lt;/td&gt;
   &lt;td&gt;2001&lt;/td&gt;
   &lt;td&gt;
     &lt;a href="http://eprints.foobar.ac.uk/archive/00000923/"&gt;
       &lt;img ... /&gt;
     &lt;/a&gt;
   &lt;/td&gt;
 &lt;/tr&gt;
 &lt;tr&gt;
   &lt;td&gt;Eating Food&lt;/td&gt;
   &lt;td&gt;Herring, Walter and Chips, Bob&lt;/td&gt;
   &lt;td&gt;2000&lt;/td&gt;
   &lt;td&gt;
     &lt;a href="http://eprints.foobar.ac.uk/archive/00000445/"&gt;
       &lt;img ... /&gt;
     &lt;/a&gt;
   &lt;/td&gt;
 &lt;/tr&gt;

===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", 
   allow_null=>0, 
   fields=>"authors.id/editors.id", 
   order=>"-year/title", 
   noindex=>1, 
   include=>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.