From d041f205fbc5982d0d021c3592eb8233c58ac187 Mon Sep 17 00:00:00 2001 From: David Paez Date: Wed, 5 Apr 2017 23:47:58 -0500 Subject: [PATCH 1/6] Add http:// to address in index.rst Signed-off-by: David Paez --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 3038bca246..aaace9abb1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,7 +19,7 @@ and install it from PyPI with the following commands: (venv) mayan-edms.py initialsetup (venv) mayan-edms.py runserver -Point your browser to 127.0.0.1:8000 and use the automatically created admin +Point your browser to http://127.0.0.1:8000 and use the automatically created admin account. .. image:: /_static/overview.gif From 25c66a51010fc1e0ef444dd6ab4a9fa6c8e9473d Mon Sep 17 00:00:00 2001 From: David Paez Date: Wed, 5 Apr 2017 23:50:10 -0500 Subject: [PATCH 2/6] Fix typo in deploying.rst Signed-off-by: David Paez --- docs/topics/deploying.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/deploying.rst b/docs/topics/deploying.rst index e9dccbb704..f3c96e5873 100644 --- a/docs/topics/deploying.rst +++ b/docs/topics/deploying.rst @@ -2,7 +2,7 @@ Deploying ========= -Below are some ways to deploye and use Mayan EDMS. Do use more than one method. +Below are some ways to deploy and use Mayan EDMS. Do not use more than one method. OS "bare metal" method ====================== From 2fc462bad5a2ff205d77ab44befef569632376ea Mon Sep 17 00:00:00 2001 From: David Paez Date: Wed, 5 Apr 2017 23:53:41 -0500 Subject: [PATCH 3/6] Character and style fixes in development.rst Signed-off-by: David Paez --- docs/topics/development.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/topics/development.rst b/docs/topics/development.rst index 46fcf90bd4..d855f2da69 100644 --- a/docs/topics/development.rst +++ b/docs/topics/development.rst @@ -16,8 +16,8 @@ request on GitLab_. 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. @@ -36,7 +36,7 @@ why things are the way they are in Mayan EDMS. not viable/mature/efficient. - Each app is as independent and self contained as possible. Exceptions, the basic requirements: navigation, permissions, common, main. -- If an app is meant to be used by more than one other app it should be as +- If an app is meant to be used by more than one other app, it should be as generic as possible in regard to the project and another app will bridge the functionality. - Example: since indexing (document_indexing) only applies to documents, the @@ -48,7 +48,7 @@ Coding conventions Follow PEP8 ~~~~~~~~~~~ -Whenever possible, but don't obsess over things like line length. +Whenever possible, but don't obsess over things like line length: .. code-block:: bash @@ -103,9 +103,9 @@ Example: ) from .models import Index, IndexInstanceNode, DocumentRenameCount -All local app module imports are in relative form, local app module name is to +All local app module imports are in relative form. Local app module name is to be referenced as little as possible, unless required by a specific feature, -trick, restriction, ie: Runtime modification of the module's attributes. +trick, restriction (e.g., Runtime modification of the module's attributes). Incorrect: @@ -128,7 +128,7 @@ Dependencies 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 +documents app and the Document model are the basic entities; they must never import anything else. The common and main apps are the base apps. From 7bd88561d5ce0126a4298b27879db3d7a1e6079a Mon Sep 17 00:00:00 2001 From: David Paez Date: Wed, 5 Apr 2017 23:54:22 -0500 Subject: [PATCH 4/6] Style fixes in features.rst Signed-off-by: David Paez --- docs/topics/features.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/features.rst b/docs/topics/features.rst index 33d32c7159..3d93dc0145 100644 --- a/docs/topics/features.rst +++ b/docs/topics/features.rst @@ -30,7 +30,7 @@ Features * Dynamic default values for metadata. * Metadata fields can have an initial value, which can be static or determined - by an user provided template code snippet. + by a template code snippet provided by the user. * Documents can be uploaded from different sources. @@ -68,7 +68,7 @@ Features * Multi page document support. - * Multiple page PDFs and TIFFs files are supported. + * Multiple page PDF and TIFF files are supported. * Automatic OCR processing. From 78365a7d4c871f5a86468379230a3de84f030608 Mon Sep 17 00:00:00 2001 From: David Paez Date: Wed, 5 Apr 2017 23:55:29 -0500 Subject: [PATCH 5/6] Typo fixes and style improvements in installation.rst Signed-off-by: David Paez --- docs/topics/installation.rst | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/topics/installation.rst b/docs/topics/installation.rst index 813f6a03c0..e559693dcc 100644 --- a/docs/topics/installation.rst +++ b/docs/topics/installation.rst @@ -9,7 +9,7 @@ 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 does. -Bellow are the step needed for a test install. +Bellow are the steps needed for a test install. Binary dependencies =================== @@ -45,15 +45,15 @@ 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 -so either you can symlink the binaries installed via MacPorts in /opt/local/bin/ -to /usr/bin/ with ... +Mayan EDMS by default will look in /usr/bin/ for the binary files it needs. +You can symlink the binaries installed via MacPorts in /opt/local/bin/ +to /usr/bin/ with: .. code-block:: bash sudo ln -s /opt/local/bin/tesseract /usr/bin/tesseract -... alternatively set the paths in the ``settings/locals.py`` +Alternatively, set the paths in the ``settings/locals.py`` .. code-block:: python @@ -71,9 +71,9 @@ 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 -so either you can symlink the binaries installed via brew in /usr/local/bin/ -to /usr/bin/ with ... +Mayan EDMS by default will look in /usr/bin/ for the binary files it needs. +You can symlink the binaries installed via brew in /usr/local/bin/ +to /usr/bin/ with: .. code-block:: bash @@ -82,7 +82,7 @@ to /usr/bin/ with ... sudo ln -s /usr/local/bin/pdftotext /usr/bin/pdftotext && \ sudo ln -s /usr/local/bin/gs /usr/bin/gs -... alternatively set the paths in the ``settings/locals.py`` +Alternatively, set the paths in the ``settings/locals.py`` .. code-block:: python @@ -99,7 +99,7 @@ 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 +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: @@ -117,11 +117,13 @@ Background tasks and scheduled tasks will not run when using the test server. The ``runserver`` command is only meant for testing, do not use in a production server. -Note that the default IP address, 127.0.0.1, is not accessible from other +Note that the default 127.0.0.1 IP address is not accessible from other machines on your network. To make your test server viewable to other -machines on the network, use its own IP address (e.g. 192.168.2.1) or 0.0.0.0 or :: (with IPv6 enabled). +machines on the network, use its own IP address like 192.168.2.1 or 0.0.0.0 or +:: (with IPv6 enabled). -You can provide an IPv6 address surrounded by brackets (e.g. [200a::1]:8000). This will automatically enable IPv6 support. +You can provide an IPv6 address surrounded by brackets (e.g. [200a::1]:8000). +This will automatically enable IPv6 support. Production use ============== @@ -129,7 +131,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 on deployment instructions and examples, checkout Django's official documentation -on the topic https://docs.djangoproject.com/en/1.7/howto/deployment/ +on the topic at https://docs.djangoproject.com/en/1.7/howto/deployment/ For a simple production deployment setup follow the instructions in the :doc:`deploying` chapter. From ced28963add3de871df5693365ae8a85236f7d66 Mon Sep 17 00:00:00 2001 From: David Paez Date: Wed, 5 Apr 2017 23:56:22 -0500 Subject: [PATCH 6/6] Style improvements in transformations.rst Signed-off-by: David Paez --- docs/topics/transformations.rst | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/topics/transformations.rst b/docs/topics/transformations.rst index ffde0c7c7c..ebe4355be8 100644 --- a/docs/topics/transformations.rst +++ b/docs/topics/transformations.rst @@ -2,21 +2,20 @@ Transformations =============== -Transformation are persistent manipulations to the previews of the stored -documents. For example: a scanning equipment may only produce landscape PDFs. -In this case an useful transformation for that document source would be to -rotate all documents scanned by 270 degrees after being uploaded, this way -whenever a document is uploaded from that scanner it will appear in portrait -orientation. In this case add a this transformation to the Mayan EDMS source -that is connected to that device this way all pages scanned via that source -with inherit the transformation as they are created. +Transformations are persistent manipulations to the previews of the stored +documents. For example: a scanning equipment may only produce landscape PDFs. +In this case a useful transformation for that document source would be to rotate +all scanned documents by 270 degrees after being uploaded. By adding this +transformation to the Mayan EDMS source that is connected to the scanner, all +pages scanned via that source will inherit the transformation as they are +created. The result is that whenever a document is uploaded from that scanner, +it will appear in portrait orientation, instead of landscape orientation. -Transformations can also be added to existing documents, by clicking on a -document's page, then clicking on "transformations". In this view the Actions -menu will have a new option that reads "Create new transformation". At the -moment the rotation, zoom, crop, and resize transformations are available. -Once the document image has been corrected resubmit it for OCR for improved -results. +Transformations can also be added to existing documents by clicking on a +document's page and then clicking on "transformations". In this view the Actions +menu will have a new option that reads "Create new transformation". Currently, +the available transformations are: rotation, zoom, crop, and resize. Once the +document image has been corrected, resubmit it for OCR for improved results. -Transformations are not destructive and do not physically modify the document +Transformations are not destructive and do not physically modify the document file, they just modify the document's graphical representation.