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

From EPrints Documentation
Jump to: navigation, search
(Finished adding descriptions for configuration files.)
(Fixed typos)
Line 12: Line 12:
 
** '''[[database.pl]]''' - Configuration for connecting to the database.
 
** '''[[database.pl]]''' - Configuration for connecting to the database.
 
** '''[[datasets.pl]]''' - Configuration for bespoke datasets and data objects for the repository archive.
 
** '''[[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]]''' - Configuration 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.
 
** '''[[document_fields.pl]]''' - Non-core field definitions for the document data object.
 
** '''[[document_fields.pl]]''' - Non-core field definitions for the document data object.
Line 19: Line 19:
 
** '''[[dynamic_template.pl]]''' - Legacy 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]]''' - Configuration for automatically setting eprint fields based on the values of other fields.
 
** '''[[eprint_fields_common.pl]]''' - Common (across [[EPrints Flavours|flavours]]) non-core fields for the eprint data object.
 
** '''[[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.
Line 53: Line 53:
 
** '''[[rdf_triples_skos.pl]]''' - Configuration for generating SKOS RDF triples for an eprint and subject data objects.
 
** '''[[rdf_triples_skos.pl]]''' - Configuration for generating SKOS RDF triples for an eprint and subject data objects.
 
** '''[[rdf_uris.pl]]''' - Configuration for generating RDF URIs.
 
** '''[[rdf_uris.pl]]''' - Configuration for generating RDF URIs.
** '''[[registration.pl]]''' - Configuation for enabling/managing user reegistration for the repository archive.
+
** '''[[registration.pl]]''' - Configuration 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.
 
** '''[[request_copy.pl]]''' - Configuration for "request a copy" of a restricted document.
 
** '''[[request_copy.pl]]''' - Configuration for "request a copy" of a restricted document.
** '''[[search.pl]]''' - Miscelleanous search configuation not tied to a specific data object or type of search.
+
** '''[[search.pl]]''' - Miscelleanous search configuration 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]]''' - Functions for bespoke operations when initiating or closing a session.
 
** '''[[session.pl]]''' - Functions for bespoke operations when initiating or closing a session.
Line 64: Line 64:
 
** '''[[template_links.pl]]''' - Links trogger for generating dynamic template.
 
** '''[[template_links.pl]]''' - Links trogger for generating dynamic template.
 
** '''[[user_auth_limits.pl]]''' - Configuration for limiting user authentication attempts.
 
** '''[[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]]''' - Configuration 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.
 
** '''[[user_fields.pl]]''' - Non-core field definitions for the user data object.
 
** '''[[user_fields.pl]]''' - Non-core field definitions for the user data object.

Revision as of 14:50, 30 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;