diff --git a/dspace/config/modules/authentication-ip.cfg b/dspace/config/modules/authentication-ip.cfg index 5836811eb0..a69b7cc5fb 100644 --- a/dspace/config/modules/authentication-ip.cfg +++ b/dspace/config/modules/authentication-ip.cfg @@ -1,4 +1,9 @@ -#### IP-Address Based Authentication Configuration #### +#---------------------------------------------------------------# +#---------IP-ADDRESS AUTHENTICATION CONFIGURATIONS--------------# +#---------------------------------------------------------------# +# Configuration properties used by the IP-Address Based # +# Authentication plugin, when it is enabled. # +#---------------------------------------------------------------# # # In order to enable IP-Address Authentication, you must first ensure the # 'org.dspace.authenticate.IPAuthentication' class is added to the diff --git a/dspace/config/modules/authentication-ldap.cfg b/dspace/config/modules/authentication-ldap.cfg index bdc981d04a..f6f11e5a45 100644 --- a/dspace/config/modules/authentication-ldap.cfg +++ b/dspace/config/modules/authentication-ldap.cfg @@ -1,4 +1,9 @@ -#### LDAP Authentication Configuration #### +#---------------------------------------------------------------# +#------------LDAP AUTHENTICATION CONFIGURATIONS-----------------# +#---------------------------------------------------------------# +# Configuration properties used by the LDAP Authentication # +# plugin, when it is enabled. # +#---------------------------------------------------------------# # # In order to enable LDAP Authentication, you must first ensure the # 'org.dspace.authenticate.LDAPAuthentication' OR diff --git a/dspace/config/modules/authentication-password.cfg b/dspace/config/modules/authentication-password.cfg index 3148f7ded7..5b0c1aa00e 100644 --- a/dspace/config/modules/authentication-password.cfg +++ b/dspace/config/modules/authentication-password.cfg @@ -1,4 +1,9 @@ -#### Authentication by Password Configuration #### +#---------------------------------------------------------------# +#----------PASSWORD AUTHENTICATION CONFIGURATIONS---------------# +#---------------------------------------------------------------# +# Configuration properties used by the Password # +# Authentication plugin, when it is enabled. # +#---------------------------------------------------------------# # # In order to enable Password Authentication, you must first ensure the # 'org.dspace.authenticate.PasswordAuthentication' class is added to the diff --git a/dspace/config/modules/authentication-shibboleth.cfg b/dspace/config/modules/authentication-shibboleth.cfg index 6feec62b73..c1a468b1fa 100644 --- a/dspace/config/modules/authentication-shibboleth.cfg +++ b/dspace/config/modules/authentication-shibboleth.cfg @@ -1,4 +1,9 @@ -#### Shibboleth Authentication Configuration #### +#---------------------------------------------------------------# +#---------SHIBBOLETH AUTHENTICATION CONFIGURATIONS--------------# +#---------------------------------------------------------------# +# Configuration properties used by the Shibboleth # +# Authentication plugin, when it is enabled. # +#---------------------------------------------------------------# # # In order to enable Shibboleth Authentication, you must first ensure the # 'org.dspace.authenticate.ShibAuthentication' class is added to the diff --git a/dspace/config/modules/authentication-x509.cfg b/dspace/config/modules/authentication-x509.cfg index 0874fabd73..279490df46 100644 --- a/dspace/config/modules/authentication-x509.cfg +++ b/dspace/config/modules/authentication-x509.cfg @@ -1,4 +1,9 @@ -#### X.509 Certificate Authentication Configuration #### +#---------------------------------------------------------------# +#------X.509 CERTIFICATE AUTHENTICATION CONFIGURATIONS----------# +#---------------------------------------------------------------# +# Configuration properties used by the X.509 Certificate # +# Authentication plugin, when it is enabled. # +#---------------------------------------------------------------# # # In order to enable X.509 Authentication, you must first ensure the # 'org.dspace.authenticate.X509Authentication' class is added to the diff --git a/dspace/config/modules/authentication.cfg b/dspace/config/modules/authentication.cfg index e0afab1a0b..b24afc7c7d 100644 --- a/dspace/config/modules/authentication.cfg +++ b/dspace/config/modules/authentication.cfg @@ -1,9 +1,13 @@ -#### Enabled Authentication Methods/Plugins #### -# This configuration setting contains the listing of all currently enabled -# authentication plugins. DSpace supports an Authentication "stack" -# which allows you to enable multiple forms of Authentication at the same time. -# The Authentication plugins are invoked in order until one of them succeeds. -# +#---------------------------------------------------------------# +#----------ENABLED AUTHENTICATION METHODS/PLUGINS---------------# +#---------------------------------------------------------------# +# This configuration setting contains the listing of all # +# currently enabled authentication plugins. DSpace supports an # +# Authentication "stack" which allows you to enable multiple # +# forms of Authentication at the same time. Enabled # +# Authentication plugins are invoked in order until one of them # +# succeeds. # +#---------------------------------------------------------------# # Out-of-the-box DSpace Authentication Plugins include: # * Authentication by Password # Plugin class: org.dspace.authenticate.PasswordAuthentication diff --git a/dspace/config/modules/bulkedit.cfg b/dspace/config/modules/bulkedit.cfg index 0069e70358..6ad147b8b7 100644 --- a/dspace/config/modules/bulkedit.cfg +++ b/dspace/config/modules/bulkedit.cfg @@ -1,3 +1,9 @@ +#---------------------------------------------------------------# +#-----------BATCH METADATA EDITOR CONFIGURATIONS----------------# +#---------------------------------------------------------------# +# Configuration properties used solely by the Batch Metadata # +# Editing System # +#---------------------------------------------------------------# ### Bulk metadata editor settings ### # The delimiter used to separate values within a single field (defaults to a double pipe ||) # valueseparator = || diff --git a/dspace/config/modules/discovery.cfg b/dspace/config/modules/discovery.cfg index ff60524039..4d1f1aecc7 100644 --- a/dspace/config/modules/discovery.cfg +++ b/dspace/config/modules/discovery.cfg @@ -1,3 +1,9 @@ +#---------------------------------------------------------------# +#-----------------DISCOVERY CONFIGURATIONS----------------------# +#---------------------------------------------------------------# +# Configuration properties used solely by the Discovery # +# faceted-search system. # +#---------------------------------------------------------------# ##### Search Indexing ##### search.server = http://localhost:8080/solr/search diff --git a/dspace/config/modules/oai.cfg b/dspace/config/modules/oai.cfg index 7d4cc2edff..818d986830 100644 --- a/dspace/config/modules/oai.cfg +++ b/dspace/config/modules/oai.cfg @@ -1,7 +1,13 @@ - +#---------------------------------------------------------------# +#-------------OAI-PMH & OAI-ORE CONFIGURATIONS------------------# +#---------------------------------------------------------------# +# These configs are used by both OAI-PMH and OAI-ORE # +# (Harvester) Interfaces. # +#---------------------------------------------------------------# # The base URL of the OAI webapp (do not include /request). dspace.oai.url = ${dspace.baseUrl}/oai + #---------------------------------------------------------------# #--------------OAI-PMH SPECIFIC CONFIGURATIONS------------------# #---------------------------------------------------------------# diff --git a/dspace/config/modules/submission-curation.cfg b/dspace/config/modules/submission-curation.cfg index bb2a1e4fc1..1942816d2d 100644 --- a/dspace/config/modules/submission-curation.cfg +++ b/dspace/config/modules/submission-curation.cfg @@ -1,4 +1,8 @@ -# This file contains configuration properties solely relating to the scheduling of curation tasks during submission. - +#---------------------------------------------------------------# +#------------SUBMISSION CURATION CONFIGURATIONS-----------------# +#---------------------------------------------------------------# +# This file contains configuration properties solely relating # +# to the scheduling of curation tasks during submission. # +#---------------------------------------------------------------# # Scan for viruses virus-scan = false \ No newline at end of file diff --git a/dspace/config/modules/sword-client.cfg b/dspace/config/modules/sword-client.cfg index a833da22ee..d25cc76a92 100644 --- a/dspace/config/modules/sword-client.cfg +++ b/dspace/config/modules/sword-client.cfg @@ -1,3 +1,10 @@ +#---------------------------------------------------------------# +#--------------SWORD V.1 CLIENT CONFIGURATIONS------------------# +#---------------------------------------------------------------# +# Configuration properties used solely by the XMLUI SWORD # +# Client interface (used to submit DSpace content to another # +# SWORD server). # +#---------------------------------------------------------------# # List of remote Sword servers. Used to build the drop-down list of selectable Sword targets. targets = http://localhost:8080/sword/servicedocument, \ http://client.swordapp.org/client/servicedocument, \ diff --git a/dspace/config/modules/sword-server.cfg b/dspace/config/modules/sword-server.cfg index 76936fb4fe..95722b4539 100644 --- a/dspace/config/modules/sword-server.cfg +++ b/dspace/config/modules/sword-server.cfg @@ -1,7 +1,9 @@ #---------------------------------------------------------------# -#--------------SWORD SPECIFIC CONFIGURATIONS--------------------# +#-------------SWORD V.1 SERVER CONFIGURATIONS-------------------# #---------------------------------------------------------------# -# These configs are only used by the SWORD interface # +# These configs are only used by the SWORD Server interface, # +# version 1.3 (used by DSpace to accept ingest packages via # +# SWORD protocol) # #---------------------------------------------------------------# # tell the SWORD METS implementation which package ingester to use diff --git a/dspace/config/modules/swordv2-server.cfg b/dspace/config/modules/swordv2-server.cfg index 35896cab1f..eb02b5c3ac 100644 --- a/dspace/config/modules/swordv2-server.cfg +++ b/dspace/config/modules/swordv2-server.cfg @@ -1,7 +1,9 @@ #---------------------------------------------------------------# -#-------------------SWORD 2.0 CONFIGURATIONS-------------------# +#----------------SWORD 2.0 SERVER CONFIGURATIONS----------------# #---------------------------------------------------------------# -# These configs are only used by the SWORD 2.0 interface # +# These configs are only used by the SWORD Server interface, # +# version 2.0 (used by DSpace to accept ingest packages via # +# SWORD 2.0 protocol) # #---------------------------------------------------------------# # the base url of the sword 2.0 system diff --git a/dspace/config/modules/translator.cfg b/dspace/config/modules/translator.cfg index 4f6e2b534a..f4ef9fc0b7 100644 --- a/dspace/config/modules/translator.cfg +++ b/dspace/config/modules/translator.cfg @@ -1,3 +1,9 @@ +#---------------------------------------------------------------# +#----------TRANSLATOR CURATION TASK CONFIGURATIONS--------------# +#---------------------------------------------------------------# +# Configuration properties used solely by MicrosoftTranslator # +# Curation Task (uses Microsoft Translation API v2) # +#---------------------------------------------------------------# ## Translation field settings ## ## Authoritative language field diff --git a/dspace/config/modules/workflow.cfg b/dspace/config/modules/workflow.cfg index 651d1c8579..737b930685 100644 --- a/dspace/config/modules/workflow.cfg +++ b/dspace/config/modules/workflow.cfg @@ -1,3 +1,12 @@ +#---------------------------------------------------------------# +#--------CONFIGURABLE REVIEWER WORKFLOW CONFIGURATIONS----------# +#---------------------------------------------------------------# +# Configuration properties used solely by the Configurable # +# Reviewer Workflow (XMLUI only) # +#---------------------------------------------------------------# #Selection of workflow framework that will be used in DSpace +# Possible values: +# originalworkflow = Traditional DSpace Workflow +# xmlworkflow = New (as of 1.8.0) Configurable Reviewer Workflow workflow.framework=originalworkflow #workflow.framework=xmlworkflow