Remove bold markup from all mentions of "Mayan EDMS"
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
Access control lists
|
||||
====================
|
||||
|
||||
Besides the permissions system explained in :doc:`permissions`, **Mayan EDMS**
|
||||
Besides the permissions system explained in :doc:`permissions`, Mayan EDMS
|
||||
provides per object permission granting. This feature is used to grant a
|
||||
permission to a role, but this permission can only be executed for a limited
|
||||
number of objects (documents, folders, tags) instead of being effective
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
App creation
|
||||
============
|
||||
|
||||
**Mayan EDMS** apps are essentially Django app with some extra code to register
|
||||
Mayan EDMS apps are essentially Django app with some extra code to register
|
||||
navigation, permissions and other relationships.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ App modules
|
||||
|
||||
- api_views.py
|
||||
|
||||
REST API views go here. **Mayan EDMS** uses Django REST Framework API view
|
||||
REST API views go here. Mayan EDMS uses Django REST Framework API view
|
||||
classes.
|
||||
|
||||
- apps.py
|
||||
@@ -135,7 +135,7 @@ Views
|
||||
=====
|
||||
|
||||
The module common.generics provides custom generic class based views to be used.
|
||||
The basic views used to create, edit, view and delete objects in **Mayan EDMS**
|
||||
The basic views used to create, edit, view and delete objects in Mayan EDMS
|
||||
are: SingleObjectCreateView, SingleObjectDetailView, SingleObjectEditView,
|
||||
and SingleObjectListView
|
||||
|
||||
|
||||
@@ -15,14 +15,14 @@ Search for information in the `archives of the mayan-edms mailing list`_, or
|
||||
`post a question`_. If you prefer news servers, use the gateway provided by
|
||||
Gmane_.
|
||||
|
||||
**Mayan EDMS** community developers do their best to reply to basic questions.
|
||||
Mayan EDMS community developers do their best to reply to basic questions.
|
||||
Be sure to check the list archives as it may already containt the answers to
|
||||
your questions.
|
||||
|
||||
Twitter
|
||||
-------
|
||||
|
||||
**Mayan EDMS** has an official Twitter account, `@mayanedms
|
||||
Mayan EDMS has an official Twitter account, `@mayanedms
|
||||
<http://twitter.com/mayanedms>`_, which is used for announcements and occasional
|
||||
related news tidbits.
|
||||
|
||||
@@ -30,7 +30,7 @@ related news tidbits.
|
||||
Bugs/ticket tracker
|
||||
-------------------
|
||||
|
||||
Report bugs with **Mayan EDMS** or search existing ones using Github's `ticket tracker`_.
|
||||
Report bugs with Mayan EDMS or search existing ones using Gitlab's `ticket tracker`_.
|
||||
|
||||
|
||||
.. _archives of the mayan-edms mailing list: http://groups.google.com/group/mayan-edms/
|
||||
|
||||
@@ -8,7 +8,7 @@ Contributors
|
||||
How to contribute?
|
||||
------------------
|
||||
|
||||
You can help further the development of **Mayan EDMS** by testing, reporting
|
||||
You can help further the development of Mayan EDMS by testing, reporting
|
||||
bugs, submitting documentation or code patches.
|
||||
|
||||
Lead developer
|
||||
|
||||
@@ -5,7 +5,7 @@ Deploying
|
||||
OS "bare metal"
|
||||
===============
|
||||
|
||||
Like other Django based projects **Mayan EDMS** can be deployed in a wide variety
|
||||
Like other Django based projects Mayan EDMS can be deployed in a wide variety
|
||||
of ways. The method provided below is only a bare minimum example.
|
||||
These instructions are independent of the instructions mentioned in the
|
||||
:doc:`installation` chapter but assume you have already made a test install to
|
||||
@@ -109,7 +109,7 @@ Create the directory for the uWSGI log files::
|
||||
|
||||
mkdir /var/log/uwsgi
|
||||
|
||||
Create the NGINX site file for **Mayan EDMS**, ``/etc/nginx/sites-available/mayan``::
|
||||
Create the NGINX site file for Mayan EDMS, ``/etc/nginx/sites-available/mayan``::
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
@@ -134,7 +134,7 @@ Create the NGINX site file for **Mayan EDMS**, ``/etc/nginx/sites-available/maya
|
||||
}
|
||||
}
|
||||
|
||||
Enable the NGINX site for **Mayan EDMS**::
|
||||
Enable the NGINX site for Mayan EDMS::
|
||||
|
||||
ln -s /etc/nginx/sites-available/mayan /etc/nginx/sites-enabled/
|
||||
|
||||
@@ -198,7 +198,7 @@ Deploy the Docker image stack::
|
||||
docker run --name redis -d redis
|
||||
docker run --name mayan-edms -p 80:80 --link postgres:postgres --link redis:redis -e POSTGRES_DB=mayan -e POSTGRES_USER=mayan -e POSTGRES_PASSWORD=mysecretpassword -v /usr/local/lib/python2.7/dist-packages/mayan/media -d mayanedms/monolithic
|
||||
|
||||
After the **Mayan EDMS** container finishes initializing (about 5 minutes), it will
|
||||
After the Mayan EDMS container finishes initializing (about 5 minutes), it will
|
||||
be available by browsing to http://127.0.0.1. You can inspect the initialization
|
||||
with::
|
||||
|
||||
@@ -242,7 +242,7 @@ Launch the entire stack (Postgres, Redis, and Mayan EDMS) using::
|
||||
|
||||
docker-compose -f docker-compose.yml -p mayanedms up -d
|
||||
|
||||
After the **Mayan EDMS** container finishes initializing (about 5 minutes), it will
|
||||
After the Mayan EDMS container finishes initializing (about 5 minutes), it will
|
||||
be available by browsing to http://127.0.0.1. You can inspect the initialization
|
||||
with::
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
Development
|
||||
===========
|
||||
|
||||
**Mayan EDMS** is under active development, and contributions are welcome.
|
||||
Mayan EDMS is under active development, and contributions are welcome.
|
||||
|
||||
If you have a feature request, suggestion or bug report, please open a new
|
||||
issue on the `GitLab issue tracker`_. To submit patches, please send a pull
|
||||
@@ -16,8 +16,8 @@ request on GitLab_. Make sure to add yourself to the :ref:`contributors` file.
|
||||
Project philosophies
|
||||
--------------------
|
||||
|
||||
How to think about **Mayan EDMS** when doing changes or adding new features,
|
||||
why things are the way they are in **Mayan EDMS**.
|
||||
How to think about Mayan EDMS when doing changes or adding new features,
|
||||
why things are the way they are in Mayan EDMS.
|
||||
|
||||
- Functionality must be as market/sector independent as possible, code for the
|
||||
95% of use cases.
|
||||
@@ -125,7 +125,7 @@ Correct:
|
||||
|
||||
Dependencies
|
||||
~~~~~~~~~~~~
|
||||
**Mayan EDMS** apps follow a hierarchical model of dependency. Apps import from
|
||||
Mayan EDMS apps follow a hierarchical model of dependency. Apps import from
|
||||
their parents or siblings, never from their children. Think plugins. A parent
|
||||
app must never assume anything about a possible existing child app. The
|
||||
documents app and the Document model are the basic entities they must never
|
||||
@@ -136,7 +136,7 @@ Variables
|
||||
~~~~~~~~~
|
||||
Naming of variables should follow a Major to Minor convention, usually
|
||||
including the purpose of the variable as the first piece of the name, using
|
||||
underscores as spaces. camelCase is not used in **Mayan EDMS**.
|
||||
underscores as spaces. camelCase is not used in Mayan EDMS.
|
||||
|
||||
Examples:
|
||||
|
||||
@@ -171,7 +171,7 @@ Classes:
|
||||
|
||||
Strings
|
||||
~~~~~~~
|
||||
Quotation character used in **Mayan EDMS** for strings is the single quote.
|
||||
Quotation character used in Mayan EDMS for strings is the single quote.
|
||||
Double quote is used for multiple line comments or HTML markup.
|
||||
|
||||
Migrations
|
||||
@@ -199,7 +199,7 @@ as passed directly from the exception object.
|
||||
Source Control
|
||||
--------------
|
||||
|
||||
**Mayan EDMS** source is controlled with Git_.
|
||||
Mayan EDMS source is controlled with Git_.
|
||||
|
||||
The project is publicly accessible, hosted and can be cloned from **GitLab** using::
|
||||
|
||||
@@ -209,7 +209,7 @@ The project is publicly accessible, hosted and can be cloned from **GitLab** usi
|
||||
Git branch structure
|
||||
--------------------
|
||||
|
||||
**Mayan EDMS** follows a simplified model layout based on Vincent Driessen's
|
||||
Mayan EDMS follows a simplified model layout based on Vincent Driessen's
|
||||
`Successful Git Branching Model`_ blog post.
|
||||
|
||||
``develop``
|
||||
@@ -299,7 +299,7 @@ merged.
|
||||
Debugging
|
||||
---------
|
||||
|
||||
**Mayan EDMS** makes extensive use of Django's new `logging capabilities`_.
|
||||
Mayan EDMS makes extensive use of Django's new `logging capabilities`_.
|
||||
By default debug logging for all apps is turned on. If you wish to customize
|
||||
how logging is managed turn off automatic logging by setting
|
||||
`COMMON_AUTO_LOGGING` to ``False`` and add the following lines to your
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Document types
|
||||
==============
|
||||
|
||||
The basic unit of data in **Mayan EDMS** is the ``document type``. A document
|
||||
The basic unit of data in Mayan EDMS is the ``document type``. A document
|
||||
type can be interpreted also as a document category, a document class, or a
|
||||
document template. Document types need to be created before documents can be
|
||||
uploaded. It is not possible to upload documents without assigning them a
|
||||
@@ -11,7 +11,7 @@ document type. Examples of document type: **invoices**, **blueprints**,
|
||||
|
||||
Settings and attributes are applied to document types and documents will
|
||||
inherit those settings and attributes based on the document type they were
|
||||
assigned when uploaded into **Mayan EDMS**. A document can only be of one
|
||||
assigned when uploaded into Mayan EDMS. A document can only be of one
|
||||
type at a given moment, but if needed, the type of a document can be changed.
|
||||
Upon changing its type, the document will lose its previous settings and
|
||||
attributes, and will inherit the settings and attributes of its new type.
|
||||
|
||||
@@ -7,7 +7,7 @@ Frequently asked questions and solutions
|
||||
**Q: PostgreSQL vs. MySQL**
|
||||
|
||||
Since Django abstracts database operations from a functional point of view
|
||||
**Mayan EDMS** will behave exactly the same either way. The only concern
|
||||
Mayan EDMS will behave exactly the same either way. The only concern
|
||||
would be that MySQL doesn't support transactions for schema modifying
|
||||
commands. The only moment this could cause problems is when running
|
||||
South migrations during upgrades, if a migration fails the database
|
||||
|
||||
@@ -19,7 +19,7 @@ Features
|
||||
|
||||
* Office document format support.
|
||||
|
||||
* **Mayan EDMS** can detect the presence of Libre Office and use it to support
|
||||
* Mayan EDMS can detect the presence of Libre Office and use it to support
|
||||
word processing files, spreadsheets and presentations.
|
||||
|
||||
* User defined metadata fields.
|
||||
@@ -44,7 +44,7 @@ Features
|
||||
|
||||
* Previews for many file formats.
|
||||
|
||||
* **Mayan EDMS** provides image preview generation for many popular file
|
||||
* Mayan EDMS provides image preview generation for many popular file
|
||||
formats.
|
||||
|
||||
* Full text searching.
|
||||
@@ -78,7 +78,7 @@ Features
|
||||
|
||||
* Multilingual user interface.
|
||||
|
||||
* **Mayan EDMS** being written using the Django_ framework, can be translated
|
||||
* Mayan EDMS being written using the Django_ framework, can be translated
|
||||
to practically any language spoken in the world. For a list of translated
|
||||
languages have a look at the Transifex_ project location.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
File storage
|
||||
============
|
||||
|
||||
The files are stored and placed under **Mayan EDMS** "control" to avoid
|
||||
The files are stored and placed under Mayan EDMS "control" to avoid
|
||||
filename clashes each file gets renamed to its ``UUID`` (Universally Unique ID),
|
||||
without extension, and stored in a simple flat arrangement in a directory.
|
||||
|
||||
@@ -20,7 +20,7 @@ This doesn't stop access to the files but renaming, moving or updating
|
||||
directly them is not recommended because it would throw the database out
|
||||
of sync.
|
||||
|
||||
Because **Mayan EDMS** components are as decoupled from each other as possible,
|
||||
Because Mayan EDMS components are as decoupled from each other as possible,
|
||||
storage in this case is decoupled and its behavior is controlled
|
||||
not by the project but by the ``Storage`` module class. All the other
|
||||
modules don't make any assumptions about how the actual document files are
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
Concepts
|
||||
========
|
||||
|
||||
Introductions to all the key parts of **Mayan EDMS** you'll need to know:
|
||||
Introductions to all the key parts of Mayan EDMS you'll need to know:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
@@ -17,7 +17,7 @@ Example:
|
||||
- Metadata type: ``Product year``, associated as a required metadata for the document type ``Product sheet``.
|
||||
|
||||
- Index: ``Product sheets per year``, and associated to the document type ``Product sheet``.
|
||||
- Index slug: ``product-sheets-per-year``. Slugs are internal unique identifiers that can be used by other **Mayan EDMS** modules to reference each index.
|
||||
- Index slug: ``product-sheets-per-year``. Slugs are internal unique identifiers that can be used by other Mayan EDMS modules to reference each index.
|
||||
- Index tree template as follows:
|
||||
|
||||
.. blockdiag::
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
**Mayan EDMS** should be deployed like any other Django_ project and
|
||||
Mayan EDMS should be deployed like any other Django_ project and
|
||||
preferably using virtualenv_.
|
||||
|
||||
Being a Django_ and a Python_ project, familiarity with these technologies is
|
||||
recommended to better understand why **Mayan EDMS** does some of the things it
|
||||
recommended to better understand why Mayan EDMS does some of the things it
|
||||
does.
|
||||
|
||||
Bellow are the step needed for a test install.
|
||||
@@ -20,13 +20,13 @@ Ubuntu
|
||||
If using a Debian_ or Ubuntu_ based Linux distribution, get the executable
|
||||
requirements using::
|
||||
|
||||
sudo apt-get install libjpeg-dev libmagic1 libpng-dev libreoffice libtiff-dev gcc ghostscript gpgv python-dev python-virtualenv tesseract-ocr unpaper poppler-utils -y
|
||||
sudo apt-get install libjpeg-dev libmagic1 libpng-dev libreoffice libtiff-dev gcc ghostscript gpgv python-dev python-virtualenv tesseract-ocr poppler-utils -y
|
||||
|
||||
|
||||
Mac OSX
|
||||
-------
|
||||
|
||||
**Mayan EDMS** is dependent on a number of binary packages and the recommended
|
||||
Mayan EDMS is dependent on a number of binary packages and the recommended
|
||||
way is to use a package manager such as `MacPorts <https://www.macports.org/>`_
|
||||
or `Homebrew <http://brew.sh/>`_.
|
||||
|
||||
@@ -45,7 +45,7 @@ With MacPorts installed run the command:
|
||||
Set the Binary paths
|
||||
********************
|
||||
|
||||
**Mayan EDMS** by default will look in /usr/bin/ for the binary files it needs
|
||||
Mayan EDMS by default will look in /usr/bin/ for the binary files it needs
|
||||
so either you can symlink the binaries installed via MacPorts in /opt/local/bin/
|
||||
to /usr/bin/ with ...
|
||||
|
||||
@@ -71,7 +71,7 @@ With Homebrew installed run the command:
|
||||
Set the Binary paths
|
||||
********************
|
||||
|
||||
**Mayan EDMS** by default will look in /usr/bin/ for the binary files it needs
|
||||
Mayan EDMS by default will look in /usr/bin/ for the binary files it needs
|
||||
so either you can symlink the binaries installed via brew in /usr/local/bin/
|
||||
to /usr/bin/ with ...
|
||||
|
||||
@@ -99,8 +99,8 @@ Initialize a ``virtualenv`` to deploy the project:
|
||||
source venv/bin/activate
|
||||
pip install mayan-edms
|
||||
|
||||
By default **Mayan EDMS** will create a single file SQLite_ database, which makes
|
||||
it very easy to start using **Mayan EDMS**. Populate the database with the
|
||||
By default Mayan EDMS will create a single file SQLite_ database, which makes
|
||||
it very easy to start using Mayan EDMS. Populate the database with the
|
||||
project's schema doing:
|
||||
|
||||
.. code-block:: bash
|
||||
@@ -127,7 +127,7 @@ Production use
|
||||
==============
|
||||
|
||||
After making sure everything is running correctly, stop the ``runserver`` command.
|
||||
Deploy **Mayan EDMS** using the webserver of your preference. For more information
|
||||
Deploy Mayan EDMS using the webserver of your preference. For more information
|
||||
on deployment instructions and examples, checkout Django's official documentation
|
||||
on the topic https://docs.djangoproject.com/en/1.7/howto/deployment/
|
||||
For a simple production deployment setup follow the instructions in the
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
License
|
||||
=======
|
||||
|
||||
**Mayan EDMS** is distributed under the `Apache 2.0 License`_.
|
||||
Mayan EDMS is distributed under the `Apache 2.0 License`_.
|
||||
The complete license terms are included below.
|
||||
|
||||
.. _Apache 2.0 License: https://www.apache.org/licenses/LICENSE-2.0.txt
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Permissions
|
||||
===========
|
||||
|
||||
**Mayan EDMS** provides very fine control over which actions users can
|
||||
Mayan EDMS provides very fine control over which actions users can
|
||||
perform. Action control works by allowing ``roles``, that are composed of
|
||||
``groups`` of ``users`` to be granted a ``permission`` such that the holder of
|
||||
that permission can exercise it throughout the entire system.
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Document signatures
|
||||
===================
|
||||
|
||||
**Mayan EDMS** supports two types of document signatures: embedded and
|
||||
Mayan EDMS supports two types of document signatures: embedded and
|
||||
detached signatures. When a document with an embedded signature is
|
||||
uploaded, this signature is readily detected as part of the document
|
||||
inspection step. The status of the signature can be verified by accessing the
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Document versioning
|
||||
===================
|
||||
|
||||
**Mayan EDMS** has the ability to store different versions of the same
|
||||
Mayan EDMS has the ability to store different versions of the same
|
||||
document. A comment field is provided to allow users to summarize the new
|
||||
version changes in comparison with the previous one. If a new version was
|
||||
uploaded by mistake or such new version is no longer necessary the option to
|
||||
|
||||
Reference in New Issue
Block a user