Simplify documentation structure, small upgrades to documentation
This commit is contained in:
Roberto Rosario
@@ -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
|
||||
|
||||
@@ -12,8 +12,5 @@ Mayan EDMS documentation contents
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
intro/index
|
||||
topics/index
|
||||
credits/index
|
||||
releases/index
|
||||
faq/index
|
||||
|
||||
@@ -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
|
||||
@@ -20,7 +20,7 @@ Mayan EDMS documentation
|
||||
Getting help
|
||||
============
|
||||
|
||||
* Try the :doc:`FAQ <faq/index>` -- it's got answers to many common questions.
|
||||
* Try the :doc:`FAQ <topics/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 <intro/overview>` |
|
||||
:doc:`Features <intro/features>` |
|
||||
:doc:`Requirements <intro/requirements>` |
|
||||
:doc:`Installation <intro/installation>` |
|
||||
:doc:`Getting started <intro/getting_started>`
|
||||
:doc:`Overview <topics/overview>` |
|
||||
:doc:`Features <topics/features>` |
|
||||
:doc:`Requirements <topics/requirements>` |
|
||||
:doc:`Installation <topics/installation>` |
|
||||
:doc:`Getting started <topics/getting_started>`
|
||||
|
||||
Understanding Mayan EDMS
|
||||
========================
|
||||
@@ -73,8 +73,5 @@ For developers
|
||||
Credits
|
||||
=======
|
||||
|
||||
:doc:`Contributors <credits/contributors>` |
|
||||
:doc:`Licensing <credits/license>`
|
||||
|
||||
|
||||
|
||||
:doc:`Contributors <topics/contributors>` |
|
||||
:doc:`Licensing <topics/license>`
|
||||
|
||||
@@ -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
|
||||
@@ -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::
|
||||
|
||||
@@ -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/
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
----------------
|
||||
|
||||
|
||||
Reference in New Issue
Block a user