Documenation: Fix spelling errors

Fix spelling errors in documentation and other program texts.
Update the spelling exceptions list.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
This commit is contained in:
Roberto Rosario
2018-10-31 18:39:26 -04:00
parent 8b41a9bfc9
commit cf1726505b
23 changed files with 111 additions and 48 deletions

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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``

View File

@@ -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,

View File

@@ -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,

View File

@@ -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

View File

@@ -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_.

View File

@@ -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

View File

@@ -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.

View File

@@ -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.

View File

@@ -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``

View File

@@ -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

View File

@@ -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.

View File

@@ -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.

View File

@@ -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

View File

@@ -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.

View File

@@ -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.

View File

@@ -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.

View File

@@ -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

View File

@@ -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):

View File

@@ -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):