diff --git a/docs/figure_src/versioning.svg b/docs/figure_src/versioning.svg new file mode 100644 index 0000000000..e5e64cf1f0 --- /dev/null +++ b/docs/figure_src/versioning.svg @@ -0,0 +1,211 @@ + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + Original version: 1.0.0 + + New major version: 2.0.0 + + New minor version: 1.1.0 + + New micro version: 1.0.1 + + + + diff --git a/docs/index.rst b/docs/index.rst index a28c4f98f6..b13a2291a4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,13 +38,16 @@ First steps Understanding Mayan EDMS ======================== + :doc:`File storage ` | + :doc:`Initial data loading ` | + :doc:`Permission system ` | + :doc:`Transformations ` | + :doc:`Document visualization ` | + :doc:`Document versioning ` | + :doc:`Document signatures ` | :doc:`Indexes ` | :doc:`Smart links ` | - :doc:`Permission system ` | - :doc:`Document visualization ` | - :doc:`OCR ` | - :doc:`File storage ` | - :doc:`Transformations ` + :doc:`OCR ` Between versions diff --git a/docs/intro/features.rst b/docs/intro/features.rst index 43e9bfa267..71d19c1dd9 100644 --- a/docs/intro/features.rst +++ b/docs/intro/features.rst @@ -2,11 +2,11 @@ Features ======== -* Document versioning. +* :doc:`Document versioning <../topics/versioning>`. * Store many versions of the same document, download or revert to a previous version. -* Electronic signature verification. +* :doc:`Electronic signature verification <../topics/signatures>`. * Check the authenticity of documents by verifying their embedded cryptographic signatures or upload detached signatures for document @@ -56,11 +56,11 @@ Features * Automatic linking of documents based on metadata values or document properties. -* Roles support. +* :doc:`Roles support <../topics/permissions>`. * Users can created an unlimited amount of different roles and are not restricted to the traditional admin, operator, guest paradigm. -* Fine grained permissions system. +* :doc:`Fine grained permissions system <../topics/permissions>`. * There is a permission for every atomic operation performed by users. @@ -68,7 +68,7 @@ Features * Multiple page PDFs and TIFFs files supported. -* Distributed OCR processing. +* :doc:`Distributed OCR processing <../topics/ocr>`. * The task of transcribing text from documents via OCR can be distributed among several physical or virtual computers to decrease load and increase availability. @@ -76,13 +76,13 @@ Features * **Mayan EDMS** is written using the Django_ framework which natively support Unicode, this coupled with the use of text templates allows **Mayan EDMS** to be translated to practically any language spoken in the world, by default four translations are provided: English, Spanish, Portuguese and Russian. -* Multilingual OCR support. +* :doc:`Multilingual OCR support <../topics/ocr>`. * As supported by the OCR engine tesseract. * Duplicated document search. -* Plugable storage backends (File based and GridFS included). +* :doc:`Plugable storage backends <../topics/file_storage>` (File based and GridFS included). * Very easy to use 3rd party plugins such as the ones available for Amazon EC2. diff --git a/docs/releases/0.12.rst b/docs/releases/0.12.rst index 1f3563a4b2..68dba8a8ea 100644 --- a/docs/releases/0.12.rst +++ b/docs/releases/0.12.rst @@ -46,6 +46,10 @@ ACL support * Object level access control is now in place for documents, folders, tags and smart links. What this means is that administrators can now grant permissions to users, groups or roles on for specific objects. + A more in-depth explanation of how this new ACL system can be found in + the :doc:`3 tier access control <../topics/permissions>` section of the + permissions chapter. + * Default class ACL support. Administrators can setup the access control lists that new documents, folders and tags will automatically inheric when created. Aside from asigning permission to users, groups and roles @@ -83,52 +87,32 @@ the download of several documents in a single compressed file. Customizable GPG home directory ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Addition of the SIGNATURES_GPG_HOME configuration option to let +Addition of the :setting:`SIGNATURES_GPG_HOME` configuration option to let administrators set **Mayan EDMS**'s GPG instance home directory, used to store keyrings and other GPG configuration files. Out of process bulk uploading ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ A management command has been added to help upload a large number of documents -from a compressed file. The command line options for this feature are as -follow:: +from a compressed file. For information about this new feature check the +:doc:`Initial data loading <../topics/initial_import>` chapter. - $ ./manage.py bulk_upload --noinput --metadata '{"project": "bulk"}' --document_type "Accounting documents" compressed.zip - -**Optional arguments** - -* The ``--noinput`` argument skips confirmation and starts the upload immediately. -* The ``--metadata`` argument allows specifing what metadata will be assigned - to the documents when uploaded. -* And the ``--document_type`` applies a previously defined - document type to the uploaded documents. Out of process user import ~~~~~~~~~~~~~~~~~~~~~~~~~~ A management command has been added to import a large number users -from a CSV file. The command line options for this feature are as -follow:: +from a CSV file. More information about this new feature can also be found +in the :doc:`Initial data loading <../topics/initial_import>` chapter. - $ ./manage.py import_users --noinput --password=welcome123 --skip-repeated user_list.csv - -The CSV field order must be: username, first name, last name and email, any other -column after those is ignored. - -**Optional arguments** - -* The ``--noinput`` argument skips confirmation and starts the import immediately. -* The ``--password`` argument allows specifing what default password will be assigned - to all the new users that are imported. -* The ``--skip-repeated`` tells the importedr to not stop when finding - that a user already exists in the database. Refactored document indexing ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The document indexing functionality has been improved and moved from experimental +:doc:`The document indexing <../topics/indexes>` functionality has been +improved and moved from experimental stage to beta stage. Index configuration menus are now available on the -``Setup`` menu and allows administrators to create a skeleton tree that will +``Setup`` menu and allows administrators to create skeleton trees that will be populated with document links depending on their metadata and properties. -This populated tree can also be mirrored on the physical filesystem and shared +These populated trees can also be mirrored on the physical filesystem and shared using Samba or another filesharing server giving users a structured view of the documents contained within **Mayan EDMS** from the ``Indexes`` tab or from a mirrored index shared via the network. A new configuration option @@ -147,7 +131,7 @@ the need of the **Mayan EDMS** user base. Staging file previews ~~~~~~~~~~~~~~~~~~~~~ -The staging file previews now show the filename as the title for easier +The staging file previews now show the filename for easier identification and speedier upload selection. The staging files previews are now treated as a gallery which means that users can preview an entire page of staging files without having to click and close each one diff --git a/docs/releases/index.rst b/docs/releases/index.rst index bd3fc2ddd6..3bbee2aa57 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -11,18 +11,15 @@ all the backwards-incompatible changes and deprecated features for each 'final' release from the one after your current **Mayan EDMS** version, up to and including the new version. -Final releases -============== - -0.12 release ------------- +Latest version (0.12) +--------------------- .. toctree:: :maxdepth: 1 0.12 Historic changelogs -=================== +------------------- .. toctree:: :maxdepth: 1 diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 2d297d1745..a97ff7d101 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -6,10 +6,13 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: .. toctree:: :maxdepth: 1 + file_storage + initial_import + permissions + transformations + document_visualization + versioning + signatures indexes smart_links - permissions - document_visualization ocr - file_storage - transformations diff --git a/docs/topics/initial_import.rst b/docs/topics/initial_import.rst new file mode 100644 index 0000000000..72859f49bf --- /dev/null +++ b/docs/topics/initial_import.rst @@ -0,0 +1,48 @@ +==================== +Initial data loading +==================== + +Bulk document import +-------------------- + +**Mayan EDMS** has the ability to individually upload the contents of compressed +files, however by nature of being a web based application it is bounded by the +limitations of the HTTP protocol, this imposes a limit on the file size and +the amount of time **Mayan EDMS** may keep a connection open while it processes +compressed files. When the desired amount of documents is bigger than what +these limitations allow, **Mayan EDMS** provides a command line tool for out of +process document importation. + +The command line options for this feature are as follows:: + + $ ./manage.py bulk_upload --noinput --metadata '{"project": "bulk"}' --document_type "Accounting documents" compressed.zip + +**Optional arguments** + +* The ``--noinput`` argument skips confirmation and starts the upload immediately. +* The ``--metadata`` argument allows specifing what metadata will be assigned + to the documents when uploaded. +* And the ``--document_type`` applies a previously defined + document type to the uploaded documents. + + +Bulk user import +---------------- + +As well as providing bulk document import functionality **Mayan EDMS** also +includes a management command to import a large number users +from a CSV file. The command line options for this feature are as +follow:: + + $ ./manage.py import_users --noinput --password=welcome123 --skip-repeated user_list.csv + +The CSV field order must be: username, first name, last name and email, any other +column after those is ignored. + +**Optional arguments** + +* The ``--noinput`` argument skips confirmation and starts the import immediately. +* The ``--password`` argument allows specifing what default password will be assigned + to all the new users that are imported. +* The ``--skip-repeated`` tells the importedr to not stop when finding + that a user already exists in the database. diff --git a/docs/topics/signatures.rst b/docs/topics/signatures.rst new file mode 100644 index 0000000000..f2cad89fc2 --- /dev/null +++ b/docs/topics/signatures.rst @@ -0,0 +1,24 @@ +=================== +Document signatures +=================== + +**Mayan EDMS** supports two types of document signatures, these are embedded and +detached signatures. When a document with an embedded signature is +uploaded, this signature is readily detected as part of the document +inspection step. If the public key corresponding to the signee of the +document is not found, **Mayan EDMS** will try to obtain it from the list of +keyserver specified in the config option :setting:`SIGNATURES_KEYSERVERS`. +Failing that, **Mayan EDMS** will indicate that the document is signed +but that it has no way to verify such signature. +Existing non signed documents can be signed in one of two way: +by downloading the document, signing it, and uploading the signed document +as a new version of the existing one using **Mayan EDMS** :doc:`versioning support ` +or by creating a detached signature for the non signed document and uploading +such detached signature file using the option likewise named menu option. + +Maintenance of the public keyring can be done using the ``Key management`` +functionality in the ``Setup menu`` + +From this menu, key servers can be queried +and the results imported. Public keys no longer needed can also be deleted +from this menu. diff --git a/docs/topics/versioning.png b/docs/topics/versioning.png new file mode 100644 index 0000000000..6ec2f24d86 Binary files /dev/null and b/docs/topics/versioning.png differ diff --git a/docs/topics/versioning.rst b/docs/topics/versioning.rst new file mode 100644 index 0000000000..5aa6dedee9 --- /dev/null +++ b/docs/topics/versioning.rst @@ -0,0 +1,25 @@ +=================== +Document versioning +=================== + +**Mayan EDMS** has the ability to store different versions of the same +document. Users are provided with a very comprehensive but easy to use +version numbering system that allows specifying a major, minor or micro +version number increase. + +.. image:: versioning.png + :alt: versioning diagram + +A comment field is also provided to allow users +to summarize the new verdion changes in comparison with the previous +one. If a new version was uploded by mistake or such new version is no +longer necessary **Mayan EDMS** provides the option to revert to a previous +version of the document. + +To upload a new document version, select an existing document, click on the +version tab of the document, and click on the 'upload new version' on the +side bar. A new view very similar to the new document upload view will +appear show the same interactive document sources that have been defined, +but with new options to specify the new version number and an optional +comment. +