Lib/cfg.d/ - Revision history

Drn@ecs.soton.ac.uk at 11:22, 4 February 2022

2022-02-04T11:22:33Z

Drn@ecs.soton.ac.uk at 10:11, 4 February 2022

2022-02-04T10:11:38Z

Drn@ecs.soton.ac.uk at 10:07, 4 February 2022

2022-02-04T10:07:57Z

Drn@ecs.soton.ac.uk: Added missing descriptions.

2022-02-04T10:06:05Z

Added missing descriptions.

Drn@ecs.soton.ac.uk: Added files actually in directory

2022-02-04T09:53:54Z

Added files actually in directory

Drn@ecs.soton.ac.uk at 09:29, 4 February 2022

2022-02-04T09:29:25Z

Drn@ecs.soton.ac.uk: Drn@ecs.soton.ac.uk moved page EPrints Directory Structure/eprints3/lib/cfg.d to Lib/cfg.d/ without leaving a redirect

2022-02-03T19:39:18Z

Drn@ecs.soton.ac.uk moved page EPrints Directory Structure/eprints3/lib/cfg.d to Lib/cfg.d/ without leaving a redirect

Drn@ecs.soton.ac.uk: Added page about lib/cfg.d directory

2022-02-03T18:38:17Z

Added page about lib/cfg.d directory

New page

{{dirs}}
{{noeditdir}}

This directory contains core configuration files. Generally these should not need to be changed but if they do they should be copied to the archive's [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d]] directory and then edited there. This directory is at the bottom of the levels of precedence for configuration files:

'''lib/cfg.d''' <- flavours/FLAVOURLIB/cfg.d <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d <- archives/ARCHIVEID/cfg/cfg.d

A full list of all configuration files provided within the core codebase can be found [[Archives/ARCHIVEID/cfg/cfg.d/|here]].

@@ Line 64: / Line 64: @@
 ** '''[[user_search.pl]]''' - Configuration for search of user data objects.
 ** '''[[user_validate.pl]]''' - Validation of the user data object as a whole.
-** '''[[vlit.pl]] <sup>1</sup>''' - Configuration for [[VLit]].
+** '''[[vlit.pl]]''' - Configuration for [[VLit]].

@@ Line 20: / Line 20: @@
 ** '''[[document_validate.pl]]''' - Validation of the eprint data object as a whole.
 ** '''[[dynamic_template.pl]]''' - Legacy configuration for dynamic template of repository archive.
-** '''[[element_classes.pl]]''' - Configuration for assigning classes to particular HTML elements generated by EPrints to assist branding.
+** '''[[element_classes.pl]]''' - Configuration for assigning classes EPrints generated HTML elements.
 ** '''[[email.pl]]''' - Configuration for sending email from the repository archive.
 ** '''[[eprint_locking.pl]]''' - Configuration for locking eprint data objects so they can only be edited by one user at once.

@@ Line 35: / Line 35: @@
 ** '''[[mime_types.pl]]''' - Configuration to load [[mime.types]] file.
 ** '''[[misc.pl]]''' - Miscellaneous configuration settings.
-** '''[[optional_filename_sanitise.pl]]''' -
+** '''[[optional_filename_sanitise.pl]]''' - Configuration to santise uploaded file names.
 ** '''[[paths.pl]]''' - Configuration for filesystem paths for particular parts of the repository archive.
 ** '''[[rdf.pl]]''' - Configuration for setting XML namespaces for RDF data files.

@@ Line 9: / Line 9: @@
 *'''[[EPrints_Directory_Structure/eprints3|eprints3]]/[[EPrints_Directory_Structure/eprints3/lib|lib]]/cfg.d'''
-** '''[[00_version.pl]]''' -
+** '''[[00_version.pl]]''' - The version information for EPrints core. as opposed to a particular [[flavour_info.pl|flavour]].
 ** '''[[20_baseurls.pl]]''' - Configuration for how base URLs used by the repository archive.
