diff --git a/dspace/docs/docbook/configure.xml b/dspace/docs/docbook/configure.xml index 2009818641..bfbb795e05 100644 --- a/dspace/docs/docbook/configure.xml +++ b/dspace/docs/docbook/configure.xml @@ -108,48 +108,21 @@ dspace.history = ${dspace.dir}/history - dspace.dir + dspace.dir +dspace.url +dspace.hostname +dspace.name 5.2.2 - - - dspace.url - - - 5.2.2 - - - - - dspace.hostname - - - 5.2.2 - - - - - dspace.name - - - 5.2.2 - - - - - config.template.foo - - ____ - Database Configurations - -db.name + + db.name db.url db.driver db.username @@ -161,13 +134,14 @@ db.password Advanced Database Configuration - -db.schema + + db.schema db.maxconnection db.maxwait db.maxidle db.statementpool -db.poolname +db.poolname + 5.2.3 @@ -227,27 +201,69 @@ srb.parentdir.1 Handle Configuration - -handle.prefix -handle.dir + + handle.prefix +handle.dir + 5.2.7 + + Authorization System Configuration + + + + core.authorization.community-admin.create-subelement +core.authorization.community-admin.delete-subelement +core.authorization.community-admin.policies +core.authorization.community-admin.admin-group +core.authorization.community-admin.collection.policies +core.authorization.community-admin.collection.template-item +core.authorization.community-admin.collection.submitters +core.authorization.community-admin.collection.workflows +core.authorization.community-admin.collection.admin-group +core.authorization.community-admin.item.delete +core.authorization.community-admin.item.withdraw +core.authorization.community-admin.item.reinstatiate +core.authorization.community-admin.item.policies +core.authorization.community-admin.item.create-bitstream +core.authorization.community-admin.item.delete-bitstream +core.authorization.community-admin.item-admin.cc-license +core.authorization.collection-admin.policies +core.authorization.collection-admin.template-item +core.authorization.collection-admin.submitters +core.authorization.collection-admin.workflows +core.authorization.collection-admin.admin-group +core.authorization.collection-admin.item.delete +core.authorization.collection-admin.item.withdraw +core.authorization.collection-admin.item.reinstatiate +core.authorization.collection-admin.item.policies +core.authorization.collection-admin.item.create-bitstream +core.authorization.collection-admin.item.delete-bitstream +core.authorization.collection-admin.item-admin.cc-license +core.authorization.item-admin.policies +core.authorization.item-admin.create-bitstream +core.authorization.item-admin.delete-bitstream +core.authorization.item-admin.cc-license + + 5.2.45 + Stackable Authentication Methods - plugin.sequence.org.dspace.authenticate.AuthenticationMethod + plugin.sequence.org.dspace.authenticate.AuthenticationMethod + 5.2.8 or 5.2.9 LDAP Authentication - -ldap.enable + + ldap.enable ldap.provider_url ldap.id_field ldap.object_context @@ -257,30 +273,31 @@ ldap.surname_field ldap.givenname_field ldap.phone_field webui.ldap.autoregister -ldap.login.specialgroup - 5.2.8.5 +ldap.login.specialgroup + + 5.2.8.5 - Hierarchical LDAP Settings: - -ldap.search_scope + Hierarchical LDAP Settings: + ldap.search_scope ldap.search.user ldap.netid_email_domain - 5.2.8.5 + 5.2.8.5 - Shibboleth Authentication Settings + Shibboleth Authentication Settings - -authentication.shib.email-header + + authentication.shib.email-header authentication.shib.firstname-header authentication.shib.lastname-header authentication.shib.email-use-tomcat-remote-user authentication.shib.autoregister authentication.shib.role-header -authentication.shib.default-roles - 5.2.9- +authentication.shib.default-roles + + 5.2.9- Log Configuration @@ -298,48 +315,11 @@ authentication.shib.default-roles - search.dir - - - 5.2.11 - - - - - search.max-clauses - - - 5.2.11 - - - - - search.analyzer - - - 5.2.11 - - - - - search.operator - - - 5.2.11 - - - - - search.maxfieldlength - - - 5.2.11 - - - - - search.index. - n + search.dir +search.max-clauses +search.analyzer +search.operator +search.maxfieldlengthsearch.index.n 5.2.11 @@ -350,15 +330,8 @@ authentication.shib.default-roles - http.proxy.host - - - 5.2.12 - - - - - http.proxy.port + http.proxy.host +http.proxy.port 5.2.12 @@ -372,77 +345,35 @@ authentication.shib.default-roles 5.2.13 - -plugin.named.org.dspace.app.mediafilter.FormatFilter -filter.org.dspace.app.mediafilter.PDFFilter.inputFormats -filter.org.dspace.app.mediafilter.HTMLFilter.inputFormats -filter.org.dspace.app.mediafilter.WordFilter.inputFormats -filter.org.dspace.app.mediafilter.JPEGFilter.inputFormats -filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormats + + plugin.named.org.dspace.app.mediafilter.FormatFilter + filter.org.dspace.app.mediafilter.PDFFilter.inputFormats + filter.org.dspace.app.mediafilter.HTMLFilter.inputFormats + filter.org.dspace.app.mediafilter.WordFilter.inputFormats + filter.org.dspace.app.mediafilter.JPEGFilter.inputFormats + filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormats 5.2.13 - pdffilter.largepdfs + + pdffilter.largepdfs +pdffilter.skiponmemoryexception + 5.2.13 - - pdffilter.skiponmemoryexception - Crosswalks (MODS, QDC, XSLT, etc.) - crosswalk.mods.properties.MODS - - - 5.2.14 - - - - - crosswalk.submission.MODS.stylesheet - - - 5.2.15 - - - - - crosswalk.qdc.namespace.QDC.dc - - - 5.2.16 - - - - - crosswalk.qdc.namespace.QDC.dcterms - - - 5.2.16 - - - - - crosswalk.qdc.schemaLocation.QDC - - - 5.2.16 - - - - - plugin.named.org.dspace.content.crosswalk.IngestionCrosswalk - - - 5.2.17 - - - - - plugin.named.org.dspace.content.crosswalk.DisseminationCrosswalk + crosswalk.mods.properties.MODS +crosswalk.submission.MODS.stylesheet +crosswalk.qdc.namespace.QDC.dc +crosswalk.qdc.namespace.QDC.dcterms +crosswalk.qdc.schemaLocation.QDC +plugin.named.org.dspace.content.crosswalk.IngestionCrosswalk +plugin.named.org.dspace.content.crosswalk.DisseminationCrosswalk 5.2.18 @@ -453,103 +384,19 @@ filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormats - event.dispatcher.default.class - - - 5.2.19 - - - - - event.dispatcher.default.consumers - - - 5.2.19 - - - - - event.dispatcher.noindex.class - - - 5.2.19 - - - - - event.dispatcher.noindex.consumers - - - 5.2.19 - - - - - event.consumer.search.class - - - 5.2.19 - - - - - event.consumer.search.filters - - - 5.2.19 - - - - - event.consumer.browse.class - - - 5.2.19 - - - - - event.consumer.browse.filters - - - 5.2.19 - - - - - event.consumer.eperson.class - - - 5.2.19 - - - - - event.consumer.eperson.filters - - - 5.2.19 - - - - - event.consumer.test.class - - - 5.2.19 - - - - - event.consumer.test.filters - - - 5.2.19 - - - - - testConsumer.verbose + event.dispatcher.default.class +event.dispatcher.default.consumers +event.dispatcher.noindex.class +event.dispatcher.noindex.consumers +event.consumer.search.class +event.consumer.search.filters +event.consumer.browse.class +event.consumer.browse.filters +event.consumer.eperson.class +event.consumer.eperson.filters +event.consumer.test.class +event.consumer.test.filters +testConsumer.verbose 5.2.19 @@ -560,23 +407,9 @@ filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormats - plugin.single.org.dspace.checker.BitsreamDispatcher - - - 5.2.20 - - - - - checker.retention.default - - - 5.2.20 - - - - - checker.retention.CHECKSUM-MATCH + plugin.single.org.dspace.checker.BitsreamDispatcher +checker.retention.default +checker.retention.CHECKSUM-MATCH 5.2.20 @@ -587,31 +420,10 @@ filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormats - org.dspace.app.itemexport.work.dir - - - 5.2.21 - - - - - org.dspace.app.itemexport.download.dir - - - 5.2.21 - - - - - org.dspace.app.itemexport.life.span.hours - - - 5.2.21 - - - - - org.dspace.app.itemexport.max.size + org.dspace.app.itemexport.work.dir +org.dspace.app.itemexport.download.dir +org.dspace.app.itemexport.life.span.hours +org.dspace.app.itemexport.max.size 5.2.21 @@ -659,9 +471,10 @@ filter.org.dspace.app.mediafilter.BrandedPreviewJPEGFilter.inputFormats WEBUI Configurations [General] - -webui.browse.thumbnail.max.height -webui.browse.thumbnail.max.width + + webui.browse.thumbnail.max.height +webui.browse.thumbnail.max.width + 5.2.25 @@ -669,25 +482,28 @@ webui.browse.thumbnail.max.width 5.2.25 - -thumbnail.maxwidth -thumbnail.maxheight - 5.2.25 + + thumbnail.maxwidth +thumbnail.maxheight + + 5.2.25 webui.preview.enabled 5.2.25 - -webui.preview.maxwidth -webui.preview.maxheight + + webui.preview.maxwidth +webui.preview.maxheight + 5.2.25 - -webui.preview.brand -webui.preview.brand.abbrev + + webui.preview.brand +webui.preview.brand.abbrev + 5.2.25 @@ -695,9 +511,10 @@ webui.preview.brand.abbrev 5.2.25 - -webui.preview.brand.font -webui.preview.brank.fontpoint + + webui.preview.brand.font +webui.preview.brank.fontpoint + 5.2.25 @@ -705,9 +522,10 @@ webui.preview.brank.fontpoint 5.2.25 - -webui.strengths.show -webui.strengths.cache + + webui.strengths.show +webui.strengths.cache + 5.2.25 @@ -726,11 +544,12 @@ webui.strengths.cache 5.2.26.3 - -webui.browse.value_columns.max + + webui.browse.value_columns.max webui.browse.sort_columns.max webui.browse.value_columns.omission_mark -plugin.named.org.dspace.sort.OrderFormatDelegate +plugin.named.org.dspace.sort.OrderFormatDelegate + 5.2.26.4 @@ -755,16 +574,18 @@ plugin.named.org.dspace.sort.OrderFormatDelegate Recent Submission - -recent.submission.sort-option -recent.submissions.count + + recent.submission.sort-option +recent.submissions.count + 5.2.29 Syndication Feed (RSS) Settings - -webui.feed.enable + + + webui.feed.enable webui.feed.items webui.feed.cache.size webui.cache.age @@ -772,25 +593,28 @@ webui.feed.formats webui.feed.localresolve webui.feed.item.title webui.feed.item.date -webui.feed.item.description +webui.feed.item.description + 5.2.30 Content Inline Disposition Threshold - -webui.content_disposition_threshold -xmlui.content_disposition_threshold + + webui.content_disposition_threshold +xmlui.content_disposition_threshold + 5.2.31 Multifile HTML Settings - -webui.html.max-depth-guess -xmlui.html.max-depth-guess + + webui.html.max-depth-guess +xmlui.html.max-depth-guess + 5.2.32 @@ -825,9 +649,10 @@ xmlui.html.max-depth-guess 5.2.40 - -webui.suggest.enable -webui.suggest.loggedinusers.only + + webui.suggest.enable +webui.suggest.loggedinusers.only + 5.2.41 @@ -842,8 +667,8 @@ webui.suggest.loggedinusers.only JSP Web Interface Settings - -webui.licence_bundle.show + + webui.licence_bundle.show webui.itemdisplay.default webui.resolver.1.urn webui.resolver.1.baseurl @@ -860,14 +685,16 @@ webui.itemlist.browse.<browse name>.columns webui.itemlist.*lt;sort or index name>.columns webui.itemlist.dateaccessioned.columns webui.itemlist.dateaccessioned.widths -webui.itemlist.tablewidth +webui.itemlist.tablewidth + 5.2.36 - XMLUI Settings (Manakin) + + XMLUI Settings (Manakin) - -xmlui.supportedlocales + + xmlui.supportedlocales xmlui.force.ssl xmlui.user.registration xmlui.user.assumelogon @@ -880,13 +707,11 @@ xmlui.bitstream.mods xmlui.bitstream.mets xmlui.google.analytics.key xmlui.controlpanel.activity.max -xmlui.controlpanel.activity.ipheader +xmlui.controlpanel.activity.ipheader + 5.2.43 - - - - +
@@ -5536,6 +5361,92 @@ webui.itemlist.<sort or index name>.columns
+
+ <anchor id="docbook-configure.html-authorization" xreflabel="Authorization system configuration"/>Delegation Administration + (Authorization System Configuration) + + + + + + + + + + Property: + core.authorization.community-admin.create-subelement + + + Example Value: + core.authorization.community-admin.create-subelement = true + + + Informational Note: + It is now possible to delegate the administration of Communities and Collections without the need of the Administrator Superuser. The delegation uses an "inherited" technique. A community admin will be a collection admin for all the collections within the community and a collection admin will be always an item admin for all the item owned by the collection. All the functions that are allowed to user with WRITE permission on an object will always allowed to be the ADMIN of the + object (e.g. community/collection/admin will be always allowed to edit metadata of the object). The default will be "on" for all the configurations. + + + + Community Administration: subcommunities and collections + core.authorization.community-admin.create-subelement +core.authorization.community-admin.delete-subelement + + + then administers the following keys: + core.authorization.community-admin.policies +core.authorization.community-admin.admin-group + + + Collections in the above community: + core.authorization.community-admin.collection.policies +core.authorization.community-admin.collection.template-item +core.authorization.community-admin.collection.submitters +core.authorization.community-admin.collection.workflows +core.authorization.community-admin.collection.admin-group + + + Item owned by Collections in the above Community: + core.authorization.community-admin.item.delete +core.authorization.community-admin.item.withdraw +core.authorization.community-admin.item.reinstatiate +core.authorization.community-admin.item.policies + And also these bundles: + core.authorization.community-admin.item.create-bitstream +core.authorization.community-admin.item.delete-bitstream +core.authorization.community-admin.item-admin.cc-license + + + Collection Administration: + core.authorization.collection-admin.policies +core.authorization.collection-admin.template-item +core.authorization.collection-admin.submitters +core.authorization.collection-admin.workflows +core.authorization.collection-admin.admin-group + Item owned by the above Collection +core.authorization.collection-admin.item.delete +core.authorization.collection-admin.item.withdraw +core.authorization.collection-admin.item.reinstatiate +core.authorization.collection-admin.item.policies + And also these bundles: +core.authorization.collection-admin.item.create-bitstream +core.authorization.collection-admin.item.delete-bitstream +core.authorization.collection-admin.item-admin.cc-license + + + Item Administration: + core.authorization.item-admin.policies + And also these bundles: +core.authorization.item-admin.create-bitstream +core.authorization.item-admin.delete-bitstream +core.authorization.item-admin.cc-license + + + + + + Oracle users should consult Chapter 4 Updating a DSpace Installation regarding the necessary database changes that need to take place. + +
@@ -6191,6 +6102,216 @@ plugin.named.org.dspace.sword.SWORDIngester = \
+
+ <anchor id="docbook-configure.html-opensearch" xreflabel="OpenSearch Support"/>OpenSearch Support + OpenSearch is a small set of conventions and documents for describing and using "serach enginges", meaning any service that returns a set of results for a query. See extensive description in the Business Layer section of the documentation. + Please note that for result data formatting, OpenSearch uses Syndication Feed Settings (RSS). So, even if Syndication Feeds are not enable, they must be configured to enable OpenSearch. OpenSearch uses all the configuration properties for DSpace RSS to determine the mapping of metadata fields to feed fields. Note that a new field for authors has been added (used in Atom format only). + + + + + + Property: + websvc.opensearch.enable + + + Example Value: + websvc.opensearch.enable = false + + + Informational Note: + Whether or not OpenSearch is enabled. By default, the feature is disabled. Change the property key to 'ture' to enable. + + + + + + + + Property: + websvc.opensearch.uicontext + + + Example Value: + websvc.opensearch.uicontext = simple-search + + + Informational Note: + Context for HTML request URLs. Change only for non-standard servlet mapping. + + + + + + + + Property: + websvc.opensearch.svccontext + + + Example Value: + websvc.opensearch.svccontext = open-search/ + + + Informational Note: + Context for RSS/Atom request URLs. Change only for non-standard servlet mapping. + + + + + + + + Property: + websvc.opensearch.autolink + + + Example Value: + websvc.opensearch.autolink = true + + + Informational Note: + Present autodiscovery link in every page head. + + + + + + + + Property: + websvc.opensearch.validity + + + Example Value: + websvc.opensearch.validity = 48 + + + Informational Note: + Number of hours to retain results before recalculating. This applies to the Manakin interface only. + + + + + + + + Property: + websvc.opensearch.shortname + + + Example Value: + websvc.opensearch.shortname = DSpace + + + Informational Note: + A short name used in browsers for search service. It should be sixteen (16) or fewer characters. + + + + + + + + Property: + websvc.opensearch.longname + + + Example Value: + websvc.opensearch.longname = ${dspace.name} + + + Informational Note: + A longer name up to 48 characters. + + + + + + + + Property: + websvc.opensearch.description + + + Example Value: + websvc.opensearch.description = ${dspace.name} DSpace repository + + + Informational Note: + Brief service description + + + + + + + + Property: + websvc.opensearch.faviconurl + + + Example Value: + websvc.opensearch.faviconurl = http://www.dspace.org/images/favicon.ico + + + Informational Note: + Location of favicon for service, if any. They must by 16 x 16 pixels. You can profide your own local favicon instead of the default. + + + + + + + + Property: + websvc.opensearch.samplequery + + + Example Value: + websvc.opensearch.samplequery = photosynthesis + + + Informational Note: + Sample query. This should return results. You can replace the sample query with search terms that should actually yield results in your repository. + + + + + + + + Property: + websvc.opensearch.tags + + + Example Value: + websc.opensearch.tags = IR DSpace + + + Informational Note: + Tags used to describe search service. + + + + + + + + Property: + websvc.opensearch.formats + + + Example Value: + websvc.opensearch.formats = html,atom,rss + + + Informational Note: + Result formats offered. Use one or more comma-separated from the list: html, atom, rss. Please note that html is requred for autodiscovery in browsers to function, and must be the first in the list if present. + + + +