Difference between revisions of "Archives/ARCHIVEID/cfg/cfg.d/"

From EPrints Documentation
Jump to: navigation, search
(Added more config files.)
(Finished adding descriptions for configuration files.)
Line 11: Line 11:
 
** '''[[branding.pl]]''' - Branding for the repository archive.
 
** '''[[branding.pl]]''' - Branding for the repository archive.
 
** '''[[database.pl]]''' - Configuration for connecting to the database.
 
** '''[[database.pl]]''' - Configuration for connecting to the database.
** '''[[datasets.pl]]''' -
+
** '''[[datasets.pl]]''' - Configuration for bespoke datasets and data objects for the repository archive.
 
** '''[[document_fields_automatic.pl]]''' - Configuation for automatically setting document fields based on the values of other fields.
 
** '''[[document_fields_automatic.pl]]''' - Configuation for automatically setting document fields based on the values of other fields.
 
** '''[[document_fields_default.pl]]''' - Default initial values for document fields.
 
** '''[[document_fields_default.pl]]''' - Default initial values for document fields.
Line 17: Line 17:
 
** '''[[document_upload.pl]]''' - Configuration relating to managing document uploads.
 
** '''[[document_upload.pl]]''' - Configuration relating to managing document uploads.
 
** '''[[document_validate.pl]]''' - Validation of the eprint data object as a whole.
 
** '''[[document_validate.pl]]''' - Validation of the eprint data object as a whole.
** '''[[dynamic_template.pl]]''' - Configuration for dynamic template of repository archive.
+
** '''[[dynamic_template.pl]]''' - Legacy configuration for dynamic template of repository archive.
 
** '''[[email.pl]]''' - Configuration for sending email from the repository archive.
 
** '''[[email.pl]]''' - Configuration for sending email from the repository archive.
 
** '''[[eprint_fields_automatic.pl]]''' - Configuation for automatically setting eprint fields based on the values of other fields.
 
** '''[[eprint_fields_automatic.pl]]''' - Configuation for automatically setting eprint fields based on the values of other fields.
** '''[[eprint_fields_common.pl]]''' -
+
** '''[[eprint_fields_common.pl]]''' - Common (across [[EPrints Flavours|flavours]]) non-core fields for the eprint data object.
 
** '''[[eprint_fields_default.pl]]''' - Default initial values for eprint fields.
 
** '''[[eprint_fields_default.pl]]''' - Default initial values for eprint fields.
 
** '''[[eprint_fields.pl]]''' - Non-core field definitions for the eprint data object.
 
** '''[[eprint_fields.pl]]''' - Non-core field definitions for the eprint data object.
** '''[[eprint_fields_pub.pl]]''' -  
+
** '''[[eprint_fields_pub.pl]]''' - Publication [[EPrints Flavours|flavour]] fields for the eprint data object.
** '''[[eprint_locking.pl]]''' -  
+
** '''[[eprint_locking.pl]]''' - Configuration for locking eprint data objects so they can only be edited by one user at once.
 
** '''[[eprint_render.pl]]''' - Configuration for rendering eprint abstract/summary pages.
 
** '''[[eprint_render.pl]]''' - Configuration for rendering eprint abstract/summary pages.
 
** '''[[eprint_search_advanced.pl]]''' - Configuration for advanced search of eprint data objects.
 
** '''[[eprint_search_advanced.pl]]''' - Configuration for advanced search of eprint data objects.
Line 31: Line 31:
 
** '''[[eprint_validate.pl]]''' - Validation of the eprint data object as a whole.
 
** '''[[eprint_validate.pl]]''' - Validation of the eprint data object as a whole.
 
** '''[[eprint_warnings.pl]]''' - Warnings to advise the depositor on potential issues with the eprint (e.g. no uploaded documents).
 
** '''[[eprint_warnings.pl]]''' - Warnings to advise the depositor on potential issues with the eprint (e.g. no uploaded documents).
** '''[[exports.pl]]''' -
+
** '''[[exports.pl]]''' - Configuration relating to generic aspects of export plugins.
 
** '''[[field_property_defaults.pl]]''' - Defaults for various attributes for a field specification.
 
** '''[[field_property_defaults.pl]]''' - Defaults for various attributes for a field specification.
 
** '''[[field_validate.pl]]''' - General validation of a metadata field.
 
** '''[[field_validate.pl]]''' - General validation of a metadata field.
** '''[[flavour_info.pl]]''' -  
+
** '''[[flavour_info.pl]]''' - Information about the [[EPrints Flavours|flavour]] of the repository archive.
 
** '''[[indexing.pl]]''' - Configuration for indexing of metadata and document content.
 
** '''[[indexing.pl]]''' - Configuration for indexing of metadata and document content.
** '''[[issues_search.pl]]''' -
+
** '''[[issues_search.pl]]''' - Configuration for search of eprint issues.
 
** '''[[languages.pl]]''' - Configuration for languages used by the repository archive.
 
** '''[[languages.pl]]''' - Configuration for languages used by the repository archive.
** '''[[latest_tool.pl]]''' -
+
** '''[[latest_tool.pl]]''' - Configuration for generating listings and feeds of latest eprints in the repository archive.
 
** '''[[log.pl]]''' - Configuration for logging error/warnung messages for the repository archive.
 
** '''[[log.pl]]''' - Configuration for logging error/warnung messages for the repository archive.
 
** '''[[misc.pl]]''' - Miscellaneous configuration settings.
 
** '''[[misc.pl]]''' - Miscellaneous configuration settings.
Line 44: Line 44:
 
** '''[[paths.pl]]''' - Configuration for filesystem paths for particular parts of the repository archive.
 
