Add new how to documentation sections

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>

docs/chapters/document_types.rst

@@ -68,5 +68,21 @@ type at a given moment, but if needed, the type of a document can be changed.
 Upon changing its type, the document will lose its previous settings and
 attributes, and will inherit the settings and attributes of its new type.
 
-Document types are create in the
-:menuselection:`System --> Setup --> Document types` menu.
+
+Creating document types
+=======================
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Create document types" permission is required for this action.
+
+
+#. Go to the :menuselection:`System --> Setup --> Document types` menu.
+#. From the :guilabel:`Actions` dropdown select :guilabel:`Create document type`.
+#. Enter a label to be shown to users when using this document type.
+#. Optional: Enter a period of time after which documents of this type will be moved to the trash.
+#. Optional: Select the unit of time for the period after which the document will be moved to the trash.
+#. Optional: Enter a period of time after which documents moved to the trash will be permanently deleted.
+#. Optional: Select the unit of time for the period of time after which the documents moved to the trash will be permanently deleted
+#. Press :guilabel:`Submit`.

docs/chapters/index_examples.rst

@@ -5,6 +5,16 @@ Index examples
 Index of document types
 ^^^^^^^^^^^^^^^^^^^^^^^
 
+.. admonition:: Permissions required
+    :class: warning
+
+    - The "Create new document indexes" permission is required for this action.
+    - The "Edit document indexes" permission is required for this action, globally
+      of via an ACL for a document index.
+    - The "Edit document types" permission is required for this action, globally
+      of via an ACL for a document type.
+
+
 This index will create one level for each document type in the system and place
 links to the document of each respective type.
 

docs/chapters/metadata.rst

@@ -26,3 +26,73 @@ interpret and modify the value provided by the user to a conform to a specific
 format. An example of a provided parser is the date parser which will interpret
 and correct dates provided by users regardless of the format in which they are
 entered.
+
+
+Creating metadata types
+=======================
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Create new metadata types" permission is required for this action.
+
+
+#. Go to the :menuselection:`System --> Setup --> Metadata types` menu.
+#. From the :guilabel:`Actions` dropdown select :guilabel:`Create new`.
+#. Provide a name to reference this metadata type in other parts of the system.
+#. Enter a label to be shown to users when using this metadata type.
+#. Optional: Enter a default value for the metadata type.
+#. Optional: Provide a comma separated list of options to restrict the data entry
+   when using this metadata type.
+#. Optional: Select a validator and a parser to validate and cleanup the data
+   entry when not using a predetermined list of values.
+#. Press :guilabel:`Submit`.
+
+
+Assigning a metadata type to a document type
+============================================
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Edit metadata types" permission is required for this action, globally or
+    via an ACL for a metadata type. Also the "Edit document type" permission
+    is required, globally or via an ACL for a document type.
+
+
+This action can be performed in two ways.
+
+Option 1: Via the metadata type view
+------------------------------------
+
+#. Go to the :menuselection:`System --> Setup --> Metadata types` menu.
+#. Click on the button :guilabel:`Document types` of the metadata type you which
+   to associate.
+#. From the list of existing document types press either:
+
+   - :guilabel:`None` if this metadata type will not be available for documents
+     of the type.
+   - :guilabel:`Optional` if this metadata type will be available and is
+     optional to provide a value for documents of the type.
+   - :guilabel:`Required` if this metadata type will be available and is
+     required to provide a value for documents of the type.
+
+#. Press :guilabel:`Save`.
+
+
+Option 2: Via the document type view
+------------------------------------
+
+#. Go to the :menuselection:`System --> Setup --> Document types` menu.
+#. Click on the button :guilabel:`Metadata types` of the metadata type you which
+   to associate.
+#. From the list of existing metadata types press either:
+
+   - :guilabel:`None` if this metadata type will not be available for documents
+     of the type.
+   - :guilabel:`Optional` if this metadata type will be available and is
+     optional to provide a value for documents of the type.
+   - :guilabel:`Required` if this metadata type will be available and is
+     required to provide a value for documents of the type.
+
+#. Press :guilabel:`Save`.

docs/chapters/quick_labels.rst

