mirror of
https://github.com/silverstripe/silverstripe-dms
synced 2024-10-22 14:05:56 +02:00
54 lines
2.9 KiB
Markdown
54 lines
2.9 KiB
Markdown
# Document Management Module (DMS)
|
|
|
|
[](https://travis-ci.org/silverstripe/silverstripe-dms)
|
|
[](https://scrutinizer-ci.com/g/silverstripe/silverstripe-dms/?branch=master)
|
|
[](https://codecov.io/gh/silverstripe/silverstripe-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](docs/en/index.md).
|
|
|
|
## 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](https://github.com/silverstripe-big-o/gridfieldpaginatorwithshowall)
|
|
* (optional) [Sorting of Documents in the CMS](https://github.com/silverstripe-big-o/SortableGridField)
|
|
* (optional) [Full text search of Documents](https://github.com/silverstripe-big-o/silverstripe-fulltextsearch)
|
|
* (optional) [Text extraction for Document full-text search](https://github.com/silverstripe-big-o/silverstripe-textextraction)
|
|
* (optional) [Tags](https://github.com/tubbs/silverstripe-dms-simple-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/](https://www.transifex.com/projects/p/silverstripe-dms/) to contribute translations,
|
|
rather than sending pull requests with YAML files.
|
|
|
|
See the ["i18n" topic](http://doc.silverstripe.org/framework/en/trunk/topics/i18n) on doc.silverstripe.org for more details.
|