Some more review of the documentation.
This commit is contained in:
Mathias Behrle
@@ -18,19 +18,19 @@ Features
|
||||
|
||||
* Office document format support.
|
||||
|
||||
* Word processing files? Spreadsheets? Presentations? They are supported too.
|
||||
* Word processing files, spreadsheets, presentations are common supported formats.
|
||||
|
||||
* 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`_
|
||||
* 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 snipped.
|
||||
* 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 hosting computers and shared via Samba_ or any other method to clients computers on a network.
|
||||
* 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.
|
||||
|
||||
@@ -50,7 +50,7 @@ Features
|
||||
|
||||
* Full text searching.
|
||||
|
||||
* Document can be searched by their text content, their metadata or any other file attribute such as name, extension, etc.
|
||||
* Documents can be searched by their text content, their metadata or any other file attribute such as name, extension, etc.
|
||||
|
||||
* Configurable document grouping.
|
||||
|
||||
@@ -58,7 +58,7 @@ Features
|
||||
|
||||
* :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.
|
||||
* It is possible to create an unlimited amount of different roles not being restricted to the traditional admin, operator, guest paradigm.
|
||||
|
||||
* :doc:`Fine grained permissions system <../topics/permissions>`.
|
||||
|
||||
@@ -66,7 +66,7 @@ Features
|
||||
|
||||
* Multi page document support.
|
||||
|
||||
* Multiple page PDFs and TIFFs files supported.
|
||||
* Multiple page PDFs and TIFFs files are supported.
|
||||
|
||||
* :doc:`Distributed OCR processing <../topics/ocr>`.
|
||||
|
||||
@@ -74,13 +74,16 @@ Features
|
||||
|
||||
* Multilingual user interface (English, Spanish, Portuguese, Russian, Polish).
|
||||
|
||||
* **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.
|
||||
* **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_.
|
||||
|
||||
* :doc:`Multilingual OCR support <../topics/ocr>`.
|
||||
|
||||
* As supported by the OCR engine tesseract.
|
||||
* Multilingual OCR is provided as supported by the available language backends of the OCR engine tesseract.
|
||||
|
||||
* Duplicated document search.
|
||||
* Search of duplicates.
|
||||
|
||||
* Duplicate documents can easily be searched.
|
||||
|
||||
* :doc:`Plugable storage backends <../topics/file_storage>` (File based and GridFS included).
|
||||
|
||||
@@ -88,7 +91,7 @@ Features
|
||||
|
||||
* Color coded tagging.
|
||||
|
||||
* Labeled and color coded tags that are intituitive.
|
||||
* Labeled and color coded tags can be assigned for intuitive recognition.
|
||||
|
||||
* Staging folders to receive scanned documents directly from network attached scanners.
|
||||
|
||||
@@ -98,3 +101,4 @@ Features
|
||||
.. _`Dublin core`: http://dublincore.org/metadata-basics/
|
||||
.. _Samba: http://www.samba.org/
|
||||
.. _Django: https://www.djangoproject.com/
|
||||
.. _Transifex: https://www.transifex.net/projects/p/mayan-edms/
|
||||
|
||||
@@ -20,7 +20,7 @@ New to Mayan EDMS? Read this material to quickly get up and running.
|
||||
comfort with Python you'll probably get a lot more out of Mayan EDMS.
|
||||
|
||||
If you're new to programming entirely, you might want to start with this
|
||||
`list of Python resources for non-programmers`_
|
||||
`list of Python resources for non-programmers`_.
|
||||
|
||||
If you already know a few other languages and want to get up to speed with
|
||||
Python quickly, we recommend `Dive Into Python`_ (also available in a
|
||||
|
||||
@@ -3,12 +3,14 @@ History and overview
|
||||
====================
|
||||
|
||||
**Mayan EDMS** started as a simple project whose only requirement was the storage of PDF files, from there it has grown into a complete electronic document management solution.
|
||||
**Mayan EDMS** can optimize an organization's bulk upload, storage and retrieval or documents.
|
||||
**Mayan EDMS** can optimize an organization's bulk upload, storage and retrieval of documents.
|
||||
Documents are organized using document classes, user defined metadata fields as well as automatic document grouping and indexing. Documents can be retrieved from the document index or by means of full
|
||||
text searching. Users can search for terms in the document's metadata, properties or contents extracted from PDFs or transcribed by OCR_. **Mayan EDMS** is written in Python_ using the Django_ framework, which makes it very agile and fast, specially when compared with existing Java based solutions.
|
||||
text searching. Users can search for terms in the document's metadata, properties or contents extracted from PDFs or transcribed by OCR_.
|
||||
|
||||
**Mayan EDMS** is written in Python_ using the Django_ framework, which makes it very agile and fast, specially when compared with existing Java based solutions.
|
||||
Being based on patent free, `Open source`_ technologies, **Mayan EDMS** provides legal safety to users and organizations, as well as peace of mind as documents and all related information is stored in open source and transparent formats allowing portability and avoiding `vendor lock-in`_.
|
||||
Being written using Python_, **Mayan EDMS** runs on many POSIX compliant operating systems, this coupled with many configuration parameters, allows **Mayan EDMS** to be deployed on many hardware and software configurations such as single server based, clusters, virtualized and cloud based hosting giving adopters the choice of using the infrastructure of their choice.
|
||||
On hosting providers that support Django_ such as DjangoZoom_, **Mayan EDMS** can be deployed in under 2 minutes with just a few clicks of the mouse [#]_.
|
||||
Being written using Python_, **Mayan EDMS** runs on many POSIX compliant operating systems. Featuring many configuration parameters, **Mayan EDMS** allows to be deployed on many hardware and software configurations such as single server based, clusters, virtualized and cloud based hosting giving adopters the choice of using the infrastructure of their choice.
|
||||
On hosting providers that support Django_ such as DjangoZoom_, **Mayan EDMS** can be deployed in under 2 minutes with just a few mouse clicks [#]_.
|
||||
|
||||
.. [#] "Deploying Mayan EDMS on DjangoZoom.com" @ Youtube (http://bit.ly/mayan-djangozoom)
|
||||
.. _`vendor lock-in`: https://secure.wikimedia.org/wikipedia/en/wiki/Vendor_lock-in
|
||||
|
||||
@@ -8,11 +8,11 @@ by changing a few settings.
|
||||
------
|
||||
Themes
|
||||
------
|
||||
**Mayan EDMS** uses `Andrea Franz's excellent web app template`_ which includes
|
||||
**Mayan EDMS** uses `Andrea Franz's excellent web app template`_, which includes
|
||||
several themes that could be used to adapt **Mayan EDMS**'s appearance to match
|
||||
an organtization existing applications' look and feel.
|
||||
|
||||
The theme can be changed very easily by settings the :setting:`WEB_THEME_THEME`
|
||||
The theme can be changed very easily by setting the :setting:`WEB_THEME_THEME`
|
||||
configuration option to one of its valid values.
|
||||
|
||||
.. image:: themes.png
|
||||
@@ -22,7 +22,7 @@ configuration option to one of its valid values.
|
||||
Login screen
|
||||
------------
|
||||
The amount of information presented at the login screen can also be restricted
|
||||
if for security or desgin reasons using :setting:`WEB_THEME_VERBOSE_LOGIN`
|
||||
for security or design reasons using :setting:`WEB_THEME_VERBOSE_LOGIN`
|
||||
configuration option.
|
||||
|
||||
.. image:: mayan-login.png
|
||||
@@ -32,8 +32,8 @@ configuration option.
|
||||
Home screen
|
||||
-----------
|
||||
Sometimes users just want to go directly to work and not just be greeted with
|
||||
a home screen, for these kind of situations **Mayan EDMS** has the
|
||||
:setting:`MAIN_DISABLE_HOME_VIEW` configuration option which will cause
|
||||
a home screen. For these kind of situations **Mayan EDMS** has the
|
||||
:setting:`MAIN_DISABLE_HOME_VIEW` configuration option, which will cause
|
||||
users to land on their ``recent document list`` as soon as they log in.
|
||||
|
||||
-----
|
||||
|
||||
@@ -36,7 +36,7 @@ Git branch structure
|
||||
``master``
|
||||
Current production release (|version|).
|
||||
``feature/``
|
||||
Unfinished/ummerged feature.
|
||||
Unfinished/unmerged feature.
|
||||
|
||||
|
||||
Each release is tagged and available for download on the Downloads_ section of the **Mayan EDMS** repository on GitHub_
|
||||
|
||||
Reference in New Issue
Block a user