Home

Welcome

Welcome to the CGSpace wiki! Here I intend to write notes, document procedures, etc.

Contribution guidelines

• File an issue so we can document and discuss
• Make a pull request with a fix
• Coding standards... no white space!

Adding new metadata

Assuming you want to add a new, custom metadata field to DSpace (ie cg.subject.icarda), the procedure is:

• Add to metadata registry (control panel)
• Add to browse indexes (dspace.cfg)?
  • webui.browse.index.21 = icardasubject:metadata:cg.subject.icarda:text
• Add to search filters in discovery.xml
• Add to sidebar facets in discovery.xml
• Add strings to messages.xml:
  • xmlui.ArtifactBrowser.AdvancedSearch.type_icardasubject -> sidebar facet title!
  • xmlui.ArtifactBrowser.ConfigurableBrowse.icardasubject.column_heading -> Browse sidebar column heading
  • xmlui.ArtifactBrowser.ConfigurableBrowse.title.metadata.icardasubject -> Shown in Browse results
  • xmlui.ArtifactBrowser.ConfigurableBrowse.trail.metadata.icardasubject -> Shown in Browse results
  • xmlui.ArtifactBrowser.Navigation.browse_icardasubject -> Text in Browse sidebar
  • xmlui.ArtifactBrowser.SimpleSearch.filter.icardasubject? -> "Advanced Search", aka /discover search page
  • xmlui.reporting-suite.statistics.graph-editor.data-source.dataset.option.icardasubject
  • xmlui.reporting-suite.statistics.contentanalysis.icardasubject
  • xmlui.Discovery.AbstractSearch.type_icardasubject -> Shown in Discovery "View more" results
• Add strings to Atmire modules:
  • dspace/config/modules/atmire-listings-and-reports.cfg
  • dspace/config/modules/atmire-cua.cfg
  • dspace/modules/additions/src/main/resources/Messages.properties

Adding a new XMLUI theme

• copy theme to dspace/modules/xmlui/src/main/webapp/themes
• things to check for:
  • banner name banner.jpg or banner.png
  • add Google Analytics code
  • add handle for XMLUI theme to dspace/config/xmlui.xconf