-** '''[[branding.pl]]
+** '''[[branding.pl]]''' - Branding for the repository archive.
 ** '''[[datasets.pl]]''' - Configuration for bespoke datasets and data objects for the repository archive.
-** '''[[doc_rewrite.pl]]''' -
+** '''[[doc_rewrite.pl]]''' - Configuration to handle relation-based document redirects.
 ** '''[[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.
@@ Line 21: / Line 20: @@
 ** '''[[document_validate.pl]]''' - Validation of the eprint data object as a whole.
 ** '''[[dynamic_template.pl]]''' - Legacy configuration for dynamic template of repository archive.
-** '''[[element_classes.pl]]''' -
+** '''[[element_classes.pl]]''' - Configuration for assigning classes to particular HTML elements generated by EPrints to assist branding.
 ** '''[[email.pl]]''' - Configuration for sending email from the repository archive.
 ** '''[[eprint_locking.pl]]''' - Configuration for locking eprint data objects so they can only be edited by one user at once.
@@ Line 30: / Line 29: @@
 ** '''[[languages.pl]]''' - Configuration for languages used by the repository archive.
 ** '''[[latest_tool.pl]] <sup>1</sup>''' - Configuration for generating listings and feeds of latest eprints in the repository archive.
-** '''[[limit_names_shown.pl]]''' -
+** '''[[limit_names_shown.pl]]''' - Configuration to restrict number of names shown in a citation.
 ** '''[[log.pl]]''' - Configuration for logging error/warning messages for the repository archive.
-** '''[[make_orderkey.pl]]''' -
+** '''[[make_orderkey.pl]]''' - Configuration to better manage diacritics in ordering items.
-** '''[[media_info.pl]]''' -
+** '''[[media_info.pl]]''' - Configuration to file in media information about documents/files.
-** '''[[mime_types.pl]]''' -
+** '''[[mime_types.pl]]''' - Configuration to load [[mime.types]] file.
 ** '''[[misc.pl]]''' - Miscellaneous configuration settings.
 ** '''[[optional_filename_sanitise.pl]]''' -
@@ Line 49: / Line 48: @@
 ** '''[[registration.pl]]''' - Configuration for enabling/managing user reegistration for the repository archive.
 ** '''[[search.pl]]''' - Miscelleanous search configuration not tied to a specific data object or type of search.
-** '''[[search_xapian.pl]]''' -
+** '''[[search_xapian.pl]]''' - Xapian-specific search configuration.
 ** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents.
 ** '''[[session.pl]]''' - Functions for bespoke operations when initiating or closing a session.

← Older revision		Revision as of 09:53, 4 February 2022
Line 6:		Line 6:
	'''lib/cfg.d/''' <- flavours/FLAVOURLIB/cfg.d/ <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d/ <- archives/ARCHIVEID/cfg/cfg.d/		'''lib/cfg.d/''' <- flavours/FLAVOURLIB/cfg.d/ <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d/ <- archives/ARCHIVEID/cfg/cfg.d/

−	A full list of all configuration files provided within the core codebase can be found [[Archives/ARCHIVEID/cfg/cfg.d/\|here]].	+	A full list of all configuration files provided within the core codebase can be found [[Archives/ARCHIVEID/cfg/cfg.d/\|here]]. Only the following configuration files are found in this directory.
		+
		+	*'''[[EPrints_Directory_Structure/eprints3\|eprints3]]/[[EPrints_Directory_Structure/eprints3/lib\|lib]]/cfg.d'''
		+	** '''[[00_version.pl]]''' -
		+	** '''[[20_baseurls.pl]]''' - Configuration for how base URLs used by the repository archive.
		+	** '''[[branding.pl]]
		+	''' - Branding for the repository archive.
		+	** '''[[datasets.pl]]''' - Configuration for bespoke datasets and data objects for the repository archive.
		+	** '''[[doc_rewrite.pl]]''' -
		+	** '''[[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.pl]]''' - Non-core field definitions for the document data object.
		+	** '''[[document_upload.pl]]''' - Configuration relating to managing document uploads.
		+	** '''[[document_validate.pl]]''' - Validation of the eprint data object as a whole.
		+	** '''[[dynamic_template.pl]]''' - Legacy configuration for dynamic template of repository archive.
		+	** '''[[element_classes.pl]]''' -
		+	** '''[[email.pl]]''' - Configuration for sending email from the repository archive.
		+	** '''[[eprint_locking.pl]]''' - Configuration for locking eprint data objects so they can only be edited by one user at once.
		+	** '''[[eprint_search_staff.pl]]''' - Configuration for staff search of eprint data objects.
		+	** '''[[field_property_defaults.pl]] <sup>1</sup>''' - Defaults for various attributes for a field specification.
		+	** '''[[field_validate.pl]] <sup>1</sup>''' - General validation of a metadata field.
		+	** '''[[indexing.pl]]''' - Configuration for indexing of metadata and document content.
		+	** '''[[languages.pl]]''' - Configuration for languages used by the repository archive.
		+	** '''[[latest_tool.pl]] <sup>1</sup>''' - Configuration for generating listings and feeds of latest eprints in the repository archive.
		+	** '''[[limit_names_shown.pl]]''' -
		+	** '''[[log.pl]]''' - Configuration for logging error/warning messages for the repository archive.
		+	** '''[[make_orderkey.pl]]''' -
		+	** '''[[media_info.pl]]''' -
		+	** '''[[mime_types.pl]]''' -
		+	** '''[[misc.pl]]''' - Miscellaneous configuration settings.
		+	** '''[[optional_filename_sanitise.pl]]''' -
		+	** '''[[paths.pl]]''' - Configuration for filesystem paths for particular parts of the repository archive.
		+	** '''[[rdf.pl]]''' - Configuration for setting XML namespaces for RDF data files.
		+	** '''[[rdf_license.pl]]''' - Configuration for adding licences to RDF data files.
		+	** '''[[rdf_triples_bibo.pl]]''' - Configuration for generating Bibo RDF triples for an eprint data object.
		+	** '''[[rdf_triples_eprints.pl]]''' - Configuration for generating EPrints RDF triples for an eprint data object.
		+	** '''[[rdf_triples_formats.pl]]''' - Configuration for generating format RDF triples for an eprint data object.
		+	** '''[[rdf_triples_general.pl]]''' - Configuration for generating general RDF triples.
		+	** '''[[rdf_triples_repository.pl]]''' - Configuration for generating repository RDF triples.
		+	** '''[[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.
		+	** '''[[registration.pl]]''' - Configuration for enabling/managing user reegistration for the repository archive.
		+	** '''[[search.pl]]''' - Miscelleanous search configuration not tied to a specific data object or type of search.
		+	** '''[[search_xapian.pl]]''' -
		+	** '''[[security.pl]]''' - Functions for securing appropriate access to uploaded documents.
		+	** '''[[session.pl]]''' - Functions for bespoke operations when initiating or closing a session.
		+	** '''[[template_core.pl]]''' - Core trigger for generating dynamic template.
		+	** '''[[template_edit_phrases.pl]]''' - Edit phrases trigger for generating dynamic template.
		+	** '''[[template_legacy.pl]]''' - Legacy trigger for generating dynamic template, as defined in [[dynamic_template.pl]].
		+	** '''[[template_links.pl]]''' - Links trogger for generating dynamic template.
		+	** '''[[user_auth_limits.pl]]''' - Configuration for limiting aspects of user authentication to prevent brute force password cracking, denial-of-service, user spamming, etc.
		+	** '''[[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.pl]]''' - Non-core field definitions for the user data object.
		+	** '''[[user_login.pl]]''' - Configuration for managing user login to the repository archive.
		+	** '''[[user_render.pl]]''' - Configuration for rendering user pages.
		+	** '''[[user_roles.pl]]''' - The roles assigned to different types of user.
		+	** '''[[user_search.pl]]''' - Configuration for search of user data objects.
		+	** '''[[user_validate.pl]]''' - Validation of the user data object as a whole.
		+	** '''[[vlit.pl]] <sup>1</sup>''' - Configuration for [[VLit]].

@@ Line 4: / Line 4: @@
 This directory contains core configuration files.  Generally these should not need to be changed but if they do they should be copied to the archive's [[Archives/ARCHIVEID/cfg/cfg.d/|cfg/cfg.d]] directory and then edited there.  This directory is at the bottom of the levels of precedence for configuration files:
-  '''lib/cfg.d''' <- flavours/FLAVOURLIB/cfg.d <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d <- archives/ARCHIVEID/cfg/cfg.d
+  '''lib/cfg.d/''' <- flavours/FLAVOURLIB/cfg.d/ <- ingredients/INGREDIENTID/cfg.d/ <- site_lib/cfg.d/ <- archives/ARCHIVEID/cfg/cfg.d/
 A full list of all configuration files provided within the core codebase can be found [[Archives/ARCHIVEID/cfg/cfg.d/|here]].

← Older revision	Revision as of 19:39, 3 February 2022
(No difference)