Config Options by File

From EPrints Documentation
Revision as of 17:40, 13 July 2024 by Drn@ecs.soton.ac.uk (talk | contribs) (→‎flavour_info.pl)
Jump to: navigation, search

0-9 | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

Warning.png

Work in Progress
The page is a work in progress.

Only some of the config files have full lists of settings with descriptions and other configuration files have yet to be added.

0-9

00_version.pl

  • version_long - The long version name of EPrints (e.g. EPrints 3.4.5).
  • version_alias - The alias/codename for the core EPrints release version (e.g. Smoothie Squall).
  • vendor_long - The long name of the vendor responsible for the EPrints software release (e.g. EPrints Services).
  • vendor_short - The short name / abbreviation of the vendor responsible for the EPrints software release (e.g. eps).
  • version_description - A fully description of the EPrints software version using above version/vendor settings.

10_core.pl

  • aliases - Other hostnames for the repository archive and whether they should redirect to the primary hostname.
  • host - The primary hostname of the repository archive on HTTP.
  • port - The TCP port number to connect to the repository archiver over HTTP. (Typically 80).
  • securehost - The primary hostname of the repository archive on HTTPS. Normally the same as host, so typically can be a reference.
  • secureport - The TCP port number to connect to the repository archiver over HTTPS. (Typically 443).
  • http_root - Where the repository archive will be hosted. (Typically undefined).

