Plugins.pl: Difference between revisions

Latest revision as of 11:07, 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

Back to cfg.d

plugins.pl contains configuration for managing plugins under the $c->{plugins} hash reference. Most of the configuration is commented out as it provides example on how to:

Set the generic options (e.g. params and appears) for a particular plugin.
Set action options for screen plugins.
Set options for import and export plugins.
Plugin mapping. Useful for overriding plugins with your own archive level version of the plugin.

The only enabled configuation is for setting the pid, doi_field and use_prefix params for CrossRef import plugins (i.e. DOI and DOI_UNIXREF).

@@ Line 2: / Line 2: @@
 {{cfgd}}
-This file contains configuration for the paths on the filesystem for certain parts of the archive:
+'''plugins.pl''' contains configuration for managing [[API:EPrints/Plugin|plugins]] under the '''<code>$c->{plugins}</code>''' hash reference.  Most of the configuration is commented out as it provides example on how to:
-* '''<code>$c->{documents_path}</code>''' - Path to the documents directory of the archive. By default ''ARCHIVE_ROOT/documents''.
+# Set the generic options (e.g. ''params'' and ''appears'') for a particular plugin.
-* '''<code>$c->{config_path}</code>''' - Path to the configuration directory of the archive. By default ''ARCHIVE_ROOT/cfg''.
+# Set action options for [[API:EPrints/Plugin/Screen|screen plugins]].
-* '''<code>$c->{htdocs_path}</code>''' - Path to the HTML docuuments cache directory of the archive. By default ''ARCHIVE_ROOT/html''.
+# Set options for [[API:EPrints/Plugin/Import|import]] and [[API:EPrints/Plugin/Export|export]] plugins.
+# Plugin mapping.  Useful for overriding plugins with your own archive level version of the plugin.
+The only enabled configuation is for setting the ''pid'', ''doi_field'' and ''use_prefix'' params for CrossRef import plugins (i.e. DOI and DOI_UNIXREF).