silverstripe-dms/README.md

Document Management Module (DMS)

Overview

The module adds a new DMSDocument model which allows management of large amounts of files, and their relations to pages. In contrast to the File model built into SilverStripe core, it aims to wrap storage and access concerns in a generic API. This allows more fine-grained control over how the documents are managed and exposed through the website.

Additionally, documents are stored and managed as part of a page instead of away in a separate assets store.

Features

• Relation of documents to pages
• Relation of documents to other documents
• Management and upload of documents within a page context in the CMS
• Metadata management through the powerful GridField and UploadField core APIs
• Configurable tags for documents
• Download via SilverStripe controller (rather than filesystem URLs)
• Access control based on PHP logic, and page relations
• Replacement of existing files

Documentation

For information on configuring and using this module, please see the documentation section.

Requirements

• PHP 5.3 with the "fileinfo" module (or alternatively the "whereis" and "file" Unix commands)
• SilverStripe framework/CMS ^3.5
• (optional) Pagination of Documents in the CMS
• (optional) Sorting of Documents in the CMS
• (optional) Full text search of Documents
• (optional) Text extraction for Document full-text search
• (optional) Tags

Contributing

Translations

Translations of the natural language strings are managed through a third party translation interface, transifex.com. Newly added strings will be periodically uploaded there for translation, and any new translations will be merged back to the project source code.

Please use https://www.transifex.com/projects/p/silverstripe-dms/ to contribute translations, rather than sending pull requests with YAML files.

See the "i18n" topic on doc.silverstripe.org for more details.