This repository has been archived by the owner on Jul 30, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 512
add i18n documentation #638
Open
IngoKl
wants to merge
1
commit into
pallets-eco:develop
Choose a base branch
from
IngoKl:i18n-doc
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
|
@@ -7,6 +7,7 @@ Quick Start | |
- `Basic MongoEngine Application <#basic-mongoengine-application>`_ | ||
- `Basic Peewee Application <#basic-peewee-application>`_ | ||
- `Mail Configuration <#mail-configuration>`_ | ||
- `Localization Configuration <#localization-configuration>`_ | ||
|
||
Basic SQLAlchemy Application | ||
============================= | ||
|
@@ -367,3 +368,39 @@ the basic application code in the previous section:: | |
To learn more about the various Flask-Mail settings to configure it to | ||
work with your particular email server configuration, please see the | ||
`Flask-Mail documentation <http://packages.python.org/Flask-Mail/>`_. | ||
|
||
|
||
Localization Configuration | ||
========================== | ||
|
||
Flask-Security comes with translations for several languages. Localization is implemented via | ||
`Flask-BabelEx <https://pythonhosted.org/Flask-BabelEx/>`_, a fork of the | ||
`Flask-Babel <https://pythonhosted.org/Flask-Babel/>`_ package. | ||
|
||
The following three step process will enable translations/i18n for a basic application: | ||
|
||
1. Install Flask-BabelEx:: | ||
|
||
pip install flask-babelex | ||
|
||
2. Configure Flask-Security to use the correct I18N_DOMAIN:: | ||
|
||
app.config['SECURITY_I18N_DOMAIN'] = 'flask_security' | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is already a default (see https://github.com/mattupstate/flask-security/blob/develop/flask_security/core.py#L48) |
||
|
||
Please refer to the :doc:`configuration <configuration>` documentation for more information. | ||
|
||
3. Initialize Flask-BabelEx and create a locale selector function:: | ||
|
||
from flask_babelex import Babel | ||
|
||
# Create app | ||
app = Flask(__name__) | ||
|
||
# Initialize Flask-BabelEx | ||
babel = Babel(app) | ||
app.babel = babel | ||
|
||
@babel.localeselector | ||
def get_locale(): | ||
# Add your locale selection logic here | ||
return 'de_De' |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is always installed (see https://github.com/mattupstate/flask-security/blob/develop/setup.py#L53).