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

Update documentation

Browse Source
This commit is contained in:
Roberto Rosario
2014-06-29 20:11:00 -04:00
parent 1f7b6cac79
commit 280d2da576
2 changed files with 44 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
docs/credits/software_used.rst
View File

@@ -2,33 +2,11 @@
Software used Software used
============= =============
* Python
* Copyright (c) 2001-2010 Python Software Foundation.
* Copyright (c) 2000 BeOpen.com.
* Copyright (c) 1995-2001 Corporation for National Research Initiatives.
* Copyright (c) 1991-1995 Stichting Mathematisch Centrum, Amsterdam.
* Django - A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
* Copyright Django Software Foundation
* http://www.djangoproject.com/
* django-pagination
* Copyright Eric Florenzano (floguy@gmail.com)
* http://django-pagination.googlecode.com/
* Web App Theme * Web App Theme
* Copyright Andrea Franz (http://gravityblast.com) * Copyright Andrea Franz (http://gravityblast.com)
* git://github.com/pilu/web-app-theme.git * git://github.com/pilu/web-app-theme.git
* Imagemagick - Convert, Edit, Or Compose Bitmap Images
* Copyright 1999-2011 ImageMagick Studio LLC
* http://www.imagemagick.org/script/index.php
* FAMFAMFAM Silk icons * FAMFAMFAM Silk icons
* Copyright Mark James (http://www.twitter.com/markjames) * Copyright Mark James (http://www.twitter.com/markjames)
@@ -39,39 +17,10 @@ Software used
* Copyright Sky Sanders * Copyright Sky Sanders
* skysanders.net/subtext * skysanders.net/subtext
* django-extensions - Extensions for Django
* Copyright Bas van Oostveen (v.oostveen@gmail.com)
* http://code.google.com/p/django-command-extensions/
* django-rosetta - A Django application that eases the translation of Django projects
* Copyright Marco Bonetti (mbonetti@gmail.com)
* http://code.google.com/p/django-rosetta/
* Werkzeug - The Swiss Army knife of Python web development
* Copyright Armin Ronacher (armin.ronacher@active-4.com)
* http://werkzeug.pocoo.org/
* BoundFormWizard - A subclass of Django's FormWizard that handled FormSets.
* Matthew Flanagan (http://www.blogger.com/profile/15093905875465763876)
* http://code.google.com/p/wadofstuff/
* django-filetransfers - File upload/download abstraction
* Waldemar Kornewald
* http://www.allbuttonspressed.com/projects/django-filetransfers
* tesseract - An OCR Engine that was developed at HP Labs between 1985 and 1995... and now at Google.
* http://code.google.com/p/tesseract-ocr/
* Image file 1068504_92921456 "Mayan piramid" (Stock Exchange) * Image file 1068504_92921456 "Mayan piramid" (Stock Exchange)
* Andres Ojeda (http://www.sxc.hu/profile/andres_ol) * Andres Ojeda (http://www.sxc.hu/profile/andres_ol)
* http://www.sxc.hu/browse.phtml?f=view&id=1068504 * http://www.sxc.hu/browse.phtml?f=view&id=1068504
* Image 1297211435_error * Image 1297211435_error
@@ -81,76 +30,17 @@ Software used
* http://www.fatcow.com/free-icons * http://www.fatcow.com/free-icons
* Python-magic - python-magic is a simple wrapper for libmagic
* Adam Hupp <adam at hupp.org>
* https://github.com/ahupp/python-magic
* Fancybox - FancyBox is a tool for displaying images, html content and multi-media in a Mac-style "lightbox" that floats overtop of web page.
* http://fancybox.net
* unpaper - post-processing scanned and photocopied book pages
* Jens Gulden 2005-2007 - unpaper@jensgulden.de.
* http://unpaper.berlios.de/
* favicon * favicon
* http://www.iconfinder.com/icondetails/21581/24/draw_pyramid_icon * http://www.iconfinder.com/icondetails/21581/24/draw_pyramid_icon
* Gnome Project * Gnome Project
* MongoDB - (from "humongous") is a scalable, high-performance, open source, document-oriented database.
* Copyright 10gen
* http://www.mongodb.org/
* PyMongo - is a Python distribution containing tools for working with MongoDB, and is the recommended way to work with MongoDB from Python.
* Copyright 2009, Michael Dirolf
* http://api.mongodb.org/python/
* GridFS - is a storage specification for large objects in MongoDB
* Copyright 10gen
* http://www.mongodb.org/display/DOCS/GridFS+Specification
* django-sendfile - This is a wrapper around web-server specific methods for sending files to web clients.
* johnsensible (John Montgomery)
* https://github.com/johnsensible/django-sendfile
* jQuery-Jail - Jquery Asynchronous Image Loader (JAIL)
* Sebastiano Armeli-Battana (contact@sebarmeli.com)
* http://www.sebastianoarmelibattana.com/projects/jail
* django-taggit - is a reusable Django application for simple tagging
* Alex Gaynor (alex.gaynor@gmail.com)
* http://pypi.python.org/pypi/django-taggit
* Image 392336_7079 (stock exchange) "Chichen Itza" (Stock Exchange) * Image 392336_7079 (stock exchange) "Chichen Itza" (Stock Exchange)
* Joerg Witthoeft "Beamer29" (http://www.sxc.hu/profile/Beamer29) * Joerg Witthoeft "Beamer29" (http://www.sxc.hu/profile/Beamer29)
* http://www.sxc.hu/browse.phtml?f=view&id=392336 * http://www.sxc.hu/browse.phtml?f=view&id=392336
* Django REST framework - lightweight REST framework for Django, that aims to make it easy to build well-connected, self-describing RESTful Web APIs.
* http://django-rest-framework.org/
* South - intelligent schema and data migrations for Django projects.
* http://south.aeracode.org/
* python-gnupg - a Python library which takes care of the internal details and allows its users to generate and manage keys, encrypt and decrypt data, and sign and verify messages.
* http://code.google.com/p/python-gnupg/
* python-hkp - Python HKP client
* Copyright Dmitry Gladkov
* https://github.com/dgladkov/python-hkp

70
docs/releases/1.0.rst
View File

@@ -2,14 +2,19 @@
Mayan EDMS v1.0 release notes Mayan EDMS v1.0 release notes
============================= =============================
*[...] 2014* *July 2014*
Welcome to Mayan EDMS v1.0! Welcome to Mayan EDMS v1.0!
Overview Overview
======== ========
After a year of low activity the focus of this release was to get the code
updated to work with the most recent version of Django and the most recent
version of the dependencies Mayan EDMS uses. The goal was to have a strong
and stable 1.0 release so reduction, trimming, warning reductions and bug
fixes were the primary focus of this cycle. Because of this not much
emphasis was placed on adding new features, or at least new features
that could have the potential to break things.
What's new in Mayan EDMS v1.0 What's new in Mayan EDMS v1.0
============================= =============================
@@ -30,28 +35,29 @@ Translation updates
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
The translation for all languages were synchronized to the latest transifex project sources. The translation for all languages were synchronized to the latest transifex project sources.
Translation completion as reported by Transifex: Translation completion as reported by Transifex:
English - 100%
Arabic - 100% * English - 100%
Bosnian - 100% * Arabic - 100%
French - 100% * Bosnian - 100%
German - 100% * French - 100%
Romanian - 100% * German - 100%
Russian - 100% * Romanian - 100%
Spanish - 100% * Russian - 100%
Italian - 80% * Spanish - 100%
Portuguese - 78% * Italian - 80%
Dutch - 70% * Portuguese - 78%
Portugese (Brazil) - 69% * Dutch - 70%
Bulgarian - 63% * Portugese (Brazil) - 69%
Danish - 44% * Bulgarian - 63%
Vietnamese - 41% * Danish - 44%
Polish - 40% * Vietnamese - 41%
Hungarian - 28% * Polish - 40%
Indonesian - 19% * Hungarian - 28%
Slovenian - 17% * Indonesian - 19%
Persian - 6% * Slovenian - 17%
Croatian - 3% * Persian - 6%
Turkish - 3% * Croatian - 3%
* Turkish - 3%
Model updates Model updates
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@@ -64,7 +70,8 @@ Source code improvements
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
A circular import of metadata and document_index apps code from the documents app 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. directly as before. A lot of time was spent cleaning up the code for PEP8
compliance.
Removal of included 3rd party modules Removal of included 3rd party modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -99,6 +106,8 @@ These files are now part of their own project.
Pluggable OCR backends Pluggable OCR backends
~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~
A commonly requested feature, it is now possible to write backends drivers
to do document OCR using software or services other than Tesseract.
License change License change
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
@@ -108,7 +117,7 @@ commercial products is now explicitly allowed.
Upgrading from a previous version Upgrading from a previous version
================================= =================================
If you installed **Mayan EDMS** by cloning the Git repository issue the commands:: If you installed Mayan EDMS by cloning the Git repository issue the commands::
$ git reset --hard HEAD $ git reset --hard HEAD
$ git pull $ git pull
@@ -128,6 +137,8 @@ Add new static media::
$ ./manage.py collectstatic --noinput $ ./manage.py collectstatic --noinput
If using the SQLite3 database option, rename the file named `mayan.sqlite` file to `db.sqlite3`
The upgrade procedure is now complete. The upgrade procedure is now complete.
@@ -137,7 +148,4 @@ Backward incompatible changes
Bugs fixed or issues closed Bugs fixed or issues closed
=========================== ===========================
* `issue #39`_ Feature request "Bulk move folders" * None
.. _issue #39: https://github.com/rosarior/mayan/issues/39