diff --git a/README.rst b/README.rst index 7131f0a79e..b4bdb3baa5 100644 --- a/README.rst +++ b/README.rst @@ -59,7 +59,7 @@ Contribute .. _Mailing list (via Google Groups): http://groups.google.com/group/mayan-edms .. _Apache 2.0 License: https://www.apache.org/licenses/LICENSE-2.0.txt .. _`the repository`: http://github.com/mayan-edms/mayan-edms -.. _`contributors file`: https://github.com/mayan-edms/mayan-edms/blob/master/docs/credits/contributors.rst +.. _`contributors file`: https://github.com/mayan-edms/mayan-edms/blob/master/docs/topics/contributors.rst .. |Build Status| image:: http://img.shields.io/travis/mayan-edms/mayan-edms/master.svg?style=flat :target: https://travis-ci.org/mayan-edms/mayan-edms diff --git a/docs/contents.rst b/docs/contents.rst index b9b9e27203..1ab54886a3 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -12,8 +12,5 @@ Mayan EDMS documentation contents .. toctree:: :maxdepth: 3 - intro/index topics/index - credits/index releases/index - faq/index diff --git a/docs/credits/index.rst b/docs/credits/index.rst deleted file mode 100644 index e204701957..0000000000 --- a/docs/credits/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -Credits -======= - -Here we list everything and everybody that has made his/her/its part in improving -**Mayan EDMS** - -.. toctree:: - :maxdepth: 1 - - contributors - license diff --git a/docs/index.rst b/docs/index.rst index 2b2f0a00cf..d51f9b38e1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,7 @@ Mayan EDMS documentation Getting help ============ -* Try the :doc:`FAQ ` -- it's got answers to many common questions. +* Try the :doc:`FAQ ` -- it's got answers to many common questions. * Search for information in the `archives of the mayan-edms mailing list`_, or `post a question`_. If you prefer news servers, use the gateway provided by Gname_. @@ -35,11 +35,11 @@ Getting help First steps =========== - :doc:`Overview ` | - :doc:`Features ` | - :doc:`Requirements ` | - :doc:`Installation ` | - :doc:`Getting started ` + :doc:`Overview ` | + :doc:`Features ` | + :doc:`Requirements ` | + :doc:`Installation ` | + :doc:`Getting started ` Understanding Mayan EDMS ======================== @@ -73,8 +73,5 @@ For developers Credits ======= - :doc:`Contributors ` | - :doc:`Licensing ` - - - + :doc:`Contributors ` | + :doc:`Licensing ` diff --git a/docs/intro/index.rst b/docs/intro/index.rst deleted file mode 100644 index 05987c3813..0000000000 --- a/docs/intro/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -Getting started -=============== - -New to **Mayan EDMS**? Read this material to quickly get up and running. - -.. toctree:: - :maxdepth: 1 - - overview - features - requirements - installation - getting_started diff --git a/docs/releases/index.rst b/docs/releases/index.rst index 3e6df7ea50..ab6283f588 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -17,6 +17,14 @@ Final releases Below are release notes through **Mayan EDMS** |version| and its minor releases. Newer versions of the documentation contain the release notes for any later releases. +1.1 release +----------- +.. toctree:: + :maxdepth: 1 + + 1.1 + + 1.0 release ----------- .. toctree:: diff --git a/docs/credits/contributors.rst b/docs/topics/contributors.rst similarity index 100% rename from docs/credits/contributors.rst rename to docs/topics/contributors.rst diff --git a/docs/faq/index.rst b/docs/topics/faq.rst similarity index 100% rename from docs/faq/index.rst rename to docs/topics/faq.rst diff --git a/docs/intro/features.rst b/docs/topics/features.rst similarity index 89% rename from docs/intro/features.rst rename to docs/topics/features.rst index 10dddb4f70..c0b7cf5669 100644 --- a/docs/intro/features.rst +++ b/docs/topics/features.rst @@ -14,7 +14,7 @@ Features * Collaboration tools. - * Discuss documents, comment on new version of a document. + * Discuss documents, or comment on new versions of a document. * Office document format support. @@ -23,22 +23,22 @@ Features * User defined metadata fields and meta data sets. * Metadata fields can be grouped into sets per technical, legal or structural requirements such as the `Dublin core`_. - + * Dynamic default values for metadata. - + * Metadata fields can have an initial value, which can be static or determined by an user provided Python code snippet. * Filesystem integration. - + * If enabled, the document database index can be mirrored in the filesystem of the host and shared via Samba_ or any other sharing method to client computers on a network. - + * User defined document unique identifier and checksum algorithms. - + * Users can alter the default method used to uniquely indentify documents. * Documents can be uploaded from different sources. - * Local file or server side file uploads. + * Local file or server side file uploads, multifunctional copier, or even via email. * Batch upload many documents with the same metadata. @@ -53,7 +53,7 @@ Features * Documents can be searched by their text content, their metadata or any other file attribute such as name, extension, etc. * Configurable document grouping. - + * Automatic linking of documents based on metadata values or document properties. * :doc:`Roles support <../topics/permissions>`. @@ -72,7 +72,7 @@ Features * The task of transcribing text from documents via OCR can be distributed among several physical or virtual computers to decrease load and increase availability. -* Multilingual user interface (English, Spanish, Portuguese, Russian, Polish). +* Multilingual user interface. * **Mayan EDMS** is written using the Django_ framework, which natively supports Unicode. Together with the use of text templates **Mayan EDMS** can be translated to practically any language spoken in the world. For a list of translated languages have a look at Transifex_. @@ -81,22 +81,14 @@ Features * Multilingual OCR is provided as supported by the available language backends of the OCR engine tesseract. -* Search of duplicates. - - * Duplicate documents can easily be searched. - * :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. * Color coded tagging. * Labeled and color coded tags can be assigned for intuitive recognition. -* Staging folders to receive scanned documents directly from network attached scanners. - - * Preview scanned files even before uploading them. - .. _`Dublin core`: http://dublincore.org/metadata-basics/ .. _Samba: http://www.samba.org/ diff --git a/docs/intro/getting_started.rst b/docs/topics/getting_started.rst similarity index 100% rename from docs/intro/getting_started.rst rename to docs/topics/getting_started.rst diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 6188681fb9..ca94d117fd 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -6,18 +6,26 @@ 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 - tags - ocr - settings + contributors development documentation + document_visualization + faq + features + file_storage + getting_started + indexes + initial_import + installation + license + ocr + overview + permissions + requirements + settings + signatures + smart_links + tags + transformations translations + versioning diff --git a/docs/topics/initial_import.rst b/docs/topics/initial_import.rst index 0f84a434f6..1efdb3b829 100644 --- a/docs/topics/initial_import.rst +++ b/docs/topics/initial_import.rst @@ -2,30 +2,6 @@ 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:: - - $ mayan-edms.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 ---------------- diff --git a/docs/intro/installation.rst b/docs/topics/installation.rst similarity index 100% rename from docs/intro/installation.rst rename to docs/topics/installation.rst diff --git a/docs/credits/license.rst b/docs/topics/license.rst similarity index 100% rename from docs/credits/license.rst rename to docs/topics/license.rst diff --git a/docs/intro/overview.rst b/docs/topics/overview.rst similarity index 100% rename from docs/intro/overview.rst rename to docs/topics/overview.rst diff --git a/docs/intro/requirements.rst b/docs/topics/requirements.rst similarity index 100% rename from docs/intro/requirements.rst rename to docs/topics/requirements.rst