diff --git a/docs/index.rst b/docs/index.rst index d8986b782b..448a3058dc 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,18 +4,7 @@ Mayan EDMS documentation ======================== -.. rubric:: `Open source`_, Django_ based document manager with custom - metadata_ indexing_, file serving integration, `checking out and in`_, OCR_ capabilities, - document versioning_ and `digital signature verification`_. - -.. _Django: http://www.djangoproject.com/ -.. _OCR: https://secure.wikimedia.org/wikipedia/en/wiki/Optical_character_recognition -.. _digital signature verification: http://en.wikipedia.org/wiki/Digital_signature -.. _versioning: http://en.wikipedia.org/wiki/Versioning -.. _metadata: http://en.wikipedia.org/wiki/Metadata -.. _indexing: http://en.wikipedia.org/wiki/Index_card -.. _Open source: http://en.wikipedia.org/wiki/Open_source -.. _checking out and in: http://en.wikipedia.org/wiki/Revision_control +.. rubric:: `Open source`_ `document management system`_. Getting help ============ @@ -27,15 +16,9 @@ Getting help * Report bugs with **Mayan EDMS** using Github's `ticket tracker`_. -.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/ -.. _Gname: http://news.gmane.org/gmane.comp.python.django.mayan-edms -.. _post a question: http://groups.google.com/group/mayan-edms -.. _ticket tracker: https://github.com/mayan-edms/mayan-edms/issues - First steps =========== - :doc:`Overview ` | :doc:`Features ` | :doc:`Installation ` | :doc:`Getting started ` @@ -46,7 +29,6 @@ Understanding Mayan EDMS :doc:`File storage ` | :doc:`Permission system ` | :doc:`Transformations ` | - :doc:`Document visualization ` | :doc:`Document versioning ` | :doc:`Document signatures ` | :doc:`Indexes ` | @@ -56,6 +38,7 @@ Understanding Mayan EDMS Release notes ============= + :doc:`Release notes and upgrading instructions ` For developers @@ -68,3 +51,12 @@ Credits :doc:`Contributors ` | :doc:`Licensing ` + + +.. _Django: http://www.djangoproject.com/ +.. _Gname: http://news.gmane.org/gmane.comp.python.django.mayan-edms +.. _Open source: http://en.wikipedia.org/wiki/Open_source +.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/ +.. _document management system: https://en.wikipedia.org/wiki/Document_management_system +.. _post a question: http://groups.google.com/group/mayan-edms +.. _ticket tracker: https://github.com/mayan-edms/mayan-edms/issues diff --git a/docs/topics/document_visualization.rst b/docs/topics/document_visualization.rst deleted file mode 100644 index 9e7eb6a4c6..0000000000 --- a/docs/topics/document_visualization.rst +++ /dev/null @@ -1,34 +0,0 @@ -====================== -Document visualization -====================== - - -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_) -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 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 rotated 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/ -.. _supervisor: http://supervisord.org/introduction.html diff --git a/docs/topics/index.rst b/docs/topics/index.rst index 62816bd8ab..6eccd98a02 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -8,7 +8,6 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: contributors development - document_visualization faq features file_storage @@ -17,7 +16,6 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: installation license ocr - overview permissions signatures smart_links diff --git a/docs/topics/overview.rst b/docs/topics/overview.rst deleted file mode 100644 index 70d78e73ea..0000000000 --- a/docs/topics/overview.rst +++ /dev/null @@ -1,18 +0,0 @@ -==================== -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 of 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. Featuring many configuration parameters, **Mayan EDMS** allows 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. - -.. _`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