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

Updated the documentation in a Sphinx ready format

Browse Source
This commit is contained in:
Roberto Rosario
2011-08-19 08:57:03 -04:00
parent b4be6115a1
commit 9277e9cdee
18 changed files with 1085 additions and 558 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
apps/common/forms.py
View File

@@ -166,7 +166,7 @@ class FileDisplayForm(forms.Form):
class ChangelogForm(FileDisplayForm): class ChangelogForm(FileDisplayForm):
FILENAME = u'Changelog.txt' FILENAME = u'changelog.rst'
DIRECTORY = u'docs' DIRECTORY = u'docs'

132
docs/CREDITS
View File

@@ -1,132 +0,0 @@
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
Copyright Andrea Franz (http://gravityblast.com)
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
Copyright Mark James (http://www.twitter.com/markjames)
http://www.famfamfam.com/lab/icons/silk/
3 state FAMFAMFAM Silk icon sets: discrete images and CSS sprite palette
Copyright Sky Sanders
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)
Andres Ojeda (http://www.sxc.hu/profile/andres_ol)
Image 1297211435_error
http://kde-look.org/usermanager/search.php?username=InFeRnODeMoN
Fat cow icon set
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/
celery - Celery is an open source asynchronous task queue/job queue
based on distributed message passing. It is focused on real-time
operation, but supports scheduling as well.
Copyright 2009-2011, Ask Solem & contributors
http://ask.github.com/celery/getting-started/introduction.html
django-celery - django-celery provides Celery integration for Django;
Using the Django ORM and cache backend for storing
results, autodiscovery of task modules for applications
listed in INSTALLED_APPS, and more.
Copyright Ask Solem & contributors
http://github.com/ask/django-celery/
favicon
http://www.iconfinder.com/icondetails/21581/24/draw_pyramid_icon
by 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
Image 1299549572_unknown2.png
Everaldo Coelho
http://www.everaldo.com/
Image 1299549805_unknown.png
Oxygen Team
http://www.oxygen-icons.org/
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)

10
docs/Contributors.txt
View File

@@ -1,10 +0,0 @@
Bug reports
-----------
Aziz M. Bookwala https://github.com/azizmb
tightwork https://github.com/tightwork
Joost Cassee joost@cassee.net, https://github.com/jcassee
Brian Huxley
Bug fixes
---------
Aziz M. Bookwala https://github.com/azizmb

66
docs/FAQ
View File

@@ -1,66 +0,0 @@
* Following error when using MySQL and doing OCR on languages other than english:
Incorrect string value: '\xE2\x80\x95rs6...' for column 'content' at row 1
- Solution:
Use utf-8 collation on MySQL server, or at least in table 'documents_documentpage', 'content' field
Ref: 1- http://groups.google.com/group/django-users/browse_thread/thread/429447086fca6412
Ref: 2- http://markmail.org/message/bqajx2utvmtriixi
* File system links not showing on client computers when serving content with Samba:
- Solution:
Disable unix extensions in the [global] section and enable wide links for the file serving share
- Example:
[global]
unix extensions = no
[digitalizacion]
path = /var/local/mayan
guest ok = yes
read only = yes
wide links = yes
follow symlinks = yes
Ref: 1- http://www.samba.org/samba/docs/man/manpages-3/smb.conf.5.html
* How to store documents outside Mayan's path:
1)Sub class Django's FileSystemStorage class:
-Create a file called customstorage.py
from django.core.files.storage import FileSystemStorage
class CustomStorage(FileSystemStorage):
def __init__(self, *args, **kwargs):
super(CustomStorage, self).__init__(*args, **kwargs)
self.location='/new/path/to/documents/'
self.base_url='document_storage'
2)In settings.py add:
from customstorage import CustomStorage
DOCUMENTS_STORAGE_BACKEND = CustomStorage
* How to enable the GridFS storage backend
- Solution:
Add the following lines to settings.py:
from storage.backends.gridfsstorage import GridFSStorage
DOCUMENTS_STORAGE_BACKEND = GridFSStorage
- Filesystem metadata indexing will not work with this storage backend as
file are inside a MongoDB database and can't be linked (at least for now)
* Site search is slow
- Add indexes to the following fields:
documents_document - description, recomended size: 160
documents_documentmetadata - value, recomended size: 80
documents_documentpage - content, recomended size: 3000
* How to enable x-sendile support for Apache
- Add SENDFILE_BACKEND = 'sendfile.backends.xsendfile' to your settings.py file
- On your apache configuration file add:
XSendFile on
XSendFileAllowAbove on

17
docs/INSTALL
View File

