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

Documentation updates

Browse Source
This commit is contained in:
Roberto Rosario
2012-02-01 13:43:24 -04:00
parent 58bea814f1
commit a90896e774
35 changed files with 994 additions and 914 deletions
Download Patch File Download Diff File Expand all files Collapse all files

721
docs/changelog.rst
View File

File diff suppressed because it is too large Load Diff

4
docs/conf.py
View File

@@ -48,10 +48,10 @@ copyright = u'2011, Roberto Rosario'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.11.1' version = '0.12'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.11.1' release = '0.12'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

17
docs/faq.rst → docs/faq/index.rst
View File

@@ -4,9 +4,11 @@ FAQ
Frequently asked questions and solutions Frequently asked questions and solutions
Database related
----------------
_mysql_exceptions.OperationalError: (1267, "Illegal mix of collations (latin1_swedish_ci,IMPLICIT) and (utf8_general_ci,COERCIBLE) for operation '='") Q: _mysql_exceptions.OperationalError: (1267, "Illegal mix of collations (latin1_swedish_ci,IMPLICIT) and (utf8_general_ci,COERCIBLE) for operation '='")
------------------------------------------------------------------------------------------------------------------------------------------------------ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Solution:: * Solution::
@@ -25,8 +27,8 @@ _mysql_exceptions.OperationalError: (1267, "Illegal mix of collations (latin1_sw
- http://stackoverflow.com/questions/1073295/django-character-set-with-mysql-weirdness - http://stackoverflow.com/questions/1073295/django-character-set-with-mysql-weirdness
Incorrect string value: ``'\xE2\x80\x95rs6...'`` for column ``'content'`` at row 1 Q: Incorrect string value: ``'\xE2\x80\x95rs6...'`` for column ``'content'`` at row 1
---------------------------------------------------------------------------------- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When using ``MySQL`` and doing OCR on languages other than English When using ``MySQL`` and doing OCR on languages other than English
@@ -37,8 +39,11 @@ When using ``MySQL`` and doing OCR on languages other than English
- Ref: 2- http://markmail.org/message/bqajx2utvmtriixi - Ref: 2- http://markmail.org/message/bqajx2utvmtriixi
File system links not showing when serving content with ``Samba`` Document sharing
----------------------------------------------------------------- ----------------
Q: File system links not showing when serving content with ``Samba``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Solution: * Solution:

100
docs/features.rst
View File

@@ -1,100 +0,0 @@
========
Features
========
* Document versioning.
* Store many versions of the same document, download or revert to a previous version.
* Electronic signature verification.
* Check the authenticity of documents by verifying their embedded cryptographic signatures or upload detached signatures for document signed after they were stored.
* Collaboration tools.
* Discuss documents, comment on new version of a document.
* Office document format support.
* Word processing files? Spreadsheets? Sresentations? They are supported too.
* 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`_
.. _`Dublin core`: http://dublincore.org/metadata-basics/
* 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.
* 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.
.. _Samba: http://www.samba.org/
* 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.
* Batch upload many documents with the same metadata.
* Clone a document's metadata for speedier uploads and eliminate repetitive data entry.
* Previews for a great deal of image formats, including PDF.
* **Mayan EDMS** provides different file conversion backends with different levels of functionality and requirements to adapt to different deployment environments.
* Full text searching.
* Document 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.
* Roles support.
* Users can created an unlimited amount of different roles and are not restricted to the traditional admin, operator, guest paradigm.
* Fine grained permissions system.
* There is a permission for every atomic operation performed by users.
* Multi page document support.
* Multiple page PDFs and TIFFs files supported.
* Distributed OCR processing.
* 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).
* **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.
.. _Django: https://www.djangoproject.com/
* Multilingual OCR support.
* *As supported by the OCR engine tesseract.
* Duplicated document search.
* Plugable storage backends (File based and GridFS included).
* Very easy to convert other 3rd party such as the ones available for Amazon EC2.
* Color coded tagging.
* Labeled and color coded tags that are intituitive.
* Staging folders to receive scanned documents directly from network attached scanners.
* Preview scanned files even before uploading them.

96
docs/index.rst
View File

@@ -1,49 +1,81 @@
========
Overview
========
Open source, Django_ based document manager with custom metadata indexing, file serving integration, OCR_ capabilities, document versioning and digital signature verification. .. _index:
========================
Mayan EDMS documentation
========================
.. rubric:: Open source, Django_ based document manager with custom metadata indexing, file serving integration, OCR_ capabilities, document versioning and digital signature verification.
.. _Django: http://www.djangoproject.com/ .. _Django: http://www.djangoproject.com/
=================
Links of interest
=================
:Website: http://www.mayan-edms.com :Website: http://www.mayan-edms.com
:Source: http://github.com/rosarior/mayan :Source: http://github.com/rosarior/mayan
:Video: http://bit.ly/pADNXv :Video: http://bit.ly/pADNXv
:Issue tracker: http://github.com/rosarior/mayan/issues :Issue tracker: http://github.com/rosarior/mayan/issues
:Mailing list: http://groups.google.com/group/mayan-edms :Mailing list: http://groups.google.com/group/mayan-edms
**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.
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.
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 [#]_.
.. [#] "Deploying Mayan EDMS on DjangoZoom.com" @ Youtube (http://bit.ly/mayan-djangozoom) First steps
.. _`vendor lock-in`: https://secure.wikimedia.org/wikipedia/en/wiki/Vendor_lock-in ===========
.. _Python: http://www.python.org/
.. _Django: http://www.djangoproject.com/ :doc:`Overview <intro/overview>` |
.. _OCR: https://secure.wikimedia.org/wikipedia/en/wiki/Optical_character_recognition :doc:`Features <intro/features>` |
.. _`Open source`: https://secure.wikimedia.org/wikipedia/en/wiki/Open_source :doc:`Requirements <intro/requirements>` |
.. _DjangoZoom: http://djangozoom.com/ :doc:`Installation <intro/installation>`
======== Understanding Mayan EDMS
Contents ========================
========
:doc:`Transformations <topics/transformations>`
Between versions
================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
features releases/index
requirements
installation
releases/index Customization and fine tunning
settings ==============================
development
contributors :doc:`Settings <topics/settings>`
credits
faq
license For developers
==============
:doc:`Development <topics/development>`
Credits
=======
:doc:`Contributors <topics/contributors>` |
:doc:`Software used <topics/software_used>` |
:doc:`Lincensing <license>`
Getting help
============
Having trouble? We'd like to help!
* Try the :doc:`FAQ <faq/index>` -- it's got answers to many common questions.
* Search for information in the `archives of the mayan-edms mailing list`_, or
`post a question`_.
* Report bugs with **Mayan EDMS** using Github's `ticket tracker`_.
.. _archives of the mayan-edms mailing list: http://groups.google.com/group/django-users/
.. _post a question: http://groups.google.com/group/mayan-edms
.. _ticket tracker: http://github.com/rosarior/mayan/issues

100
docs/intro/features.rst Normal file
View File

@@ -0,0 +1,100 @@
========
Features
========
* Document versioning.
* Store many versions of the same document, download or revert to a previous version.
* Electronic signature verification.
* Check the authenticity of documents by verifying their embedded
cryptographic signatures or upload detached signatures for document
signed after they were stored.
* Collaboration tools.
* Discuss documents, comment on new version of a document.
* Office document format support.
* Word processing files? Spreadsheets? Sresentations? They are supported too.
* 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 snipped.
* 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.
* 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.
* Batch upload many documents with the same metadata.
* Clone a document's metadata for speedier uploads and eliminate repetitive data entry.
* Previews for a great deal of image formats, including PDF.
* **Mayan EDMS** provides different file conversion backends with different levels of functionality and requirements to adapt to different deployment environments.
* Full text searching.
* Document 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.
* Roles support.
* Users can created an unlimited amount of different roles and are not restricted to the traditional admin, operator, guest paradigm.
* Fine grained permissions system.
* There is a permission for every atomic operation performed by users.
* Multi page document support.
* Multiple page PDFs and TIFFs files supported.
* Distributed OCR processing.
* 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).
* **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.
* As supported by the OCR engine tesseract.
* Duplicated document search.
* Plugable storage backends (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 that are intituitive.
* 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/
.. _Django: https://www.djangoproject.com/

74
docs/installation.rst → docs/intro/installation.rst
View File

@@ -52,25 +52,25 @@ Webfaction
To install **Mayan EDMS** on Webfaction_, follow these steps: To install **Mayan EDMS** on Webfaction_, follow these steps:
#. Create a new database: 1. Create a new database:
* Enter the following selections: * Enter the following selections:
* Type:* ``Mysql`` * Type:* ``Mysql``
* Name:* ``<username>_mayan`` * Name:* ``<username>_mayan``
* Encoding:* ``utf-8`` * Encoding:* ``utf-8``
* Anotate the provided password. * Anotate the provided password.
#. Create a new app: 2. Create a new app:
* Enter the following in the textbox: * Enter the following in the textbox:
* Name:* ``mayan`` * Name:* ``mayan``
* App category:* ``mod_wsgi`` * App category:* ``mod_wsgi``
* App type:* ``mod_wsgi 3.3/Python 2.7`` * App type:* ``mod_wsgi 3.3/Python 2.7``
#. Login via ssh, and execute:: 3. Login via ssh, and execute::
$ easy_install-2.7 virtualenv $ easy_install-2.7 virtualenv
$ cd ~/webapps/mayan_app $ cd ~/webapps/mayan_app
@@ -81,11 +81,11 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
$ source ../bin/activate $ source ../bin/activate
$ pip install -r requirements/production.txt $ pip install -r requirements/production.txt
#. Install the Python MySQL database driver:: 4. Install the Python MySQL database driver::
$ pip install MySQL-python $ pip install MySQL-python
#. Create a settings_local.py file, and paste into it the following:: 5. Create a settings_local.py file, and paste into it the following::
$ DATABASES = { $ DATABASES = {
$ 'default': { $ 'default': {
@@ -98,45 +98,45 @@ To install **Mayan EDMS** on Webfaction_, follow these steps:
$ } $ }
$ } $ }
#. Create the database schema (during this step two errors will appears about failling to install indexes on ``documents.Document`` and ``documents.DocumentPage`` models, ignore them for now):: 6. Create the database schema (during this step two errors will appears about failling to install indexes on ``documents.Document`` and ``documents.DocumentPage`` models, ignore them for now)::
$ ./manage.py syncdb --migrate $ ./manage.py syncdb --migrate
#. Collect the static files of the apps:: 7. Collect the static files of the apps::
$ ./manage.py collectstatic -l --noinput $ ./manage.py collectstatic -l --noinput
#. Create a new app: 8. Create a new app:
* Enter the following: * Enter the following:
* Name:* ``mayan_static`` * Name:* ``mayan_static``
* App category:* ``Symbolic link`` * App category:* ``Symbolic link``
* App type:* ``Symbolic link to static-only app`` * App type:* ``Symbolic link to static-only app``
* Extra info: ``/home/<username>/webapps/mayan_app/mayan/mayan/static`` * Extra info: ``/home/<username>/webapps/mayan_app/mayan/mayan/static``
#. Create the website: 9. Create the website:
* Name: ``mayan_edms`` * Name: ``mayan_edms``
* Choose a subdomain * Choose a subdomain
* Under ``Site apps:`` enter the following selections: * Under ``Site apps:`` enter the following selections:
* App #1 * App #1
* App:* ``mayan_app`` * App:* ``mayan_app``
* URL path (ex: '/' or '/blog'):* ``/`` * URL path (ex: '/' or '/blog'):* ``/``
* App #2 * App #2
* App:* ``mayan_static`` * App:* ``mayan_static``
* URL path (ex: '/' or '/blog'):* ``/mayan-static`` * URL path (ex: '/' or '/blog'):* ``/mayan-static``
#. Edit the file ``~/webapps/mayan_app/apache2/conf/httpd.conf``: 10. Edit the file ``~/webapps/mayan_app/apache2/conf/httpd.conf``:
* Disable the ``DirectoryIndex`` line and the ``DocumentRoot`` line * Disable the ``DirectoryIndex`` line and the ``DocumentRoot`` line
* Add the following line:: * Add the following line::
WSGIScriptAlias / /home/<username>/webapps/mayan_app/mayan/mayan/wsgi/dispatch.wsgi WSGIScriptAlias / /home/<username>/webapps/mayan_app/mayan/mayan/wsgi/dispatch.wsgi
DjangoZoom DjangoZoom
---------- ----------
@@ -152,6 +152,7 @@ For instructions on how to deploy **Mayan EDMS** on DjangoZoom, watch the screen
.. _`Open source`: https://secure.wikimedia.org/wikipedia/en/wiki/Open_source .. _`Open source`: https://secure.wikimedia.org/wikipedia/en/wiki/Open_source
.. _DjangoZoom: http://djangozoom.com/ .. _DjangoZoom: http://djangozoom.com/
.. _Youtube: http://bit.ly/mayan-djangozoom .. _Youtube: http://bit.ly/mayan-djangozoom
.. _Django: http://www.djangoproject.com/
.. _Apache: https://www.apache.org/ .. _Apache: https://www.apache.org/
@@ -160,5 +161,4 @@ For instructions on how to deploy **Mayan EDMS** on DjangoZoom, watch the screen
.. _Download: https://github.com/rosarior/mayan/archives/master .. _Download: https://github.com/rosarior/mayan/archives/master
.. _Webfaction: http://www.webfaction.com .. _Webfaction: http://www.webfaction.com
.. _deployed: https://docs.djangoproject.com/en/1.3/howto/deployment/ .. _deployed: https://docs.djangoproject.com/en/1.3/howto/deployment/
.. _Django: https://www.djangoproject.com
.. _virtualenv: http://www.virtualenv.org/en/latest/index.html .. _virtualenv: http://www.virtualenv.org/en/latest/index.html

19
docs/intro/overview.rst Normal file
View File

@@ -0,0 +1,19 @@
====================
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.
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.
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 [#]_.
.. [#] "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
.. _Python: http://www.python.org/
.. _Django: http://www.djangoproject.com/
.. _OCR: https://secure.wikimedia.org/wikipedia/en/wiki/Optical_character_recognition
.. _`Open source`: https://secure.wikimedia.org/wikipedia/en/wiki/Open_source
.. _DjangoZoom: http://djangozoom.com/

0
docs/requirements.rst → docs/intro/requirements.rst
View File

10
docs/releases/0.10.1.rst Normal file
View File

@@ -0,0 +1,10 @@
Version 0.10.1
--------------
* Upgraded django-compressor to version 1.1.1, run::
$ pip install --upgrade -r requirements/production.txt
to upgrade
* django-compressor is now disabled by default, users must explicitly
enable it adding COMPRESS_ENABLED=True to their settings_local.py file

51
docs/releases/0.10.rst Normal file
View File

@@ -0,0 +1,51 @@
Version 0.10
------------
* Added a proper setup views for the document grouping functionality.
* Document grouping is now called smart linking as it relates better to
how it actually works. The data base schema was changed and users must
do the required::
$ ./manager syncdb
for the new tables to be created.
* Grappelli is no longer required as can be uninstalled.
* New smarter document preview widget that doesn't allow zooming or viewing
unknown or invalid documents.
* New office document converter, requires:
* LibreOffice (https://www.libreoffice.org/)
* unoconv [version 0.5] (https://github.com/dagwieers/unoconv)
* The new office documents converter won't convert files with the extension
.docx because these files are recognized as zip files instead. This
is an issue of the libmagic library.
* New configuration option added ``CONVERTER_UNOCONV_USE_PIPE`` that controls
how unoconv handles the communication with LibreOffice. The default of
``True`` causes unoconv to use **pipes**, this approach is slower than using
**TCP/IP** ports but it is more stable.
* Initial `REST` `API` that exposes documents properties and one method, this
new `API` is used by the new smart document widget and requires the
package ``djangorestframework``, users must issue a::
$ pip install -r requirements/production.txt
to install this new requirement.
* MIME type detection and caching performance updates.
* Updated the included version of ``jQuery`` to 1.7
* Updated the included version of ``JqueryAsynchImageLoader`` to 0.9.7
* Document image serving response now specifies a MIME type for increased
browser compatibility.
* Small change in the scheduler that increases stability.
* Russian translation updates (Сергей Глита [Sergey Glita])
* Improved and generalized the OCR queue locking mechanism, this should
eliminate any posibility of race conditions between Mayan EDMS OCR nodes.
* Added support for signals to the OCR queue, this results in instant OCR
processing upon submittal of a document to the OCR queue, this works in
addition to the current polling processing which eliminates the
posibility of stale documents in the OCR queue.
* Added multiple document OCR submit link
* Re enabled tesseract language specific OCR processing and added a one
(1) time language neutral retry for failed language specific OCR

8
docs/releases/0.11.1.rst Normal file
View File

@@ -0,0 +1,8 @@
Version 0.11.1
--------------
* Fixed a document deletion regression
* Improves error detection when importing keys from a keyserver, catching
the exception KeyImportError and not KeyFetchingError
* Fixes a wrong method call when verifying signatures for the first time upon document uploading
* django-compress is now disabled by default to avoid problems when deploying with DjangoZoom
* Improve post metadata set delete redirection

32
docs/releases/0.11.rst Normal file
View File

@@ -0,0 +1,32 @@
Version 0.11
------------
* Support for signed documents verification added, embedded and detached
signatures are supported. When verifying a document Mayan EDMS will
try to fetch the public key from the list of keyservers provided in the
configuration option SIGNATURES_KEYSERVERS (which defaults to
'pool.sks-keyservers.net'). A public key management view has been added
to the setup menu as well as a key query and fetching view to manually
import keys from a keyserver.
* Added support for document versions. Users can upload unlimited amount
of versions for a document using a very flexible document version numbering
system, users can also revert to a previous document version.
* OCR queue processing improvements.
* Office documents handling improvements.
* Text extraction support for office documents.
* RTF text documents are now handled as office documents.
* Added a view to delete the document image cache, useful when switching
converter backends or doing diagnostics.
* Added South to the requirements.
* Merged documents' filename and extension database fiels into a single
filename field, filename are store as uploaded not manipulation is done
Users with existing data must install South and run the appropiate
migrate commands::
$ pip install -r requirements/production.txt
$ ./manager syncdb
$ ./manage.py migrate documents 0001 --fake
$ ./manage.py migrate documents
* Added new office document mimetype
* application/vnd.ms-office
* Fixed documents not saving the file encoding
* Removed extra slash in ajax-loader.gif URL fixes #15, thanks to
IHLeanne for finding this one

30
docs/releases/0.12.rst
View File

@@ -126,16 +126,20 @@ column after those is ignored.
Upgrading from a previous version Upgrading from a previous version
================================= =================================
:: Start off by creating the new database structures with::
$ ./manage.py syncdb $ ./manage.py syncdb
Then migrate existing database schema with::
$ ./manage.py migrate permissions 0001 --fake $ ./manage.py migrate permissions 0001 --fake
$ ./manage.py migrate permissions $ ./manage.py migrate permissions
When the following message appears When the following message appears
.. epigraph:: ::
The following content types are stale and need to be deleted: The following content types are stale and need to be deleted:
permissions | permission permissions | permission
@@ -146,13 +150,31 @@ When the following message appears
Type 'yes' to continue, or 'no' to cancel: Type 'yes' to continue, or 'no' to cancel:
Types ``yes`` and press **Enter** Type ``yes`` and press **Enter**
:: And continue migrating database schema with::
$ ./manage.py migrate documents $ ./manage.py migrate documents
$ ./manage.py migrate document_signatures $ ./manage.py migrate document_signatures
$ ./manage.py migrate permissions 0001 --fake
$ ./manage.py migrate permissions
Again when a similar messages appears
::
The following content types are stale and need to be deleted:
document_indexing | indexinstance
Any objects related to these content types by a foreign key will also
be deleted. Are you sure you want to delete these content types?
If you're unsure, answer 'no'.
Type 'yes' to continue, or 'no' to cancel:
Type ``yes`` and press **Enter**
The upgrade procedure is complete.
Backward incompatible changes Backward incompatible changes
============================= =============================

10
docs/releases/0.5.1.rst Normal file
View File

@@ -0,0 +1,10 @@
Version 0.5.1
-------------
* Applied initial merge of the new subtemplate renderer
* Fixed tag removal logic
* Initial commit to support document comments
* Updated so that loading spinner is displayed always
* Exclude tags from the local document upload form
* Added document tagging support
- Requires installing ``django-taggit`` and doing a ``sync-db``

300
docs/releases/0.5.rst Normal file
View File

@@ -0,0 +1,300 @@
Version 0.5
-----------
* Added tag list view and global tag delete support
* Added tag editing view and listing documents with an specific tag
* Changed the previewing and deleting staging files views to required
``DOCUMENT_CREATE`` permission
* Added no-parent-history class to document page links so that iframe clicking doesn't affect the parent window history
- Fixes back button issue on Chrome 9 & 10
* Added per app version display tag
* Added loading spinner animation
* Messages tweaks and translation updates
* Converter app cleanups, document pre-cache, magic number removal
* Added OCR view displaying all active OCR tasks from all cluster nodes
* Disabled ``CELERY_DISABLE_RATE_LIMITS`` by default
* Implement local task locking using Django locmem cache backend
* Added doc extension to office document format list
* Removed redundant transformation calculation
* Make sure OCR in processing documents cannot be deleted
* PEP8, pylint cleanups and removal of relative imports
* Removed the obsolete ``DOCUMENTS_GROUP_MAX_RESULTS`` setting option
* Improved visual appearance of messages by displaying them outside the
main form
* Added link to close all notifications with one click
* Made the queue processing interval configurable by means of a new
setting: ``OCR_QUEUE_PROCESSING_INTERVAL``
* Added detection and reset of orphaned ocr documents being left as
'processing' when celery dies
* Improved unknown format detection in the graphicsmagick backend
* Improved document convertion API
* Added initial support for converting office documents (only ods and
docx tested)
* Added sample configuration files for supervisor and apache under
contrib/
* Avoid duplicates in recent document list
* Added the configuration option CONVERTER_GM_SETTINGS to pass
GraphicsMagicks specific commands the the GM backend
* Lower image convertion quality if the format is jpg
* Inverted the rotation button, more intuitive this way
* Merged and reduced the document page zoom and rotation views
* Increased permissions app permission's label field size
- DB Update required
* Added support for metadata group actions
* Reduced the document pages widget size
* Display the metadata group numeric total in the metadata group form
title
* Reorganized page detail icons
* Added first & last page navigation links to document page view
* Added interactive zoom support to document page detail view
* Spanish translation updates
* Added ``DOCUMENTS_ZOOM_PERCENT_STEP``, ``DOCUMENTS_ZOOM_MAX_LEVEL``,
``DOCUMENTS_ZOOM_MIN_LEVEL`` configuration options to allow detailed
zoom control
* Added interactive document page view rotation support
* Changed the side bar document grouping with carousel style document
grouping form widget
* Removed the obsolete ``DOCUMENTS_TRANFORMATION_PREVIEW_SIZE`` and
``DOCUMENTS_GROUP_SHOW_THUMBNAIL`` setting options
* Improved double submit prevention
* Added a direct rename field to the local update and staging upload
forms
* Separated document page detail view into document text and document
image views
* Added grab-scroll to document page view
* Disabled submit buttons and any buttons when during a form submit
* Updated the page preview widget to display a infinite-style horizontal
carousel of page previews
* Added support user document folders
- Must do a ``syncdb`` to add the new tables
* Added support for listing the most recent accessed documents per user
* Added document page navigation
* Fixed diagnostics url resolution
* Added confirmation dialog to document's find missing document file
diagnostic
* Added a document page edit view
* Added support for the command line program pdftotext from the
poppler-utils packages to extract text from PDF documents without
doing OCR
* Fixed document description editing
* Replaced page break text with page number when displaying document
content
* Implemented detail form readonly fields the correct way, this fixes
copy & paste issues with Firefox
* New document page view
* Added view to add or remove user to a specific role
* Updated the jQuery packages with the web_theme app to version 1.5.2
* Made ``AVAILABLE_INDEXING_FUNCTION`` setting a setting of the documents
app instead of the filesystem_serving app
* Fixed document download in FireFox for documents containing spaces in
the filename
* If mime detection fails set mime type to '' instead of 'unknown'
* Use document MIME type when downloading otherwise use
'application/octet-stream' if none
* Changed the way document page count is parsed from the graphics
backend, fixing issue #7
* Optimized document metadata query and display
* Implemented OCR output cleanups for English and Spanish
* Redirect user to the website entry point if already logged and lands
in the login template
* Changed from using SimpleUploadedFile class to stream file to the
simpler File class wrapper
* Updated staging files previews to use sendfile instead of serve_file
* Moved staging file preview creation logic from documents.views to
staging.py
* When deleting staging file, it's cached preview is also deleted
* Added a new setup option:
- ``FILESYSTEM_INDEXING_AVAILABLE_FUNCTIONS`` - a dictionary to allow users
to add custom functions
* Made automatic OCR a function of the OCR app and not of Documents app (via signals)
- Renamed setup option ``DOCUMENT_AUTOMATIC_OCR`` to ``OCR_AUTOMATIC_OCR``
* Clear node name when requeueing a document for OCR
* Added support for editing the metadata of multiple documents at the
same time
* Added Graphics magick support by means of user selectable graphic convertion backends
- Some settings renamed to support this change:
+ ``CONVERTER_CONVERT_PATH`` is now ``CONVERTER_IM_CONVERT_PATH``
+ ``CONVERTER_IDENTIFY_PATH`` is now ``CONVERTER_IM_IDENTIFY_PATH``
- Added options:
+ ``CONVERTER_GM_PATH`` - File path to graphicsmagick's program.
+ ``CONVERTER_GRAPHICS_BACKEND`` - Backend to use: ``ImageMagick`` or
``GraphicMagick``
* Raise ImportError and notify user when specifying a non existant
converter graphics backend
* Fixed issue #4, avoid circular import in permissions/__init__.py
* Add a user to a default role only when the user is created
* Added total page count to statistics view
* Added support to disable the default scrolling JS code included in
web_theme app, saving some KBs in transfer
* Clear last ocr results when requeueing a document
* Removed the 'exists' column in document list view, diagnostics
superceded this
* Added 3rd party sendfile app (support apache's X-sendfile)
* Updated the get_document_image view to use the new sendfile app
* Fixed the issue of the strip spaces middleware conflicting with
downloads
* Removed custom IE9 tags
* Closed Issue #6
* Allow deletion of non existing documents from OCR queue
* Allow OCR requeue of pending documents
* Invalid page numbers now raise Http404, not found instead of error
* Added an additional check to lower the chance of OCR race conditions
between nodes
* Introduce a random delay to each node to further reduce the chance of
a race condition, until row locking can be implemented or is
implemented by Django
* Moved navigation code to its own app
* Reimplemented OCR delay code, only delay new document
Added a new field: delay, update your database schema accordingly
* Made the concurrent ocr code more granular, per node, every node can
handle different amounts of concurrent ocr tasks
Added a new field: node_name, update your database schema acordinging
* Reduced default ocr delay time
* Added a new diagnostics tab under the tools menu
* Added a new option ``OCR_REPLICATION_DELAY`` to allow the storage some
time for replication before attempting to do OCR to a document
* Added OCR multi document re-queue and delete support
* Added simple statistics page (total used storage, total docs, etc)
* Implemented form based and button based multi item actions (button
based by default)
* Added multi document delete
* Fixed a few HTML validation errors
* Issues are now tracked using github
* Added indexing flags to ocr model
* Small optimization in document list view
* Small search optimization
* Display "DEBUG mode" string in title if ``DEBUG`` variable is set to True
* Added the fix-permissions bash script under misc/ folder
* Plugged another file descriptor leak
* Show class name in config settings view
* Added missing config option from the setup menu
* Close file descriptor to avoid leaks
* Don't allow duplicate documents in queues
* Don't raise ``PermissionDenied`` exception in ``PermissionDenied middleware``,
even while debugging
* Fixed page number detection
* Created 'simple document' for non technical users with all of a
document pages content
* Use document preview code for staging file also
* Error picture literal name removal
* Spanish translation updates
* Show document file path in regards of its storage
* Added new setting: side bar search box
* Implemented new ``PermissioDenied`` exception middleware handler
* Permissions app api now returns a ``PermissionDenied`` exception instead
of a custom one
* Added new 403 error template
* Updated the 404 template to display only a not found message
* Moved the login required middleware to the common app
* Fixed search app's model.objects.filter indentation, improved result
count calculation
* Added dynamic comparison types to search app
* Separated search code from view code
* Correctly calculate show result count for multi model searches
* Fixed OCR queue list showing wrong thumbnail
* Fixed staging file preview
* Show current metadata in document upload view sidebar
* Show sentry login for admin users
* Do not reinitialize document queue and/or queued document on reentry
* Try extra hard not to assign same uuid to two documents
* Added new transformation preview size setting
* Renamed document queue state links
* Changed ocr status display sidebar from form based to text based
* Added document action to clear all the document's page transformations
* Allow search across related fields
* Optimzed search for speed and memory footprint
* Added ``LIMIT`` setting to search
* Show search elapsed time on result page
* Converter now differentiates between unknown file format and convert
errors
* Close file descriptors when executing external programs to
prevent/reduce file descriptior leaks
* Improved exception handling of external programs
* Show document thumbnail in document ocr queue list
* Make ocr document date submitted column non breakable
* Fix permissions, directories set to mode 755 and files to mode 644
* Try to fix issue #2, "random ORM field error on search while doing OCR"
* Added configurable location setting for file based storage
* Prepend storage name to differentiate config options
* Fixed duplicated document search
* Optimized document duplicate search
* Added locale middleware, menu bar language switching works now
* Only show language selection list if localemiddleware is active
* Spanish translation updates
* Added links, views and permissions to disable or enable an OCR queue
* Enabled Django's template caching
* Added document queue property side bar window to the document queue
list view
* Added HTML spaceless middleware to remove whitespace in HTML code
* If current user is superuser or staff show thumbnail & preview
generation error messages
* Added a setting to show document thumbnail in metadata group list
* Started adding configurations setting descriptions
* Initial GridFS storage support
* Implemented size and delete methods for GridFS
* Implement GridFS storage user settings
* Added document link in the OCR document queue list
* Link to manually re queue failed OCR
* Don't separate links (encose object list links with white-space:
nowrap;)
* Added document description to the field search list
* Sort OCR queued documents according to submitted date & time
* Document filesystem serving is now a separate app
- Steps to update (Some warnings may be returned, but these are not
fatal as they might be related to missing metadata in some documents):
+ rename the following settings:
+ ``DOCUMENTS_FILESYSTEM_FILESERVING_ENABLE`` to ``FILESYSTEM_FILESERVING_ENABLE``
+ ``DOCUMENTS_FILESYSTEM_FILESERVING_PATH`` to ``FILESYSTEM_FILESERVING_PATH``
+ ``DOCUMENTS_FILESYSTEM_SLUGIFY_PATHS`` to ``FILESYSTEM_SLUGIFY_PATHS``
+ ``DOCUMENTS_FILESYSTEM_MAX_RENAME_COUNT`` to ``FILESYSTEM_MAX_RENAME_COUNT``
+ Do a ./manage.py syncdb
+ Execute 'Recreate index links' locate in the tools menu
+ Wait a few minutes
* Added per document duplicate search and a tools menu option to seach
all duplicated documents
* Added document tool that deletes and re-creates all documents
filesystem links
* Increased document's and document metadata index filename field's size
to 255 characters
* Added sentry to monitor and store error for later debugging
* Zip files can now be uncompressed in memory and their content uploaded
individually in one step
* Added support for concurrent, queued OCR processing using celery
* Apply default transformations to document before OCR
* Added unpaper to the OCR convertion pipe
* Added views to create, edit and grant/revoke permissions to roles
* Added multipage documents support (only tested on pdfs)
- To update a previous database do: [d.update_page_count() for d in Document.objects.all()]
* Added support for document page transformation (no GUI yet)
* Added permissions and roles support
* Added python-magic for smarter MIME type detection
(https://github.com/ahupp/python-magic).
* Added a new Document model field: file_mime_encoding.
* Show only document metadata in document list view.
* If one document type exists, the create document wizard skips the
first step.
* Changed to a liquid css grid
* Added the ability to group documents by their metadata
* New abstracted options to adjust document conversion quality (default,
low, high)

32
docs/releases/0.7.3.rst Normal file
View File

@@ -0,0 +1,32 @@
Version 0.7.3
-------------
* Refactored main menu navigation and converted all apps to this new
system
* Multi item links are now displayed on top of generic lists as well as
on the bottom
* Spanish translation updates
* Updated requirements to use the latest development version of
django-mptt
* Improved user folder document removal views
* Added ability to specify default metadata or metadataset per
document type
* Converted filename handling to use os.path library for improved
portability
* Added edit source object attribute difference detection and logging
to history app
* Missing metadata type in a document during a multi document editing doesn't raise errors anymore.
- This allows for multi document heterogeneous metadata editing in a single step.
* Added document multi item links in search results
- Direct editing can be done from the search result list
* Permissions are now grouped and assigned a group name
* Improved role management views
* Document type is now an optional document property
- Documents can be created without an explicit document type
* Added support for per user staging directories
* Updated logos

6
docs/releases/0.7.4.rst Normal file
View File

@@ -0,0 +1,6 @@
Version 0.7.4
-------------
* Renamed 'secondary actions' to 'secondary menu'
* Added document type setup views to the setup menu
* Added document type file name editing views to the setup menu
* Fixed document queue properties sidebar template not showing

16
docs/releases/0.7.5.rst Normal file
View File

@@ -0,0 +1,16 @@
Version 0.7.5
-------------
* Added a help messages to the sidebar of some views
* Renamed some forms submit button to more intuitive one
- 'Search' on the submit button of the search form
- 'Next step' on the document creation wizard
* Added view to list supported file formats and reported by the
converter backend
* Added redirection support to multi object action views
* Renamed 'document list' link to 'all documents' and
'recent document list' to 'recent documents'
* Removed 'change password' link next to the current user's name and
added a few views to handle the current user's password, details and
details editing

23
docs/releases/0.7.6.rst Normal file
View File

@@ -0,0 +1,23 @@
Version 0.7.6
-------------
* Added recent searches per user support
- The ammount of searches stored is controlled by the setup option
``SEARCH_RECENT_COUNT``
* The document page zoom button are now disabled when reaching the minimum
or maximum zoom level
* The document page navigation links are now disabled when view the first
and last page of a document
* Document page title now displays the current page vs the total page
count
* Document page title now displays the current zoom level and rotation
degrees
* Added means set the expansion compressed files during document creation,
via web interface removing the need for the configuration options:
``UNCOMPRESS_COMPRESSED_LOCAL_FILES`` and ``UNCOMPRESS_COMPRESSED_STAGING_FILES``
* Added 'search again' button to the advances search results view
* Implementes an advanced search feature, which allows for individual field terms
- Search fields supported: document type, MIME type, filename,
extension, metadata values, content, description, tags, comments

13
docs/releases/0.7.rst Normal file
View File

@@ -0,0 +1,13 @@
Version 0.7
-----------
* Added confirmation dialogs icons
* Added comment app with support for adding and deleting comments to
and from documents
* Updated requirements files as per issue #9
* Show tagged item count in the tag list view
* Show tagget document link in the tags subtemplate of documents
* Made comment sorted by oldest first, made comment subtemplate
scrollable
* Rename comments app to document_comment to avoid conflict with
Django's comment app
* Made document comments searchable

32
docs/releases/0.8.1.rst Normal file
View File

@@ -0,0 +1,32 @@
Version 0.8.1
-------------
* Tags can now also be created from the main menu
* Added item count column to index instance list view
* Updated document indexing widget to show different icon for indexes or
indexes that contain documents
* Replaced the Textarea widget with the TextAreaDiv widget on document
and document page detail views
- This change will allow highlighting search terms in the future
* Unknown document file format page count now defaults to 1
- When uploading documents which the selected converted backend doesn't
understand, the total page count will fallback to 1 page to at least
show some data, and a comment will be automatically added to the
document description
* Added new MAIN_DISABLE_ICONS to turn off all icons
- This options works very well when using the ``default`` theme
* The default theme is now ``activo``
* Improved document page views and document page transformation views
navigation
* Added OCR queue document transformations
- Use this for doing resizing or rotation fixes to improve OCR results
* Added reset view link to the document page view to reset the zoom
level and page rotation
* Staging files now show a thumbnail preview instead of preview link

24
docs/releases/0.8.2.rst Normal file
View File

@@ -0,0 +1,24 @@
Version 0.8.2
-------------
* Moved code to Django 1.3
- Users have to use the ``collectstatic`` management command::
$ ./manage.py collectstatic
- The ``site_media`` directory is no more, users must update the media
serving directives in current deployments and point them to the
``static`` directory instead
* The changelog is now available under the ``about`` main menu
* ``Grappelli`` no longer bundled with Mayan
- Users must install Grappelli or execute::
$ pip install --upgrade -r requirements/production.txt
* Even easier UI language switching
* Added email login method, to enable it, set::
AUTHENTICATION_BACKENDS = ('common.auth.email_auth_backend.EmailAuthBackend',)
COMMON_LOGIN_METHOD = 'email'

29
docs/releases/0.8.3.rst Normal file
View File

@@ -0,0 +1,29 @@
Version 0.8.3
-------------
* Added a Contributors file under the docs directory
* Moved the document grouping subtemplate windows into a document
information tab
* Change the mode the setup options are shown, opting to use a more of a
dashboard style now
* Changed the tool menu to use the same button layout of the setup menu
* Moved OCR related handling to the tools main menu
* Improved the metadata type and metadata set selection widget during
the document upload wizard
* Added a view to the about menu to read the LICENSE file included with
Mayan
* Added converter backend agnostic image file format descriptions
* Disable whitelist and blacklist temporarily, removed document_type
field from interactive sources
* Fully disabled watch folders until they are working correctly
* Updated the project title to 'Mayan EDMS'
* If ghostscript is installed add PDF and PS to the list of file formats
by the python converter backend
* Use Pillow (http://pypi.python.org/pypi/Pillow) instead of PIL
- Pillow is a fork of PIL with several updated including better jpeg and png library detection
- Users must uninstall PIL before installing Pillow
* Updated the static media url in the login excempt url list
* Added remediatory code to sidestep issue #10 caused by DjangoZoom's deployment script executing the collectstatic command before creating the database structure with syncdb. Thanks to Joost Cassee (https://github.com/jcassee) for reporting this one.
* Perform extra validation of the image cache directory and fallback to creating a temporary directory on validation failure
* Fixed a source creation bug, that caused invalid links to a non existing source transformation to appear on the sidebar

62
docs/releases/0.8.rst Normal file
View File

@@ -0,0 +1,62 @@
Version 0.8
-----------
* Distributed OCR queue processing via celery is disabled for the time
being
* Added support for local scheduling of jobs
- This addition removes celery beat requirement, and make is optional
* Improve link highlighting
* Navigation improvements
* Documents with an unknown file format now display a mime type place
holder icon instead of a error icon
* Mayan now does pre caching of document visual representation improving
overall thumbnail, preview and display speed
- Page image rotation and zooming is faster too with this update
* Removed all QUALITY related settings
* ``COMMON_TEMPORARY_DIRECTORY`` is now validated when Mayan starts and if
not valid falls back to creating it's own temporary folder
* Added PDF file support to the python converter backend via ghostscript
- This requires the installation of:
+ ghostscript python package
+ ghostscript system binaries and libraries
* Added PDF text parsing support to the python converter backend
- This requires the installation of:
+ pdfminer python package
* Added PDF page count support to the python converter backend
* Added python only converter backend supporting resizing, zooming and rotation
- This backend required the installation of the python image library (PIL)
- This backend is useful when Graphicsmagick or Imagemagick can not be installed for some reason
- If understand fewer file format than the other 2 backends
* Added default tranformation support to document sources
* Removed ``DOCUMENT_DEFAULT_TRANSFORMATIONS`` setup options
* Document sources are now defined via a series of view under the setup main menu
* This removes all the ``DOCUMENT_STAGING`` related setup options
- Two document source types are supported local (via a web form),
and staging
- However multiple document sources can be defined each with their own
set of transformations and default metadata selection
* Use ``python-magic`` to determine a document's mimetype otherwise
fallback to use python's mimetypes library
* Remove the included sources for ``python-magic`` instead it is now fetched
from github by pip
* Removed the document subtemplates and changed to a tabbed style
* Added link to document index content view to navigate the tree upwards
* Added new option ``MAIN_DISABLE_HOME_VIEW`` to disable the home main menu
tab and save some space
* Added new option to the web theme app, ``WEB_THEME_VERBOSE_LOGIN``
that display a more information on the login screen
(version, copyright, logos)
* Added a confirmation dialog to the document tag removal view

7
docs/releases/0.9.1.rst Normal file
View File

@@ -0,0 +1,7 @@
Version 0.9.1
-------------
* Added handling percent encoded unicode query strings in search URL,
thanks to (Сергей Глита [Sergei Glita]) for reporting.
* Added a FAQ explaing how to fix MySQL collation related error when
doing searches also thanks to (Сергей Глита [Sergei Glita]) for
reporting this one.

44
docs/releases/0.9.rst Normal file
View File

@@ -0,0 +1,44 @@
Version 0.9
-----------
* Simplified getting mimetypes from files by merging 2 implementations
(document based and file based)
* Updated python converter backend, document model and staging module
to use the new get_mimetype API
* Only allow clickable thumbnails for document and staging files with a
valid image
* Removed tag count from the group document list widget to conserve
vertical space
* Updated required Django version to 1.3.1
* Removed the included 3rd party module django-sendfile, now added to
the requirement files.
* User should do a pip install -r requirements/production.txt to update
* Changed to Semantic Versioning (http://semver.org/), with
recommendations 7, 8 and 9 causing the most effect in the versioning number.
* Added Russian locale post OCR cleanup backend (Сергей Глита [Sergei Glita])
* Reduced severity of the messages displayed when no OCR cleanup backend
is found for a language
* Complete Portuguese translation (Emerson Soares and Renata Oliveira)
* Complete Russian translation (Сергей Глита [Sergei Glita])
* Added animate.css to use CSS to animate flash messages with better
fallback on non JS browsers
* The admin and sentry links are no longer hard-coded (Meurig Freeman)
* Improved appearance of the document tag widget
(https://p.twimg.com/Ac0Q0b-CAAE1lfA.png:large)
* Added django_compress and cssmin to the requirements files and enabled
django_compress for CSS and JS files
* Added granting and revoking permission methods to the permission model
* Correctly calculate the mimetype icons paths when on development mode
* Added a new more comprehensive method of passing multiple variables
per item in multi item selection views
* Used new multi parameter passing method to improve the usability of
the grant/revoke permission view, thanks to Cezar Jenkins
(https://twitter.com/#!/emperorcezar) for the suggestion
* Added step to the documentation explaining how to install Mayan EDMS
on Webfaction
* Added an entry in the documentation to the screencast explaining how
to install Mayan EDMS on DjangoZoom
* Added required changes to add Mayan EDMS to Transifex.com
* Fixed the apache contrib file static file directory name
* Added improved documentation

25
docs/releases/index.rst
View File

@@ -14,7 +14,6 @@ up to and including the new version.
Final releases Final releases
============== ==============
0.12 release 0.12 release
----------- -----------
.. toctree:: .. toctree::
@@ -22,7 +21,25 @@ Final releases
0.12 0.12
Historic releases Historic changelogs
================= ===================
.. toctree::
:maxdepth: 1
.. include:: ../changelog.rst 0.11.1
0.11
0.10.1
0.10
0.9.1
0.9
0.8.3
0.8.2
0.8.1
0.8
0.7.6
0.7.5
0.7.4
0.7.3
0.7
0.5.1
0.5

0
docs/contributors.rst → docs/topics/contributors.rst
View File

0
docs/development.rst → docs/topics/development.rst
View File

0
docs/settings.rst → docs/topics/settings.rst
View File

6
docs/credits.rst → docs/topics/software_used.rst
View File

@@ -1,6 +1,6 @@
======= =============
Credits Software used
======= =============
* Python * Python
* Copyright (c) 2001-2010 Python Software Foundation. * Copyright (c) 2001-2010 Python Software Foundation.

0
docs/technical.rst → docs/topics/technical.rst
View File

12
docs/topics/transformations.rst Normal file
View File

@@ -0,0 +1,12 @@
=========================
What are transformations?
=========================
Transformation are useful to manipulate the preview of the stored documents
in a persistent manner, for example some scanning equipment only produce
landscape PDFs, in this case a default transformation for that document
source would be "rotation: 270 degress", this way whenever a document is
uploaded from that scanner it appears in portrait orientation.
The transformation remains attached to the document, this way the file
is preserved in it's original state (a requirement in legal environments)
but only the representation is transformed to make it look right to the user.

5
docs/updates.rst
View File

@@ -1,5 +0,0 @@
=========
Changelog
=========
.. include:: changelog.rst