From 8f016eaeff2985359b1a48e77c0c31f11034eab5 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Thu, 1 Sep 2011 03:54:24 -0400 Subject: [PATCH] Documentation update --- docs/development.rst | 9 +++++--- docs/index.rst | 9 ++++---- docs/technical.rst | 55 ++++++++++++++++++++++++-------------------- 3 files changed, 40 insertions(+), 33 deletions(-) diff --git a/docs/development.rst b/docs/development.rst index 869669d5b6..1a5aeb61e2 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -23,7 +23,7 @@ Source Control The project is publicly accessable, hosted and can be cloned from **GitHub** using:: - ``git clone git://github.com/rosarior/mayan.git`` + $ git clone git://github.com/rosarior/mayan.git Git branch structure @@ -32,9 +32,12 @@ Git branch structure **Mayan EDMS** follows the model layout by Vincent Driessen in his `Successful Git Branching Model`_ blog post. Git-flow_ is a great tool for managing the repository in this way. ``develop`` - The "next release" branch. Likely unstable. + The "next release" branch, likely unstable. ``master`` Current production release (|version|). +``feature/`` + Unfinished/ummerged feature. + Each release is tagged and available for download on the Downloads_ section of the **Mayan EDMS** repository on GitHub_ @@ -54,7 +57,7 @@ Documentation The documentation is written in `reStructured Text`_ format. -The documentation lives in ``docs`` directory. In order to build it, you will first need to install Sphinx_. :: +The documentation lives in the ``docs`` directory. In order to build it, you will first need to install Sphinx_. :: $ pip install sphinx diff --git a/docs/index.rst b/docs/index.rst index 878a9a4377..2f2f9d96fd 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ -========== -Mayan EDMS -========== +======== +Overview +======== Open source, Django_ based document manager with custom metadata indexing, file serving integration and OCR_ capabilities. @@ -12,8 +12,6 @@ Open source, Django_ based document manager with custom metadata indexing, file :Video: http://bit.ly/pADNXv :Issue tracker: http://github.com/rosarior/mayan/issues -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 or documents. @@ -32,6 +30,7 @@ On hosting providers that support Django_ such as DjangoZoom_, **Mayan EDMS** ca .. _DjangoZoom: http://djangozoom.com/ +======== Contents ======== diff --git a/docs/technical.rst b/docs/technical.rst index 3f33fd15c1..cd97745b6d 100644 --- a/docs/technical.rst +++ b/docs/technical.rst @@ -11,32 +11,37 @@ Internals **Mayan EDMS** is not a single program, but a collection of different Django apps, each designed to provide a specific functionality. -* common - Holds code and provide a central place to put code thats used by all the other apps. -* document_indexing -* history -* main - Can be thought as the project app, is small on purpose. -* navigation - Handles the complex automatic creation of hyper text links. -* project_setup -* scheduler -* storage - Abstracts the storage of documents. -* web_theme - Handles the presentation of the HTML and CSS to the user. -* converter - Abstracts the convertions between file formats, calls the backends of which are wrappers for ImageMagick, GraphicsMagick and python's PIL coupled with ghostscript. -* documents - The main app, handles the Document and DocumentPage classes. -* folders -* job_processor -* metadata -* ocr -* project_tools -* smart_settings -* tags - Handles Document tagging, it is a wrapper for django-taggit_. -* document_comments - Handles document comments it's a wrapper for `Django\'s comment framework`_. -* dynamic_search -* grouping -* mimetype - Handles file mimetype detection using python-magic or falling back to Pythons mimetype library, also handles the mimetype icon library. -* permissions - All the other apps register their permissions with this one. -* sources - Handles the document file sources definitions. -* user_management - User and group management, it is a wrapper for Django's user creating and authentication system. +* ``common`` - Provide a central place to put code, models or templates that are used by all the other apps. +* ``document_indexing`` +* ``history`` +* ``main`` - Can be thought as the project app, is small on purpose. +* ``navigation`` - Handles the complex automatic creation of hyper text links. +* ``project_setup`` +* ``scheduler`` +* ``storage`` - Abstracts the storage of documents. +* ``web_theme`` - Handles the presentation of the HTML and CSS to the user. +* ``converter`` - Abstracts the convertions between file formats, calls the backends of which are wrappers for ImageMagick_, GraphicsMagick_ and python's PIL_ coupled with Ghostscript_. +* ``documents`` - The main app, handles the ``Document`` and ``DocumentPage`` classes. +* ``folders`` +* ``job_processor`` +* ``metadata`` +* ``ocr`` +* ``project_tools`` +* ``smart_settings`` +* ``tags`` - Handles document tagging, it is a wrapper for django-taggit_. +* ``document_comments`` - Handles document comments it's a wrapper for `Django\'s comment framework`_. +* ``dynamic_search`` +* ``grouping`` +* ``mimetype`` - Handles file MIME type detection using python-magic_ or falling back to Python's mimetype library, also handles the MIME type icon library. +* ``permissions`` - All the other apps register their permissions with this one. +* ``sources`` - Handles the document file sources definitions. +* ``user_management`` - User and group management, it is a wrapper for Django's user creating and authentication system. .. _`Django\'s comment framework`: https://docs.djangoproject.com/en/dev/ref/contrib/comments/ .. _django-taggit: https://github.com/alex/django-taggit +.. _ImageMagick: http://www.imagemagick.org/script/index.php +.. _GraphicsMagick: http://www.graphicsmagick.org/ +.. _PIL: http://www.pythonware.com/products/pil/ +.. _Ghostscript: http://pages.cs.wisc.edu/~ghost/ +.. _python-magic: https://github.com/ahupp/python-magic