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

Documentation update

Browse Source
This commit is contained in:
Roberto Rosario
2011-09-01 03:54:24 -04:00
parent f44d135a87
commit 8f016eaeff
3 changed files with 40 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/development.rst
View File

@@ -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

9
docs/index.rst
View File

@@ -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
========

55
docs/technical.rst
View File

@@ -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