@@ -21,6 +21,13 @@ For example if a document file is named "file0001.pdf" and the quick label
 Creating quick labels
 =====================
 
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Edit document types" permission is required for this action, either
+    globally or via an ACL for a document type.
+
+
 Since quick labels are associated with document types, creating quick labels
 must be done from the document type view.
 
@@ -47,6 +54,13 @@ Using quick labels during upload
 Using quick labels for existing documents
 =========================================
 
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Edit document properties" permission is required for this action, either
+    globally or via an ACL for a document or document type.
+
+
 #. Navigate to the document preview view of the document to rename. Make sure
    quick labels for the document type of the document select have been created.
 #. From the :guilabel:`Actions` dropdown select :guilabel:`Edit Properties`.

docs/chapters/sources.rst

@@ -56,9 +56,24 @@ compressed files which are decompressed and their content uploaded as separate
 documents. This feature is useful when migrating from another document
 manager system.
 
-Sources are create in the :menuselection:`System --> Setup --> Sources` menu.
 
 .. note::
 
     If you deployed a Mayan EDMS Docker container and want to use watched folders
     or staging folder, refer to the Docker chapter :ref:`docker-accessing-outside-data`.
+
+
+Creating new sources
+====================
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Create new document sources" permission is required for this action.
+
+
+#. Go to the :menuselection:`System --> Setup --> Sources` menu.
+#. From the :guilabel:`Actions` dropdown select the new type of source to create.
+#. Each source type will have different fields to customize its behaviour. Enter
+   the required information in each field based on the help text provided.
+#. Press :guilabel:`Save`.

docs/chapters/tags.rst

@@ -5,10 +5,6 @@ Tags are color coded properties that can be attached or removed from documents.
 Tags allow giving documents a binary property. Documents can also be tagged
 with more than one tag.
 
-Tags are created from the :menuselection:`Tags --> Create` menu.
-
-To view all created tags use the :menuselection:`Tags --> All` menu.
-
 Once tagged, documents can be searched by their tags. It is also possible to
 show all the documents tagged with a particular
 tag via the **Documents** link of each tag.
@@ -21,3 +17,30 @@ more tags to the document and another to remove tags from the document.
 It is also possible to tag documents in bulk by selecting several documents
 from any view that displays a list documents and selecting the **Attach tag**
 or **Remove tags** from the dropdown menu.
+
+
+Creating tags
+=============
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Create new tags" permission is required for this action.
+
+
+#. Go to the :menuselection:`Tags --> Create` menu.
+#. Enter a label to identify the tag.
+#. Select a color for the tag.
+#. Press :guilabel:`Submit`.
+
+
+View all tags
+=============
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "View tags" permission is required for this action, globally or via an
+    ACL for a tag.
+
+#. Go to the :menuselection:`Tags --> All` menu.

docs/chapters/versioning.rst

@@ -46,3 +46,35 @@ There is no limit to the number of versions a document can have.
 
 By default, the last version will be showed when working with the document
 but any of the versions can be inspected and viewed.
+
+
+View a document version list
+============================
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "View documents' versions list" permission is required for this action,
+    either globally or via an ACL for a document or document type.
+
+
+#. Navigate to the select document's preview view.
+#. Click on the sibebar's :guilabel:`Versions` button.
+
+
+Uploading a new document version
+================================
+
+.. admonition:: Permissions required
+    :class: warning
+
+    The "Create new document versions" permission is required for this action,
+    either globally or via an ACL for a document or document type.
+
+
+#. Navigate to the select document's versions list view.
+#. From the :guilabel:`Actions` dropdown select :guilabel:`Upload new version`.
+#. Optionally type a comment explaining the changes in the new version.
+#. Press the :guilabel:`Browse` button and select a new file.
+#. Press :guilabel:`Save` upload the new verision.
+

docs/topics/categorization.rst

@@ -7,10 +7,12 @@ allows showing users different views of document groups. These are divided
 into ones requiring manual maintenance and others that are updated
 automatically.
 
+
 **************
 Manual methods
 **************
 
+.. include:: ../chapters/document_types.rst
 .. include:: ../chapters/cabinets.rst
 .. include:: ../chapters/tags.rst