20_baseurls.pl

  • base_url - URL including protocol and hostname, used as a basis whenever a full URL for a specific location needs to be generated.
  • perl_url - URL including protocol and hostname, used as a basis whenever a full URL for a specific CGI script needs to be generated.
  • use_long_url_format - Use long URLs for abstract pages / documents (e.g. /id/eprint/1234 or /id/eprint/1234/1/paper.pdf rather than /1234 or /1234/1/paper.pdf. Will redirect from short to long URL rather than the long to short. (Default is 0 to not use long URLs).

A

adminemail.pl

  • adminemail - The email address for the administrator of the repository archive. Will be displayed in contact page and default address email will be sent to and from.
  • sendermail - Alternative email address to send email for the repository archive from. Useful if restrictions on where email can be sent from for the domain of the adminemail address. Will still set adminemail in reply-to.

B

branding.pl

  • site_logo - Default logo to use for the site. Probably only useful if using default template for EPrints.

build_attributes.pl

  • build_node_attributes - Defines function for manipulating attributes that can be called by EPrints::XML::create_element.

C

citation_default.pl

  • citation_default
    • document
      • for_summary_page - The default document citation to use when rendering a document of an abstract/summary page.
    • eprint
      • export - The default eprint citation to use with export plugins.
      • for_issue - The default eprint citation to use when rendering an issue.
      • for_result - The default eprint citation to use when rendering a set of eprint search results.
      • for_summary_page - The default eprint citation to use when rendering a eprint of an abstract/summary page.

citationcaches.pl

  • datasets
    • citationcache - Defines dataset configuration for EPrints::DataObj::CitationCache.
  • citation_caching
    • enabled - Whether citation caching is enabled. (Default is 0, i.e. not enabled).
    • excluded_dataobjs - Data objects that should not cache citations because they are dynamic/context dependent. (Default [ 'epm', 'loginticket', 'subject']).
    • excluded_style - Citation styles that should not be cache because they are dynamic/context dependent. (Default [ 'result' ]).

csrf_protection.pl

  • csrf_token_salt - A salt to ensure generated CSRF tokens are not guessable.

D

database.pl

  • dbhost - The hostname or IP address where the database for the repository archive is hosted. (Typically localhost).
  • dbname - The name of the database where the repository archive is hosted. (Typically the same as the archive's ID).
  • dbpass - The password to connect to the database where the repository archive is hosted. (Typically automatically generated 16 character string).
  • dbuser - The username to connect to the database where the repository archive is hosted. (Often the same as the archive's ID).
  • dbengine - The database table engine to use when creating new tables in the database where the repository archive is hosted. (Default is InnoDB, previously has been MyISAM).

datasets.pl

  • datasets - Initialises hash reference (if not already) so other configuration files can add bespoke datasets.

doc_rewrite.pl

Adds an EP_TRIGGER_DOC_URL_REWRITE trigger to handle relation-based document redirects.

document_fields_automatic.pl

  • set_document_automatic_fields - A function that updates specified fields for a document when its data object is committed. By default no fields are updated.

document_fields_default.pl

  • set_document_defaults - A function that sets the initial values specified fields for a document when its data object is created. (By default the language field is set to the default language for the repository and the security field is set to public).
  • eprint_details_document_fields - The document fields that should be displayed in the Upload section of Details tab of the eprint view page. (Default: [ "content", "format", "format_desc", "language", "security", "license", "date_embargo", "embargo_reason" ]

document_fields.pl

  • fields
    • -document' - Extra fields to add to the document data object beyond those defined by EPrints::DataObj::Document. (By default this configuration is commented out. I.e. no new fields will be added).

document_upload.pl

  • diskspace_error_threshold -
  • diskspace_warn_threshold -
  • guess_doc_type -
  • on_files_modified -
  • required_formats -

document_validate.pl

  • validate_document - A function that validates the metadata for a document data object.

The following validation tests are performed on a document data object:

  1. formatdesc is set if the format is other.
  2. Unless retain_embargo_dates config option is set true, if security is set to public then the date_embargo field must be unset.
  3. If the year part of date_embargo is set then the month and day most also be set to ensure clarity on when an embargo expires.
  4. Unless retain_embargo_dates config option is set true, date_embargo must be in the past.
  5. If security is set to public then date_embargo cannot be in the future (and can only be in the past if retain_embargo_dates config option is set true).

dynamic_template.pl

For more information see Dynamic Pins.

  • dynamic_template
    • enable - Enables dynamic template. (Default is 1).
  • plugins
    • Screen::Login
      • appears
        • key_tools - Where login page link should appear in the key tools menu bar, if the user is not already logged in.
    • Screen::Register
      • actions
        • register
          • appears
            • key_tools - Where the user registration page link should appear in the key tools menu bar.
    • Screen::Logout
      • appears
        • key_tools - Where logout page link should appear in the key tools menu bar, if the user is already logged in.
    • Screen::Admin::Config::Edit::XPage
      • actions
        • edit
          • appears
            • key_tools - Where the edit static page (if current page is a static page) link should appear in the key tools menu bar.
    • Screen::Admin::Phrases
      • actions
        • edit
          • appears
            • key_tools - Where the edit page phrases link should appear in the key tools menu bar.
    • Screen::OtherTools
      • appears
        • key_tools - Where Other Tools page link should appear in the key tools menu bar.

E

element_classes.pl

These can be useful if you are trying use an existing [[1]] template. CSS, etc. for your institution.

  • eprint
    • summary_content_class - The classes that should be used for HTML div 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 - A function for send email from your EPrints repository. (By defaults this calls EPrints::Email::send_mail_via_smtp, which will then use whatever hostname is set for smtp_server under EPrints::SystemSettings. if this is localhost or 127.0.0.1 you have set up an application on your server to relay email from the server, e.g. Sendmail or Postfix).

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, ispublished is set to pub if type is patent and not yet set ispublished is set to unpub if type is thesis. Also, full_text_status is set to none if there are no documents, restricted if any documents are restricted and public if all documents are unrestricted. Default configuration for zero flavour does not set any eprint fields automatically).

eprint_fields_common.pl

  • fields
    • eprint - Adds contact_email 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 type to article, for zero flavour its set it to other).

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: 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).

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. 1).
      • timeout - Number of seconds before a lock is released if the current user does not complete or cancel editing. (Default 3600, 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 meta_fields 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: default).
      • preamble_phrase - The phrase at the top of the advanced search form. I.e. to explain how to use it. (Default: cgi/advsearch:preamble).
      • title_phrase - The phrase to use for the page title of the advanced search form. (Default: cgi/advsearch:adv_search).
      • citation - The eprint citation style to use for search results. (Default: result).
      • page_size - How many results to display per page. (Default: 20).
      • order_methods - Different ways or ordering search results (Default varies depending on flavour).
      • default_order - Default order for search results (Default: byyear for pub_lib, bytitle for zero).
      • show_zero_results - Whether to go to results page with no results or say on search form page. (Default: 1, 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. documents, title for zero, documents, title, abstract, creators_name, date for pub_lib).
      • template - The page template to use when displaying the simple search form. (Default: default).
      • title_phrase - The phrase to use for the page title of the dimple search form. (Default: cgi/search:simple_search).
      • citation - The eprint citation style to use for search results. (Default: result).
      • page_size - How many results to display per page. (Default: 20).
      • order_methods - Different ways or ordering search results (Default varies depending on flavour).
      • default_order - Default order for search results (Default: byyear for pub_lib, bytitle for zero).
      • show_zero_results - Whether to go to results page with no results or say on search form page. (Default: 1, 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 meta_fields to include in the staff search form. (Default varies depending on flavour. Advanced search fields plus: eprintid, userid.username, userid.name, dir. Also eprint_status 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: Plugin/Screen/Staff/EPrintSearch:description).
        • title_phrase - The phrase to use for the page title of the staff search form. (Default: Plugin/Screen/Staff/EPrintSearch:titl).
        • citation - The eprint citation style to use for search results. (Default: result).
        • page_size - How many results to display per page. (Default: 20).
        • order_methods - Different ways or ordering search results (Default varies depending on flavour).
        • default_order - Default order for search results (Default: byyear for pub_lib, bytitle for zero).
        • show_zero_results - Whether to go to results page with no results or say on search form page. (Default: 1, i.e. go to search results page).
        • staff - Whether search is only accessible to staff (Default 1, i.e. only available to staff).

eprint_validate.pl

  • validate_eprint - Function that performs complex (i.e. containing multiple metadata fields) validation on eprint 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 - Function that performs complex (i.e. containing multiple metadata fields) checks on eprint 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 contact_email has been set.

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. ispublished is set to unpub.). (Default is 1 types can be changed).

