silverstripe-dms/README.md

# Document Management Module (DMS)

[![Build status](https://travis-ci.org/silverstripe/silverstripe-dms.png?branch=master)](https://travis-ci.org/silverstripe/silverstripe-dms)
[![Code quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-dms/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-dms/?branch=master)
[![Code coverage](https://codecov.io/gh/silverstripe/silverstripe-dms/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-dms)
![Helpful Robot](https://img.shields.io/badge/helpfulrobot-52-yellow.svg?style=flat)

## 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.
Added README 2012-08-06 16:20:33 +02:00			`# Document Management Module (DMS)`

Add Codecov integration and Codecov/Scrutinizer badges to readme 2017-05-01 06:44:51 +02:00			`[![Build status](https://travis-ci.org/silverstripe/silverstripe-dms.png?branch=master)](https://travis-ci.org/silverstripe/silverstripe-dms)`
			`[![Code quality](https://scrutinizer-ci.com/g/silverstripe/silverstripe-dms/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/silverstripe/silverstripe-dms/?branch=master)`
			`[![Code coverage](https://codecov.io/gh/silverstripe/silverstripe-dms/branch/master/graph/badge.svg)](https://codecov.io/gh/silverstripe/silverstripe-dms)`
DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`![Helpful Robot](https://img.shields.io/badge/helpfulrobot-52-yellow.svg?style=flat)`
Travis support 2013-03-11 01:44:38 +01:00
Added README 2012-08-06 16:20:33 +02:00			`## Overview`

DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			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.`
MINOR: additional documentation of DMS 2012-10-09 07:01:44 +02:00
DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`Additionally, documents are stored and managed as part of a page instead of away in a separate assets store.`
MINOR: updating links 2012-11-20 22:52:15 +01:00
DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`## Features`
Added README 2012-08-06 16:20:33 +02:00
			`* Relation of documents to pages`
DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`* Relation of documents to other documents`
Added README 2012-08-06 16:20:33 +02:00			`* 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`

DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`## Documentation`
Added README 2012-08-06 16:20:33 +02:00
DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`For information on configuring and using this module, please see [the documentation section](docs/en/index.md).`
Added README 2012-08-06 16:20:33 +02:00
DOCS Split readme documentation into docs/en files, add related documents information 2017-05-02 02:32:49 +02:00			`## Requirements`
Added README 2012-08-06 16:20:33 +02:00
			`* PHP 5.3 with the "fileinfo" module (or alternatively the "whereis" and "file" Unix commands)`
Bump minimum version requirements for framework and CMS to 3.5 2017-05-08 06:24:25 +02:00			`* SilverStripe framework/CMS ^3.5`
MINOR: updating links 2012-11-20 22:52:15 +01:00			`* (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)`
MINOR: adding reference to tags module for DMS 2014-05-19 02:54:16 +02:00			`* (optional) [Tags](https://github.com/tubbs/silverstripe-dms-simple-tags)`
Added README 2012-08-06 16:20:33 +02:00
Transifex translation support 2013-07-08 12:53:17 +02:00			`## 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.`

Update README.md to fix broken build status icon 2016-11-10 00:01:36 +01:00			`See the ["i18n" topic](http://doc.silverstripe.org/framework/en/trunk/topics/i18n) on doc.silverstripe.org for more details.`