From fb45a6c3c965ef7678be7d3d488e05a545797a16 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Sat, 12 Jul 2014 03:03:26 -0400 Subject: [PATCH] Update documentation --- HISTORY.rst | 17 +- docs/{topics => _static}/ACL.png | Bin docs/{topics => _static}/index_instance.png | Bin docs/{topics => _static}/index_template.png | Bin docs/{topics => _static}/indexes.png | Bin docs/{topics => _static}/mayan-login.png | Bin docs/{topics => _static}/no-icons.png | Bin docs/{topics => _static}/permissions.png | Bin docs/{topics => _static}/themes.png | Bin docs/{topics => _static}/versioning.png | Bin docs/intro/installation.rst | 49 ++-- docs/releases/1.0.rst | 19 +- docs/releases/index.rst | 2 - docs/topics/customization.rst | 6 +- docs/topics/development.rst | 15 +- docs/topics/file_storage.rst | 4 +- docs/topics/indexes.rst | 12 +- docs/topics/permissions.rst | 18 +- docs/topics/settings.rst | 297 +++++++++----------- docs/topics/versioning.rst | 28 +- 20 files changed, 227 insertions(+), 240 deletions(-) rename docs/{topics => _static}/ACL.png (100%) rename docs/{topics => _static}/index_instance.png (100%) rename docs/{topics => _static}/index_template.png (100%) rename docs/{topics => _static}/indexes.png (100%) rename docs/{topics => _static}/mayan-login.png (100%) rename docs/{topics => _static}/no-icons.png (100%) rename docs/{topics => _static}/permissions.png (100%) rename docs/{topics => _static}/themes.png (100%) rename docs/{topics => _static}/versioning.png (100%) diff --git a/HISTORY.rst b/HISTORY.rst index 78378ba747..b74b54a853 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -1,16 +1 @@ -1.0 (XX/07/2014) -================ - -- New repository: https://github.com/mayan-edms/mayan-edms -- Update required version of Django to 1.6 -- Translation update and inclusion of new languages -- Use of related_name in some models -- Removal of circular imports -- Removal of included 3rd party modules -- Automatic testing and code coverage check -- Update of required modules and libraries versions -- Database connection leaks fixes -- Deletion of detached signatures -- Removal of fabric based installations -- New project structure -- New API system, browseable API, browseable API documentation +.. include:: docs/releases/1.0.rest diff --git a/docs/topics/ACL.png b/docs/_static/ACL.png similarity index 100% rename from docs/topics/ACL.png rename to docs/_static/ACL.png diff --git a/docs/topics/index_instance.png b/docs/_static/index_instance.png similarity index 100% rename from docs/topics/index_instance.png rename to docs/_static/index_instance.png diff --git a/docs/topics/index_template.png b/docs/_static/index_template.png similarity index 100% rename from docs/topics/index_template.png rename to docs/_static/index_template.png diff --git a/docs/topics/indexes.png b/docs/_static/indexes.png similarity index 100% rename from docs/topics/indexes.png rename to docs/_static/indexes.png diff --git a/docs/topics/mayan-login.png b/docs/_static/mayan-login.png similarity index 100% rename from docs/topics/mayan-login.png rename to docs/_static/mayan-login.png diff --git a/docs/topics/no-icons.png b/docs/_static/no-icons.png similarity index 100% rename from docs/topics/no-icons.png rename to docs/_static/no-icons.png diff --git a/docs/topics/permissions.png b/docs/_static/permissions.png similarity index 100% rename from docs/topics/permissions.png rename to docs/_static/permissions.png diff --git a/docs/topics/themes.png b/docs/_static/themes.png similarity index 100% rename from docs/topics/themes.png rename to docs/_static/themes.png diff --git a/docs/topics/versioning.png b/docs/_static/versioning.png similarity index 100% rename from docs/topics/versioning.png rename to docs/_static/versioning.png diff --git a/docs/intro/installation.rst b/docs/intro/installation.rst index 99aa762589..0d228893f8 100644 --- a/docs/intro/installation.rst +++ b/docs/intro/installation.rst @@ -15,35 +15,21 @@ If using a Fedora_ based Linux distribution get the executable requirements usin $ sudo yum install -y git gcc tesseract unpaper python-virtualenv ghostscript libjpeg-turbo-devel libpng-devel poppler-util python-devel -Initialize a ``virtualenv`` to deploy the project:: +Initialize a ``virtualenv`` to deploy the project: - $ virtualenv --no-site-packages venv +.. code-block:: bash + + $ virtualenv venv $ source venv/bin/activate + $ pip install mayan-edms==1.0.rc1 -Download_ and decompress the latest version of **Mayan EDMS**:: +By default **Mayan EDMS** will create a single file SQLite_ database which makes +is very easy to start using **Mayan EDMS**. Populate the database with the project's schema doing: - $ cd venv - $ tar -xvzf mayan.tar.gz +.. code-block:: bash -Or clone the latest development version straight from github:: - - $ cd venv - $ git clone https://github.com/mayan-edms/mayan-edms.git - -To install the python dependencies ``easy_install`` can be used, however for easier retrieval a production dependencies file is included, to use it execute:: - - $ cd mayan-edms - $ pip install -r requirements.txt - -By default **Mayan EDMS** will create a single file SQLite_ database which makes is very easy to start using **Mayan EDMS**. -Populate the database with the project's schema doing:: - - $ ./manage.py syncdb --migrate --noinput - - -To test your installation, execute Django’s development server using the ``runserver`` command to launch a local instance of **Mayan EDMS**:: - - $ ./manage.py runserver + $ mayan-edms.py syncdb --migrate --noinput + $ mayan-edms.py runserver Point your browser to http://127:0.0.1:8000, if everything was installed correctly you should see the login screen and panel showing a randomly generated admin password. @@ -52,6 +38,21 @@ correctly you should see the login screen and panel showing a randomly generated Production use -------------- +To create a custom settings file for **Mayan EDMS**, create your a Python (.py) file +in the directory: venv/mayan/settings/ with the following basic content:: + + # my_settings.py + + from __future__ import absolute_import + + from .local import * + + + +Then test your settings launch **Mayan EDMS** use:: + + $ mayan-edms runserver --settings=mayan.settings.my_settings + After making sure everything is running correctly, stop the runserver command. Deploy **Mayan EDMS** using the webserver of your preference. For more information on deployment instructions and examples checkout Django's official documentation diff --git a/docs/releases/1.0.rst b/docs/releases/1.0.rst index aa59630378..b0932bce80 100644 --- a/docs/releases/1.0.rst +++ b/docs/releases/1.0.rst @@ -115,6 +115,17 @@ Mayan EDMS is now licensed under the Apache 2.0 license. This means many things but the main change is that inclusion of Mayan EDMS into commercial products is now explicitly allowed. +PyPI package +~~~~~~~~~~~~ +**Mayan EDMS** has been packaged and submitted to the PyPI_ Python Package Index +making it even easier to install and use. + +New REST API +~~~~~~~~~~~~ +This release feature a completely new REST API and automatic API documentation. +This new API is also used internally by *Mayan EDMS* itself. + +:q Upgrading from a previous version ================================= If you installed Mayan EDMS by cloning the Git repository issue the commands:: @@ -143,9 +154,15 @@ The upgrade procedure is now complete. Backward incompatible changes ============================= -* If using the SQLite3 database option, rename the file named `mayan.sqlite` file to `db.sqlite3` +* If using the SQLite3 database option, rename the file named `mayan.sqlite` file to `db.sqlite3` and + move it to the new `media` provided folder. +* Also move to the `media` folder any `gpg_home`, `document_storage` and `image_cache` folders + from your previous installation. Bugs fixed or issues closed =========================== * None + + +.. _PyPI: https://pypi.python.org/pypi/mayan-edms/ diff --git a/docs/releases/index.rst b/docs/releases/index.rst index e0d817779d..3e6df7ea50 100644 --- a/docs/releases/index.rst +++ b/docs/releases/index.rst @@ -17,8 +17,6 @@ Final releases Below are release notes through **Mayan EDMS** |version| and its minor releases. Newer versions of the documentation contain the release notes for any later releases. -.. _development_release_notes: - 1.0 release ----------- .. toctree:: diff --git a/docs/topics/customization.rst b/docs/topics/customization.rst index e49d7a1f34..9598ccdd3a 100644 --- a/docs/topics/customization.rst +++ b/docs/topics/customization.rst @@ -15,7 +15,7 @@ an organtization existing applications' look and feel. The theme can be changed very easily by setting the :setting:`WEB_THEME_THEME` configuration option to one of its valid values. -.. image:: themes.png +.. image:: ../_static/themes.png :alt: themes ------------ @@ -25,7 +25,7 @@ The amount of information presented at the login screen can also be restricted for security or design reasons using :setting:`WEB_THEME_VERBOSE_LOGIN` configuration option. -.. image:: mayan-login.png +.. image:: ../_static/mayan-login.png :alt: mayan login screen ----------- @@ -43,7 +43,7 @@ Some themes such as ``default`` might be more visually appealing to some people without the menu icons, for this **Mayan EDMS** provides the :setting:`MAIN_DISABLE_ICONS` configuration option. -.. image:: no-icons.png +.. image:: ../_static/no-icons.png :alt: mayan screens with out icons .. _`Andrea Franz's excellent web app template`: https://github.com/pilu/web-app-theme diff --git a/docs/topics/development.rst b/docs/topics/development.rst index 9d4aec0296..d4cf4cf473 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -12,9 +12,7 @@ issue on the `GitHub issue tracker`_. To submit patches, please send a pull requ .. _GitHub: https://github.com/mayan-edms/mayan-edms/ .. _`GitHub issue tracker`: https://github.com/mayan-edms/mayan-edms/issues -.. _scm: --------------- Source Control -------------- @@ -48,10 +46,19 @@ When submitting patches, please place your feature/change in its own branch prio .. _git-flow: https://github.com/nvie/gitflow .. _Downloads: https://github.com/mayan-edms/mayan-edms/archives/master -.. _docs: + +Contributing changes +-------------------- +Once your have create and committed some new code or feature, submit a Pull Request. +Be sure to merge with mayan-edms/master before doing a pull request so that patches +apply as cleanly as possible. If there are no conflicts, Pull Requests can be merged +directly from Github otherwise a manual command line merge has to be done and +your patches might take longer to get merged. + +For more information on how to create Pull Request read: https://help.github.com/articles/using-pull-requests +or the quick version: https://help.github.com/articles/creating-a-pull-request ---------- Debugging --------- diff --git a/docs/topics/file_storage.rst b/docs/topics/file_storage.rst index 8d980a15cf..127bc1e484 100644 --- a/docs/topics/file_storage.rst +++ b/docs/topics/file_storage.rst @@ -8,7 +8,7 @@ and stored in a simple flat arrangement in a directory. This doesn't stop access to the files but it is not recommended because moving, renaming or updating the files directly would throw the database out of sync. For direct access to the files the recommended way is to create an -:doc:`index `, use the indexing mirroring feature and share the result via +:doc:`index `, use the indexing mirroring feature and share the result via file serving software [#f1]_. **Mayan EDMS** components are as decoupled from each other as possible, @@ -19,7 +19,7 @@ storage, so that **Mayan EDMS** can work saving files locally, over the network or even across the internet and still operate exactly the same. The file storage behavior is controlled by the :setting:`DOCUMENTS_STORAGE_BACKEND` -and should be set to a class or subclass of Django's ``django.core.files.storage.FileSystemStorage`` class. +and should be set to a class or subclass of Django's ``django.core.files.storage.Storage`` class. .. rubric:: Footnotes diff --git a/docs/topics/indexes.rst b/docs/topics/indexes.rst index 717773e637..a1c6bd66c9 100644 --- a/docs/topics/indexes.rst +++ b/docs/topics/indexes.rst @@ -16,7 +16,7 @@ Each branch can be a pseudo folder, which can hold other child 'folders' or a document container which will have all the links to the documents that matched the path to reach the document container. -.. image:: index_template.png +.. image:: ../_static/index_template.png :alt: index template Index instances @@ -26,7 +26,7 @@ The template is the skeleton from which an instance of the index is then auto-populated with links to the documents depending on the rules of each branch of the index evaluated against the metadata and properties of the documents. -.. image:: index_instance.png +.. image:: ../_static/index_instance.png :alt: index instance Index serving @@ -35,7 +35,7 @@ Index serving Indexes can be mirrored to the operating system filesystem using the configuration option :setting:`DOCUMENT_INDEXING_FILESYSTEM_SERVING`. - + ``settings_local.py``:: # Supposing the 'Sample index' internal name is 'sample_index' @@ -44,9 +44,9 @@ using the configuration option } This creates an actual directory tree and links to the actual stored files but using -the filename of the documents as stored in the database. +the filename of the documents as stored in the database. -.. image:: indexes.png +.. image:: ../_static/indexes.png :alt: indexes diagram This filesystem mirror of the index can them be served with Samba_ across the @@ -57,7 +57,7 @@ The index cannot be edited manually to protect it's integrity, only changing the rules or the metadata of the documents would cause the index to be regenerated. For manual organization of documents there are the folders, their structure is however flat, and they have to be manually updated and -curated. +curated. .. _Samba: http://www.samba.org/ diff --git a/docs/topics/permissions.rst b/docs/topics/permissions.rst index 9e79af09e2..1d5d2387f6 100644 --- a/docs/topics/permissions.rst +++ b/docs/topics/permissions.rst @@ -2,7 +2,7 @@ Permissions =========== -**Mayan EDMS** provides very exact control over what activies users can +**Mayan EDMS** provides very exact control over what activies users can perform. This control is divided into two levels of operation: 2 tier permissions assignement @@ -16,13 +16,13 @@ this method could be thought out as a global permission granting level. Example: Roles being granted the ``Document view`` permission will be able to view **all** documents in existance. -.. image:: permissions.png +.. image:: ../_static/permissions.png :alt: 2-tier permission diagram - - + + 3 tier access control ===================== - + When more control is desired over which objects actors(user, groups and roles) can exercise an action this method should be used. Under this level, actors are granted a @@ -30,9 +30,9 @@ permission but only in relation to a selected object. Example: Granting user ``Joe`` the ``Document view`` access control for document ``Payroll``, would allow him to view this document only. -.. image:: ACL.png +.. image:: ../_static/ACL.png :alt: 3-tier access control diagram - + The permission system enforces inheritance by first checking if the user has a global permission, is a member of a group or a role that has a global permission and if not then checks to see if that user, a group or role to @@ -51,13 +51,13 @@ One of the specifics of the 3 tier access control in contrast with the 2 tier ac **Example 1.** Each user have to access only the documents that he uploads -The example will show how to restrict a user in order not to view documents uploaded by other users, but only by himself. For that purpose we have to restrict the access to something that does not exist yet. The system must know that before the actual upload in order to act accordingly. This is where Default ACLs come in place. +The example will show how to restrict a user in order not to view documents uploaded by other users, but only by himself. For that purpose we have to restrict the access to something that does not exist yet. The system must know that before the actual upload in order to act accordingly. This is where Default ACLs come in place. Follow the steps: 1. Enter **Mayan EDMS** with user that has administrative rights. 2. Go to Setup menu. Enter Default ACLs submenu. 3. Click ``New holder`` next to the class Documents. From the list of users choose the special user Creator. Give the permission ``View Documents`` to the Creator. - 4. Go back to Setup menu. Go to Users and create the users ``Pedro`` and ``Sancho``. + 4. Go back to Setup menu. Go to Users and create the users ``Pedro`` and ``Sancho``. 5. Go back to Setup menu. Go to Groups and create the group ``Employees``. Click to members of the groups and add ``Pedro`` and ``Sancho`` to that group. 6. Go back to Setup menu. Go to Roles submenu. Create the role ``Uploaders``. Give the permission ``Create documents`` to the role. Add the group ``Employees`` as a member to that role. 7. Now enter **Mayan EDMS** with ``Pedro`` and ``Sancho`` one after another and upload documents. Pedro should not see the documents that ``Sancho`` uploaded and vice versa. He should see only documents uploaded by himself. diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index ea60c91886..a551b30def 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -30,15 +30,15 @@ The function that will be used to internally identify each uploaded document. **DOCUMENTS_STORAGE_BACKEND** -Default: ``FileBasedStorage`` class +Default: ``storages.backends.filebasedstorage.FileBasedStorage`` -The storage backend that will be used to store every document. +The full path to the storage backend class that will be used to store every document and document signatures. .. setting:: DOCUMENTS_PREVIEW_SIZE **DOCUMENTS_PREVIEW_SIZE** - + Default: ``640x480`` Size of the document list and recent document list previews. @@ -47,11 +47,11 @@ Size of the document list and recent document list previews. .. setting:: DOCUMENTS_PRINT_SIZE **DOCUMENTS_PRINT_SIZE** - -Default: ``1400`` - -.. setting:: DOCUMENTS_MULTIPAGE_PREVIEW_SIZE +Default: ``1400`` + + +.. setting:: DOCUMENTS_MULTIPAGE_PREVIEW_SIZE **DOCUMENTS_MULTIPAGE_PREVIEW_SIZE** @@ -61,71 +61,71 @@ Default: ``160x120`` .. setting:: DOCUMENTS_THUMBNAIL_SIZE **DOCUMENTS_THUMBNAIL_SIZE** - -Default: ``50x50`` - -.. setting:: DOCUMENTS_DISPLAY_SIZE +Default: ``50x50`` + + +.. setting:: DOCUMENTS_DISPLAY_SIZE **DOCUMENTS_DISPLAY_SIZE** - + Default: ``1200`` - + .. setting:: DOCUMENTS_RECENT_COUNT **DOCUMENTS_RECENT_COUNT** - -Default: ``40`` - + +Default: ``40`` + Maximum number of recent (created, edited, viewed) documents to -remember per user. - +remember per user. + .. setting:: DOCUMENTS_ZOOM_PERCENT_STEP **DOCUMENTS_ZOOM_PERCENT_STEP** - -Default: ``50`` - -Amount in percent zoom in or out a document page per user interaction. - - -.. setting:: DOCUMENTS_ZOOM_MAX_LEVEL + +Default: ``50`` + +Amount in percent zoom in or out a document page per user interaction. + + +.. setting:: DOCUMENTS_ZOOM_MAX_LEVEL **DOCUMENTS_ZOOM_MAX_LEVEL** - -Default: ``200`` - + +Default: ``200`` + Maximum amount in percent (%) to allow user to zoom in a document page interactively. - + .. setting:: DOCUMENTS_ZOOM_MIN_LEVEL **DOCUMENTS_ZOOM_MIN_LEVEL** - -Default: ``50`` - + +Default: ``50`` + Minimum amount in percent (%) to allow user to zoom out a document page interactively. - + .. setting:: DOCUMENTS_ROTATION_STEP **DOCUMENTS_ROTATION_STEP** - -Default: ``90`` - -Amount in degrees to rotate a document page per user interaction. - - + +Default: ``90`` + +Amount in degrees to rotate a document page per user interaction. + + .. setting:: DOCUMENTS_CACHE_PATH **DOCUMENTS_CACHE_PATH** - -Default: ``image_cache`` (relative to the installation path) - + +Default: ``image_cache`` (inside the `media` folder) + The path where the visual representations of the documents are stored for fast display. - + Converter ========= @@ -133,19 +133,19 @@ Converter **CONVERTER_GRAPHICS_BACKEND** -Default: ``converter.backends.python`` - +Default: ``converter.backends.python.Python`` + Graphics conversion backend to use. Options are: -* ``converter.backends.imagemagick`` - Wrapper for ImageMagick +* ``converter.backends.imagemagick.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 + +* ``converter.backends.graphicsmagick.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_ +* ``converter.backends.python.Python`` - Wrapper for Pillow_ and Ghostscript_ .. _Pillow: http://pypi.python.org/pypi/Pillow @@ -155,36 +155,36 @@ Graphics conversion backend to use. Options are: .. setting:: CONVERTER_IM_CONVERT_PATH **CONVERTER_IM_CONVERT_PATH** - + Default: ``/usr/bin/convert`` - -File path to imagemagick's convert program. - - -.. setting:: CONVERTER_IM_IDENTIFY_PATH - + +File path to imagemagick's convert program. + + +.. setting:: CONVERTER_IM_IDENTIFY_PATH + **CONVERTER_IM_IDENTIFY_PATH** Default: ``/usr/bin/identify`` -File path to imagemagick's identify program. - - -.. setting:: CONVERTER_GM_PATH +File path to imagemagick's identify program. + + +.. setting:: CONVERTER_GM_PATH **CONVERTER_GM_PATH** Default: ``/usr/bin/gm`` - + File path to graphicsmagick's program. - + .. setting:: CONVERTER_GM_SETTINGS **CONVERTER_GM_SETTINGS** Default: None - + Suggested options: ``-limit files 1 -limit memory 1GB -limit map 2GB -density 200`` Set of configuration options to pass to the GraphicsMagick executable to @@ -201,51 +201,30 @@ fine tune it's functionality as explained in the `GraphicsMagick documentation`_ Default: ``/usr/bin/libreoffice`` Path to the libreoffice binary used to call LibreOffice for office document conversion. - - + + Linking ======= .. setting:: LINKING_SHOW_EMPTY_SMART_LINKS **LINKING_SHOW_EMPTY_SMART_LINKS** - + Default: ``True`` - + Show smart links even when they don't return any documents. - + Storage ======= -.. setting:: STORAGE_GRIDFS_HOST - -**STORAGE_GRIDFS_HOST** - -Default: ``localhost`` - - -.. setting:: STORAGE_GRIDFS_PORT - -**STORAGE_GRIDFS_PORT** - -Default: ``27017`` - - -.. setting:: STORAGE_GRIDFS_DATABASE_NAME - -**STORAGE_GRIDFS_DATABASE_NAME** - -Default: ``document_storage`` - - .. setting:: STORAGE_FILESTORAGE_LOCATION **STORAGE_FILESTORAGE_LOCATION** - -Default: ``document_storage`` - + +Default: ``document_storage`` + Document indexing ================= @@ -253,31 +232,31 @@ Document indexing .. setting:: DOCUMENT_INDEXING_AVAILABLE_INDEXING_FUNCTIONS **DOCUMENT_INDEXING_AVAILABLE_INDEXING_FUNCTIONS** - -Default: ``proper_name`` + +Default: ``proper_name`` .. setting:: DOCUMENT_INDEXING_SUFFIX_SEPARATOR **DOCUMENT_INDEXING_SUFFIX_SEPARATOR** - + Default: ``_`` (underscore) - + .. setting:: DOCUMENT_INDEXING_FILESYSTEM_SLUGIFY_PATHS **DOCUMENT_INDEXING_FILESYSTEM_SLUGIFY_PATHS** - -Default: ``False`` - - + +Default: ``False`` + + .. setting:: DOCUMENT_INDEXING_FILESYSTEM_MAX_SUFFIX_COUNT **DOCUMENT_INDEXING_FILESYSTEM_MAX_SUFFIX_COUNT** - -Default: ``1000`` - - + +Default: ``1000`` + + .. setting:: DOCUMENT_INDEXING_FILESYSTEM_SERVING **DOCUMENT_INDEXING_FILESYSTEM_SERVING** @@ -286,81 +265,81 @@ Default: ``{}`` A dictionary that maps the index name and where on the filesystem that index will be mirrored. - + OCR === - + .. setting:: OCR_TESSERACT_PATH **OCR_TESSERACT_PATH** - -Default: ``/bin/tesseract`` + +Default: ``/bin/tesseract`` File path to the ``tesseract`` executable, used to perform OCR on document page's images. - - + + .. setting:: OCR_TESSERACT_LANGUAGE **OCR_TESSERACT_LANGUAGE** - -Default: ``eng`` + +Default: ``eng`` Language code passed to the ``tesseract`` executable. - - + + .. setting:: OCR_REPLICATION_DELAY **OCR_REPLICATION_DELAY** - -Default: ``0`` - + +Default: ``0`` + Amount of seconds to delay OCR of documents to allow for the node's -storage replication overhead. - - +storage replication overhead. + + .. setting:: OCR_NODE_CONCURRENT_EXECUTION **OCR_NODE_CONCURRENT_EXECUTION** - -Default: ``1`` - + +Default: ``1`` + Maximum amount of concurrent document OCRs a node can perform. .. setting:: OCR_AUTOMATIC_OCR **OCR_AUTOMATIC_OCR** - -Default: ``True`` - + +Default: ``True`` + Automatically queue newly created documents or newly uploaded versions of existing documents for OCR. - - + + .. setting:: OCR_QUEUE_PROCESSING_INTERVAL **OCR_QUEUE_PROCESSING_INTERVAL** - -Default: ``10`` + +Default: ``10`` .. setting:: OCR_UNPAPER_PATH **OCR_UNPAPER_PATH** - -Default: ``/usr/bin/unpaper`` - + +Default: ``/usr/bin/unpaper`` + File path to the ``unpaper`` executable, used to clean up images before doing OCR. - + .. setting:: OCR_PDFTOTEXT_PATH **OCR_PDFTOTEXT_PATH** - -Default: ``/usr/bin/pdftotext`` - + +Default: ``/usr/bin/pdftotext`` + File path to ``poppler's`` ``pdftotext`` program used to extract text from PDF files. @@ -372,14 +351,14 @@ Metadata **METADATA_AVAILABLE_FUNCTIONS** -Default: ``current_date`` +Default: ``current_date`` .. setting:: METADATA_AVAILABLE_MODELS **METADATA_AVAILABLE_MODELS** -Default: ``User`` +Default: ``User`` Common @@ -389,10 +368,10 @@ Common **COMMON_TEMPORARY_DIRECTORY** -Default: ``/tmp`` +Default: ``/tmp`` Temporary directory used site wide to store thumbnails, previews -and temporary files. If none is specified, one will be created +and temporary files. If none is specified, one will be created using tempfile.mkdtemp() @@ -400,21 +379,21 @@ using tempfile.mkdtemp() **COMMON_DEFAULT_PAPER_SIZE** -Default: ``Letter`` +Default: ``Letter`` .. setting:: COMMON_DEFAULT_PAGE_ORIENTATION **COMMON_DEFAULT_PAGE_ORIENTATION** -Default: ``Portrait`` +Default: ``Portrait`` .. setting:: COMMON_AUTO_CREATE_ADMIN **COMMON_AUTO_CREATE_ADMIN** -Default: ``True`` +Default: ``True`` Automatically creates an administrator superuser with the username specified by COMMON_AUTO_ADMIN_USERNAME and with the default password @@ -425,7 +404,7 @@ specified by COMMON_AUTO_ADMIN_PASSWORD **COMMON_AUTO_ADMIN_USERNAME** -Default: ``admin`` +Default: ``admin`` Username of the automatically created superuser @@ -437,13 +416,13 @@ Username of the automatically created superuser Default: Random generated password The password of the automatically created superuser - + .. setting:: COMMON_LOGIN_METHOD **COMMON_LOGIN_METHOD** -Default: ``username`` +Default: ``username`` Controls the mechanism used to authenticated user. Options are: ``username``, ``email`` If using the ``email`` login method a proper email authentication backend must used @@ -462,11 +441,11 @@ Allow non authenticated users, access to all views. Search ====== -.. setting:: SEARCH_LIMIT +.. setting:: SEARCH_LIMIT **SEARCH_LIMIT** -Default: ``100`` +Default: ``100`` Maximum amount search hits to fetch and display. @@ -475,9 +454,9 @@ Maximum amount search hits to fetch and display. **SEARCH_RECENT_COUNT** -Default: ``5`` +Default: ``5`` -Maximum number of search queries to remember per user. +Maximum number of search queries to remember per user. Web theme @@ -487,7 +466,7 @@ Web theme **WEB_THEME_THEME** -Default: ``activo`` +Default: ``activo`` CSS theme to apply, options are: ``amro``, ``bec``, ``bec-green``, ``blue``, ``default``, ``djime-cerulean``, ``drastic-dark``, ``kathleene``, ``olive``, @@ -498,7 +477,7 @@ CSS theme to apply, options are: ``amro``, ``bec``, ``bec-green``, ``blue``, **WEB_THEME_VERBOSE_LOGIN** -Default: ``True`` +Default: ``True`` Display extra information in the login screen. @@ -510,7 +489,7 @@ Main **MAIN_SIDE_BAR_SEARCH** -Default: ``False`` +Default: ``False`` Controls whether the search functionality is provided by a sidebar widget or by a menu entry. @@ -519,7 +498,7 @@ Controls whether the search functionality is provided by a sidebar widget or by **MAIN_DISABLE_HOME_VIEW** -Default: ``False`` +Default: ``False`` Disable the home view and redirect users straight to the recent document list as soon as they log in. @@ -528,7 +507,7 @@ Disable the home view and redirect users straight to the recent document list as **MAIN_DISABLE_ICONS** -Default: ``False`` +Default: ``False`` Turns off navigation links' icons. @@ -540,7 +519,7 @@ User management **ROLES_DEFAULT_ROLES** -Default: ``[]`` +Default: ``[]`` A list of existing roles that are automatically assigned to newly created users @@ -548,11 +527,11 @@ A list of existing roles that are automatically assigned to newly created users Signatures ========== -.. setting:: SIGNATURES_KEYSERVERS +.. setting:: SIGNATURES_KEYSERVERS **SIGNATURES_KEYSERVERS** -Default: ``['pool.sks-keyservers.net']`` +Default: ``['pool.sks-keyservers.net']`` List of keyservers to be queried for unknown keys. diff --git a/docs/topics/versioning.rst b/docs/topics/versioning.rst index 5aa6dedee9..f8e170532f 100644 --- a/docs/topics/versioning.rst +++ b/docs/topics/versioning.rst @@ -2,24 +2,24 @@ Document versioning =================== -**Mayan EDMS** has the ability to store different versions of the same -document. Users are provided with a very comprehensive but easy to use -version numbering system that allows specifying a major, minor or micro +**Mayan EDMS** has the ability to store different versions of the same +document. Users are provided with a very comprehensive but easy to use +version numbering system that allows specifying a major, minor or micro version number increase. -.. image:: versioning.png +.. image:: ../_static/versioning.png :alt: versioning diagram -A comment field is also provided to allow users -to summarize the new verdion changes in comparison with the previous -one. If a new version was uploded by mistake or such new version is no -longer necessary **Mayan EDMS** provides the option to revert to a previous +A comment field is also provided to allow users +to summarize the new verdion changes in comparison with the previous +one. If a new version was uploded by mistake or such new version is no +longer necessary **Mayan EDMS** provides the option to revert to a previous version of the document. -To upload a new document version, select an existing document, click on the -version tab of the document, and click on the 'upload new version' on the -side bar. A new view very similar to the new document upload view will -appear show the same interactive document sources that have been defined, -but with new options to specify the new version number and an optional -comment. +To upload a new document version, select an existing document, click on the +version tab of the document, and click on the 'upload new version' on the +side bar. A new view very similar to the new document upload view will +appear show the same interactive document sources that have been defined, +but with new options to specify the new version number and an optional +comment.