DSpace Manual
User Manual:
Open the PDF directly: View PDF
Page Count: 901 [warning: Documents this large are best viewed by clicking the View PDF Link!]
- Introduction
- Installing DSpace
- For the Impatient
- Hardware Recommendations
- Prerequisite Software
- Installation Instructions
- Advanced Installation
- Windows Installation
- Checking Your Installation
- Known Bugs
- Common Problems
- Upgrading DSpace
- Using DSpace
- Authentication and Authorization
- Authentication Plugins
- Embargo
- Managing User Accounts
- Request a Copy
- Exporting Content and Metadata
- OAI
- Exchanging Content Between Repositories
- SWORDv1 Client
- Linked (Open) Data
- Ingesting Content and Metadata
- Submission User Interface
- Default Submission Process
- Understanding the Submission Configuration File
- Reordering/Removing/Adding Submission Steps
- Assigning a custom Submission Process to a Collection
- Custom Metadata-entry Pages for Submission
- Configuring the File Upload step
- Creating new Submission Steps
- Configuring StartSubmissionLookupStep
- 2016 Framework for live import from external sources
- Simple HTML Fragment Markup
- Configurable Workflow
- Importing and Exporting Content via Packages
- Importing and Exporting Items via Simple Archive Format
- Registering Bitstreams via Simple Archive Format
- Importing Items via basic bibliographic formats (Endnote, BibTex, RIS, TSV, CSV) and online services (OAI, arXiv, PubMed, CrossRef, CiNii)
- Importing Community and Collection Hierarchy
- SWORDv1 Server
- SWORDv2 Server
- Ingesting HTML Archives
- Submission User Interface
- Items and Metadata
- Authority Control of Metadata Values
- Batch Metadata Editing
- DOI Digital Object Identifier
- Item Level Versioning
- Mapping Items
- Metadata Recommendations
- Moving Items
- ORCID Integration
- Introduction
- Use case and high level benefits
- Enabling the ORCID authority control
- Importing existing authors & keeping the index up to date
- Configuration
- Adding additional fields under ORCID
- Integration with other systems beside ORCID
- FAQ
- Which information from ORCID is currently indexed in the authority cache?
- How can I index additional fields in the authority cache?
- How can I use the information stored in the authority cache?
- How to add additional metadata fields in the authority cache that are not related to ORCID?
- What happens to data if another authority control was already present?
- Where can I find the URL that is used to lookup ORCIDs?
- PDF Citation Cover Page
- Updating Items via Simple Archive Format
- Managing Community Hierarchy
- Statistics and Metrics
- DSpace Google Analytics Statistics
- Elasticsearch Usage Statistics
- SOLR Statistics
- What is exactly being logged ?
- Web User Interface Elements
- Architecture
- Configuration settings for Statistics
- Upgrade Process for Statistics
- Statistics Administration
- Statistics differences between DSpace 1.7.x and 1.8.0
- Statistics differences between DSpace 1.6.x and 1.7.0
- Web UI Statistics Modification (XMLUI Only)
- Custom Reporting - Querying SOLR Directly
- Manually Installing/Updating GeoLite Database File
- SOLR Statistics Maintenance
- DSpace Log Converter
- Filtering and Pruning Spiders
- Export SOLR records to intermediate format for import into Elasticsearch
- Export SOLR statistics, for backup and moving to another server
- Import SOLR statistics, for restoring lost data or moving to another server
- Reindex SOLR statistics, for upgrades or whenever the Solr schema for statistics is changed
- Routine Solr Index Maintenance
- Solr Sharding By Year
- Testing Solr Shards
- User Interfaces
- Discovery
- What is DSpace Discovery
- Discovery Changelist
- Configuration files
- General Discovery settings ( config/modules/discovery.cfg )
- Modifying the Discovery User Interface ( config/spring/api/discovery.xml )
- Structure Summary
- Default settings
- Non indexed metadata fields
- Search filters & sidebar facets Customization
- Sort option customization for search results
- DiscoveryConfiguration
- Configuring lists of sidebarFacets and searchFilters
- Configuring and customizing search sort fields
- Adding default filter queries (OPTIONAL)
- Access Rights Awareness
- Customizing the Recent Submissions display
- Customizing hit highlighting & search snippets
- "More like this" configuration
- "Did you mean" spellcheck aid for search configuration
- Customizing the "Tag Cloud" facet
- Disabling the "Has file(s)" facet
- Discovery Solr Index Maintenance
- Advanced Solr Configuration
- Internationalization
- Localization L10n
- JSPUI Configuration and Customization
- XMLUI Configuration and Customization
- Overview of XMLUI / Manakin
- Manakin Configuration Property Keys
- Configuring Themes and Aspects
- Multilingual Support
- Creating a New Theme
- Customizing the News Document
- Adding Static Content
- Harvesting Items from XMLUI via OAI-ORE or OAI-PMH
- Additional XMLUI Learning Resources
- Mirage 2 Configuration and Customization
- /*<![CDATA[*/ div.rbtoc1499973225848 {padding: 0px;} div.rbtoc1499973225848 ul {list-style: disc;margin-left: 0px;} div.rbtoc1499973225848 li {margin-left: 0px;padding-left: 0px;} /*]]>*/
- Introduction
- Responsive design
- The build process and enabling Mirage 2
- Configuration options
- Customizing Mirage 2
- Automatically retrieving the latest versions of Mirage 2 dependencies
- Additional Developer documentation
- Mirage Configuration and Customization
- XMLUI Base Theme Templates (dri2xhtml)
- DRI Schema Reference
- Discovery
- Authentication and Authorization
- System Administration
- Introduction to DSpace System Administration
- AIP Backup and Restore
- Background & Overview
- Running the Code
- Command Line Reference
- Configuration in 'dspace.cfg'
- Common Issues or Error Messages
- DSpace AIP Format
- Ant targets and options
- Command Line Operations
- Mediafilters for Transforming DSpace Content
- Performance Tuning DSpace
- Scheduled Tasks via Cron
- Search Engine Optimization
- Ensuring your DSpace is indexed
- Keep your DSpace up to date
- Ensure your DSpace is visible to search engines
- Enable the sitemaps feature
- Create a good robots.txt
- Ensure Item Metadata appears in the HTML HEAD
- Avoid redirecting file downloads to Item landing pages
- Turn OFF any generation of PDF cover pages
- In general, OAI-PMH is not useful to Search Engines
- Google Scholar Metadata Mappings
- Ensuring your DSpace is indexed
- Troubleshooting Information
- Validating CheckSums of Bitstreams
- DSpace Development
- Advanced Customisation
- REST API
- What is DSpace REST API
- Introduction to Jersey for developers
- Configuration for DSpace REST
- Recording Proxy Access by Tools
- Additional Information
- REST Based Quality Control Reports
- /*<![CDATA[*/ div.rbtoc1499973228622 {padding: 0px;} div.rbtoc1499973228622 ul {list-style: disc;margin-left: 0px;} div.rbtoc1499973228622 li {margin-left: 0px;padding-left: 0px;} /*]]>*/
- Summary
- API Calls Used in these Reports
- Report Screen Shots
- Installation and Configuration
- Installing in DSpace 6
- Disabling the REST Reports
- Configuring Access of the Reporting Tools
- Configure the REST Reports that can be requested by name
- Configure Item handle resolution
- Enable User Authentication (Password AuthN only) for REST reports
- Configure the database-specific format for a regex expression
- Configure the sets of filters of interest to your repository managers
- Other filter configuration settings
- Enabling Sort-able Report Tables
- Installing in DSpace 5
- REST Reports - Collection Report Screenshots with Annotated API Calls
- REST Reports - Metadata Query Screenshots with Annotated API Calls
- REST Reports - Summary of API Calls
- /*<![CDATA[*/ div.rbtoc1499973228744 {padding: 0px;} div.rbtoc1499973228744 ul {list-style: disc;margin-left: 0px;} div.rbtoc1499973228744 li {margin-left: 0px;padding-left: 0px;} /*]]>*/
- GET /rest - Summary of API Calls
- GET /rest/reports - List of Available Reports
- GET /rest/reports/[report name] - Redirect to a Specific Report
- GET /rest/filters - Return filters to apply to a list of items
- GET /rest/filtered-collections - Return collections and item counts based on pre-defined filters
- GET /rest/filtered-collections/{collection_id} - Return items and item counts for a collection based on pre-defined filters
- GET /rest/filtered-items - Retrieve a set of items based on a metadata query and a set of filters
- Curation System
- Changes in 1.8
- Tasks
- Activation
- Writing your own tasks
- Task Invocation
- Asynchronous (Deferred) Operation
- Task Output and Reporting
- Task Properties
- Task Annotations
- Scripted Tasks
- Bundled Tasks
- Curation tasks in Jython
- Date parser tester
- Services to support Alternative Identifiers
- Batch Processing
- Extensible control panel
- DSpace Reference
- Configuration Reference
- General Configuration
- The local.cfg Configuration Properties File
- The dspace.cfg Configuration Properties File
- Main DSpace Configurations
- DSpace Database Configuration
- DSpace Email Settings
- File Storage
- Logging Configuration
- General Plugin Configuration
- Configuring the Search Engine
- Handle Server Configuration
- Delegation Administration: Authorization System Configuration
- Restricted Item Visibility Settings
- Proxy Settings
- Configuring Media Filters
- Crosswalk and Packager Plugin Settings
- Event System Configuration
- Embargo
- Checksum Checker Settings
- Item Export and Download Settings
- Subscription Emails
- Hiding Metadata
- Settings for the Submission Process
- Configuring the Sherpa/RoMEO Publishers Policy Database Integration
- Configuring Creative Commons License
- WEB User Interface Configurations
- Browse Index Configuration
- Author (Multiple metadata value) Display
- Links to Other Browse Contexts
- Recent Submissions
- Submission License Substitution Variables
- Syndication Feed (RSS) Settings
- OpenSearch Support
- Content Inline Disposition Threshold
- Multi-file HTML Document/Site Settings
- Sitemap Settings
- Authority Control Settings
- Configuring Multilingual Support
- JSPUI Upload File Settings
- JSP Web Interface (JSPUI) Settings
- JSPUI Item Mapper
- Display of Group Membership
- JSPUI / XMLUI SFX Server
- JSPUI Item Recommendation Setting
- Controlled Vocabulary Settings
- XMLUI Specific Configuration
- Optional or Advanced Configuration Settings
- Command-line Access to Configuration Properties
- Directories and Files
- Metadata and Bitstream Format Registries
- Architecture
- Overview
- Application Layer
- Business Logic Layer
- DSpace Services Framework
- Storage Layer
- History
- Changes in 6.x
- Changes in 5.x
- Changes in 4.x
- Changes in 3.x
- Changes in 1.8.x
- Changes in 1.7.x
- Changes in 1.6.x
- Changes in 1.5.x
- Changes in 1.4.x
- Changes in 1.3.x
- Changes in 1.2.x
- Changes in 1.1.x
- DSpace Item State Definitions
- Configuration Reference