diff --git a/docs/changelog.rst b/docs/changelog.rst index d04f4b2407..80d0787351 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,19 +1,22 @@ -2011-12-2 ---------- -* Added migrations and model updated to support document versions - -2011-12-1 ---------- -* OCR queue processing improvements -* Office documents handling improvements -* Text extraction support for office documents -* RTF text documents are now handled as office documents +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 - -2011-11-30 ----------- -* Added South to the requirements + 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 @@ -22,16 +25,11 @@ $ ./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 - - -2011-11-28 ----------- -* Removed extra slash in ajax-loader.gif URL fixes #15, thanks to IHLeanne for finding this one +* Removed extra slash in ajax-loader.gif URL fixes #15, thanks to + IHLeanne for finding this one Version 0.10.1 @@ -41,6 +39,9 @@ Version 0.10.1 $ 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 Version 0.10 diff --git a/docs/conf.py b/docs/conf.py index 2b9ba3a5ff..cb26e3e359 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,10 +48,10 @@ copyright = u'2011, Roberto Rosario' # built documents. # # The short X.Y version. -version = '0.10.1' +version = '0.11' # The full version, including alpha/beta/rc tags. -release = '0.10' +release = '0.11' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/credits.rst b/docs/credits.rst index d56f2c0d93..e0b3e815d6 100644 --- a/docs/credits.rst +++ b/docs/credits.rst @@ -112,3 +112,13 @@ Credits * http://pypi.python.org/pypi/django-taggit * Image 392336_7079 (stock exchange) + +* djangorestframework + +* South + +* python-gnupg + +* python-hkp + + diff --git a/docs/features.rst b/docs/features.rst index 75360e15f6..e272d75e40 100644 --- a/docs/features.rst +++ b/docs/features.rst @@ -2,6 +2,23 @@ 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`_ @@ -27,18 +44,28 @@ Features * 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. -* Permissions and roles support. +* Roles support. - * User can created many different roles and are not limited to the traditional limited admin, operator, guest paradigm. + * 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. @@ -55,7 +82,19 @@ Features .. _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. diff --git a/docs/index.rst b/docs/index.rst index 2f2f9d96fd..5c115df121 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,7 +43,6 @@ Contents settings updates development - technical contributors credits faq diff --git a/docs/requirements.rst b/docs/requirements.rst index 1ba97459bc..665b9ba641 100644 --- a/docs/requirements.rst +++ b/docs/requirements.rst @@ -23,6 +23,7 @@ Executables: * ``tesseract-ocr`` - An OCR Engine that was developed at HP Labs between 1985 and 1995... and now at Google. * ``unpaper`` - post-processing scanned and photocopied book pages +* ``gpg`` - The GNU Privacy Guard Optional requirements ===================== diff --git a/docs/settings.rst b/docs/settings.rst index 0f95b103d4..323bf84405 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -88,6 +88,8 @@ Documents Default: ``image_cache`` (relative to the installation path) + The path where the visual representations of the documents are stored for fast display. + Converter --------- @@ -128,19 +130,32 @@ Converter Graphics conversion backend to use. Options are: ``converter.backends.imagemagick``, ``converter.backends.graphicsmagick`` and ``converter.backends.python``. + Suggested options: ``-limit files 1 -limit memory 1GB -limit map 2GB -density 200`` + .. data:: CONVERTER_UNOCONV_PATH Default: ``/usr/bin/unoconv`` + Path to the unoconv program. -Grouping ---------- - -.. data:: GROUPING_SHOW_EMPTY_GROUPS + +.. data:: CONVERTER_UNOCONV_USE_PIPE Default: ``True`` + Use alternate method of connection to LibreOffice using a pipe, it is slower but less prone to segmentation faults. + + +Linking +------- + +.. data:: LINKING_SHOW_EMPTY_SMART_LINKS + + Default: ``True`` + + Show smart links even when they don't return any documents. + Storage ------- @@ -224,7 +239,7 @@ OCR .. data:: OCR_REPLICATION_DELAY - Default: ``10`` + Default: ``0`` Amount of seconds to delay OCR of documents to allow for the node's storage replication overhead. @@ -384,3 +399,13 @@ User management Default: ``[]`` A list of existing roles that are automatically assigned to newly created users + + +Signatures +---------- + +.. data:: SIGNATURES_KEYSERVERS + + Default: ``['pool.sks-keyservers.net']`` + + List of keyservers to be queried for unknown keys.