F

field_property_defaults.pl

  • field_defaults
    • input_cols - The default number of cols (columns) in a <textarea> or size of <input> HTML form field. (Default 60).
    • input_rows - The default number of rows in a <textarea&gt HTML form field. (Default 10).
    • input_name_cols - The default size of <input> HTML form field for various sub-fields of a name metadata field.
      • honourific - The honourific sub-field. (Default is 8).
      • given - The given name sub-field. (Default is 20).
      • family - The family name sub-field. (Default is 20).
      • lineage - The lineage sub-field. (Default is 8).
    • input_add_boxes - The number of rows to add to a metadata field that allows multiple values when clicking the More input rows button. (Default is 2).
    • input_boxes - The initial number of rows for metadata field that allows multiple values. (Default is 3).
    • digits - The maximum number of digits that can be added for an int (integer) metadata field. (Default is 9. Any higher might exceed the biggest number the database can store).
    • search_cols - The default number of cols (columns) in a <textarea&gt or size of <input> HTML form field when part of a search form. (Default 40).
    • search_rows - The default number of rows in a <textarea&gt HTML form field when part of a search form. (Default 12).
    • hide_honourific - Whether the honourific sub-field when rendering name metadata field in an HTML input form (Default 0, do not hide).
    • hide_lineage - Whether the lineage sub-field when rendering a name metadata field in an HTML input form (Default 1, do hide).
    • family_first - Whether the family name sub-field should appear before the given name sub-field in an HTML input form Default 0, given name should come first).

