diff --git a/HISTORY.rst b/HISTORY.rst index 1fd539552f..d78952dbf9 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -31,6 +31,8 @@ - Add support for signing documents. - Instead of multiple keyservers only one keyserver is now supported. - Replace document type selection widget with an opened selection list. +- Add mailing documentation chapter. +- Add roadmap documentation chapter. 2.0.2 (2016-02-09) ================== diff --git a/docs/index.rst b/docs/index.rst index 4e08474c94..314da95ccf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,6 +33,7 @@ account. Concepts Development App creation + Roadmap Translations Contributors Screenshots diff --git a/docs/topics/roadmap.rst b/docs/topics/roadmap.rst new file mode 100644 index 0000000000..640cf4cc64 --- /dev/null +++ b/docs/topics/roadmap.rst @@ -0,0 +1,100 @@ +======= +Roadmap +======= + +- Goals for version 2.2: + + - Improve workflow system + - Workflow indexing support. Accessor already works ``{{ document.workflows.all.0.get_current_state }}``. Index recalculation after workflow transition is missing. + - Workflow actions. Predefined actions to be execute on document leaving or entering a state or a transition. Example: "Add to folder X", "Attach tag X". + - Add support for state recipients. + - Add workflow document inbox notification. + - Replace indexing and smart linking template language (use Jinja2 instead of Django's). + +- Goals for version 3.0: + + - Replace UI. + +- General goals: + + - Distribution: + + - Debian packages. Limited success so far using https://github.com/astraw/stdeb. + + - Downloads: + + - Transition from filetransfer package to django-downloadview. This task was started and the view ``common.generics.SingleObjectDownloadView`` was created. The ``document_signatures`` app is the first app to use it. + + - Notifications: + + - Add support for subscribing to a document's events. + - Add support for subscribing to a document type events. + - Add support for subscribing specific events. + + - OCR: + + - Add image preprocessing for OCR. Increase effectiveness of Tesseract. + - Improve interface with tesseract. + - Fix pytesseract shortcomings via upstream patches or re-implement. Move to PyOCR. + + - Python 3: + + - Complete support for Python3. + - Find replacement for pdfminer (Python3 support blocker). Use pdfminer.six (#257). + + - Simple serving: + + - Provide option to serve Mayan EDMS without a webserver (using Tornado o similar). Work started in branch: ``/feature/tornado`` + + - Source code: + + - Implement Developer certificate of origin: http://developercertificate.org/ + + - Upload wizard: + + - Make wizard step configurable. Create ``WirzardStep`` class so apps can add their own upload wizard steps, instead of the steps being hardcoded in the sources app. + - Add upload wizard step to add the new documents to a folder. + + - Other + + - Use a sequence and not the document upload date to determine the document version sequence. MySQL doesn't store milisecond value in dates and if several version are uploaded in a single second there is no way to know the order or which one is the latests. This is why the document version tests include a 2 second delay. Possible solution: http://schinckel.net/2015/05/17/django-second-autofield/ + - Include external app Mayan-EXIF into main code. + - Convert all views from functions to class based views (CBV). + - Increase test coverage. + - Mock external services in tests. For example the ``django_GPG`` app key search and receive tests. + - Pluggable icon app. Make switching icon set easier. + - Reduce dependency on binary executables for a default install. + - Find replacement for ``cssmin`` & ``django-compressor``. + - Find replacement for ``python-gnupg``. Unstable & inconsistent API. + - Google docs integration. Upload document from Google Drive. + - Get ``dumpdata`` and ``loaddata`` working flawlessly. Will allow for easier backups, restores and database backend migrations. + - Make more view asynchronous: + + - trash can emptying. + - document delete view. + + - Add support for loading settings from environment variables, not just settings/local.py. + - Add generic list ordering. ``django.views.generic.list.MultipleObjectMixin`` (https://docs.djangoproject.com/en/1.8/ref/class-based-views/mixins-multiple-object/#django.views.generic.list.MultipleObjectMixin) now supports an ``ordering`` parameter. + - Workaround GitLab CI MySQL test errors. GitLab MySQL's container doesn't support UTF-8 content. + - Add support for downloading the OCR content as a text file. + - Add support to convert any document to PDF. https://gitlab.mister-muffin.de/josch/img2pdf + - Add support for combining documents. + - Add support for splitting documents. + - Add task viewer. + - Add new document source to get documents from an URL. + - Document overlay support. Such as watermarks. https://gist.github.com/umrashrf/8616550 + - Add support for metadata mapping files. CSV file containing filename to metadata values mapping, useful for bulk upload and migrations. + - Add support for registering widgets to the home screen. + - Merge mimetype and converter apps. + - Add entry in About menu to check latest Mayan EDMS version via PyPI. + - Add GPG key generation. + - Add documentation section on editing the settings/local.py file. + - Add documentation section with warning about using runserver. + - Replace ``urlpatterns = patterns( ''``, with Python lists. Django recommendation for post 1.7. + - If SourceColumn label is None take description from model. Avoid unnecessary translatable strings. + - Metadata widgets (Date, time, timedate). + - Datatime widget: https://github.com/smalot/bootstrap-datetimepicker + - Separate Event class instances with a parent namespace class: EventNamespace. + - Add events for document signing app (uploaded detached signateure, signed document, deleted signature) + - A configurable conversion process. Being able to invoke different binaries for file conversion, as opposed to the current libreoffice only solution. + - A tool in the admin interface to mass (re)convert the files (basically the page count function, but then applied on all documents).