Documentation updates

docs/topics/development.rst

@@ -51,9 +51,9 @@ To familiarize yourself with the technical details of the project read the :ref:
 
 .. _docs:
 
------------------
+-------------
 Documentation
------------------
+-------------
 
 The documentation is written in `reStructured Text`_ format.
 
@@ -74,8 +74,51 @@ You can also generate the documentation in format other than HTML.
 .. _Sphinx: http://sphinx.pocoo.org
 
 
----------------
+------------
 Translations
----------------
+------------
 
 Translations are now being handled online via the **Transifex** website: https://www.transifex.net/projects/p/mayan-edms/
+To create a translation team for a new language or contribute to an already
+existing language translation, create a **Transifex** account and contact
+the team coordinator of the respective language in which you are interested.
+
+---------
+Debugging
+---------
+
+**Mayan EDMS** makes extensive use of Django's new `logging capabilities`_.
+To enable debug logging for the documents app for example add the following
+lines to your ``settings_local.py`` file::
+
+    LOGGING = {
+        'version': 1,
+        'disable_existing_loggers': True,
+        'formatters': {
+            'verbose': {
+                'format': '%(levelname)s %(asctime)s %(name)s %(process)d %(thread)d %(message)s'
+            },
+            'intermediate': {
+                'format': '%(name)s <%(process)d> [%(levelname)s] "%(funcName)s() %(message)s"'
+            },
+            'simple': {
+                'format': '%(levelname)s %(message)s'
+            },
+        },    
+        'handlers': {
+            'console':{
+                'level':'DEBUG',
+                'class':'logging.StreamHandler',
+                'formatter': 'intermediate'
+            }
+        },
+        'loggers': {
+            'documents': {
+                'handlers':['console'],
+                'propagate': True,
+                'level':'DEBUG',
+            },            
+        }
+    }
+
+.. _`logging capabilities`: https://docs.djangoproject.com/en/dev/topics/logging

docs/topics/document_visualization.rst

@@ -7,8 +7,9 @@ The philosophy in place is to try to avoid having users download a documents and
 **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_ (more information about ``unoconv`` can be found in the :doc:`FAQ section <../faq/index>`)
+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
@@ -17,7 +18,7 @@ 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
+(thumbnail, page preview, full preview) and rotated interactively
 in the details view.
 
 
@@ -31,4 +32,6 @@ before they can be previewed and text can be extracted.
 
 
 .. _PDF: http://en.wikipedia.org/wiki/Portable_Document_Format
-.. _Libreoffice: http://www.libreoffice.org/
+.. _LibreOffice: http://www.libreoffice.org/
+.. _unoconv: https://github.com/dagwieers/unoconv/
+.. _supervisor: http://supervisord.org/introduction.html

docs/topics/settings.rst

@@ -129,7 +129,29 @@ The path where the visual representations of the documents are stored for fast d
 
 Converter
 =========
+.. setting:: CONVERTER_GRAPHICS_BACKEND
+
+**CONVERTER_GRAPHICS_BACKEND**
+
+Default: ``converter.backends.python``    
     
+Graphics conversion backend to use. Options are:
+
+* ``converter.backends.imagemagick`` - Wrapper for ImageMagick
+
+  * Use the :setting:`CONVERTER_IM_CONVERT_PATH` and :setting:`CONVERTER_IM_IDENTIFY_PATH` to specify the binary files locations.
+  
+* ``converter.backends.graphicsmagick`` - Wrapper for GraphicsMagick
+
+  * Use the :setting:`CONVERTER_GM_PATH` and :setting:`CONVERTER_GM_SETTINGS` to specify the binary file location and customized settings.
+
+* ``converter.backends.python`` - Wrapper for Pillow_ and Ghostscript_
+
+
+.. _Pillow: http://pypi.python.org/pypi/Pillow
+.. _Ghostscript: http://www.ghostscript.com/
+
+
 .. setting:: CONVERTER_IM_CONVERT_PATH
 
 **CONVERTER_IM_CONVERT_PATH**
@@ -170,18 +192,6 @@ fine tune it's functionality as explained in the `GraphicsMagick documentation`_
 
 .. _GraphicsMagick documentation: http://www.graphicsmagick.org/convert.html#conv-opti
 
-
-.. setting:: CONVERTER_GRAPHICS_BACKEND
-
-**CONVERTER_GRAPHICS_BACKEND**
-
-Default: ``converter.backends.python``    
-    
-Graphics conversion backend to use. Options are:
-
-* ``converter.backends.imagemagick`` - Wrapper for ImageMagick
-* ``converter.backends.graphicsmagick`` - Wrapper for GraphicsMagick
-* ``converter.backends.python`` - Wrapper for Pillow and Ghostscript
     
 .. setting:: CONVERTER_UNOCONV_PATH
 

docs/topics/smart_links.rst

@@ -4,6 +4,6 @@ Smart links
 
 Smart links are usefull for navigation between documents.  They are rule
 based but don't created any organizational structure just show the documents
-that match the rules as evaluated against the metadata of currently
+that match the rules as evaluated against the metadata of the currently
 displayed document.  The index is global, the smart links are dependant
 on the current document the user is viewing.