@@ -1,17 +0,0 @@
apt-get update
apt-get install tesseract-ocr-spa unpaper imagemagick python-virtualenv -y
cd /usr/share
virtualenv --no-site-packages mayan
cd mayan
git clone git://github.com/rosarior/mayan.git
cd mayan
source ../bin/activate
pip install -r requirements/production.txt
#For MySQL support
apt-get install python-dev libmysqlclient-dev
pip install MySQL-python

130
docs/Makefile Normal file
View File

@@ -0,0 +1,130 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MayanEDMS.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MayanEDMS.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/MayanEDMS"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MayanEDMS"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

456
docs/Changelog.txt → docs/changelog.rst
View File

File diff suppressed because it is too large Load Diff

216
docs/conf.py Normal file
View File

@@ -0,0 +1,216 @@
# -*- coding: utf-8 -*-
#
# Mayan EDMS documentation build configuration file, created by
# sphinx-quickstart on Fri Aug 19 05:13:38 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'Mayan EDMS'
copyright = u'2011, Roberto Rosario'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.8.3'
# The full version, including alpha/beta/rc tags.
release = '0.8.3'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'MayanEDMSdoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'MayanEDMS.tex', u'Mayan EDMS Documentation',
u'Roberto Rosario', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'mayanedms', u'Mayan EDMS Documentation',
[u'Roberto Rosario'], 1)
]

10
docs/contributors.txt Normal file
View File

