Merge pull request #180 from creative-commoners/pulls/2.0/add-userguide

DOCS Add userguide for DMS 2.0

docs/en/userguide/doc-cart.md

@@ -0,0 +1,3 @@
+# Document Management System Cart Module
+
+You can now request a hard-copy of preconfigured documents using the [DMS Cart Module](https://github.com/creative-commoners/silverstripe-dms-cart). The Cart Module is similar to a shopping cart and allows multiple documents to be requested in print form. This is an optional installation to enhance your DMS.

docs/en/userguide/document-sets.md

@@ -0,0 +1,71 @@
+# Document set management
+
+## Creating a Document Set
+
+You can create Document Sets directly on a **Page** or in the **Documents** section.
+
+In the **Documents** section, go to the new tab "Document Set", then use the button "Add Document Set" to create a new document set.
+
+![Example of deleting a document set](_images/document_section.png)
+
+If you want to create a Document Set directly from a page, navigate to the page, select the "Document Set" tab and the same "Add Document Set" button will appear.
+
+![Example of deleting a document set](_images/pages_section.png)
+
+Clicking the "Add Document Set" button will prompt you to fill in two fields: "Title" and "Show on page".
+
+![Example of deleting a document set](_images/document_set.png)
+
+The "Title" is the name of the document set that is used for display and searching purposes. The "Show on page" dropdown will let you immediately assign this document set to a page.
+
+If you don't want to assign a document set to a page right now, you can leave it blank – although the title for your new document set is compulsory. Once you’ve given it a name, click "Create".
+
+## Adding documents to a Document Set
+
+As soon as you create a Document Set you can add documents to it, regardless of where it was created from. You can do this by clicking "Add Document".
+
+The "Add Documents" page allows you to upload a file directly from your computer; either select "Choose files to upload" if you want to find the files in your file system using a navigation tool; or just drag-and-drop the files into the "Drop Area".
+
+Alternatively, you can add documents to your new Document Set that already exist in the CMS. To do this, just select the "From the CMS" tab and search for the filename or browse by the page that document is on.
+
+_**Note:** All of your documents will be uploaded into the "Documents" section's "Document" tab. Uploading documents in the "Documents" section works the same way as uploading files in the "Files" section. The only difference is that DMS documents are invisible to parts of SilverStripe CMS that handle files, meaning that they cannot be selected via the "Insert File" button when editing HTML content on a page, for example. They also have a higher level of security permissions and flexibility. You can read more about [working with images and documents](https://userhelp.silverstripe.org/en/creating_pages_and_content/creating_and_editing_content/working_with_images_and_documents/)._
+
+After uploading your documents click "Done!". You will then be taken back to that document set. You will see your documents in a list with their ID and filename, along with other information such as when the document was last edited and how the documents were added to the document set.
+
+**Tip:** If you have the [sortablegridfield module](http://addons.silverstripe.org/add-ons/undefinedoffset/sortablegridfield) installed, you can reorder the documents in the list by drag-and-dropping them.
+
+![Example of deleting a document set](_images/sortablegridfield.png)
+
+## Assigning a document set to a page
+
+Head to the **Pages** section, click "Home" and go to the "Document Sets" tab. You can "Link existing" by using the _"Find Document Sets by Title"_ search bar to add an existing document set. To link existing document sets, start typing into the "link existing" search box and an autocompleted list of document sets that are not already assigned to a page will be displayed. Select the set you want from the results and click "Link Existing" to link it to the current page.
+
+![Example of deleting a document set](_images/link_existing.png)
+
+You can add and edit document sets while in the "Document Sets" tab attached to a page, or from the **Documents** section in the CMS. Both methods work the same way.
+
+## Unlinking a document set from a page
+
+If you want to remove a Document Set from a page, go to "Document Sets" tab and then use the "Unlink" button. This won't delete the Document Set, but will stop displaying that set on that page.
+
+![Example of deleting a document set](_images/unlink_doc_set.png)
+
+## Deleting a Document Set
+
+To delete a Document Set, you must navigate to the **Documents** section. Click the "Document Set" tab and click on the delete icon on the right hand side of the set you want to delete. This will bring up a dialog box confirming if you want to delete the set. Click "OK" to delete the document set or "Cancel" to return to the Document Set page.
+
+_**Note:** If you delete a Document Set, the documents will still remain on the system._
+
+![Example of deleting a document set](_images/delete_doc_set.png)
+
+## Removing a file from a Document Set
+
+To remove a file from a Document Set, navigate to the Document Set tab (either in **Documents** or from the **Page**) and open the Document Set. All documents in that set will be displayed along with an "Unlink" button. This will not delete the document, but will remove it from the Document Set.
+
+![Example of deleting a document set](_images/unlink_doc_from_set.png)
+
+## Deleting files from the CMS
+
+To delete documents entirely from the system go to the **Documents** section, "Document" tab, and click on the delete icon on the right hand side of the document you want to delete. Similarly to deleting a Document Set, you will be asked to confirm if you want to delete the document.
+
+![Example of deleting a document set](_images/delete_doc_from_system.png)

docs/en/userguide/index.md

@@ -0,0 +1,10 @@
+title: Document Management System
+summary: Using the Document Management System module in the SilverStripe CMS
+
+# Using the Document Management System
+
+* [Introduction to DMS](introduction.md)
+* [Document set management](document-sets.md)
+* [Query Builder](query-builder.md)
+* [Setting permissions on a document](permissions.md)
+* [Document Management System Cart Module](doc-cart.md)

docs/en/userguide/introduction.md

@@ -0,0 +1,7 @@
+# Introduction
+
+The Document Management System (DMS) is a way to organise related documents into sets, either through manually creating links between documents or through utilising tags and other key criteria already placed on a Document. Sets of similar documents are called Document Sets. This module provides an easy way to create, maintain and manage Document Sets as well as individual documents included in each set.
+
+This guide will show you how to create a Document Set manually or by using our Query Builder tool that can create a set of multiple documents with just a few clicks.
+
+Once created, Document Sets can be added to your pages to display "Related documents", providing supporting documents or relevant information.

docs/en/userguide/permissions.md

@@ -0,0 +1,47 @@
+# Setting permissions on a document
+
+You can edit a document’s details and permissions inside a "Document Set" or in the **Documents** area under the "Document" tab by clicking on the document in the list. Here you will find where to change the "Title", "Description", "Cover Image", "Download behaviour" and "Actions" of your document.
+
+There are various options that you can set for particular documents under the title "Actions".
+
+![Example of deleting a document set](_images/actions.png)
+
+**Embargo**
+
+"Embargo" is where you can choose to set your content to draft then have it automatically published on a set time and date.
+
+**Expiry**
+
+You can also set your document to expire on a particular date under the "Expiry" tab. Expired documents will immediately stop showing up on the main website. Visitors cannot view unpublished content but you can access it in the CMS. For both "Embargo" and "Expiry" settings, simply select a date from the calendar date picker and enter the time you need.
+
+**Replace**
+
+The "Replace" tab allows you to replace a file using drag-and-drop or by attaching a file from your computer.
+
+**Usage**
+
+The "Usage" tab shows what pages the current document is used on.
+
+**References**
+
+The "References" tab will show you pages where the current document has been referenced in the HTML content, such as adding shortcodes to documents which direct to content.
+
+**Related documents**
+
+The "Related documents" tab allows you to link related documents to a document. Related documents will be displayed in a list underneath the main document when viewing the associated page on your website. This example shows "document.pdf" with its related document "example.pdf".
+
+![Example of deleting a document set](_images/related_documents.png)
+
+![Example of deleting a document set](_images/main_website.png)
+
+_**Note:** You can link any document in the DMS to any document set. A document does not "belong" to a specific set. For example, if you upload a document to set-A, then relate it to set-B, then unlink the document from set-A, the document will stay on set-B._
+
+You can set various permissions for different user groups under the "Permissions" tab such as "Who can view this document?" and "Who can edit this document?". For example, if the group "Test group" is able to view but not edit a document, the group will see a magnifying glass icon to only view uneditable information of that particular document. When viewing the main website, only users logged in and belonging to the "Test group" will be able to see the document.
+
+![Example of deleting a document set](_images/permissions.png)
+
+![Example of deleting a document set](_images/test_group_CMS.png)
+
+**Versions**
+
+The "Versions" tab shows you old versions of the document if you have previously replaced it.

docs/en/userguide/query-builder.md

@@ -0,0 +1,11 @@
+# Query Builder
+
+## Bulk add documents to a Document Set
+
+The query builder is an easy way to add multiple, similar documents to a Document Set. To see the "Query Builder" tab, navigate to the Document Set you want.
+
+![Example of deleting a document set](_images/query_builder.png)
+
+Using a selection of criteria, query builder allows you to search for and automatically add relevant documents to the current set. The fields in this section are developer configurable, and may include things such as "title matches", "order by" and "tags match" (if the [taxonomy module](http://addons.silverstripe.org/add-ons/silverstripe/taxonomy) is installed).
+
+Once you define query builder criteria, the results will be built when you save the document set.