field_validate.pl

  • validate_field - Function that validates particular metadata fields. Currently only used on user and eprint data objects. Default validations include:
    1. url fields starts with a protocol (e.g. http:, https: etc.). Checking
    2. name fields has a family and given name set.
    3. email fields contains only one @, which is not at the start and end and no spaces.
    4. id fields and sub-classes (e.g. text, longtext url, etc.) are no longer than the specified maxlength attribute for the field.
    5. User's username field is not a duplicate.

flavour_info.pl

  • flavour_id - The ID of the flavour. (E.g. zero or pub).
  • flavour_name - The name of the flavour. (E.g. Zero or Publication).
  • flavour_version - The release version of the flavour. (Different to the EPrints release version).
  • version_alias - Updates the alias for the EPrints version with a particular flavour. (I.e. not updated for zero flavour).

G

H

I

indexing.pl

  • extract_words -
  • index -
  • indexing -

issues_search.pl

TO BE ADDED

J

K

L

languages.pl

  • defaultlanguage -
  • languages -

latest_tool.pl

TO BE ADDED

limit_names_shown.pl

TO BE ADDED

log.pl

  • log -
  • loghandler -

M

make_orderkey.pl

TO BE ADDED

media_info.pl

TO BE ADDED

mime_types.pl

TO BE ADDED

misc.pl

  • allow_user_removal_request -
  • cache_maxlife -
  • cache_timeout -
  • cookie_auth -
  • cookie_domain -
  • disable_userinfo -
  • pin_timeout -
  • skip_buffer -
  • use_mimetex -

N

O

oai.pl

  • oai -

optional_filename_sanitise.pl

TO BE ADDED

P

paths.pl

  • config_path -
  • documents_path -
  • htdocs_path -

plugins.pl

TO BE ADDED

private_ips.pl

TO BE ADDED

Q

R

rdf_license.pl

TO BE ADDED

rdf_triples_bibo.pl

TO BE ADDED

rdf_triples_eprints.pl

TO BE ADDED

rdf_triples_formats.pl

TO BE ADDED

rdf_triples_general.pl

TO BE ADDED

rdf_triples_repository.pl

TO BE ADDED

rdf_triples_skos.pl

TO BE ADDED

rdf_triples_bibo.pl

TO BE ADDED

rdf_uris.pl

TO BE ADDED

registration.pl

  • allow_reset_password -
  • allow_web_signup -
  • default_user_type -
  • signup_style -
  • user_registration_fields -

render_paras.pl

TO BE ADDED

request_copy.pl

  • email_for_doc_request -

restrict_paths.pl

TO BE ADDED

rewrite_url_demo.pl

TO BE ADDED

S

search.pl

  • editor_limit_fields -
  • issues_search -
  • latest_citation -
  • latest_tool_modes -
  • match_start_of_name -
  • search -

search_xapian.pl

TO BE ADDED

security.pl

  • can_request_view_document -
  • can_user_view_document -

session.pl

  • session_close -
  • session_init -

sword.pl

  • sword -

signposting.pl

TO BE ADDED

template_core.pl

TO BE ADDED

template_edit_phrases.pl

TO BE ADDED

template_legacy.pl

TO BE ADDED

template_leinks.pl

TO BE ADDED

U

upload.pl

TO BE ADDED

urls.pl

  • frontpage -
  • rewrite_exceptions
  • userhome -

user_auth_limits.pl

TO BE ADDED

user_fields_automatic.pl

  • set_user_automatic_fields -

user_fields_default.pl

  • set_user_defaults -

user_fields.pl

  • fields -

user_render.pl

  • user_render -

user_review_scope.pl

TO BE ADDED

user_roles.pl

  • user_roles -

user_search.pl

TO BE ADDED

user_validate.pl

  • validate_user -

V

views.pl

  • browse_views -

views_render_items_example.pl

TO BE ADDED

views_render_menu_example.pl

TO BE ADDED

vlit.pl

  • vlit -

W

X

Y

y_export_privacy.pl

TO BE ADDED

Z

zz_version.pl

  • version_description -
Retrieved from ‘https://wiki.eprints.org/w/index.php?title=Config_Options_by_File&oldid=16364’