@@ -0,0 +1,10 @@
Bug reports
-----------
* Aziz M. Bookwala (https://github.com/azizmb)
* tightwork (https://github.com/tightwork)
* Joost Cassee (joost@cassee.net, https://github.com/jcassee)
* Brian Huxley
Bug fixes
---------
* Aziz M. Bookwala (https://github.com/azizmb)

110
docs/credits.rst Normal file
View File

@@ -0,0 +1,110 @@
* 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
* Copyright Andrea Franz (http://gravityblast.com)
* 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
* Copyright Mark James (http://www.twitter.com/markjames)
* http://www.famfamfam.com/lab/icons/silk/
* 3 state FAMFAMFAM Silk icon sets: discrete images and CSS sprite palette
* Copyright Sky Sanders
* 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)
* Andres Ojeda (http://www.sxc.hu/profile/andres_ol)
* Image 1297211435_error
* http://kde-look.org/usermanager/search.php?username=InFeRnODeMoN
* Fat cow icon set
* 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/
* celery - Celery is an open source asynchronous task queue/job queue based on distributed message passing. It is focused on real-time operation, but supports scheduling as well.
* Copyright 2009-2011, Ask Solem & contributors
* http://ask.github.com/celery/getting-started/introduction.html
* django-celery - django-celery provides Celery integration for Django
* Copyright Ask Solem & contributors
* http://github.com/ask/django-celery/
* favicon
* http://www.iconfinder.com/icondetails/21581/24/draw_pyramid_icon
* 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)

98
docs/faq.rst Normal file
View File

@@ -0,0 +1,98 @@
===
FAQ
===
Frequently asked questions and solutions
Incorrect string value: ``'\xE2\x80\x95rs6...'`` for column ``'content'`` at row 1
----------------------------------------------------------------------------------
When using ``MySQL`` and doing OCR on languages other than english
* Solution:
- Use utf-8 collation on MySQL server, or at least in table 'documents_documentpage', 'content' field
- Ref: 1- http://groups.google.com/group/django-users/browse_thread/thread/429447086fca6412
- Ref: 2- http://markmail.org/message/bqajx2utvmtriixi
File system links not showing when serving content with ``Samba``
-----------------------------------------------------------------
* Solution:
- Disable unix extensions in the [global] section and enable wide links for the file serving share
- Example::
[global]
unix extensions = no
...
[digitalizacion]
path = /var/local/mayan
guest ok = yes
read only = yes
wide links = yes
follow symlinks = yes
- Ref: 1- http://www.samba.org/samba/docs/man/manpages-3/smb.conf.5.html
How to store documents outside Mayan's path
-------------------------------------------
* Sub class Django's ``FileSystemStorage`` class:
- Create a file called ``customstorage.py``::
from django.core.files.storage import FileSystemStorage
class CustomStorage(FileSystemStorage):
def __init__(self, *args, **kwargs):
super(CustomStorage, self).__init__(*args, **kwargs)
self.location='/new/path/to/documents/'
self.base_url='document_storage'
- In the ``settings.py`` add::
from customstorage import CustomStorage
DOCUMENTS_STORAGE_BACKEND = CustomStorage
How to enable the ``GridFS`` storage backend
--------------------------------------------
* Solution:
- Add the following lines to ``settings.py``::
from storage.backends.gridfsstorage import GridFSStorage
DOCUMENTS_STORAGE_BACKEND = GridFSStorage
- Filesystem metadata indexing will not work with this storage backend as
the files are inside a ``MongoDB`` database and can't be linked (at least for now)
Site search is slow
-------------------
* Add indexes to the following fields:
- ``documents_document`` - description, recomended size: 160
- ``documents_documentmetadata`` - value, recomended size: 80
- ``documents_documentpage`` - content, recomended size: 3000
How to enable x-sendile support for ``Apache``
----------------------------------------------
* Add the following line to your ``settings.py`` file::
SENDFILE_BACKEND = 'sendfile.backends.xsendfile'
* On your apache configuration file add::
XSendFile on
XSendFileAllowAbove on

20
docs/features.rst Normal file
View File

@@ -0,0 +1,20 @@
========
Features
========
* User defined meta-data fields
* Dynamic default values for metadata
* Filesystem integration
* User defined document unique identifier and checksum algorithms
* Local file or server side file uploads
* Batch upload many documents with the same meta-data
* Previews for a great deal of image formats, including PDF
* Full text searching
* Configurable document grouping
* Permissions and roles support
* Multi page document support
* Distributed OCR processing
* Multilingual user interface (English, Spanish)
* Multilingual OCR support
* Duplicated document search
* Plugable storage backends (File based and GridFS included)
* Color coded tagging

35
docs/index.rst Normal file
View File

@@ -0,0 +1,35 @@
==========
Mayan EDMS
==========
Open source, Django_ based document manager with custom metadata indexing, file serving integration and OCR capabilities.
.. _Django: http://www.djangoproject.com/
:Website: http://bit.ly/mayan-edms
:Source: http://github.com/rosarior/mayan
Overview
========
Bulk upload documents directly or by using a staging folder to receive
scanned documents. Organize using document classes and custom meta-data
as well as automatic document grouping. Find document by means of full
text searching, either meta-data, document properties, content extracted
from PDFs or transcribed by OCR.
Contents
========
.. toctree::
:maxdepth: 2
features
requirements
installation
updates
license
faq

45
docs/installation.rst Normal file
View File

@@ -0,0 +1,45 @@
============
Installation
============
Mayan EDMS should be installed like any other Django project and preferably using ``virtualenv``.
If using a Debian_ or Ubuntu_ based Linux distribution getting the executable requirements is as easy as::
$ apt-get install tesseract-ocr unpaper python-virtualenv ghostscript -y
To initialize a ``virtualenv`` to deploy the project do::
$ virtualenv --no-site-packages mayan
Download_ and uncompress the latest version of Mayan::
$ cd mayan
$ tar -xvzf mayan.tar.gz
Or clone the latest development version straight from github::
$ cd mayan
$ git clone git://github.com/rosarior/mayan.git
To install the python depencies ``easy_install`` can be used, however for easier retrieval a production dependencies file is included, to use it execute::
$ cd mayan
$ source ../bin/activate
$ pip install -r requirements/production.txt
Create the database that will hold the data. Install any corresponding python database drivers. Update the settings.py file with you database settings.
If using the ``MySQL`` database manager, use the following commands::
$ apt-get install python-dev libmysqlclient-dev gcc -y
$ pip install MySQL-python
Populate the database with the project's schema doing::
$ ./manage.py syncdb
After that deploy it using the webserver of your preference. Using your are using Apache_, a sample site file is included under the contrib directory.
.. _Apache: https://www.apache.org/
.. _Debian: http://www.debian.org/
.. _Ubuntu: http://www.ubuntu.com/
.. _Download: https://github.com/rosarior/mayan/archives/master

14
docs/license.rst Normal file
View File

@@ -0,0 +1,14 @@
=======
License
=======
Mayan EDMS is distributed under the `GNU GPL Version 3.0 License`_.
The complete license terms are included below.
.. _`GNU GPL Version 3.0 License`: https://www.gnu.org/licenses/gpl-3.0.html
License terms
=============
.. include:: LICENSE

155
docs/make.bat Normal file
View File

@@ -0,0 +1,155 @@
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
if NOT "%PAPER%" == "" (
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
)
if "%1" == "" goto help
if "%1" == "help" (
:help
echo.Please use `make ^<target^>` where ^<target^> is one of
echo. html to make standalone HTML files
echo. dirhtml to make HTML files named index.html in directories
echo. singlehtml to make a single large HTML file
echo. pickle to make pickle files
echo. json to make JSON files
echo. htmlhelp to make HTML files and a HTML help project
echo. qthelp to make HTML files and a qthelp project
echo. devhelp to make HTML files and a Devhelp project
echo. epub to make an epub
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
echo. text to make text files
echo. man to make manual pages
echo. changes to make an overview over all changed/added/deprecated items
echo. linkcheck to check all external links for integrity
echo. doctest to run all doctests embedded in the documentation if enabled
goto end
)
if "%1" == "clean" (
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
del /q /s %BUILDDIR%\*
goto end
)
if "%1" == "html" (
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
goto end
)
if "%1" == "dirhtml" (
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
goto end
)
if "%1" == "singlehtml" (
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
echo.
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
goto end
)
if "%1" == "pickle" (
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
echo.
echo.Build finished; now you can process the pickle files.
goto end
)
if "%1" == "json" (
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
echo.
echo.Build finished; now you can process the JSON files.
goto end
)
if "%1" == "htmlhelp" (
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
echo.
echo.Build finished; now you can run HTML Help Workshop with the ^
.hhp project file in %BUILDDIR%/htmlhelp.
goto end
)
if "%1" == "qthelp" (
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\MayanEDMS.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MayanEDMS.ghc
goto end
)
if "%1" == "devhelp" (
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
echo.
echo.Build finished.
goto end
)
if "%1" == "epub" (
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
echo.
echo.Build finished. The epub file is in %BUILDDIR%/epub.
goto end
)
if "%1" == "latex" (
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
echo.
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
goto end
)
if "%1" == "text" (
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
echo.
echo.Build finished. The text files are in %BUILDDIR%/text.
goto end
)
if "%1" == "man" (
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
echo.
echo.Build finished. The manual pages are in %BUILDDIR%/man.
goto end
)
if "%1" == "changes" (
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
echo.
echo.The overview file is in %BUILDDIR%/changes.
goto end
)
if "%1" == "linkcheck" (
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
echo.
echo.Link check complete; look for any errors in the above output ^
or in %BUILDDIR%/linkcheck/output.txt.
goto end
)
if "%1" == "doctest" (
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
echo.
echo.Testing of doctests in the sources finished, look at the ^
results in %BUILDDIR%/doctest/output.txt.
goto end
)
:end

57
docs/requirements.rst Normal file
View File

@@ -0,0 +1,57 @@
============
Requirements
============
Mayan EDMS supports various levels of functionality because of this
requirements can vary for each individual deployment.
Basic requirements
==================
Python:
* ``Django`` - A high-level Python Web framework that encourages rapid development and clean, pragmatic design.
* ``django-pagination``
* ``django-filetransfers`` - File upload/download abstraction
* ``django-mptt`` - Utilities for implementing a modified pre-order traversal tree in django
* ``django-taggit`` - Simple tagging for django
* ``slate`` - The simplest way to extract text from PDFs in Python
Execute pip install -r requirements/production.txt to install the python/django dependencies automatically.
Executables:
* ``tesseract-ocr`` - An OCR Engine that was developed at HP Labs between 1985 and 1995... and now at Google.
* ``unpaper`` - post-processing scanned and photocopied book pages
Optional requirements
=====================
To enable distributed OCR support
---------------------------------
* ``celery`` - asynchronous task queue/job queue based on distributed message passing
* ``django-celery`` - ``celery`` Django integration
To store documents in a GridFS database
---------------------------------------
* ``PyMongo`` - the recommended way to work with ``MongoDB`` from Python
* ``GridFS`` - a storage specification for large objects in ``MongoDB``
* ``MongoDB`` - a scalable, open source, document-oriented database
Enchanced MIME detection
------------------------
* ``libmagic`` - MIME detection library, if not installed Mayan will fall back to using python's simpler mimetype built in library
* ``python-magic`` - A python wrapper for libmagic
Image conversion backends
-------------------------
Mayan has the ability to switch between different image conversion backends, at the moment these three are supported:
* ``ImageMagick`` - Convert, Edit, Or Compose Bitmap Images.
* ``GraphicMagick`` - Robust collection of tools and libraries to read, write, and manipulate an image.
* Python only - Relies on ``PIL`` to support a limited set of the most common graphics formats.
By default the python backend is used.

26
docs/updates.rst Normal file
View File

@@ -0,0 +1,26 @@
============================
Changes, updates and credits
============================
Changelog
=========
.. include:: changelog.rst
Credits
=======
.. include:: credits.rst
.. _helping-out:
Contributors
============
How to contribute?
------------------
You can help further the development of Mayan EDMS by reporting bugs, submitting documentation, patches, with monetary or hardware donations.
.. include:: contributors.txt