** '''[[paths.pl]]''' - Configuration for filesystem paths for particular parts of the repository archive.
 
** '''[[plugins.pl]]''' - Enabling and configuration of plugins for the repository archive.
 
** '''[[plugins.pl]]''' - Enabling and configuration of plugins for the repository archive.
** '''[[rdf_license.pl]]''' -
+
** '''[[rdf_license.pl]]''' - Configuration for adding licences to RDF data files.
** '''[[rdf.pl]]''' -
+
** '''[[rdf.pl]]''' - Configuration for setting XML namespaces for RDF data files.
** '''[[rdf_triples_bibo.pl]]''' -
+
** '''[[rdf_triples_bibo.pl]]''' - Configuration for generating Bibo RDF triples for an eprint data object.
** '''[[rdf_triples_eprints.pl]]''' -
+
** '''[[rdf_triples_eprints.pl]]''' - Configuration for generating EPrints RDF triples for an eprint data object.
** '''[[rdf_triples_formats.pl]]''' -
+
** '''[[rdf_triples_formats.pl]]''' - Configuration for generating format RDF triples for an eprint data object.
** '''[[rdf_triples_general.pl]]''' -
+
** '''[[rdf_triples_general.pl]]''' - Configuration for generating general RDF triples.
** '''[[rdf_triples_repository.pl]]''' -
+
** '''[[rdf_triples_repository.pl]]''' - Configuration for generating repository RDF triples.
** '''[[rdf_triples_skos.pl]]''' -
+
** '''[[rdf_triples_skos.pl]]''' - Configuration for generating SKOS RDF triples for an eprint and subject data objects.
** '''[[rdf_uri_event_location.pl]]''' -
+
** '''[[rdf_uris.pl]]''' - Configuration for generating RDF URIs.
** '''[[rdf_uri_event.pl]]''' -
 
** '''[[rdf_uri_org.pl]]''' -
 
** '''[[rdf_uri_person.pl]]''' -
 
** '''[[rdf_uri_publication.pl]]''' -
 
 
** '''[[registration.pl]]''' - Configuation for enabling/managing user reegistration for the repository archive.
 
** '''[[registration.pl]]''' - Configuation for enabling/managing user reegistration for the repository archive.
 
** '''[[render_paras.pl]]''' - Function for rendering paragraphs for free-text fields.
 
** '''[[render_paras.pl]]''' - Function for rendering paragraphs for free-text fields.
Line 62: Line 58:
 
** '''[[search.pl]]''' - Miscelleanous search configuation not tied to a specific data object or type of search.
 
** '''[[search.pl]]''' - Miscelleanous search configuation not tied to a specific data object or type of search.
 
** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents.
 
** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents.
** '''[[session.pl]]''' -
+
** '''[[session.pl]]''' - Functions for bespoke operations when initiating or closing a session.
** '''[[template_core.pl]]''' -
+
** '''[[template_core.pl]]''' - Core trigger for generating dynamic template.
** '''[[template_edit_phrases.pl]]''' -
+
** '''[[template_edit_phrases.pl]]''' - Edit phrases trigger for generating dynamic template.
** '''[[template_legacy.pl]]''' -
+
** '''[[template_legacy.pl]]''' - Legacy trigger for generating dynamic template, as defined in [[dynamic_template.pl]].
** '''[[template_links.pl]]''' -
+
** '''[[template_links.pl]]''' - Links trogger for generating dynamic template.
** '''[[user_auth_limits.pl]]''' -
+
** '''[[user_auth_limits.pl]]''' - Configuration for limiting user authentication attempts.
 
** '''[[user_fields_automatic.pl]]''' - Configuation for automatically setting user fields based on the values of other fields.
 
** '''[[user_fields_automatic.pl]]''' - Configuation for automatically setting user fields based on the values of other fields.
 
** '''[[user_fields_default.pl]]''' - Default initial values for user fields.
 
** '''[[user_fields_default.pl]]''' - Default initial values for user fields.
Line 74: Line 70:
 
** '''[[user_password_maxlength.pl]]''' - Configuration for the maximum length of a user password to prevent DoS attacks.
 
** '''[[user_password_maxlength.pl]]''' - Configuration for the maximum length of a user password to prevent DoS attacks.
 
** '''[[user_render.pl]]''' - Configuration for rendering user pages.
 
** '''[[user_render.pl]]''' - Configuration for rendering user pages.
** '''[[user_review_scope.pl]]''' -
+
** '''[[user_review_scope.pl]]''' - Configuration defining the options for the scope of eprint items an editor user can review.
 
** '''[[user_roles.pl]]''' - The roles assigned to different types of user.
 
** '''[[user_roles.pl]]''' - The roles assigned to different types of user.
 
** '''[[user_search.pl]]''' - Configuration for search of user data objects.
 
** '''[[user_search.pl]]''' - Configuration for search of user data objects.
 
** '''[[user_validate.pl]]''' - Validation of the user data object as a whole.
 
** '''[[user_validate.pl]]''' - Validation of the user data object as a whole.
 
** '''[[views.pl]]''' - Configuration for generating browse views.
 
** '''[[views.pl]]''' - Configuration for generating browse views.
** '''[[vlit.pl]]''' -
+
** '''[[vlit.pl]]''' - Configuration for [[VLit]].

Revision as of 00:38, 24 January 2022

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

This is the main repository configuration directory. Each of these files is a valid perl script and are loaded in alphabetic order. The configuration is stored in a hash reference named $c. For example a simple file might look like this:

# the foo option modifies the number of badgers in the boojum
$c->{foo} = 23;