2014-11-25 19:04:38 +03:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta charset = "utf-8" >
2015-05-15 11:19:49 +03:00
< title > Internationalization - Django REST framework< / title >
2014-11-25 19:04:38 +03:00
< link href = "../../img/favicon.ico" rel = "icon" type = "image/x-icon" >
2018-10-11 16:48:33 +03:00
< link rel = "canonical" href = "https://www.django-rest-framework.org/topics/internationalization/" / >
2014-11-25 19:04:38 +03:00
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
2015-03-06 15:05:16 +03:00
< meta name = "description" content = "Django, API, REST, Internationalization" >
2014-11-25 19:04:38 +03:00
< meta name = "author" content = "Tom Christie" >
<!-- Le styles -->
< link href = "../../css/prettify.css" rel = "stylesheet" >
< link href = "../../css/bootstrap.css" rel = "stylesheet" >
< link href = "../../css/bootstrap-responsive.css" rel = "stylesheet" >
< link href = "../../css/default.css" rel = "stylesheet" >
<!-- Le HTML5 shim, for IE6 - 8 support of HTML5 elements -->
<!-- [if lt IE 9]>
< script src = "http://html5shim.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< script type = "text/javascript" >
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-18852272-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script');
ga.type = 'text/javascript';
ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
< / script >
< style >
2016-05-26 13:48:39 +03:00
#sidebarInclude img {
margin-bottom: 10px;
}
#sidebarInclude a.promo {
2014-11-25 19:04:38 +03:00
color: black;
2016-05-26 13:48:39 +03:00
}
2014-11-25 19:04:38 +03:00
@media (max-width: 767px) {
div.promo {
display: none;
}
}
< / style >
< / head >
< body onload = "prettyPrint()" class = "-page" >
< div class = "wrapper" >
< div class = "navbar navbar-inverse navbar-fixed-top" >
< div class = "navbar-inner" >
< div class = "container-fluid" >
2017-05-12 19:15:00 +03:00
< a class = "repo-link btn btn-primary btn-small" href = "https://github.com/encode/django-rest-framework/tree/master" > GitHub< / a >
2015-06-04 17:37:22 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "prev" href = "../ajax-csrf-cors/" >
2014-11-25 19:04:38 +03:00
Next < i class = "icon-arrow-right icon-white" > < / i >
< / a >
2016-07-07 11:41:32 +03:00
< a class = "repo-link btn btn-inverse btn-small " rel = "next" href = "../api-clients/" >
2014-11-25 19:04:38 +03:00
< i class = "icon-arrow-left icon-white" > < / i > Previous
< / a >
2015-06-04 17:37:22 +03:00
< a id = "search_modal_show" class = "repo-link btn btn-inverse btn-small" href = "#mkdocs_search_modal" data-toggle = "modal" data-target = "#mkdocs_search_modal" > < i class = "icon-search icon-white" > < / i > Search< / a >
2014-11-25 19:04:38 +03:00
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< span class = "icon-bar" > < / span >
< / a >
2018-10-11 16:48:33 +03:00
< a class = "brand" href = "https://www.django-rest-framework.org/" > Django REST framework< / a >
2014-11-25 19:04:38 +03:00
< div class = "nav-collapse collapse" >
<!-- Main navigation -->
< ul class = "nav navbar-nav" >
2015-06-04 17:37:22 +03:00
< li >
< a href = "../.." > Home< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li class = "dropdown" >
2014-11-25 19:31:00 +03:00
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Tutorial < b class = "caret" > < / b > < / a >
2014-11-25 19:04:38 +03:00
< ul class = "dropdown-menu" >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/quickstart/" > Quickstart< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/1-serialization/" > 1 - Serialization< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/2-requests-and-responses/" > 2 - Requests and responses< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/3-class-based-views/" > 3 - Class based views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/4-authentication-and-permissions/" > 4 - Authentication and permissions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/5-relationships-and-hyperlinked-apis/" > 5 - Relationships and hyperlinked APIs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../tutorial/6-viewsets-and-routers/" > 6 - Viewsets and routers< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
< a href = "../../tutorial/7-schemas-and-client-libraries/" > 7 - Schemas and client libraries< / a >
< / li >
2014-11-25 19:04:38 +03:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > API Guide < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/requests/" > Requests< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/responses/" > Responses< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/views/" > Views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/generic-views/" > Generic views< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/viewsets/" > Viewsets< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/routers/" > Routers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/parsers/" > Parsers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/renderers/" > Renderers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/serializers/" > Serializers< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/fields/" > Serializer fields< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/relations/" > Serializer relations< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-01 15:20:07 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/validators/" > Validators< / a >
2014-12-01 15:20:07 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/authentication/" > Authentication< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/permissions/" > Permissions< / a >
2014-11-25 19:04:38 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< li >
< a href = "../../api-guide/caching/" > Caching< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/throttling/" > Throttling< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/filtering/" > Filtering< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/pagination/" > Pagination< / a >
2014-11-25 19:04:38 +03:00
< / li >
2015-03-06 15:05:16 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/versioning/" > Versioning< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/content-negotiation/" > Content negotiation< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-18 18:42:42 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/metadata/" > Metadata< / a >
2014-12-18 18:42:42 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
< a href = "../../api-guide/schemas/" > Schemas< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/format-suffixes/" > Format suffixes< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/reverse/" > Returning URLs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/exceptions/" > Exceptions< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/status-codes/" > Status codes< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/testing/" > Testing< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../../api-guide/settings/" > Settings< / a >
2014-11-25 19:04:38 +03:00
< / li >
< / ul >
< / li >
< li class = "dropdown active" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Topics < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../documenting-your-api/" > Documenting your API< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-07-07 11:41:32 +03:00
< li >
< a href = "../api-clients/" > API Clients< / a >
< / li >
2015-03-06 15:05:16 +03:00
< li class = "active" >
2015-06-04 17:37:22 +03:00
< a href = "./" > Internationalization< / a >
2015-03-06 15:05:16 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../ajax-csrf-cors/" > AJAX, CSRF & CORS< / a >
2014-11-25 19:04:38 +03:00
< / li >
2015-10-28 14:35:39 +03:00
< li >
< a href = "../html-and-forms/" > HTML & Forms< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2015-06-04 17:37:22 +03:00
< a href = "../browser-enhancements/" > Browser Enhancements< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../browsable-api/" > The Browsable API< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-06-04 17:37:22 +03:00
< a href = "../rest-hypermedia-hateoas/" > REST, Hypermedia & HATEOAS< / a >
2014-11-25 19:04:38 +03:00
< / li >
2018-10-11 16:48:33 +03:00
< / ul >
< / li >
< li class = "dropdown" >
< a href = "#" class = "dropdown-toggle" data-toggle = "dropdown" > Community < b class = "caret" > < / b > < / a >
< ul class = "dropdown-menu" >
2014-11-25 19:04:38 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/tutorials-and-resources/" > Tutorials and Resources< / a >
2017-02-25 22:59:44 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/third-party-packages/" > Third Party Packages< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/contributing/" > Contributing to REST framework< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-18 16:49:50 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/project-management/" > Project management< / a >
2014-12-18 16:49:50 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/release-notes/" > Release Notes< / a >
2017-03-09 17:59:14 +03:00
< / li >
2018-10-18 13:50:44 +03:00
< li >
< a href = "../../community/3.9-announcement/" > 3.9 Announcement< / a >
< / li >
2014-11-25 19:04:38 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.8-announcement/" > 3.8 Announcement< / a >
2014-11-25 19:04:38 +03:00
< / li >
2014-12-01 15:20:07 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.7-announcement/" > 3.7 Announcement< / a >
2014-12-01 15:20:07 +03:00
< / li >
2015-08-06 16:31:52 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.6-announcement/" > 3.6 Announcement< / a >
2015-08-06 16:31:52 +03:00
< / li >
2015-10-28 14:35:39 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.5-announcement/" > 3.5 Announcement< / a >
2015-10-28 14:35:39 +03:00
< / li >
2016-07-14 15:05:57 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.4-announcement/" > 3.4 Announcement< / a >
2016-07-14 15:05:57 +03:00
< / li >
2016-10-20 18:31:37 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.3-announcement/" > 3.3 Announcement< / a >
2016-10-20 18:31:37 +03:00
< / li >
2017-03-09 17:59:14 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.2-announcement/" > 3.2 Announcement< / a >
2017-03-09 17:59:14 +03:00
< / li >
2017-10-06 15:06:25 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.1-announcement/" > 3.1 Announcement< / a >
2017-10-06 15:06:25 +03:00
< / li >
2018-04-03 16:54:40 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/3.0-announcement/" > 3.0 Announcement< / a >
2018-04-03 16:54:40 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/kickstarter-announcement/" > Kickstarter Announcement< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-05-26 13:48:39 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/mozilla-grant/" > Mozilla Grant< / a >
2016-05-26 13:48:39 +03:00
< / li >
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/funding/" > Funding< / a >
2016-05-26 13:48:39 +03:00
< / li >
2014-11-25 19:04:38 +03:00
< li >
2018-10-11 16:48:33 +03:00
< a href = "../../community/jobs/" > Jobs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< / ul >
< / li >
< / ul >
< / div >
<!-- /.nav - collapse -->
< / div >
< / div >
< / div >
< div class = "body-content" >
< div class = "container-fluid" >
<!-- Search Modal -->
2015-06-04 17:37:22 +03:00
< div id = "mkdocs_search_modal" class = "modal hide fade" tabindex = "-1" role = "dialog" aria-labelledby = "myModalLabel" aria-hidden = "true" >
2014-11-25 19:04:38 +03:00
< div class = "modal-header" >
< button type = "button" class = "close" data-dismiss = "modal" aria-hidden = "true" > × < / button >
< h3 id = "myModalLabel" > Documentation search< / h3 >
< / div >
< div class = "modal-body" >
2015-08-06 16:31:52 +03:00
< form role = "form" autocomplete = "off" >
2015-06-04 17:37:22 +03:00
< div class = "form-group" >
< input type = "text" name = "q" class = "form-control" placeholder = "Search..." id = "mkdocs-search-query" >
< / div >
< / form >
< div id = "mkdocs-search-results" > < / div >
2014-11-25 19:04:38 +03:00
< / div >
< div class = "modal-footer" >
< button class = "btn" data-dismiss = "modal" aria-hidden = "true" > Close< / button >
< / div >
< / div >
< div class = "row-fluid" >
< div class = "span3" >
< div id = "table-of-contents" >
< ul class = "nav nav-list side-nav well sidebar-nav-fixed" >
< li class = "main" >
2015-03-06 15:05:16 +03:00
< a href = "#internationalization" > Internationalization< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-03-06 15:05:16 +03:00
< a href = "#enabling-internationalized-apis" > Enabling internationalized APIs< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-03-06 15:05:16 +03:00
< a href = "#adding-new-translations" > Adding new translations< / a >
2014-11-25 19:04:38 +03:00
< / li >
< li >
2015-03-06 15:05:16 +03:00
< a href = "#how-the-language-is-determined" > How the language is determined< / a >
2014-11-25 19:04:38 +03:00
< / li >
2016-05-26 13:48:39 +03:00
< div class = "promo" >
< hr / >
< div id = "sidebarInclude" >
< / div >
2014-11-25 19:04:38 +03:00
< / ul >
< / div >
< / div >
< div id = "main-content" class = "span9" >
2015-06-04 17:37:22 +03:00
2015-11-04 17:59:23 +03:00
< h1 id = "internationalization" > < a class = "toclink" href = "#internationalization" > Internationalization< / a > < / h1 >
2014-11-25 19:04:38 +03:00
< blockquote >
2015-03-06 15:05:16 +03:00
< p > Supporting internationalization is not optional. It must be a core feature.< / p >
2018-01-15 17:42:44 +03:00
< p > — < a href = "https://youtu.be/Wa0VfS2q94Y" > Jannis Leidel, speaking at Django Under the Hood, 2015< / a > .< / p >
2014-11-25 19:04:38 +03:00
< / blockquote >
2015-03-06 15:05:16 +03:00
< p > REST framework ships with translatable error messages. You can make these appear in your language enabling < a href = "https://docs.djangoproject.com/en/1.7/topics/i18n/translation" > Django's standard translation mechanisms< / a > .< / p >
< p > Doing so will allow you to:< / p >
< ul >
< li > Select a language other than English as the default, using the standard < code > LANGUAGE_CODE< / code > Django setting.< / li >
< li > Allow clients to choose a language themselves, using the < code > LocaleMiddleware< / code > included with Django. A typical usage for API clients would be to include an < code > Accept-Language< / code > request header.< / li >
< / ul >
2015-11-04 17:59:23 +03:00
< h2 id = "enabling-internationalized-apis" > < a class = "toclink" href = "#enabling-internationalized-apis" > Enabling internationalized APIs< / a > < / h2 >
2015-03-06 15:05:16 +03:00
< p > You can change the default language by using the standard Django < code > LANGUAGE_CODE< / code > setting:< / p >
< pre > < code > LANGUAGE_CODE = "es-es"
< / code > < / pre >
< p > You can turn on per-request language requests by adding < code > LocalMiddleware< / code > to your < code > MIDDLEWARE_CLASSES< / code > setting:< / p >
< pre > < code > MIDDLEWARE_CLASSES = [
...
'django.middleware.locale.LocaleMiddleware'
]
< / code > < / pre >
< p > When per-request internationalization is enabled, client requests will respect the < code > Accept-Language< / code > header where possible. For example, let's make a request for an unsupported media type:< / p >
< p > < strong > Request< / strong > < / p >
< pre > < code > GET /api/users HTTP/1.1
Accept: application/xml
Accept-Language: es-es
Host: example.org
< / code > < / pre >
< p > < strong > Response< / strong > < / p >
< pre > < code > HTTP/1.0 406 NOT ACCEPTABLE
{"detail": "No se ha podido satisfacer la solicitud de cabecera de Accept."}
< / code > < / pre >
< p > REST framework includes these built-in translations both for standard exception cases, and for serializer validation errors.< / p >
< p > Note that the translations only apply to the error strings themselves. The format of error messages, and the keys of field names will remain the same. An example < code > 400 Bad Request< / code > response body might look like this:< / p >
2018-10-11 16:48:33 +03:00
< pre > < code > {"detail": {"username": ["Esse campo deve ser único."]}}
2015-03-06 15:05:16 +03:00
< / code > < / pre >
2015-06-04 17:37:22 +03:00
< p > If you want to use different string for parts of the response such as < code > detail< / code > and < code > non_field_errors< / code > then you can modify this behavior by using a < a href = "../../api-guide/exceptions/#custom-exception-handling" > custom exception handler< / a > .< / p >
2015-11-04 17:59:23 +03:00
< h4 id = "specifying-the-set-of-supported-languages" > < a class = "toclink" href = "#specifying-the-set-of-supported-languages" > Specifying the set of supported languages.< / a > < / h4 >
2015-03-06 15:05:16 +03:00
< p > By default all available languages will be supported.< / p >
< p > If you only wish to support a subset of the available languages, use Django's standard < code > LANGUAGES< / code > setting:< / p >
< pre > < code > LANGUAGES = [
('de', _('German')),
('en', _('English')),
]
< / code > < / pre >
2015-11-04 17:59:23 +03:00
< h2 id = "adding-new-translations" > < a class = "toclink" href = "#adding-new-translations" > Adding new translations< / a > < / h2 >
2015-03-06 15:05:16 +03:00
< p > REST framework translations are managed online using < a href = "https://www.transifex.com/projects/p/django-rest-framework/" > Transifex< / a > . You can use the Transifex service to add new translation languages. The maintenance team will then ensure that these translation strings are included in the REST framework package.< / p >
< p > Sometimes you may need to add translation strings to your project locally. You may need to do this if:< / p >
2014-11-25 19:04:38 +03:00
< ul >
2015-03-06 15:05:16 +03:00
< li > You want to use REST Framework in a language which has not been translated yet on Transifex.< / li >
< li > Your project includes custom error messages, which are not part of REST framework's default translation strings.< / li >
2014-11-25 19:04:38 +03:00
< / ul >
2015-11-04 17:59:23 +03:00
< h4 id = "translating-a-new-language-locally" > < a class = "toclink" href = "#translating-a-new-language-locally" > Translating a new language locally< / a > < / h4 >
2015-03-06 15:05:16 +03:00
< p > This guide assumes you are already familiar with how to translate a Django app. If you're not, start by reading < a href = "https://docs.djangoproject.com/en/1.7/topics/i18n/translation" > Django's translation docs< / a > .< / p >
< p > If you're translating a new language you'll need to translate the existing REST framework error messages:< / p >
< ol >
< li >
< p > Make a new folder where you want to store the internationalization resources. Add this path to your < a href = "https://docs.djangoproject.com/en/1.7/ref/settings/#std:setting-LOCALE_PATHS" > < code > LOCALE_PATHS< / code > < / a > setting.< / p >
< / li >
< li >
< p > Now create a subfolder for the language you want to translate. The folder should be named using < a href = "https://docs.djangoproject.com/en/1.7/topics/i18n/#term-locale-name" > locale name< / a > notation. For example: < code > de< / code > , < code > pt_BR< / code > , < code > es_AR< / code > .< / p >
< / li >
< li >
2017-05-12 19:15:00 +03:00
< p > Now copy the < a href = "https://raw.githubusercontent.com/encode/django-rest-framework/master/rest_framework/locale/en_US/LC_MESSAGES/django.po" > base translations file< / a > from the REST framework source code into your translations folder.< / p >
2015-03-06 15:05:16 +03:00
< / li >
< li >
< p > Edit the < code > django.po< / code > file you've just copied, translating all the error messages.< / p >
< / li >
< li >
2017-05-12 19:15:00 +03:00
< p > Run < code > manage.py compilemessages -l pt_BR< / code > to make the translations
2015-03-06 15:05:16 +03:00
available for Django to use. You should see a message like < code > processing file django.po in < ...> /locale/pt_BR/LC_MESSAGES< / code > .< / p >
< / li >
< li >
< p > Restart your development server to see the changes take effect.< / p >
< / li >
< / ol >
< p > If you're only translating custom error messages that exist inside your project codebase you don't need to copy the REST framework source < code > django.po< / code > file into a < code > LOCALE_PATHS< / code > folder, and can instead simply run Django's standard < code > makemessages< / code > process.< / p >
2015-11-04 17:59:23 +03:00
< h2 id = "how-the-language-is-determined" > < a class = "toclink" href = "#how-the-language-is-determined" > How the language is determined< / a > < / h2 >
2015-03-06 15:05:16 +03:00
< p > If you want to allow per-request language preferences you'll need to include < code > django.middleware.locale.LocaleMiddleware< / code > in your < code > MIDDLEWARE_CLASSES< / code > setting.< / p >
< p > You can find more information on how the language preference is determined in the < a href = "https://docs.djangoproject.com/en/1.7/topics/i18n/translation/#how-django-discovers-language-preference" > Django documentation< / a > . For reference, the method is:< / p >
< ol >
< li > First, it looks for the language prefix in the requested URL.< / li >
< li > Failing that, it looks for the < code > LANGUAGE_SESSION_KEY< / code > key in the current user’ < / li >
< li > Failing that, it looks for a cookie.< / li >
< li > Failing that, it looks at the < code > Accept-Language< / code > HTTP header.< / li >
< li > Failing that, it uses the global < code > LANGUAGE_CODE< / code > setting.< / li >
< / ol >
< p > For API clients the most appropriate of these will typically be to use the < code > Accept-Language< / code > header; Sessions and cookies will not be available unless using session authentication, and generally better practice to prefer an < code > Accept-Language< / code > header for API clients rather than using language URL prefixes.< / p >
2015-06-04 17:37:22 +03:00
2015-06-23 14:05:53 +03:00
< / div > <!-- /span -->
< / div > <!-- /row -->
< / div > <!-- /.fluid - container -->
< / div > <!-- /.body content -->
2014-11-25 19:04:38 +03:00
< div id = "push" > < / div >
2015-06-23 14:05:53 +03:00
< / div > <!-- /.wrapper -->
2014-11-25 19:04:38 +03:00
< footer class = "span12" >
2015-10-28 14:35:39 +03:00
< p > Documentation built with < a href = "http://www.mkdocs.org/" > MkDocs< / a > .
2014-11-25 19:04:38 +03:00
< / p >
< / footer >
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
< script src = "../../js/jquery-1.8.1-min.js" > < / script >
< script src = "../../js/prettify-1.0.js" > < / script >
< script src = "../../js/bootstrap-2.1.1-min.js" > < / script >
2019-06-04 14:04:28 +03:00
< script async src = "https://fund.django-rest-framework.org/sidebar_include.js" > < / script >
2015-06-04 17:37:22 +03:00
< script > var base _url = '../..' ; < / script >
< script src = "../../mkdocs/js/require.js" > < / script >
2014-12-11 12:55:10 +03:00
< script src = "../../js/theme.js" > < / script >
2014-11-25 19:04:38 +03:00
< script >
var shiftWindow = function() {
scrollBy(0, -50)
};
2015-06-23 14:05:53 +03:00
2014-11-25 19:04:38 +03:00
if (location.hash) shiftWindow();
window.addEventListener("hashchange", shiftWindow);
$('.dropdown-menu').on('click touchstart', function(event) {
event.stopPropagation();
});
2015-06-23 14:05:53 +03:00
// Dynamically force sidenav/dropdown to no higher than browser window
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
2014-11-25 19:04:38 +03:00
$(function() {
$(window).resize(function() {
2015-06-23 14:05:53 +03:00
$('.side-nav, .dropdown-menu').css('max-height', window.innerHeight - 130);
2014-11-25 19:04:38 +03:00
});
});
< / script >
< / body >
< / html >
