Documentation updates, allow settings reference linking from other documents

This commit is contained in:
Roberto Rosario
2012-02-01 17:04:54 -04:00
parent 600fdf0b8a
commit 3b327ff5b3
6 changed files with 455 additions and 264 deletions

View File

@@ -87,6 +87,6 @@ Having trouble? We'd like to help!
* Report bugs with **Mayan EDMS** using Github's `ticket tracker`_.
.. _archives of the mayan-edms mailing list: http://groups.google.com/group/django-users/
.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/
.. _post a question: http://groups.google.com/group/mayan-edms
.. _ticket tracker: http://github.com/rosarior/mayan/issues

View File

@@ -18,7 +18,7 @@ Features
* Office document format support.
* Word processing files? Spreadsheets? Sresentations? They are supported too.
* Word processing files? Spreadsheets? Presentations? They are supported too.
* User defined metadata fields and meta data sets.

View File

@@ -56,10 +56,10 @@ ACL support
Anonymous user support
~~~~~~~~~~~~~~~~~~~~~~
Anonymous user support is a two tier function, first is the addition of
the COMMON_ALLOW_ANONYMOUS_ACCESS that allows non authenticated to browse
all the pages of a **Mayan EDMS** installation. The second part of this
support is the ability to assign permissions or individual access to objects
to anonymous users.
the :setting:`COMMON_ALLOW_ANONYMOUS_ACCESS` configuration option that
allows non authenticated user to browse all the pages of a **Mayan EDMS** installation.
The second part of this support is the ability to assign permissions
or individual access to objects to anonymous users.
Translations
~~~~~~~~~~~~~~~~~~~

View File

@@ -3,19 +3,32 @@ Document visualization
======================
Mayan EDMS tries to avoid having users to download a document and leave
Mayan EDMS to be able to see them, so in essence making Mayan EDMS a
The philosophy in place is to try to avoid having users download a documents and leave
**Mayan EDMS** to be able to see them, so in essence making **Mayan EDMS** a
visualization tool too. The conversion backend is a stack of functions,
first the mimetype is evaluated, if it is an office document it is passed
to libreoffice working in headless mode (and managed by supervisor)
via unoconv for conversion to PDF. The PDF is stored in a temporary
to Libreoffice_ working in headless mode (and managed by supervisor)
via unoconv for conversion to PDF_. The PDF_ is stored in a temporary
cache along side all the other files that were not office documents,
from here they are inspected to determine the page count and the
corresponding blank database entires are created. After the database
update they all go to the conversion driver specified by the user
(``python``, ``graphicsmagick``, imagemagick``) and a high resolution
update they all go to the conversion driver specified by the configuration
option :setting:`CONVERTER_GRAPHICS_BACKEND` and a high resolution
master preview of each file is generated and stored in the persistent
cache. From the master previews in the persistent cache, volatile
previews are then created on demand for the different sizes requested
(thumbnail, page preview, full preview) and rotate interactively
in the details view.
Office document conversion however won't always work as expected because
LibreOffice_ do not provide proper API's, so subprocess calling,
temporary files and other black magic needs to be invoked to get it
properly integrated. **Mayan EDMS** treats documents as collections of pages
or frames, and text extraction and OCR is done per page not per document,
thats why even text documents need to be rendered by LibreOffice_
before they can be previewed and text can be extracted.
.. _PDF: http://en.wikipedia.org/wiki/Portable_Document_Format
.. _Libreoffice: http://www.libreoffice.org/

View File

@@ -4,7 +4,7 @@ OCR
Because OCR is an intensive operation, documents are queued for OCR for
later handling, the amount of documents processed in parallel is
controlled by the ``OCR_NODE_CONCURRENT_EXECUTION`` configuration
controlled by the :setting:`OCR_NODE_CONCURRENT_EXECUTION` configuration
option. Ideally the machine serving **Mayan EDMS** should disable OCR
processing by settings this options to 0, with other machines or cloud
instances then connected to the same database doing the OCR processing.
@@ -13,7 +13,6 @@ no parser is available for that file type then the document is passed
to tesseract page by page and the results stored per page, this is to
keep the page image in sync with the transcribed text. However when
viewing the document in the details tab all the pages text are
concatenated and shown to the user. Setting the ``OCR_AUTOMATIC_OCR``
concatenated and shown to the user. Setting the :setting:`OCR_AUTOMATIC_OCR`
option to ``True`` would cause all newly uploaded documents to be
queued automatically for OCR.

File diff suppressed because it is too large Load Diff