Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add internationalization (i18n) documentation.
- Loading branch information
Showing
1 changed file
with
63 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,87 @@ | ||
Configuration | ||
============= | ||
|
||
**WOOEY\_FILE\_DIR**: String, where the files uploaded by the user will | ||
Wooey Settings | ||
-------------- | ||
|
||
:code:`WOOEY_FILE_DIR`: String, where the files uploaded by the user will | ||
be saved (Default: wooey\_files) | ||
|
||
**WOOEY\_CELERY**: Boolean, whether or not celery is enabled. If | ||
:code:`WOOEY\_CELERY`: Boolean, whether or not celery is enabled. If | ||
disabled, tasks will run locally and block execution. (Default: True) | ||
|
||
**WOOEY\_CELERY\_TASKS**: String, the name of the celery tasks for | ||
:code:`WOOEY\_CELERY\_TASKS`: String, the name of the celery tasks for | ||
Wooey. (Default: 'wooey.tasks') | ||
|
||
**WOOEY\_ALLOW\_ANONYMOUS**: Boolean, whether to allow submission of | ||
:code:`WOOEY\_ALLOW\_ANONYMOUS`: Boolean, whether to allow submission of | ||
jobs by anonymous users. (Default: True) | ||
|
||
By default, Wooey has a basic user account system. It is very basic, and | ||
doesn't confirm registrations via email. | ||
|
||
**WOOEY\_AUTH**: Boolean, whether to use the authorization system of | ||
:code:`WOOEY\_AUTH`: Boolean, whether to use the authorization system of | ||
Wooey for simple login/registration. (Default: True) | ||
|
||
**WOOEY\_LOGIN\_URL**: String, if you have an existing authorization | ||
:code:`WOOEY\_LOGIN\_URL`: String, if you have an existing authorization | ||
system, the login url: (Default: settings.LOGIN\_URL | ||
|
||
**WOOEY\_REGISTER\_URL**: String, if you have an existing authorization | ||
:code:`WOOEY\_REGISTER\_URL`: String, if you have an existing authorization | ||
system, the registration url: (Default: /accounts/register/) | ||
|
||
**WOOEY\_EPHEMERAL\_FILES**: Boolean, if your file system changes with | ||
:code:`WOOEY\_EPHEMERAL\_FILES`: Boolean, if your file system changes with | ||
each restart. (Default: False) | ||
|
||
**WOOEY\_SHOW\_LOCKED\_SCRIPTS**: Boolean, whether to show locked | ||
:code:`WOOEY\_SHOW\_LOCKED\_SCRIPTS`: Boolean, whether to show locked | ||
scripts as disabled or hide them entirely. (Defalt: True -- show as | ||
disabled) | ||
|
||
|
||
Internationlization (i18n) | ||
-------------------------- | ||
|
||
Wooey supports the use of Django internationalization settings to present | ||
the interface in your own language. Currently we provide limited support | ||
for French, German and Dutch. We welcome contributions for translation | ||
extensions, fixes and new languages from our users. | ||
|
||
If you want your installation to only use a single language, you can | ||
specify this using the :code:`LANGUAGE_CODE` setting in :code:`django_settings.py`. | ||
For example to set the interface to French, you would use: | ||
|
||
.. code:: python | ||
LANGUADE_CODE = 'fr' | ||
For German you would use: | ||
|
||
.. code:: python | ||
LANGUADE_CODE = 'de' | ||
If you want the user interface to automatically change to the preferred language | ||
for your visitors, you must use the Django internationalization middelware. | ||
To do this add :code:`django.middleware.locale.LocaleMiddleware` to your :code:`MIDDLEWARE_CLASSES` | ||
block in :code:`django_settings.py`. Note that it must come *after* the Session | ||
middelware, and before the CommonMiddleware e.g. | ||
|
||
.. code:: python | ||
MIDDLEWARE_CLASSES = ( | ||
'django.contrib.sessions.middleware.SessionMiddleware', | ||
'django.middleware.locale.LocaleMiddleware', # <- HERE | ||
'django.middleware.common.CommonMiddleware', | ||
'django.middleware.csrf.CsrfViewMiddleware', | ||
'django.contrib.auth.middleware.AuthenticationMiddleware', | ||
'django.contrib.auth.middleware.SessionAuthenticationMiddleware', | ||
'django.contrib.messages.middleware.MessageMiddleware', | ||
'django.middleware.clickjacking.XFrameOptionsMiddleware', | ||
'django.middleware.security.SecurityMiddleware', | ||
) | ||
For more information on the internationlization middelware see | ||
`the Django documentation <https://docs.djangoproject.com/en/1.8/topics/i18n/translation/#how-django-discovers-language-preference>`_. | ||
|
||
Note that if a user's browser does not request an available language the language | ||
specified in :code:`LANGUAGE_CODE` will be used. |