matthias/mayan-edms
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge remote-tracking branch 'origin/master'

Browse Source
This commit is contained in:
Roberto Rosario
2014-06-15 10:45:19 +02:00
parent fd907587f5 e393e9a4d0
commit 070d4a1579
8 changed files with 53 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
apps/converter/office_converter.py
View File

@@ -39,6 +39,7 @@ CONVERTER_OFFICE_FILE_MIMETYPES = [
u'application/vnd.oasis.opendocument.text-web',
u'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
u'application/vnd.ms-office',
u'application/xml',
u'text/x-c',
u'text/x-c++',
u'text/x-pascal',

26
docs/intro/features.rst
View File

@@ -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/

12
docs/intro/getting_started.rst
View File

@@ -26,11 +26,16 @@ Quickly bootstraping your Mayan EDMS install
--------------------------------------------
|Setup tab| |Right arrow| |Bootstrap button|
**Mayan EDMS** now includes an app called ``Bootstrap``. This app stores
**Mayan EDMS** includes an app called ``Bootstrap``. This app stores
scripted configurations, that when executed will setup your installation of **Mayan EDMS**.
From there you can then fine tune this setup to your needs. To use this
app go to the ``Setup`` area and launch the app using the ``Bootstrap`` button.
.. hint:: Predefined sample setups can be downloaded from the
`Official bootstrap setup repository for Mayan EDMS`_. If you want to use
one of the available setups for testing or as a starting point, choose one
and import it with ``Import from URL``. Finally execute it on an empty database.
The longer custom setup
=======================
@@ -41,7 +46,7 @@ Setting your document types
If none of the available bootstrap setups fit your needs and your wish to
setup **Mayan EDMS** from scratch the first thing to consider are which are
going to be your document types. Examples of document types are: ``Legal documents``,
``Internal documents``, ``Medical records``, ``Desging specifications``, ``Permits``.
``Internal documents``, ``Medical records``, ``Designing specifications``, ``Permits``.
A document type represent a group, a type, a class of documents which share some
common properties. A good indicator that can help you determine you document types
is what kind of information or ``metadata`` is attached to the documents.
@@ -121,3 +126,6 @@ Refer to the chapter named :doc:`Indexes </topics/indexes>` for examples on how
.. |Metadata types button| image:: /_static/metadata_types_button.png
:alt: Metadata types button
:align: middle
.. _DjangoZoom: http://djangozoom.com/
.. _`Official bootstrap setup repository for Mayan EDMS`: http://bootstrap.mayan-edms.com/

2
docs/intro/index.rst
View File

@@ -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

10
docs/intro/overview.rst
View File

@@ -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

28
docs/releases/1.0.rst
View File

@@ -16,14 +16,14 @@ What's new in Mayan EDMS v1.0
New home
~~~~~~~~
The growth and reach of the project has necesitaded for a while the move
of the project to its own organization in Github. This moved has finally
The growth and reach of the project has necessitaded for a while the move
of the project to its own organization in Github. This move has finally been
done, the new URL of the project is: https://github.com/mayan-edms/mayan-edms
Django 1.4.13
~~~~~~~~~~~~~
This release updates the required version of Django to 1.4.13, bringing with it
not only new features but also a lot of security updates.
not only new features, but also a lot of security updates.
Translation updates
~~~~~~~~~~~~~~~~~~~
@@ -39,19 +39,19 @@ used.
Source code improvements
~~~~~~~~~~~~~~~~~~~~~~~~
A circular import of metadata and document_index apps code from the documents app
was removed. Document index updates are now handled via signals not called
was removed. Document index updates are now handled via signals, not called
directly as before.
Removal of included 3rd party modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
One last 3rd party module was included with the source code of Mayan EDMS,
this module is now available on PyPI and fetched during installation instead
One last 3rd party module was included with the source code of Mayan EDMS.
This module is now available on PyPI and fetched during the installation instead
of being included.
Automatic testing and code coverage check
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Some initial tests were added, this will help with the detection of
regressions or bug when adding new features. More tests are needed but
Some initial tests were added, which will help with the detection of
regressions or bugs when adding new features. More tests are needed, but
the initial work has being started.
Update of required modules and libraries versions
@@ -61,13 +61,13 @@ recent version if not to their most recent released version.
Database connection leaks
~~~~~~~~~~~~~~~~~~~~~~~~~
Stale database connection being left open by the OCR queue handling task
are now explictly closed. This should increase the stability and reduce memory
usage.
Stale database connection being left open by scheduler tasks are now explictly
closed. This avoids consumption of the pool of database connections, increases
stability and reduces memory usage.
Deletion of detached signatures
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Detached signatures can now be deleted if accidentally added to the wrong document.
Detached signatures can now be deleted, if accidentally added to the wrong document.
Upgrading from a previous version
@@ -79,9 +79,9 @@ If you installed **Mayan EDMS** by cloning the Git repository issue the commands
otherwise download the compressed archived and uncompress it overriding the existing installation.
Next add the new requirements::
Next upgrade/add the new requirements::
$ pip install -r requirements.txt
$ pip install --upgrade -r requirements.txt
Migrate existing database schema with::

10
docs/topics/customization.rst
View File

@@ -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.
-----

2
docs/topics/development.rst
View File

@@ -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_