Editing Quickstart:Customise EPrints (section)

= Functionality =

== Core Files ==
<p>As a rule, to make sure you see the benefit of updates to the core codebase, you don't want to directly modify files outside of your archive directory. Instead, these files can be duplicated inside your archive and modified to allow you to make specific customisations.</p>

=== Views ===
<p>A View in EPrints is a page for browsing the repository, you may have a 'Browse by Author' View and/or a 'Browse by Year' View, you can have multiple Views to accomodate how your users need to access your records.</p>
<p>The configuration for browse views can be found in <code>views.pl</code>, which by default is found under <code>/opt/eprints3/flavours/pub_lib/cfg.d/</code> but should be copied to the archive's <code>cfg/cfg.d/</code> for editing.</p>

<p>See the [[:Category:Browse_Views | Browse Views Category]] for more information.</p>

=== Workflows ===
<p>First class/top level data objects in EPrints (such as eprints records or users) have a workflow to allow the metadata they store to be edited via a sequence of forms.</p>
<p>The most common workflow is for the eprint data object. By default the configuration for this workflow is written in XML and can be found in <code>default.xml</code> in <code>/opt/eprints3/flavours/pub_lib/workflows/eprint/</code>. If this needs to be modified it should be copied to the archive's <code>/opt/eprints3/ARCHIVE_ID/cfg/workflows/eprint/</code> directory before editing.</p>

<p>Explanation of the various elements and attributes are described in the [[Workflow_Format | Workflow Format Guide]].</p>

=== Searches ===
==== Simple ====
Simple search by default provides a single text field for users to enter their search terms to search across a selection of different attributes of a publication. Typically this simple search will be included on repository's home page or as part of the template so users can conduct a search from any page. The simple search form can be found at:
 http://EPRINTS_HOSTNAME/cgi/search/simple
If you want to generate a pre-canned search the search terms are sent under the "q" parameter, e.g.
 https://demo.eprints-hosting.org/cgi/search/simple?q=Science

<p>The attributes it searches on can be modified by copying <code>eprint_search_simple.pl</code> from <code>/opt/eprints3/lib/defaultcfg_zero/cfg.d/</code> to <code>/opt/eprints3/archives/ARCHIVE_ID/cfg/cfg.d/</code> and modifying the meta_fields section.</p>
<p>Other search options such as search results ordering, paging and formatting can also be modified.</p>

==== Advanced ====
<p>Advanced Search allows a user to filter a search to specific terms and items, this search typically exists on its own page to give space for different filtering options.</p>
<p>The advanced search page can be found at:</p>
 http://EPRINTS_HOSTNAME/cgi/search/advanced
eg: 
 https://demo.eprints-hosting.org/cgi/search/advanced

<code>eprint_search_advanced.pl</code> contains configuration for the advanced search on eprint data objects, it can be copied from <code>/opt/eprints3/lib/defaultcfg_zero/cfg.d/</code> to <code>/opt/eprints3/archives/ARCHIVE_ID/cfg/cfg.d/</code> and modified.

==== Find Out More ====
<p>For more details on editing search, see our [[Search.pl | Search Guides]].</p>

== Extending ==
<p>If you find youself wanting additional functionality in EPrints, you may find it's something that someone else has also needed. To allow customisations to be transferred simply between EPrints systems we have Ingredients that can be added to your system, some functionality may also only be available through the legacy EPM/Bazaar Plugins system.
=== Ingredients ===
<p>The main purpose of ingredients is to allow complex functionality to be developed but deployed in a self contained manner, that does not impact the existing core codebase.</p>
<p>Typically, an ingredient would be deployed by checking out a tagged version of the Git repository for that ingredient on GitHub into the ingredients directory <code>/opt/eprints3/ingredients/</code>.</p>
<p>With the files ready, the ingredient then needs to be installed into the system, see our [[Installing Ingredients | Installing Ingredients Guide]] for more details</p>

=== EPMs/Bazaar Plugins ===
<p>Now mostly superceeded by Ingredients, in previous versions of EPrints the Bazaar was the preferred method of extending the functionality of an EPrints system. You may find some functionality still requires you install an EPM package from the Bazaar.</p>
<p>You can find more information on installing an EPM on our [[Installing an EPM |Installing an EPM]] page.