From cf1726505b95a9936fc335320c84e97894a1ac2c Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Wed, 31 Oct 2018 18:39:26 -0400 Subject: [PATCH] Documenation: Fix spelling errors Fix spelling errors in documentation and other program texts. Update the spelling exceptions list. Signed-off-by: Roberto Rosario --- HISTORY.rst | 14 ++-- HISTORY_2_x.rst | 4 +- docker/README.md | 9 ++- docker/README.md.tmpl | 2 +- docs/chapters/backups.rst | 2 +- docs/chapters/caa_entity.rst | 2 +- docs/chapters/caa_individual.rst | 2 +- docs/chapters/deploying.rst | 6 +- docs/chapters/development.rst | 6 +- docs/chapters/docker.rst | 4 +- docs/chapters/index_examples.rst | 2 +- docs/chapters/mailing.rst | 2 +- docs/chapters/ocr_backend.rst | 2 +- docs/chapters/scaling_up.rst | 2 +- docs/chapters/upload_wizard.rst | 2 +- docs/chapters/workflows.rst | 4 +- docs/releases/2.7.rst | 6 +- docs/releases/3.0.rst | 12 ++-- docs/releases/3.1.5.rst | 2 +- docs/releases/3.1.rst | 4 +- docs/spelling_wordlist.txt | 66 +++++++++++++++++-- .../management/commands/initialsetup.py | 2 +- .../apps/lock_manager/tests/test_backends.py | 2 +- 23 files changed, 111 insertions(+), 48 deletions(-) diff --git a/HISTORY.rst b/HISTORY.rst index 51c966725b..61af8ac033 100644 --- a/HISTORY.rst +++ b/HISTORY.rst @@ -6,7 +6,7 @@ * Add data migrations to the sources app migraton 0019 to ensure all labels are unique before performing the schema migations. * Add improvements to the metadata URL encoding and decoding to support - ampersand characters as part of the metadata value. GitLab issue + ampersand characters as part of the metadata value. GitLab issue #529. Thanks to Mark Maglana @relaxdiego for the report. * Add custom validator for multiple emails in a single text field. Change the widget of the email fields in the mailer app to avoid @@ -35,10 +35,10 @@ @TheOneValen for the report. * Ignore document stub from the index mirror. GitLab issue #520. Thanks to TheOneValen @TheOneValen for the report. -* Fix for the Docker image INSTALL_FLAG path. Thanks to +* Fix for the Docker image INSTALL_FLAG path. Thanks to Mark Maglana @relaxdiego for the report and to Hamish Farroq @farroq_HAM for the patch. GitLab issue #525. -* Fix the typo in the Docker variable for worker concurrency. Thanks to +* Fix the typo in the Docker variable for worker concurrency. Thanks to Mark Maglana @relaxdiego for the report and to Hamish Farroq @farroq_HAM for the patch. GitLab issue #527. * Add a noop OCR backend that disables OCR and the check for the @@ -56,7 +56,7 @@ starts and at the end of directories. Closes again GitLab issue #520 Thanks to TheOneValen @ for the report. * Improve index mirroring cache class to use the hash of the keys - instead of the literal keys. Avoid warning about invalid key + instead of the literal keys. Avoid warning about invalid key characters. Closes GitLab issue #518. Thanks to TheOneValen @ for the report. * Only render the Template API view for authenticated users. @@ -185,7 +185,7 @@ - Include querystring when force reload of a bare template view. - Speed up document image fade in reveal. - Use reseteable timer to ensure more document panels heights are matched. -- Rewrote Mayan's Javascript suite MayanApp into ECMAScript2015. +- Rewrote Mayan's JavaScript suite MayanApp into ECMAScript2015. - Remove use is waitForJQuery. - Remove code statistics from the documentation. - Remove the pending work chapter. This is now available in the Wiki: @@ -306,12 +306,12 @@ - New settings: SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND and SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND_ARGUMENTS to control where and how staging file caching is done. -- Fix an egde case on the document indexing where an empty +- Fix an edge case on the document indexing where an empty node could be left behind. - Improve the speed of the document indexing. - Move the matchHeight call from lazy loading to image loading. Reduces the chance of wrongly sized cards. -- Generalize the Javascript menu rendering into an API for +- Generalize the JavaScript menu rendering into an API for templates that only refresh the menu when there are changes. Closes GitLab issue #511. Thanks to Daniel Carrico @daniel1113 for the report. diff --git a/HISTORY_2_x.rst b/HISTORY_2_x.rst index f74d2cb71f..ca5f832268 100644 --- a/HISTORY_2_x.rst +++ b/HISTORY_2_x.rst @@ -61,7 +61,7 @@ - Convert document version view to item list view. - Add support for browsing individual document versions. - Add support for dropdown menus to the item list view template. -- Add support for preserving the file extenstion when downloading a document +- Add support for preserving the file extension when downloading a document version. GitLab #415. - Split OCR app into OCR and parsing. - Remove Folders app. @@ -164,7 +164,7 @@ - Document cache disabling. - Translation improvements. - Image loading improvements. -- Lower Javascript memory utilization. +- Lower JavaScript memory utilization. - HTML reponsive layout improvements. - Make document deletion a background task. - Unicode handling improvements. diff --git a/docker/README.md b/docker/README.md index 94fe1fb77a..ddfb10413d 100755 --- a/docker/README.md +++ b/docker/README.md @@ -177,7 +177,12 @@ The complete command line would then be: $ docker run -d --name mayan-edms --restart=always -p 80:80 -v mayan_data:/var/lib/mayan -v /opt/scanned_files:/srv/watch_folder mayanedms/mayanedms:2.7.3 ``` -Now create a watch folder in Mayan EDMS using the path `/srv/watch_folder` and the documents from the host folder `/opt/scanned_files` will be automatically available. Use the same procedure to mount host folders to be used as staging folderes. In this example `/srv/watch_folder` was as the container directory, but any path can be used as long as it is not an already existing path or a path used by any other program. +Now create a watch folder in Mayan EDMS using the path `/srv/watch_folder` and +the documents from the host folder `/opt/scanned_files` will be automatically +available. Use the same procedure to mount host folders to be used as staging +folders. In this example `/srv/watch_folder` was as the container directory, +but any path can be used as long as it is not an already existing path or a +path used by any other program. ## Performing backups @@ -366,7 +371,7 @@ from .base import * SECRET_KEY = '< keep your random secret key >' ``` -This is necesary because version 2.2 included experimental support for Postgres as a database backend. Now that Postgres support has been made standard, the custom configuration lines that version 2.2 added to the `local.py` file are not necesary and need to be removed to avoid configuration conflicts. +This is necessary because version 2.2 included experimental support for Postgres as a database backend. Now that Postgres support has been made standard, the custom configuration lines that version 2.2 added to the `local.py` file are not necesary and need to be removed to avoid configuration conflicts. Save the file and launch a container using the new version. diff --git a/docker/README.md.tmpl b/docker/README.md.tmpl index ec5162a3a7..fea2c45309 100755 --- a/docker/README.md.tmpl +++ b/docker/README.md.tmpl @@ -366,7 +366,7 @@ from .base import * SECRET_KEY = '< keep your random secret key >' ``` -This is necesary because version 2.2 included experimental support for Postgres as a database backend. Now that Postgres support has been made standard, the custom configuration lines that version 2.2 added to the `local.py` file are not necesary and need to be removed to avoid configuration conflicts. +This is necessary because version 2.2 included experimental support for Postgres as a database backend. Now that Postgres support has been made standard, the custom configuration lines that version 2.2 added to the `local.py` file are not necesary and need to be removed to avoid configuration conflicts. Save the file and launch a container using the new version. diff --git a/docs/chapters/backups.rst b/docs/chapters/backups.rst index b51aaafccc..9ea3bdb47e 100644 --- a/docs/chapters/backups.rst +++ b/docs/chapters/backups.rst @@ -65,6 +65,6 @@ Example:: More information at: - - Postgresl: http://www.postgresql.org/docs/current/static/backup.html + - PostgreSQL: https://www.postgresql.org/docs/current/static/backup.html - MySQL: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html - SQLite: Just copy the file ``mayan/media/db.sqlite3`` diff --git a/docs/chapters/caa_entity.rst b/docs/chapters/caa_entity.rst index bdd1790391..e9762f1009 100644 --- a/docs/chapters/caa_entity.rst +++ b/docs/chapters/caa_entity.rst @@ -27,7 +27,7 @@ Legal Entity or (iii) beneficial ownership of such entity. "Contribution" means any work of authorship that is Submitted by You to Us in which You own or assert ownership of the Copyright. We cannot accept contributions for which you do not own the Copyright or for which you don't -have the necesary legal power to transfer. +have the necessary legal power to transfer. "Copyright" means all rights protecting works of authorship owned or controlled by You or Your Affiliates, including copyright, moral and neighboring rights, diff --git a/docs/chapters/caa_individual.rst b/docs/chapters/caa_individual.rst index bc6c61466e..f47ed4fd2d 100644 --- a/docs/chapters/caa_individual.rst +++ b/docs/chapters/caa_individual.rst @@ -19,7 +19,7 @@ software project managed by Us. "Contribution" means any work of authorship that is Submitted by You to Us in which You own or assert ownership of the Copyright. We cannot accept contributions for which you do not own the Copyright or for which you don't -have the necesary legal power to transfer. +have the necessary legal power to transfer. "Copyright" means all rights protecting works of authorship owned or controlled by You, including copyright, moral and neighboring rights, diff --git a/docs/chapters/deploying.rst b/docs/chapters/deploying.rst index 2555dcee09..1b94d20222 100644 --- a/docs/chapters/deploying.rst +++ b/docs/chapters/deploying.rst @@ -347,9 +347,9 @@ Enable and restart the services [1_]: [1]: https://bugs.launchpad.net/ubuntu/+source/supervisor/+bug/1594740 -.. _Debian: http://www.debian.org/ -.. _Django: http://www.djangoproject.com/ -.. _Python: http://www.python.org/ +.. _Debian: https://www.debian.org/ +.. _Django: https://www.djangoproject.com/ +.. _Python: https://www.python.org/ .. _SQLite: https://www.sqlite.org/ .. _Ubuntu: http://www.ubuntu.com/ .. _virtualenv: http://www.virtualenv.org/en/latest/index.html diff --git a/docs/chapters/development.rst b/docs/chapters/development.rst index 19cfe7e006..526709a942 100644 --- a/docs/chapters/development.rst +++ b/docs/chapters/development.rst @@ -188,8 +188,8 @@ Double quote is used for multiple line comments or HTML markup. Migrations ---------- -Migrations should do only one thing (eg: either create a table, move data to a -new table or remove an old table) to aid retrying on failure. +Migrations should do only one thing (example: either create a table, move data +to a new table or remove an old table) to aid retrying on failure. General @@ -256,7 +256,7 @@ Special branches: of a new Docker image based on development code to the GitLab image repository. -Each release is tagged separately using annotaded Git tags. +Each release is tagged separately using annotated Git tags. When submitting patches, please place your code in its own ``feature/`` branch prior to opening a Merge Request on GitLab_. diff --git a/docs/chapters/docker.rst b/docs/chapters/docker.rst index 1587cee91a..88a63f6be9 100644 --- a/docs/chapters/docker.rst +++ b/docs/chapters/docker.rst @@ -55,7 +55,7 @@ identifier:: The Mayan EDMS container will connect to the PostgreSQL container via the ``172.17.0.1`` IP address (the Docker host's default IP address). It will -connect using the ``django.db.backends.postgresql`` database drivern and +connect using the ``django.db.backends.postgresql`` database driver and connect to the ``mayan`` database using the ``mayan`` user with the password ``mayanuserpass``. The container will keep connections to the database for up to 60 seconds in an attempt to reuse them increasing response time @@ -409,7 +409,7 @@ These are: Nightly images ============== -The continious integration pipeline used for testing development builds also +The continuous integration pipeline used for testing development builds also produces a resulting Docker image. These are build automatically and their stability is not guaranteed. They should never be used in production. If you want to try out the Docker images the development uses or want a sneak diff --git a/docs/chapters/index_examples.rst b/docs/chapters/index_examples.rst index 3d8fb9432a..d42ba86edf 100644 --- a/docs/chapters/index_examples.rst +++ b/docs/chapters/index_examples.rst @@ -23,7 +23,7 @@ links to the document of each respective type. #. Go to :menuselection:`Document types` and associate this index with existing document types in the system. #. Finally go to :menuselection:`Tools --> Rebuild indexes` to execute the - index template. The rebuild process is only necesary when changes are + index template. The rebuild process is only necessary when changes are made to the index templates. Otherwise they update automatically whenever a new document is uploaded or existing documents properties are modified. #. A new index should appear under :menuselection:`Indexes` menu. diff --git a/docs/chapters/mailing.rst b/docs/chapters/mailing.rst index 4cdba68d3a..702412e445 100644 --- a/docs/chapters/mailing.rst +++ b/docs/chapters/mailing.rst @@ -18,5 +18,5 @@ email backends. Mailing Profiles are created from the :menuselection:`System --> Setup` menu. Once created mailing profiles allow users to send email messages from -within the user interafce containing either an URL link to the document or +within the user interface containing either an URL link to the document or the actual document as an attachment. diff --git a/docs/chapters/ocr_backend.rst b/docs/chapters/ocr_backend.rst index 30de256544..a08eaba30b 100644 --- a/docs/chapters/ocr_backend.rst +++ b/docs/chapters/ocr_backend.rst @@ -4,7 +4,7 @@ OCR backend Mayan EDMS ships an OCR backend that uses the FLOSS engine Tesseract (https://github.com/tesseract-ocr/tesseract/), but it can -use other engines. To support other engines crate a wrapper that subclasess the +use other engines. To support other engines crate a wrapper that subclasses the ``OCRBackendBase`` class defined in mayan/apps/ocr/classes. This subclass should expose the ``execute`` method. For an example of how the Tesseract backend is implemented take a look at the file ``mayan/apps/ocr/backends/tesseract.py`` diff --git a/docs/chapters/scaling_up.rst b/docs/chapters/scaling_up.rst index 4e58b1b482..c15c548c6b 100644 --- a/docs/chapters/scaling_up.rst +++ b/docs/chapters/scaling_up.rst @@ -10,7 +10,7 @@ Change the database manager =========================== Use PostgreSQL or MySQL as the database manager. Tweak the memory setting of the database manager to increase memory allocation. -More PostgreSQL especific examples are available in their wiki page: +More PostgreSQL specific examples are available in their wiki page: https://wiki.postgresql.org/wiki/Performance_Optimization Increase the number of Gunicorn workers diff --git a/docs/chapters/upload_wizard.rst b/docs/chapters/upload_wizard.rst index 920b066b13..26fe160899 100644 --- a/docs/chapters/upload_wizard.rst +++ b/docs/chapters/upload_wizard.rst @@ -80,5 +80,5 @@ module. Example:: WizardStep.deregister(WizardStepTags) -This will cause the tags assigment step to not be assigned to the upload +This will cause the tags assignment step to not be assigned to the upload wizard anymore. diff --git a/docs/chapters/workflows.rst b/docs/chapters/workflows.rst index e5d39c4f24..7f040d1ab8 100644 --- a/docs/chapters/workflows.rst +++ b/docs/chapters/workflows.rst @@ -70,7 +70,7 @@ Internally, workflows are implemented as a finite state machines that only one state can be the current active state for a workflow being executed. The other limitation of the current implementation is that every workflow needs at least one state marked as the initial state. These limitations -are the result of a compromised in the design between flexilibiy and ease of +are the result of a compromised in the design between flexibility and ease of use. @@ -78,7 +78,7 @@ Visualizations ============== The graphical representation of a workflow (or a finite state machine style -in Mayan EDMS's case) is similar to a flowchart. The states are presetended +in Mayan EDMS's case) is similar to a flowchart. The states are represented with circles. The transitions are represented with arrows. Circle with a double border represent the initial state of the workflow. diff --git a/docs/releases/2.7.rst b/docs/releases/2.7.rst index 37c375f64c..06d8098cff 100644 --- a/docs/releases/2.7.rst +++ b/docs/releases/2.7.rst @@ -170,7 +170,7 @@ Other Changes - Improve mailer URL regex. - Add ordering support to the ``SourceColumn`` class. GitLab issue #417. - Shows the cabinets in the document list. GitLab #417 @corneliusludmann -- Update the index information colums to show the +- Update the index information columns to show the total number of documents and nodes contained in a level. - Add workaround for pycountry versions without the bibliographical key. GitHub issue #250. @@ -191,7 +191,7 @@ Other Changes - Convert document version view to item list view. - Add support for browsing individual document versions. - Add support for dropdown menus to the item list view template. -- Add support for preserving the file extenstion when downloading a document +- Add support for preserving the file extension when downloading a document version. GitLab #415. - Split OCR app into OCR and parsing. - Use the literal 'System' instead of the target name when @@ -211,7 +211,7 @@ Other Changes - Implement field order for the action dynamic forms. Perform action class validation by importing the class and not relying on an instance of action model, which might not - exisit when still creating the action. + exist when still creating the action. - Navigation improvements in the workflow app. - Rename index nodes to index levels. - Avoid Maximum recursion depth exceeded exception on index document diff --git a/docs/releases/3.0.rst b/docs/releases/3.0.rst index 5f8d437bb4..85a5f71dd0 100644 --- a/docs/releases/3.0.rst +++ b/docs/releases/3.0.rst @@ -9,7 +9,7 @@ Changes Turning Mayan EDMS into a single page app ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Historically, Mayan EDMS has steered away from adding too much Javascript +Historically, Mayan EDMS has steered away from adding too much JavaScript in its code. The goal was to be able to maintain a robust, backend-based page rendering method that will be as future-proof as possible. This approach comes at the cost of some page loading speed, and reduced @@ -19,7 +19,7 @@ The whole system has been update to work as a modern Single Page App. Single Page Applications (SPAs) rewrite the current page dynamically rather than loading the entire page on each click of the mouse. This makes the web application feel and behave more like a desktop -application. Because the majority of the styling and Javascript code +application. Because the majority of the styling and JavaScript code is loaded only once, there is also the added benefit of less data down the wire. Thus the application becomes lighter and provides a faster response time to user events. Because the style is loaded and @@ -233,7 +233,7 @@ module. Example:: WizardStep.deregister(WizardStepTags) -This will cause the tags assigment step to not be assigned to the upload +This will cause the tags assignment step to not be assigned to the upload wizard anymore. @@ -333,15 +333,15 @@ Add JavaScript dependency manager ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ An internal utility to install and upgrade the JavaScript dependencies was added. -This depency manager allows for the easier maintenace of the JavaScript libraries +This depency manager allows for the easier maintenance of the JavaScript libraries used through the project. Previously JavaScript libraries we downloaded and installed by manually. These libraries were them checked into the Git repository. Finally to enable them -the correspoding imports were added to the base templates in the apppeance app. +the corresponding imports were added to the base templates in the appeance app. This new manager is the first step to start resolving these issues. The manager -allows apps to specify their own dependencies. These dependecies are then +allows apps to specify their own dependencies. These dependencies are then downloaded when the project is installed or upgraded. As such they are not part of the repository and lower the file size of the project. diff --git a/docs/releases/3.1.5.rst b/docs/releases/3.1.5.rst index 4fd5aae2f9..cd00e35722 100644 --- a/docs/releases/3.1.5.rst +++ b/docs/releases/3.1.5.rst @@ -15,7 +15,7 @@ as a FUSE filesystem. It also includes a fix for indexes that return a multi line value. The carriage returns and newlines characters are now converted into spaces to make the index value a valid filesystem directory. Lastly an issue with the duplicated value was fixed. Indexes levels that -return a duplicated value will now show as directory entried when mounted +return a duplicated value will not show as directory entries when mounted as a FUSE filesystem. diff --git a/docs/releases/3.1.rst b/docs/releases/3.1.rst index e188d4a34b..7050752389 100644 --- a/docs/releases/3.1.rst +++ b/docs/releases/3.1.rst @@ -337,7 +337,7 @@ Other changes - Include querystring when force reload of a bare template view. - Speed up document image fade in reveal. - Use reseteable timer to ensure more document panels heights are matched. -- Rewrote Mayan's Javascript suite MayanApp into ECMAScript2015. +- Rewrote Mayan's JavaScript suite MayanApp into ECMAScript2015. - Remove use of ``waitForJQuery``. - Remove code statistics from the documentation. - Remove the pending work chapter. This is now available in the Wiki: @@ -394,7 +394,7 @@ Other changes - New settings: ``SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND`` and ``SOURCES_STAGING_FILE_CACHE_STORAGE_BACKEND_ARGUMENTS`` to control where and how staging file caching is done. -- Fix an egde case on the document indexing where an empty +- Fix an edge case on the document indexing where an empty node could be left behind. - Improve the speed of the document indexing. - Move the matchHeight call from lazy loading to image loading. diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 7275780d3d..fbb42282df 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -6,78 +6,117 @@ ascii backend backends Backport +boto +camelCase Carrico changelog +chinese +ci codebase compat config +contrib convertdb +corneliusludmann cors +cryptographic Customizable daniel dateutil +deprecations distributable django Django +documentpage docx drf +Driessen dropdown dropzone dumpdata +edms entrypoint +Everling fabfile fancybox farroq Farroq +filepath filesystem filesystems formtools frontend +fullscreen german gevent GitLab Glita Grappelli +gsteixei gunicorn Gunicorn +gz Hamish hardcoded hostname init +installable +Installable +IntegrityError +javascript Jesaja +jeverling jQuery +js +keyring keyserver keyservers Kombu +latin +ldap libmagic Libre +libreoffice loaddata localhost lokesh Lokesh Ludmann +Macrobb Maglana makefile matchHeight mayan +Memcached MERC minified minify mixin +ModelLock mountindex mptt +multifunctional +mysql namespace namespaces +natively noop +ocr paperattor Paperattor papercut papercuts parsers +pdftoppm pdftotext phpBB +Plotkowiak +png poppler Postgres +prepend +py +pyocr PyOCR qsstats queryset @@ -85,33 +124,52 @@ querystring readonly readthedocs Redis +reindexing relaxdiego renderer +rgarcia robert +rST runtime schoeftner Schöftner +scrollable Sergey serializers +smurfix +storages Storages +subclasses subclassing sublicense +sublicensees +swedish Teixeira +tesseract Tesseract TheOneValen +Timesheet Transifex uncompress +unicode unix +unmerged unoconv +untagged URI +url Urlichs utf +utils +utils +vhost viewport waitForJQuery +Watchfolders webserver Whitenoise +www +YaN yasg -Memcached -ModelLock -reindexing -prepend +YbN +YrcN diff --git a/mayan/apps/common/management/commands/initialsetup.py b/mayan/apps/common/management/commands/initialsetup.py index 91eba1078a..456983279c 100644 --- a/mayan/apps/common/management/commands/initialsetup.py +++ b/mayan/apps/common/management/commands/initialsetup.py @@ -29,7 +29,7 @@ class Command(management.BaseCommand): parser.add_argument( '--no-javascript', action='store_true', dest='no_javascript', - help='Don\'t download the Javascript dependencies.', + help='Don\'t download the JavaScript dependencies.', ) def initialize_system(self, force=False): diff --git a/mayan/apps/lock_manager/tests/test_backends.py b/mayan/apps/lock_manager/tests/test_backends.py index e302c309dd..005db749c0 100644 --- a/mayan/apps/lock_manager/tests/test_backends.py +++ b/mayan/apps/lock_manager/tests/test_backends.py @@ -56,7 +56,7 @@ class FileLockTestCase(TestCase): lock_1.release() # No exception is raised even though the lock has expired. # The logic is that checking for expired locks during release is - # not necesary as any attempt by someone else to aquire the lock + # not necessary as any attempt by someone else to aquire the lock # would be successfull, even after an extended lapse of time def test_release_expired_reaquired(self):