Editing Config Options by File (section)

== E ==
=== [[element_classes.pl]] ===
These can be useful if you are trying use an existing [[Branding_with_confidence|branding]] template, e.g. CSS, JavaScript, etc. for your institution. 
* '''eprint'''
** '''summary_content_class''' - The classes that should be used for HTML <code>&lt;div&gt;</code> elements around the abstract/summary page.  Default is as follows:
 {
   ROOT => 'ep_summary_content',
   top => 'ep_summary_content_top',
   left => 'ep_summary_content_left',
   main => 'ep_summary_content_main',
   right => 'ep_summary_content_right',
   bottom =>'ep_summary_content_bottom',
   after => 'ep_summary_content_after'
 };
* '''item_list_class''' - The class that should be used for items in the key tools menu bar.
* '''toolbar_class''' - The class that should be used for key tools menu bar.

=== [[email.pl]] ===
* '''send_email''' - Defines a function for sending email from your repository archive.  (By default this calls <code>EPrints::Email::send_mail_via_smtp</code>, which will then use whatever hostname is set for <code>smtp_server</code> under <code>EPrints::SystemSettings</code>. If this is <code>localhost</code> or <code>127.0.0.1</code>, you will have to set up an application on your server to relay this email. E.g. Sendmail, Postfix, etc.).

=== [[epm.pl]] ===
* '''datasets'''
** '''epm''' - Defines the dataset for Bazaar plugins / EPrints Package Manager (EPM) objects. I.e. <code>EPrints::DataObj::EPM</code>.
*** '''sqlname''' - Name of EPM dataset when referred to in SQL statements.
*** '''class''' - The package name of the class for data objects belonging to the EPM dataset.
*** '''virtual''' - Whether the EPM dataset exists in the dataset. (By default <code>1</code> is not in the database. SHOULD NOT BE CHANGED).
*** '''sources''' - Array reference of locations where EPMs can be installed from.  Each entry contains a <code>name</code> and <code>base_url</code>.  (By default one entry with <code>name</code> of <code>EPrints Bazaar</code> and <code>base_url</code> of <code>https://bazaar.eprints.org</code>).
=== [[eprint_fields_automatic.pl]] ===
* '''set_eprint_automatic_fields''' - What fields to automatically update when an eprint data object record is committed.  (By default for the pub_lib flavour, <code>ispublished</code> is set to <code>pub</code> if <code>type</code> is <code>patent</code>. If not already set,<code>ispublished</code> is set to <code>unpub</code> if <code>type</code> is <code>thesis</code>.  Also, <code>full_text_status</code> is set to <code>none</code> if there are no documents, <code>restricted</code> if any documents are restricted and <code>public</code> if all documents are unrestricted.  Default configuration for zero flavour does not set any eprint fields automatically).

=== [[eprint_fields_common.pl]] ===
* '''fields'''
** '''eprint''' - Adds <code>contact_email</code> field to the eprint data object.

=== [[eprint_fields_default.pl]] ===
* '''set_eprint_defaults''' - Sets default values for fields when eprint data object is created.  (By default pub_lib flavour sets <code>type</code> to <code>article</code>, for zero flavour its set it to <code>other</code>).

=== [[eprint_fields.pl]] ===
* '''fields'''
** '''eprint''' - Adds extra fields to eprint data object.  (The following fields are added by default for the pub_lib and zero flavours).
 '''pub_lib''': creators, contributors, corp_creators, title, ispublished, subjects, divisions, keywords, note, suggestions, abstract, date, date_type, publisher, official_url, id_number, data_type, opyright_holders

 '''zero''': title, subjects

=== [[eprint_fields_pub.pl]] ===
* '''fields'''
** '''eprint''' - Adds extra fields to eprint data object.  (The following fields are added by default for the pub_lib flavour: <code>full_text_status, monograph_type, pres_type, series, publication, volume, number, article_number, place_of_pub, pagerange, pages, event_title, event_location, event_dates, event_type, patent_applicant, institution, department, thesis_type, thesis_name, refereed, isbn, issn, book_title, edition, editors, related_url, referencetext, funders, projects, output_media, num_pieces, composition_type, pedagogic_type, completion_tome, task_purpose, skills_area, learning_level, gscholar</code>).

=== [[eprint_locking.pl]] ===
* '''locking'''
** ''' eprint''' 
*** '''enable''' - Enables locking of eprint data objects so they cannot be edited whilst another user is editing. (By default enabled, i.e. <code>1</code>).
*** '''timeout''' - Number of seconds before a lock is released if the current user does not complete or cancel editing. (Default <code>3600</code>, i.e. 1 hour).

=== [[eprint_render.pl]] ===
* '''summary_page_metadata''' - eprint metadata fields to include in the summary table on abstract/summary pages.  (The following fields are added by default for the pub_lib and zero flavours).
 '''pub_lib''': commentary, note, keywords, subjects, divisions, sword_depositor, userid, datestamp, lastmod

 '''zero''': commentary, subjects, sword_depositor, userid, datestamp, lastmod
* '''eprint_render''' - Function that generates XHTML DOM objects for the page, title and links for the abstract/summary page.

=== [[eprint_search_advanced.pl]] ===
* '''search'''
** '''advanced''' - The configuration for the advanced search for eprint data objects.
*** '''search_fields''' - Array reference of <code>meta_fields</code> to include in the advanced search form. (Default varies depending on flavour).
*** '''template''' - The page template to use when displaying the advanced search form. (Default: <code>default</code>).
*** '''preamble_phrase''' - The phrase at the top of the advanced search form.  I.e. to explain how to use it. (Default: <code>cgi/advsearch:preamble</code>).
*** '''title_phrase''' - The phrase to use for the page title of the advanced search form. (Default: <code>cgi/advsearch:adv_search</code>).
*** '''citation''' - The eprint citation style to use for search results. (Default: <code>result</code>).
*** '''page_size''' - How many results to display per page. (Default: <code>20</code>).
*** '''order_methods''' - Different ways or ordering search results (Default varies depending on flavour).
*** '''default_order''' - Default order for search results (Default: <code>byyear</code> for pub_lib, <code>bytitle</code> for zero).
*** '''show_zero_results''' - Whether to go to results page with no results or say on search form page. (Default: <code>1</code>, i.e. go to search results page).

=== [[eprint_search_simple.pl]] ===
* '''search'''
** '''simple''' - The configuration for the simple search for eprint data objects.
*** '''search_fields'''
**** '''id''' - The name to give to the single input field for the simple search form.
**** '''meta_fields''' - The eprint metadata fields that will be search over for the input in the simple search form.  (Default varies on flavour. <code>documents, title</code> for zero, <code>documents, title, abstract, creators_name, date</code> for pub_lib).
*** '''template''' - The page template to use when displaying the simple search form. (Default: <code>default</code>).
*** '''title_phrase''' - The phrase to use for the page title of the dimple search form. (Default: <code>cgi/search:simple_search</code>).
*** '''citation''' - The eprint citation style to use for search results. (Default: <code>result</code>).
*** '''page_size''' - How many results to display per page. (Default: <code>20</code>).
*** '''order_methods''' - Different ways or ordering search results (Default varies depending on flavour).
*** '''default_order''' - Default order for search results (Default: <code>byyear</code> for pub_lib, <code>bytitle</code> for zero).
*** '''show_zero_results''' - Whether to go to results page with no results or say on search form page. (Default: <code>1</code>, i.e. go to search results page).

=== [[eprint_search_staff.pl]] ===
* '''datasets''' 
** '''eprint'''
*** '''search'''
**** '''staff''' - The configuration for the staff (i.e. admins/editors only) search for eprint data objects.
**** '''search_fields''' - Array reference of <code>meta_fields</code> to include in the staff search form. (Default varies depending on flavour.  Advanced search fields plus: <code>eprintid, userid.username, userid.name, dir</code>.  Also <code>eprint_status</code> for pub_lib flavour.
**** '''preamble_phrase''' - The phrase at the top of the staff search form.  I.e. to explain how to use it. (Default: <code>Plugin/Screen/Staff/EPrintSearch:description</code>).
**** '''title_phrase''' - The phrase to use for the page title of the staff search form. (Default: <code>Plugin/Screen/Staff/EPrintSearch:titl</code>).
**** '''citation''' - The eprint citation style to use for search results. (Default: <code>result</code>).
**** '''page_size''' - How many results to display per page. (Default: <code>20</code>).
**** '''order_methods''' - Different ways or ordering search results (Default varies depending on flavour).
**** '''default_order''' - Default order for search results (Default: <code>byyear</code> for pub_lib, <code>bytitle</code> for zero).
**** '''show_zero_results''' - Whether to go to results page with no results or say on search form page. (Default: <code>1</code>, i.e. go to search results page).
**** '''staff''' - Whether search is only accessible to staff (Default <code>1</code>, i.e. only available to staff).

=== [[eprint_validate.pl]] ===
* '''validate_eprint''' - Defines a function that performs complex (i.e. containing multiple metadata fields) validation on <code>eprint</code>  data objects and generate XHTML DOM objects describe any problems found.  (Function varies depending of flavour.  Zero function does no further validation.  pub_lib flavour checks at least one creator or editor is set).

=== [[eprint_warnings.pl]] ===
* '''eprint_warnings''' - Defines a function that performs complex (i.e. containing multiple metadata fields) checks on <code>eprint</code> data objects and generate XHTML DOM objects describe warnings where metadata may not have been correctly completed. (Function varies depending of flavour. All flavours  warn if no documents have been uploaded. pub_lib flavour also warns if not <code>contact_email</code> has been set).

=== [[executables.pl]] ===
* '''disable_df''' - Whether to disable use of Unix <code>df</code> command to check free space of disk partitions and just use the one that comes last alphanumerically.  (By default <code>0</code>, i.e. do use <code>df</code>, unless already defined in <code>perl_lib/EPrints/SystemSettings.pm</code>).
* '''executables''' - File paths to external applications or internal scripts used by EPrints.  Includes the following applications/scripts: <code>convert, tar, rm, dvips, gunzip, sendmail, unzip, html2text, cp, latex, perl, pdftotext, wget, antiword, ffmpeg, file, doc2txt, unoconv, txt2refs, ffprobe, cal, ncal</code>.

=== [[exports.pl]] ===
* '''export'''
** '''publication_status_type_override''' - Allows certain export formats (BibTeX and RIS) to change the type of exported object if certain conditions are met. (e.g. <code>ispublished</code> is set to <code>unpub</code>.).  (Default is <code>1</code> types can be changed).